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. |
| built |
Gets whether the style is a built-in style. |
| font | Gets a |
| 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. |
| linked | Gets whether the style is a linked style that can be used for both paragraph and character formatting. |
| 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. |
| 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
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.
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.FontData;Property Value
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
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
nameLocal
Gets the name of the 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 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 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 style. Not applicable to a style of List type.
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 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