Edit

Share via

Word.Interfaces.TableRowLoadOptions interface

Package:
word

Represents a row 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).
cellCount

Gets the number of cells in the row.
font

Gets the font. Use this to get and set font name, size, color, and other properties.
horizontalAlignment

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

Checks whether the row is a header row. To set the number of header rows, use headerRowCount on the Table object.
parentTable

Gets parent table.
preferredHeight

Specifies the preferred height of the row in points.
range

Returns the Range object that represents the table row.
rowIndex

Gets the index of the row in its parent table.
shading

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

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

Specifies the text values in the row, as a 2D JavaScript array.
verticalAlignment

Specifies the vertical alignment of the cells in the row. The value can be top, center, or bottom.

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

cellCount

Gets the number of cells in the row.

cellCount?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi 1.3 ]

font

Gets the font. Use this to get and set font name, size, color, and other properties.

font?: Word.Interfaces.FontLoadOptions;

Property Value

Word.Interfaces.FontLoadOptions

Remarks

[ API set: WordApi 1.3 ]

horizontalAlignment

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

horizontalAlignment?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi 1.3 ]

isHeader

Checks whether the row is a header row. To set the number of header rows, use headerRowCount on the Table object.

isHeader?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi 1.3 ]

parentTable

Gets parent table.

parentTable?: Word.Interfaces.TableLoadOptions;

Property Value

Word.Interfaces.TableLoadOptions

Remarks

[ API set: WordApi 1.3 ]

preferredHeight

Specifies the preferred height of the row in points.

preferredHeight?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi 1.3 ]

range

Returns the Range object that represents the table row.

range?: Word.Interfaces.RangeLoadOptions;

Property Value

Word.Interfaces.RangeLoadOptions

Remarks

[ API set: WordApiDesktop 1.4 ]

rowIndex

Gets the index of the row in its parent table.

rowIndex?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi 1.3 ]

shading

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

shading?: Word.Interfaces.ShadingUniversalLoadOptions;

Property Value

Word.Interfaces.ShadingUniversalLoadOptions

Remarks

[ API set: WordApiDesktop 1.4 ]

shadingColor

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

shadingColor?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi 1.3 ]

values

Specifies the text values in the row, as a 2D JavaScript array.

values?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi 1.3 ]

verticalAlignment

Specifies the vertical alignment of the cells in the row. The value can be top, center, or bottom.

verticalAlignment?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi 1.3 ]