Word.Interfaces.StyleData interface
An interface describing the data returned by calling style.toJSON()
.
Properties
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
baseStyle
Specifies the name of an existing style to use as the base formatting of another style.
baseStyle?: string;
Property Value
string
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.BorderData[];
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?: string;
Property Value
string
Remarks
font
Gets a font object that represents the character formatting of the specified style.
font?: Word.Interfaces.FontData;
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.ListTemplateData;
Property Value
Remarks
nameLocal
Gets the name of a style in the language of the user.
nameLocal?: string;
Property Value
string
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?: string;
Property Value
string
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.ParagraphFormatData;
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.ShadingData;
Property Value
Remarks
tableStyle
Gets a TableStyle object representing Style properties that can be applied to a table.
tableStyle?: Word.Interfaces.TableStyleData;
Property Value
Remarks
type
Gets the style type.
type?: Word.StyleType | "Character" | "List" | "Paragraph" | "Table";
Property Value
Word.StyleType | "Character" | "List" | "Paragraph" | "Table"
Remarks
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