Word.Interfaces.TableRowCollectionLoadOptions interface

Contains the collection of the document's TableRow objects.

[ API set: WordApi 1.3 ]

Properties

$all
cellCount

For EACH ITEM in the collection: Gets the number of cells in the row. Read-only.

[ API set: WordApi 1.3 ]

font

For EACH ITEM in the collection: Gets the font. Use this to get and set font name, size, color, and other properties.

[ API set: WordApi 1.3 ]

horizontalAlignment

For EACH ITEM in the collection: Gets and sets the horizontal alignment of every cell in the row. The value can be 'Left', 'Centered', 'Right', or 'Justified'.

[ API set: WordApi 1.3 ]

isHeader

For EACH ITEM in the collection: Checks whether the row is a header row. Read-only. To set the number of header rows, use HeaderRowCount on the Table object.

[ API set: WordApi 1.3 ]

parentTable

For EACH ITEM in the collection: Gets parent table.

[ API set: WordApi 1.3 ]

preferredHeight

For EACH ITEM in the collection: Gets and sets the preferred height of the row in points.

[ API set: WordApi 1.3 ]

rowIndex

For EACH ITEM in the collection: Gets the index of the row in its parent table. Read-only.

[ API set: WordApi 1.3 ]

shadingColor

For EACH ITEM in the collection: Gets and sets the shading color. Color is specified in "#RRGGBB" format or by using the color name.

[ API set: WordApi 1.3 ]

values

For EACH ITEM in the collection: Gets and sets the text values in the row, as a 2D Javascript array.

[ API set: WordApi 1.3 ]

verticalAlignment

For EACH ITEM in the collection: Gets and sets the vertical alignment of the cells in the row. The value can be 'Top', 'Center', or 'Bottom'.

[ API set: WordApi 1.3 ]

Property Details

$all

$all?: boolean;

Property Value

boolean

cellCount

For EACH ITEM in the collection: Gets the number of cells in the row. Read-only.

[ API set: WordApi 1.3 ]

cellCount?: boolean;

Property Value

boolean

font

For EACH ITEM in the collection: Gets the font. Use this to get and set font name, size, color, and other properties.

[ API set: WordApi 1.3 ]

font?: Word.Interfaces.FontLoadOptions;

Property Value

horizontalAlignment

For EACH ITEM in the collection: Gets and sets the horizontal alignment of every cell in the row. The value can be 'Left', 'Centered', 'Right', or 'Justified'.

[ API set: WordApi 1.3 ]

horizontalAlignment?: boolean;

Property Value

boolean

isHeader

For EACH ITEM in the collection: Checks whether the row is a header row. Read-only. To set the number of header rows, use HeaderRowCount on the Table object.

[ API set: WordApi 1.3 ]

isHeader?: boolean;

Property Value

boolean

parentTable

For EACH ITEM in the collection: Gets parent table.

[ API set: WordApi 1.3 ]

parentTable?: Word.Interfaces.TableLoadOptions;

Property Value

preferredHeight

For EACH ITEM in the collection: Gets and sets the preferred height of the row in points.

[ API set: WordApi 1.3 ]

preferredHeight?: boolean;

Property Value

boolean

rowIndex

For EACH ITEM in the collection: Gets the index of the row in its parent table. Read-only.

[ API set: WordApi 1.3 ]

rowIndex?: boolean;

Property Value

boolean

shadingColor

For EACH ITEM in the collection: Gets and sets the shading color. Color is specified in "#RRGGBB" format or by using the color name.

[ API set: WordApi 1.3 ]

shadingColor?: boolean;

Property Value

boolean

values

For EACH ITEM in the collection: Gets and sets the text values in the row, as a 2D Javascript array.

[ API set: WordApi 1.3 ]

values?: boolean;

Property Value

boolean

verticalAlignment

For EACH ITEM in the collection: Gets and sets the vertical alignment of the cells in the row. The value can be 'Top', 'Center', or 'Bottom'.

[ API set: WordApi 1.3 ]

verticalAlignment?: boolean;

Property Value

boolean