Word.Interfaces.TableRowData interface

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

Properties

cellCount

Gets the number of cells in the row. Read-only.

[ API set: WordApi 1.3 ]

cells

Gets cells. Read-only.

[ API set: WordApi 1.3 ]

font

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

[ API set: WordApi 1.3 ]

horizontalAlignment

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

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 ]

preferredHeight

Gets and sets the preferred height of the row in points.

[ API set: WordApi 1.3 ]

rowIndex

Gets the index of the row in its parent table. Read-only.

[ API set: WordApi 1.3 ]

shadingColor

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

[ API set: WordApi 1.3 ]

values

Gets and sets the text values in the row, as a 2D Javascript array.

[ API set: WordApi 1.3 ]

verticalAlignment

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

cellCount

Gets the number of cells in the row. Read-only.

[ API set: WordApi 1.3 ]

cellCount?: number;

Property Value

number

cells

Gets cells. Read-only.

[ API set: WordApi 1.3 ]

cells?: Word.Interfaces.TableCellData[];

Property Value

font

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

[ API set: WordApi 1.3 ]

font?: Word.Interfaces.FontData;

Property Value

horizontalAlignment

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

Property Value

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

isHeader

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

preferredHeight

Gets and sets the preferred height of the row in points.

[ API set: WordApi 1.3 ]

preferredHeight?: number;

Property Value

number

rowIndex

Gets the index of the row in its parent table. Read-only.

[ API set: WordApi 1.3 ]

rowIndex?: number;

Property Value

number

shadingColor

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

[ API set: WordApi 1.3 ]

shadingColor?: string;

Property Value

string

values

Gets and sets the text values in the row, as a 2D Javascript array.

[ API set: WordApi 1.3 ]

values?: string[][];

Property Value

string[][]

verticalAlignment

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

Property Value

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