Word.Interfaces.StyleLoadOptions interface
Represents a style in a Word document.
Remarks
Properties
| $all | Specifying |
| automatically |
Specifies whether the style is automatically redefined based on the selection. |
| base |
Specifies the name of an existing style to use as the base formatting of another style. |
| borders | Specifies a |
| built |
Gets whether the style is a built-in style. |
| font | Gets a |
| frame | Returns a |
| has |
Specifies whether the spelling and grammar checker ignores text formatted with this style. |
| in |
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. |
| language |
Specifies a |
| language |
Specifies an East Asian language for the style. |
| linked | Gets whether the style is a linked style that can be used for both paragraph and character formatting. |
| link |
Specifies a link between a paragraph and a character style. |
| list |
Returns the list level for the style. |
| list |
Gets a |
| locked | Specifies whether the style cannot be changed or edited. |
| name |
Gets the name of the style in the language of the user. |
| next |
Specifies the name of the style to be applied automatically to a new paragraph that is inserted after a paragraph formatted with the style. |
| no |
Specifies whether to remove spacing between paragraphs that are formatted using the same style. |
| paragraph |
Gets a |
| priority | Specifies the priority. |
| quick |
Specifies whether the style corresponds to an available quick style. |
| shading | Gets a |
| table |
Gets a |
| type | Gets the style type. |
| unhide |
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 | 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
automaticallyUpdate
Specifies whether the style is automatically redefined based on the selection.
automaticallyUpdate?: boolean;Property Value
boolean
Remarks
baseStyle
Specifies the name of an existing style to use as the base formatting of another style.
baseStyle?: boolean;Property Value
boolean
Remarks
Note: The ability to set baseStyle was introduced in WordApi 1.6.
borders
Specifies a BorderCollection object that represents all the borders for the style.
borders?: Word.Interfaces.BorderCollectionLoadOptions;Property Value
Remarks
builtIn
Gets whether the style is a built-in style.
builtIn?: boolean;Property Value
boolean
Remarks
font
Gets a Font object that represents the character formatting of the style.
font?: Word.Interfaces.FontLoadOptions;Property Value
Remarks
frame
Returns a Frame object that represents the frame formatting for the style.
frame?: Word.Interfaces.FrameLoadOptions;Property Value
Remarks
hasProofing
Specifies whether the spelling and grammar checker ignores text formatted with this style.
hasProofing?: boolean;Property Value
boolean
Remarks
inUse
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
languageId
Specifies a LanguageId value that represents the language for the style.
languageId?: boolean;Property Value
boolean
Remarks
languageIdFarEast
Specifies an East Asian language for the style.
languageIdFarEast?: boolean;Property Value
boolean
Remarks
linked
Gets whether the style is a linked style that can be used for both paragraph and character formatting.
linked?: boolean;Property Value
boolean
Remarks
linkStyle
Specifies a link between a paragraph and a character style.
linkStyle?: Word.Interfaces.StyleLoadOptions;Property Value
Remarks
listLevelNumber
Returns the list level for the style.
listLevelNumber?: boolean;Property Value
boolean
Remarks
listTemplate
Gets a ListTemplate object that represents the list formatting for the style.
listTemplate?: Word.Interfaces.ListTemplateLoadOptions;Property Value
Remarks
locked
Specifies whether the style cannot be changed or edited.
locked?: boolean;Property Value
boolean
Remarks
nameLocal
Gets the name of the style in the language of the user.
nameLocal?: boolean;Property Value
boolean
Remarks
nextParagraphStyle
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
Note: The ability to set nextParagraphStyle was introduced in WordApi 1.6.
noSpaceBetweenParagraphsOfSameStyle
Specifies whether to remove spacing between paragraphs that are formatted using the same style.
noSpaceBetweenParagraphsOfSameStyle?: boolean;Property Value
boolean
Remarks
paragraphFormat
Gets a ParagraphFormat object that represents the paragraph settings for the style.
paragraphFormat?: Word.Interfaces.ParagraphFormatLoadOptions;Property Value
Remarks
priority
quickStyle
Specifies whether the style corresponds to an available quick style.
quickStyle?: boolean;Property Value
boolean
Remarks
shading
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
Remarks
tableStyle
Gets a TableStyle object representing style properties that can be applied to a table.
tableStyle?: Word.Interfaces.TableStyleLoadOptions;Property Value
Remarks
type
unhideWhenUsed
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
visibility
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