Class TableCell

Represents a cell in a tabular visualization.

Since

2.0

Hierarchy (view full)

Methods

Cast Equals GetHashCode ToString TryCast Equals

Default capability

BackgroundColor BorderColor BorderStyle Bounds CanHaveImage CellType ColumnIndex DataValue DataValueProperties FontMetadata HorizontalTextAlignment IsUpperLeftInRange Link Range RowIndex Text TextColor Tooltip WordWrap TryGetImageData

Methods

Cast

  • Cast<T1, T2>(this, type): 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

    Returns T1

Equals

  • Equals(obj): 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.

GetHashCode

  • GetHashCode(): number

  • Serves as the default hash function.

    Returns number

    A hash code for the current object.

ToString

  • ToString(): string

  • Returns a string that represents the current object.

    Returns string

    A string that represents the current object.

TryCast

  • TryCast<T1, T2>(this, type): null | T1

  • 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

    Returns null | T1

StaticEquals

  • Equals(objA, objB): 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.

Default capability

BackgroundColor

  • get BackgroundColor(): Color

  • Gets the color of the background.

    Returns Color

    Since

    2.0

BorderColor

  • get BorderColor(): Color

  • Gets the border color.

    Returns Color

    Since

    2.0

BorderStyle

Bounds

  • get Bounds(): Rectangle

  • Gets the bounds of the cell. The point (0,0) represents the upper left corner of whole layout.

    Returns Rectangle

    Since

    2.0

CanHaveImage

  • get CanHaveImage(): boolean

  • Gets a value indicating whether this instance can have image.

    Returns boolean

    Since

    2.0

CellType

ColumnIndex

  • get ColumnIndex(): number

  • Gets the index of the column.

    Returns number

    Since

    2.0

DataValue

  • get DataValue(): DataValue

  • Gets the data value of this cell. Can be null.

    Returns DataValue

    Since

    2.0

DataValueProperties

FontMetadata

HorizontalTextAlignment

  • get HorizontalTextAlignment(): TextAlign

  • Gets the horizontal alignment of text in the cell.

    Returns 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

  • 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

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(): Color

  • Gets the text color.

    Returns Color

    Since

    2.0

Tooltip

  • 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): boolean

  • Gets the image displayed in the cell. The image is written in PNG format to the provided stream.

    Parameters

    • outputStream: 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

Settings

Member Visibility

On This Page

Methods
Default capability