Edit

Share via

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 load options loads all the scalar properties (such as Range.address) but not the navigational properties (such as 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.
builtIn

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

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

For EACH ITEM in the collection: Gets whether the 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 the style is a linked style that can be used for both paragraph and character formatting.
nameLocal

For EACH ITEM in the collection: Gets the name of the 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 style.
paragraphFormat

For EACH ITEM in the collection: Gets a ParagraphFormat object that represents the paragraph settings for the 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 style. Not applicable to a style of List type.
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 style is made visible as a recommended style in the Styles gallery 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 style is visible as a recommended style in the Styles gallery and in the Styles task pane.

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

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.

builtIn

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

builtIn?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi 1.5 ]

font

For EACH ITEM in the collection: Gets a Font object that represents the character formatting of the 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 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 the 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 ]

nameLocal

For EACH ITEM in the collection: Gets the name of the 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 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 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 style. Not applicable to a style of List type.

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 style is made visible as a recommended style in the Styles gallery 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 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 ]