Word.Interfaces.TableRowData interface

Package:

word

An interface describing the data returned by calling tableRow.toJSON().

Properties

cellCount	Gets the number of cells in the row.
cells	Gets cells.
fields	Gets the collection of field objects in the table 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.
preferredHeight	Specifies the preferred height of the row in points.
rowIndex	Gets the index of the row in its parent table.
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

cellCount

Gets the number of cells in the row.

cellCount?: number;

Property Value

number

Remarks

[ API set: WordApi 1.3 ]

cells

Gets cells.

cells?: Word.Interfaces.TableCellData[];

Property Value

Word.Interfaces.TableCellData[]

Remarks

[ API set: WordApi 1.3 ]

fields

Gets the collection of field objects in the table row.

fields?: Word.Interfaces.FieldData[];

Property Value

Word.Interfaces.FieldData[]

Remarks

[ API set: WordApi 1.4 ]

font

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

font?: Word.Interfaces.FontData;

Property Value

Word.Interfaces.FontData

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?: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified";

Property Value

Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"

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 ]

preferredHeight

Specifies the preferred height of the row in points.

preferredHeight?: number;

Property Value

number

Remarks

[ API set: WordApi 1.3 ]

rowIndex

Gets the index of the row in its parent table.

rowIndex?: number;

Property Value

number

Remarks

[ API set: WordApi 1.3 ]

shadingColor

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

shadingColor?: string;

Property Value

string

Remarks

[ API set: WordApi 1.3 ]

values

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

values?: string[][];

Property Value

string[][]

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?: Word.VerticalAlignment | "Mixed" | "Top" | "Center" | "Bottom";

Property Value

Word.VerticalAlignment | "Mixed" | "Top" | "Center" | "Bottom"

Remarks

[ API set: WordApi 1.3 ]