Edit

Share via

Word.Interfaces.TableStyleLoadOptions interface

Package:
word

Represents the TableStyle object.

Remarks

[ API set: WordApi 1.6 ]

Properties

$all

Specifying $all for the load options loads all the scalar properties (such as Range.address) but not the navigational properties (such as Range.format.fill.color).
alignment

Specifies the table's alignment against the page margin.
allowBreakAcrossPage

Specifies whether lines in tables formatted with a specified style break across pages.
bottomCellMargin

Specifies the amount of space to add between the contents and the bottom borders of the cells.
cellSpacing

Specifies the spacing (in points) between the cells in a table style.
columnStripe

Specifies the number of columns in the banding when a style specifies odd- or even-column banding.
isBreakAcrossPagesAllowed

Specifies whether Microsoft Word allows to break the specified table across pages.
leftCellMargin

Specifies the amount of space to add between the contents and the left borders of the cells.
leftIndent

Specifies the left indent value (in points) for the rows in the table style.
rightCellMargin

Specifies the amount of space to add between the contents and the right borders of the cells.
rowStripe

Specifies the number of rows to include in the banding when the style specifies odd- or even-row banding.
shading

Returns a ShadingUniversal object that refers to the shading formatting for the table style.
tableDirection

Specifies the direction in which Microsoft Word orders cells in the table style.
topCellMargin

Specifies the amount of space to add between the contents and the top borders of the cells.

Property Details

$all

Specifying $all for the load options loads all the scalar properties (such as Range.address) but not the navigational properties (such as Range.format.fill.color).

$all?: boolean;

Property Value

boolean

alignment

Specifies the table's alignment against the page margin.

alignment?: boolean;

Property Value

boolean

Remarks

[ API set: WordApiDesktop 1.1 ]

allowBreakAcrossPage

Specifies whether lines in tables formatted with a specified style break across pages.

allowBreakAcrossPage?: boolean;

Property Value

boolean

Remarks

[ API set: WordApiDesktop 1.1 ]

bottomCellMargin

Specifies the amount of space to add between the contents and the bottom borders of the cells.

bottomCellMargin?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi 1.6 ]

cellSpacing

Specifies the spacing (in points) between the cells in a table style.

cellSpacing?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi 1.6 ]

columnStripe

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Specifies the number of columns in the banding when a style specifies odd- or even-column banding.

columnStripe?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

isBreakAcrossPagesAllowed

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Specifies whether Microsoft Word allows to break the specified table across pages.

isBreakAcrossPagesAllowed?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

leftCellMargin

Specifies the amount of space to add between the contents and the left borders of the cells.

leftCellMargin?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi 1.6 ]

leftIndent

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Specifies the left indent value (in points) for the rows in the table style.

leftIndent?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

rightCellMargin

Specifies the amount of space to add between the contents and the right borders of the cells.

rightCellMargin?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi 1.6 ]

rowStripe

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Specifies the number of rows to include in the banding when the style specifies odd- or even-row banding.

rowStripe?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

shading

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Returns a ShadingUniversal object that refers to the shading formatting for the table style.

shading?: Word.Interfaces.ShadingLoadOptions;

Property Value

Word.Interfaces.ShadingLoadOptions

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

tableDirection

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Specifies the direction in which Microsoft Word orders cells in the table style.

tableDirection?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

topCellMargin

Specifies the amount of space to add between the contents and the top borders of the cells.

topCellMargin?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi 1.6 ]