Word.Interfaces.TableLoadOptions interface

Represents a table in a Word document.

[ API set: WordApi 1.3 ]

Properties

$all
alignment

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

[ API set: WordApi 1.3 ]

font

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

[ API set: WordApi 1.3 ]

headerRowCount

Gets and sets the number of header rows.

[ API set: WordApi 1.3 ]

horizontalAlignment

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

[ API set: WordApi 1.3 ]

isUniform

Indicates whether all of the table rows are uniform. Read-only.

[ API set: WordApi 1.3 ]

nestingLevel

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

[ API set: WordApi 1.3 ]

parentBody

Gets the parent body of the table.

[ API set: WordApi 1.3 ]

parentContentControl

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

[ API set: WordApi 1.3 ]

parentContentControlOrNullObject

Gets the content control that contains the table. Returns a null object if there isn't a parent content control.

[ API set: WordApi 1.3 ]

parentTable

Gets the table that contains this table. Throws an error if it is not contained in a table.

[ API set: WordApi 1.3 ]

parentTableCell

Gets the table cell that contains this table. Throws an error if it is not contained in a table cell.

[ API set: WordApi 1.3 ]

parentTableCellOrNullObject

Gets the table cell that contains this table. Returns a null object if it is not contained in a table cell.

[ API set: WordApi 1.3 ]

parentTableOrNullObject

Gets the table that contains this table. Returns a null object if it is not contained in a table.

[ API set: WordApi 1.3 ]

rowCount

Gets the number of rows in the 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 ]

style

Gets or sets 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.

[ API set: WordApi 1.3 ]

styleBandedColumns

Gets and sets whether the table has banded columns.

[ API set: WordApi 1.3 ]

styleBandedRows

Gets and sets whether the table has banded rows.

[ API set: WordApi 1.3 ]

styleBuiltIn

Gets or sets 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.

[ API set: WordApi 1.3 ]

styleFirstColumn

Gets and sets whether the table has a first column with a special style.

[ API set: WordApi 1.3 ]

styleLastColumn

Gets and sets whether the table has a last column with a special style.

[ API set: WordApi 1.3 ]

styleTotalRow

Gets and sets whether the table has a total (last) row with a special style.

[ API set: WordApi 1.3 ]

values

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

[ API set: WordApi 1.3 ]

verticalAlignment

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

[ API set: WordApi 1.3 ]

width

Gets and sets the width of the table in points.

[ API set: WordApi 1.3 ]

Property Details

$all

$all?: boolean;

Property Value

boolean

alignment

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

[ API set: WordApi 1.3 ]

alignment?: boolean;

Property Value

boolean

font

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

headerRowCount

Gets and sets the number of header rows.

[ API set: WordApi 1.3 ]

headerRowCount?: boolean;

Property Value

boolean

horizontalAlignment

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

[ API set: WordApi 1.3 ]

horizontalAlignment?: boolean;

Property Value

boolean

isUniform

Indicates whether all of the table rows are uniform. Read-only.

[ API set: WordApi 1.3 ]

isUniform?: boolean;

Property Value

boolean

nestingLevel

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

[ API set: WordApi 1.3 ]

nestingLevel?: boolean;

Property Value

boolean

parentBody

Gets the parent body of the table.

[ API set: WordApi 1.3 ]

parentBody?: Word.Interfaces.BodyLoadOptions;

Property Value

parentContentControl

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

[ API set: WordApi 1.3 ]

parentContentControl?: Word.Interfaces.ContentControlLoadOptions;

Property Value

parentContentControlOrNullObject

Gets the content control that contains the table. Returns a null object if there isn't a parent content control.

[ API set: WordApi 1.3 ]

parentContentControlOrNullObject?: Word.Interfaces.ContentControlLoadOptions;

Property Value

parentTable

Gets the table that contains this table. Throws an error if it is not contained in a table.

[ API set: WordApi 1.3 ]

parentTable?: Word.Interfaces.TableLoadOptions;

Property Value

parentTableCell

Gets the table cell that contains this table. Throws an error if it is not contained in a table cell.

[ API set: WordApi 1.3 ]

parentTableCell?: Word.Interfaces.TableCellLoadOptions;

Property Value

parentTableCellOrNullObject

Gets the table cell that contains this table. Returns a null object if it is not contained in a table cell.

[ API set: WordApi 1.3 ]

parentTableCellOrNullObject?: Word.Interfaces.TableCellLoadOptions;

Property Value

parentTableOrNullObject

Gets the table that contains this table. Returns a null object if it is not contained in a table.

[ API set: WordApi 1.3 ]

parentTableOrNullObject?: Word.Interfaces.TableLoadOptions;

Property Value

rowCount

Gets the number of rows in the table. Read-only.

[ API set: WordApi 1.3 ]

rowCount?: boolean;

Property Value

boolean

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?: boolean;

Property Value

boolean

style

Gets or sets 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.

[ API set: WordApi 1.3 ]

style?: boolean;

Property Value

boolean

styleBandedColumns

Gets and sets whether the table has banded columns.

[ API set: WordApi 1.3 ]

styleBandedColumns?: boolean;

Property Value

boolean

styleBandedRows

Gets and sets whether the table has banded rows.

[ API set: WordApi 1.3 ]

styleBandedRows?: boolean;

Property Value

boolean

styleBuiltIn

Gets or sets 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.

[ API set: WordApi 1.3 ]

styleBuiltIn?: boolean;

Property Value

boolean

styleFirstColumn

Gets and sets whether the table has a first column with a special style.

[ API set: WordApi 1.3 ]

styleFirstColumn?: boolean;

Property Value

boolean

styleLastColumn

Gets and sets whether the table has a last column with a special style.

[ API set: WordApi 1.3 ]

styleLastColumn?: boolean;

Property Value

boolean

styleTotalRow

Gets and sets whether the table has a total (last) row with a special style.

[ API set: WordApi 1.3 ]

styleTotalRow?: boolean;

Property Value

boolean

values

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

[ API set: WordApi 1.3 ]

values?: boolean;

Property Value

boolean

verticalAlignment

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

[ API set: WordApi 1.3 ]

verticalAlignment?: boolean;

Property Value

boolean

width

Gets and sets the width of the table in points.

[ API set: WordApi 1.3 ]

width?: boolean;

Property Value

boolean