Word.Interfaces.TableLoadOptions interface

Reference

Package:: word

Represents a table in a Word document.

Remarks

Properties

$all	Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`).
alignment	Specifies the alignment of the table against the page column. The value can be 'Left', 'Centered', or 'Right'.
font	Gets the font. Use this to get and set font name, size, color, and other properties.
headerRowCount	Specifies the number of header rows.
horizontalAlignment	Specifies the horizontal alignment of every cell in the table. The value can be 'Left', 'Centered', 'Right', or 'Justified'.
isUniform	Indicates whether all of the table rows are uniform.
nestingLevel	Gets the nesting level of the table. Top-level tables have level 1.
parentBody	Gets the parent body of the table.
parentContentControl	Gets the content control that contains the table. Throws an `ItemNotFound` error if there isn't a parent content control.
parentContentControlOrNullObject	Gets the content control that contains the table. If there isn't a parent content control, then this method will return an object with its `isNullObject` property set to `true`. For further information, see *OrNullObject methods and properties.
parentTable	Gets the table that contains this table. Throws an `ItemNotFound` error if it isn't contained in a table.
parentTableCell	Gets the table cell that contains this table. Throws an `ItemNotFound` error if it isn't contained in a table cell.
parentTableCellOrNullObject	Gets the table cell that contains this table. If it isn't contained in a table cell, then this method will return an object with its `isNullObject` property set to `true`. For further information, see *OrNullObject methods and properties.
parentTableOrNullObject	Gets the table that contains this table. If it isn't contained in a table, then this method will return an object with its `isNullObject` property set to `true`. For further information, see *OrNullObject methods and properties.
rowCount	Gets the number of rows in the table.
shadingColor	Specifies the shading color. Color is specified in "#RRGGBB" format or by using the color name.
style	Specifies the style name for the table. Use this property for custom styles and localized style names. To use the built-in styles that are portable between locales, see the "styleBuiltIn" property.
styleBandedColumns	Specifies whether the table has banded columns.
styleBandedRows	Specifies whether the table has banded rows.
styleBuiltIn	Specifies the built-in style name for the table. Use this property for built-in styles that are portable between locales. To use custom styles or localized style names, see the "style" property.
styleFirstColumn	Specifies whether the table has a first column with a special style.
styleLastColumn	Specifies whether the table has a last column with a special style.
styleTotalRow	Specifies whether the table has a total (last) row with a special style.
values	Specifies the text values in the table, as a 2D JavaScript array.
verticalAlignment	Specifies the vertical alignment of every cell in the table. The value can be 'Top', 'Center', or 'Bottom'.
width	Specifies the width of the table in points.

Property Details

$all

Specifying $all for the LoadOptions loads all the scalar properties (e.g.: Range.address) but not the navigational properties (e.g.: Range.format.fill.color).

$all?: boolean;

Property Value

boolean

alignment

Specifies the alignment of the table against the page column. The value can be 'Left', 'Centered', or 'Right'.

alignment?: 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 ]

headerRowCount

Specifies the number of header rows.

headerRowCount?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi 1.3 ]

horizontalAlignment

Specifies the horizontal alignment of every cell in the table. The value can be 'Left', 'Centered', 'Right', or 'Justified'.

horizontalAlignment?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi 1.3 ]

isUniform

Indicates whether all of the table rows are uniform.

isUniform?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi 1.3 ]

nestingLevel

Gets the nesting level of the table. Top-level tables have level 1.

nestingLevel?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi 1.3 ]

parentBody

Gets the parent body of the table.

parentBody?: Word.Interfaces.BodyLoadOptions;

Property Value

Word.Interfaces.BodyLoadOptions

Remarks

[ API set: WordApi 1.3 ]

parentContentControl

Gets the content control that contains the table. Throws an ItemNotFound error if there isn't a parent content control.

parentContentControl?: Word.Interfaces.ContentControlLoadOptions;

Property Value

Word.Interfaces.ContentControlLoadOptions

Remarks

[ API set: WordApi 1.3 ]

parentContentControlOrNullObject

Gets the content control that contains the table. If there isn't a parent content control, then this method will return an object with its isNullObject property set to true. For further information, see *OrNullObject methods and properties.

parentContentControlOrNullObject?: Word.Interfaces.ContentControlLoadOptions;

Property Value

Word.Interfaces.ContentControlLoadOptions

Remarks

[ API set: WordApi 1.3 ]

parentTable

Gets the table that contains this table. Throws an ItemNotFound error if it isn't contained in a table.

parentTable?: Word.Interfaces.TableLoadOptions;

Property Value

Word.Interfaces.TableLoadOptions

Remarks

[ API set: WordApi 1.3 ]

parentTableCell

Gets the table cell that contains this table. Throws an ItemNotFound error if it isn't contained in a table cell.

parentTableCell?: Word.Interfaces.TableCellLoadOptions;

Property Value

Word.Interfaces.TableCellLoadOptions

Remarks

[ API set: WordApi 1.3 ]

parentTableCellOrNullObject

Gets the table cell that contains this table. If it isn't contained in a table cell, then this method will return an object with its isNullObject property set to true. For further information, see *OrNullObject methods and properties.

parentTableCellOrNullObject?: Word.Interfaces.TableCellLoadOptions;

Property Value

Word.Interfaces.TableCellLoadOptions

Remarks

[ API set: WordApi 1.3 ]

parentTableOrNullObject

Gets the table that contains this table. If it isn't contained in a table, then this method will return an object with its isNullObject property set to true. For further information, see *OrNullObject methods and properties.

parentTableOrNullObject?: Word.Interfaces.TableLoadOptions;

Property Value

Word.Interfaces.TableLoadOptions

Remarks

[ API set: WordApi 1.3 ]

rowCount

Gets the number of rows in the table.

rowCount?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi 1.3 ]

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 ]

style

Specifies the style name for the table. Use this property for custom styles and localized style names. To use the built-in styles that are portable between locales, see the "styleBuiltIn" property.

style?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi 1.3 ]

styleBandedColumns

Specifies whether the table has banded columns.

styleBandedColumns?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi 1.3 ]

styleBandedRows

Specifies whether the table has banded rows.

styleBandedRows?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi 1.3 ]

styleBuiltIn

Specifies the built-in style name for the table. Use this property for built-in styles that are portable between locales. To use custom styles or localized style names, see the "style" property.

styleBuiltIn?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi 1.3 ]

styleFirstColumn

Specifies whether the table has a first column with a special style.

styleFirstColumn?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi 1.3 ]

styleLastColumn

Specifies whether the table has a last column with a special style.

styleLastColumn?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi 1.3 ]

styleTotalRow

Specifies whether the table has a total (last) row with a special style.

styleTotalRow?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi 1.3 ]

values

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

values?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi 1.3 ]

verticalAlignment

Specifies the vertical alignment of every cell in the table. The value can be 'Top', 'Center', or 'Bottom'.

verticalAlignment?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi 1.3 ]

width

Specifies the width of the table in points.

width?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi 1.3 ]