Word.Interfaces.StyleLoadOptions interface
Represents a style in a Word document.
Remarks
Properties
| $all | Specifying |
| base |
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. |
| built |
Gets whether the specified style is a built-in style. |
| description | Gets the description of the specified style. |
| font | Gets a font object that represents the character formatting of the specified style. |
| in |
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 | Gets whether a style is a linked style that can be used for both paragraph and character formatting. |
| list |
Gets a ListTemplate object that represents the list formatting for the specified Style object. |
| name |
Gets the name of a 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 specified style. |
| paragraph |
Gets a ParagraphFormat object that represents the paragraph settings for the specified style. |
| priority | Specifies the priority. |
| quick |
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. |
| table |
Gets a TableStyle object representing Style properties that can be applied to a table. |
| type | Gets the style type. |
| unhide |
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
$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
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
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.BorderCollectionLoadOptions;Property Value
Remarks
builtIn
Gets whether the specified style is a built-in style.
builtIn?: boolean;Property Value
boolean
Remarks
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.
Gets the description of the specified style.
description?: boolean;Property Value
boolean
Remarks
font
Gets a font object that represents the character formatting of the specified style.
font?: Word.Interfaces.FontLoadOptions;Property Value
Remarks
inUse
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
linked
Gets whether a style is a linked style that can be used for both paragraph and character formatting.
linked?: boolean;Property Value
boolean
Remarks
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.ListTemplateLoadOptions;Property Value
Remarks
nameLocal
Gets the name of a 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 specified style.
nextParagraphStyle?: boolean;Property Value
boolean
Remarks
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.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 specified style. Not applicable to List style.
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 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
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
Office Add-ins
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for