Word.Interfaces.StyleCollectionLoadOptions interface

Package:

word

Contains a collection of Word.Style objects.

Remarks

[ API set: WordApi 1.5 ]

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).
baseStyle	For EACH ITEM in the collection: Specifies the name of an existing style to use as the base formatting of another style.
borders	For EACH ITEM in the collection: Specifies a BorderCollection object that represents all the borders for the specified style.
builtIn	For EACH ITEM in the collection: Gets whether the specified style is a built-in style.
description	For EACH ITEM in the collection: Gets the description of the specified style.
font	For EACH ITEM in the collection: Gets a font object that represents the character formatting of the specified style.
inUse	For EACH ITEM in the collection: Gets whether the specified style is a built-in style that has been modified or applied in the document or a new style that has been created in the document.
linked	For EACH ITEM in the collection: Gets whether a style is a linked style that can be used for both paragraph and character formatting.
listTemplate	For EACH ITEM in the collection: Gets a ListTemplate object that represents the list formatting for the specified Style object.
nameLocal	For EACH ITEM in the collection: Gets the name of a style in the language of the user.
nextParagraphStyle	For EACH ITEM in the collection: 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	For EACH ITEM in the collection: Gets a ParagraphFormat object that represents the paragraph settings for the specified style.
priority	For EACH ITEM in the collection: Specifies the priority.
quickStyle	For EACH ITEM in the collection: Specifies whether the style corresponds to an available quick style.
shading	For EACH ITEM in the collection: Gets a Shading object that represents the shading for the specified style. Not applicable to List style.
tableStyle	For EACH ITEM in the collection: Gets a TableStyle object representing Style properties that can be applied to a table.
type	For EACH ITEM in the collection: Gets the style type.
unhideWhenUsed	For EACH ITEM in the collection: 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	For EACH ITEM in the collection: Specifies whether the specified style is visible as a recommended style in the Styles gallery and in the Styles task pane.

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

baseStyle

For EACH ITEM in the collection: Specifies the name of an existing style to use as the base formatting of another style.

baseStyle?: boolean;

Property Value

boolean

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.

For EACH ITEM in the collection: Specifies a BorderCollection object that represents all the borders for the specified style.

borders?: Word.Interfaces.BorderCollectionLoadOptions;

Property Value

Word.Interfaces.BorderCollectionLoadOptions

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

builtIn

For EACH ITEM in the collection: Gets whether the specified style is a built-in style.

builtIn?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi 1.5 ]

description

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.

For EACH ITEM in the collection: Gets the description of the specified style.

description?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

font

For EACH ITEM in the collection: Gets a font object that represents the character formatting of the specified style.

font?: Word.Interfaces.FontLoadOptions;

Property Value

Word.Interfaces.FontLoadOptions

Remarks

[ API set: WordApi 1.5 ]

inUse

For EACH ITEM in the collection: Gets whether the specified style is a built-in style that has been modified or applied in the document or a new style that has been created in the document.

inUse?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi 1.5 ]

linked

For EACH ITEM in the collection: Gets whether a style is a linked style that can be used for both paragraph and character formatting.

linked?: boolean;

Property Value

boolean

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.

For EACH ITEM in the collection: Gets a ListTemplate object that represents the list formatting for the specified Style object.

listTemplate?: Word.Interfaces.ListTemplateLoadOptions;

Property Value

Word.Interfaces.ListTemplateLoadOptions

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

nameLocal

For EACH ITEM in the collection: Gets the name of a style in the language of the user.

nameLocal?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi 1.5 ]

nextParagraphStyle

For EACH ITEM in the collection: 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?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi 1.5 ]

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

paragraphFormat

For EACH ITEM in the collection: Gets a ParagraphFormat object that represents the paragraph settings for the specified style.

paragraphFormat?: Word.Interfaces.ParagraphFormatLoadOptions;

Property Value

Word.Interfaces.ParagraphFormatLoadOptions

Remarks

[ API set: WordApi 1.5 ]

priority

For EACH ITEM in the collection: Specifies the priority.

priority?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi 1.5 ]

quickStyle

For EACH ITEM in the collection: Specifies whether the style corresponds to an available quick style.

quickStyle?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi 1.5 ]

shading

For EACH ITEM in the collection: Gets a Shading object that represents the shading for the specified style. Not applicable to List style.

shading?: Word.Interfaces.ShadingLoadOptions;

Property Value

Word.Interfaces.ShadingLoadOptions

Remarks

[ API set: WordApi 1.6 ]

tableStyle

For EACH ITEM in the collection: Gets a TableStyle object representing Style properties that can be applied to a table.

tableStyle?: Word.Interfaces.TableStyleLoadOptions;

Property Value

Word.Interfaces.TableStyleLoadOptions

Remarks

[ API set: WordApi 1.6 ]

type

For EACH ITEM in the collection: Gets the style type.

type?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi 1.5 ]

unhideWhenUsed

For EACH ITEM in the collection: 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

For EACH ITEM in the collection: 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 ]