Word.Interfaces.TableRowData interface
An interface describing the data returned by calling tableRow.toJSON()
.
Properties
cell |
Gets the number of cells in the row. |
cells | Gets cells. |
fields | Gets the collection of |
font | Gets the font. Use this to get and set font name, size, color, and other properties. |
horizontal |
Specifies the horizontal alignment of every cell in the row. The value can be |
is |
Checks whether the row is a header row. To set the number of header rows, use |
preferred |
Specifies the preferred height of the row in points. |
row |
Gets the index of the row in its parent table. |
shading |
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. |
vertical |
Specifies the vertical alignment of the cells in the row. The value can be |
Property Details
cellCount
Gets the number of cells in the row.
cellCount?: number;
Property Value
number
Remarks
cells
Gets cells.
cells?: Word.Interfaces.TableCellData[];
Property Value
Remarks
fields
Gets the collection of Field
objects in the table row.
fields?: Word.Interfaces.FieldData[];
Property Value
Remarks
font
Gets the font. Use this to get and set font name, size, color, and other properties.
font?: Word.Interfaces.FontData;
Property Value
Remarks
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
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
preferredHeight
Specifies the preferred height of the row in points.
preferredHeight?: number;
Property Value
number
Remarks
rowIndex
Gets the index of the row in its parent table.
rowIndex?: number;
Property Value
number
Remarks
shadingColor
Specifies the shading color. Color is specified in "#RRGGBB" format or by using the color name.
shadingColor?: string;
Property Value
string
Remarks
values
Specifies the text values in the row, as a 2D JavaScript array.
values?: string[][];
Property Value
string[][]
Remarks
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"