Word.Interfaces.StyleUpdateData interface

Package:

word

An interface for updating data on the Style object, for use in style.set({ ... }).

Properties

baseStyle	Specifies the name of an existing style to use as the base formatting of another style.
borders	Specifies a BorderCollection object that represents all the borders for the specified style.
font	Gets a font object that represents the character formatting of the specified style.
listTemplate	Gets a ListTemplate object that represents the list formatting for the specified Style object.
nextParagraphStyle	Specifies the name of the style to be applied automatically to a new paragraph that is inserted after a paragraph formatted with the specified style.
paragraphFormat	Gets a ParagraphFormat object that represents the paragraph settings for the specified style.
priority	Specifies the priority.
quickStyle	Specifies whether the style corresponds to an available quick style.
shading	Gets a Shading object that represents the shading for the specified style. Not applicable to List style.
tableStyle	Gets a TableStyle object representing Style properties that can be applied to a table.
unhideWhenUsed	Specifies whether the specified style is made visible as a recommended style in the Styles and in the Styles task pane in Microsoft Word after it's used in the document.
visibility	Specifies whether the specified style is visible as a recommended style in the Styles gallery and in the Styles task pane.

Property Details

baseStyle

Specifies the name of an existing style to use as the base formatting of another style.

baseStyle?: string;

Property Value

string

Remarks

[ API set: WordApi 1.5 ]

Note: The ability to set baseStyle was introduced in WordApi 1.6.

borders

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 a BorderCollection object that represents all the borders for the specified style.

borders?: Word.Interfaces.BorderCollectionUpdateData;

Property Value

Word.Interfaces.BorderCollectionUpdateData

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

font

Gets a font object that represents the character formatting of the specified style.

font?: Word.Interfaces.FontUpdateData;

Property Value

Word.Interfaces.FontUpdateData

Remarks

[ API set: WordApi 1.5 ]

listTemplate

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.

Gets a ListTemplate object that represents the list formatting for the specified Style object.

listTemplate?: Word.Interfaces.ListTemplateUpdateData;

Property Value

Word.Interfaces.ListTemplateUpdateData

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

nextParagraphStyle

Specifies the name of the style to be applied automatically to a new paragraph that is inserted after a paragraph formatted with the specified style.

nextParagraphStyle?: string;

Property Value

string

Remarks

[ API set: WordApi 1.5 ]

Note: The ability to set nextParagraphStyle was introduced in WordApi 1.6.

paragraphFormat

Gets a ParagraphFormat object that represents the paragraph settings for the specified style.

paragraphFormat?: Word.Interfaces.ParagraphFormatUpdateData;

Property Value

Word.Interfaces.ParagraphFormatUpdateData

Remarks

[ API set: WordApi 1.5 ]

priority

Specifies the priority.

priority?: number;

Property Value

number

Remarks

[ API set: WordApi 1.5 ]

quickStyle

Specifies whether the style corresponds to an available quick style.

quickStyle?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi 1.5 ]

shading

Gets a Shading object that represents the shading for the specified style. Not applicable to List style.

shading?: Word.Interfaces.ShadingUpdateData;

Property Value

Word.Interfaces.ShadingUpdateData

Remarks

[ API set: WordApi 1.6 ]

tableStyle

Gets a TableStyle object representing Style properties that can be applied to a table.

tableStyle?: Word.Interfaces.TableStyleUpdateData;

Property Value

Word.Interfaces.TableStyleUpdateData

Remarks

[ API set: WordApi 1.6 ]

unhideWhenUsed

Specifies whether the specified style is made visible as a recommended style in the Styles and in the Styles task pane in Microsoft Word after it's used in the document.

unhideWhenUsed?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi 1.5 ]

visibility

Specifies whether the specified style is visible as a recommended style in the Styles gallery and in the Styles task pane.

visibility?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi 1.5 ]