Edit

Share via

Word.Interfaces.TableCellLoadOptions interface

Package:
word

Represents a table cell in a Word document.

Remarks

[ API set: WordApi 1.3 ]

Properties

$all

Specifying $all for the load options loads all the scalar properties (such as Range.address) but not the navigational properties (such as Range.format.fill.color).
body

Gets the Body object of the cell.
cellIndex

Gets the index of the cell in its row.
column

Returns the TableColumn object that represents the table column that contains this cell.
columnWidth

Specifies the width of the cell's column in points. This is applicable to uniform tables.
horizontalAlignment

Specifies the horizontal alignment of the cell. The value can be left, centered, right, or justified.
parentRow

Gets the parent row of the cell.
parentTable

Gets the parent table of the cell.
rowIndex

Gets the index of the cell's row in the table.
shading

Returns the ShadingUniversal object that represents the shading of the table cell.
shadingColor

Specifies the shading color of the cell. Color is specified in "#RRGGBB" format or by using the color name.
value

Specifies the text of the cell.
verticalAlignment

Specifies the vertical alignment of the cell. The value can be top, center, or bottom.
width

Gets the width of the cell in points.

Property Details

$all

Specifying $all for the load options loads all the scalar properties (such as Range.address) but not the navigational properties (such as Range.format.fill.color).

$all?: boolean;

Property Value

boolean

body

Gets the Body object of the cell.

body?: Word.Interfaces.BodyLoadOptions;

Property Value

Word.Interfaces.BodyLoadOptions

Remarks

[ API set: WordApi 1.3 ]

cellIndex

Gets the index of the cell in its row.

cellIndex?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi 1.3 ]

column

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Returns the TableColumn object that represents the table column that contains this cell.

column?: Word.Interfaces.TableColumnLoadOptions;

Property Value

Word.Interfaces.TableColumnLoadOptions

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

columnWidth

Specifies the width of the cell's column in points. This is applicable to uniform tables.

columnWidth?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi 1.3 ]

horizontalAlignment

Specifies the horizontal alignment of the cell. The value can be left, centered, right, or justified.

horizontalAlignment?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi 1.3 ]

parentRow

Gets the parent row of the cell.

parentRow?: Word.Interfaces.TableRowLoadOptions;

Property Value

Word.Interfaces.TableRowLoadOptions

Remarks

[ API set: WordApi 1.3 ]

parentTable

Gets the parent table of the cell.

parentTable?: Word.Interfaces.TableLoadOptions;

Property Value

Word.Interfaces.TableLoadOptions

Remarks

[ API set: WordApi 1.3 ]

rowIndex

Gets the index of the cell's row in the table.

rowIndex?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi 1.3 ]

shading

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Returns the ShadingUniversal object that represents the shading of the table cell.

shading?: Word.Interfaces.ShadingUniversalLoadOptions;

Property Value

Word.Interfaces.ShadingUniversalLoadOptions

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

shadingColor

Specifies the shading color of the cell. Color is specified in "#RRGGBB" format or by using the color name.

shadingColor?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi 1.3 ]

value

Specifies the text of the cell.

value?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi 1.3 ]

verticalAlignment

Specifies the vertical alignment of the cell. The value can be top, center, or bottom.

verticalAlignment?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi 1.3 ]

width

Gets the width of the cell in points.

width?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi 1.3 ]