Class TableCell

A table cell, addressed by its (table, row, column) position. Its text is read live from the model; span, alignment, borders, and content are set through the mutators.

Hierarchy (View Summary)

Handle<DocumentModule>
- TableCell

Index

Accessors

isValid _index tableId row column text

Methods

equals toString setProperties setVerticalAlign setAlignment setBorder appendRun

Accessors

isValid

get isValid(): boolean
Whether this wrapper still refers to a live engine object.

Returns boolean
Inherited from Handle.isValid
- Defined in src/core/handle.ts:55

_index

set _index(value: number): void
Parameters
- value: number
Returns void
Inherited from Handle._index
- Defined in src/core/handle.ts:69

tableId

get tableId(): number
The id of the table this cell belongs to.

Returns number
- Defined in src/documents/table-cell.ts:17

row

get row(): number
The cell's row index.

Returns number
- Defined in src/documents/table-cell.ts:22

column

get column(): number
The cell's column index.

Returns number
- Defined in src/documents/table-cell.ts:27

text

get text(): string
The cell's text (its paragraphs joined by newlines), read live from the model.

Returns string
- Defined in src/documents/table-cell.ts:32

Methods

equals

equals(other: Handle<unknown> | null): boolean
Reference equality is the identity test — prefer a === b. This is retained only for the rare cross-realm case where two wrappers describe the same handle by value. Reads the raw index so comparing a stale wrapper never throws.
Parameters
- other: Handle<unknown> | null
Returns boolean
Inherited from Handle.equals
- Defined in src/core/handle.ts:78

toString

toString(): string
A readable identity for logs and diagnostics, never [object Object].

Returns string
Inherited from Handle.toString
- Defined in src/core/handle.ts:83

setProperties

setProperties(
    properties: {
        gridSpan?: number;
        rowSpan?: number;
        verticalAlign?: number;
        shade?: number;
    },
): this
Set the cell's span, vertical alignment, and shading.
Parameters
- properties: { gridSpan?: number; rowSpan?: number; verticalAlign?: number; shade?: number }
Returns this
- Defined in src/documents/table-cell.ts:37

setVerticalAlign

setVerticalAlign(verticalAlign: number): this
Set the vertical alignment of the cell's content.
Parameters
- verticalAlign: number
Returns this
- Defined in src/documents/table-cell.ts:58

setAlignment

setAlignment(alignment: number): this
Set the horizontal alignment of the cell's paragraphs.
Parameters
- alignment: number
Returns this
- Defined in src/documents/table-cell.ts:63

setBorder

setBorder(edgeMask: number, color: number, width: number, style: number): this
Set borders on the cell's edges.
Parameters
- edgeMask: number
- color: number
- width: number
- style: number
Returns this
- Defined in src/documents/table-cell.ts:70

appendRun

appendRun(
text: string,
properties?: { format?: number; fontSizePixels?: number; color?: number },
): this
Append a formatted run of text to the cell.
Parameters
- text: string
- properties: { format?: number; fontSizePixels?: number; color?: number } = {}
Returns this
- Defined in src/documents/table-cell.ts:86