About
Working with mods
API documentation
- Action mods
  - API documentation
- Visualization mods
  - API overview
  - API documentation

Class TableCell

Represents a cell in a tabular visualization.

Since

2.0

Hierarchy (View Summary)

Spotfire.Object
- TableCell

Methods

Cast

Cast<T1, T2>(this: T2, type: TypeRef<T1>): T1
Casts this object to the specified type. Throws error on failure.
Type Parameters
- T1
  The target type of the cast.
- T2
  The type of the object to cast.
Parameters
- this: T2
- type: TypeRef<T1>
  The type to cast to.
Returns T1
Inherited from Object.Cast

Equals

Equals(obj: any): boolean
Determines whether the specified object is equal to the current object.
Parameters
- obj: any
  The object to compare with the current object.
Returns boolean
true if the specified object is equal to the current object; otherwise, false.

Inherited from Object.Equals

GetHashCode

GetHashCode(): number
Serves as the default hash function.

Returns number
A hash code for the current object.

Inherited from Object.GetHashCode

ToString

ToString(): string
Returns a string that represents the current object.

Returns string
A string that represents the current object.

Inherited from Object.ToString

TryCast

TryCast<T1, T2>(this: T2, type: TypeRef<T1>): T1 | null
Casts this object to the specified type. Returns null on failure.
Type Parameters
- T1
  The target type of the cast.
- T2
  The type of the object to cast.
Parameters
- this: T2
- type: TypeRef<T1>
  The type to cast to.
Returns T1 | null
Inherited from Object.TryCast

`Static`Equals

Equals(objA: any, objB: any): boolean
Determines whether the specified object instances are considered equal.
Parameters
- objA: any
  The first object to compare.
- objB: any
  The second object to compare.
Returns boolean
true if the objects are considered equal; otherwise, false. If both objA and objB are null, the method returns true.

Inherited from Object.Equals

Default capability

BackgroundColor

get BackgroundColor(): System.Drawing.Color
Gets the color of the background.

Returns System.Drawing.Color
Since
2.0

BorderColor

get BorderColor(): System.Drawing.Color
Gets the border color.

Returns System.Drawing.Color
Since
2.0

BorderStyle

get BorderStyle(): Spotfire.Dxp.Application.Visuals.TableCellBorderStyle
Gets the border style.

Returns Spotfire.Dxp.Application.Visuals.TableCellBorderStyle
Since
2.0

Bounds

get Bounds(): System.Drawing.Rectangle
Gets the bounds of the cell. The point (0,0) represents the upper left corner of whole layout.

Returns System.Drawing.Rectangle
Since
2.0

CanHaveImage

get CanHaveImage(): boolean
Gets a value indicating whether this instance can have image.

Returns boolean
Remark
This is a convenience property to avoid calling GetImage when not necessary.

Since
2.0

CellType

get CellType(): Spotfire.Dxp.Application.Visuals.TableCellType
Gets the type of a cell.

Returns Spotfire.Dxp.Application.Visuals.TableCellType
Since
2.0

ColumnIndex

get ColumnIndex(): number
Gets the index of the column.

Returns number
Since
2.0

DataValue

get DataValue(): Spotfire.Dxp.Data.DataValue
Gets the data value of this cell. Can be null.

Returns Spotfire.Dxp.Data.DataValue
Since
2.0

DataValueProperties

get DataValueProperties(): Spotfire.Dxp.Data.DataValueProperties
Gets metadata for the data value of this cell. Can be null.

Returns Spotfire.Dxp.Data.DataValueProperties
Since
2.0

FontMetadata

get FontMetadata(): Spotfire.Dxp.Framework.Styles.FontMetadata
Gets the font used for text in the cell.

Returns Spotfire.Dxp.Framework.Styles.FontMetadata
Since
2.0

HorizontalTextAlignment

get HorizontalTextAlignment(): Spotfire.Dxp.Framework.Styles.TextAlign
Gets the horizontal alignment of text in the cell.

Returns Spotfire.Dxp.Framework.Styles.TextAlign
Since
2.0

IsUpperLeftInRange

get IsUpperLeftInRange(): boolean
Gets a value indicating whether this instance is upper left in range. This will always be true for cells that do not span over multiple columns or rows.

Returns boolean
Since
2.0

Link

get Link(): string
Gets a string representing a link url. If the cell does not have a link, this property returns String.Empty.

Returns string
Since
2.0

Range

get Range(): Spotfire.Dxp.Application.Visuals.CellRange
Gets the extent of the cell expressed as a Spotfire.Dxp.Application.Visuals.CellRange

Returns Spotfire.Dxp.Application.Visuals.CellRange
Since
2.0

RowIndex

get RowIndex(): number
Gets the row index of the cell.

Returns number
Since
2.0

Text

get Text(): string
Gets the text.

Returns string
Since
2.0

TextColor

get TextColor(): System.Drawing.Color
Gets the text color.

Returns System.Drawing.Color
Since
2.0

get Tooltip(): string
Gets the tooltip for this cell.

Returns string
Since
2.0

WordWrap

get WordWrap(): boolean
Gets a value indicating whether cell text can be drawn on muliple lines or not.

Returns boolean
Since
2.0

TryGetImageData

TryGetImageData(outputStream: System.IO.Stream): boolean
Gets the image displayed in the cell. The image is written in PNG format to the provided stream.
Parameters
- outputStream: System.IO.Stream
  The stream to write output data to.
Returns boolean
true if the cell contains an image and it has been written to the provided stream. Otherwise false.

Since
2.0