Word.Interfaces.StyleUpdateData interface
An interface for updating data on the Style object, for use in style.set({ ... }).
Properties
| base |
Specifies the name of an existing style to use as the base formatting of another style. |
| borders | Specifies a |
| font | Gets a |
| list |
Gets a |
| 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 |
| 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.
borders
Specifies a BorderCollection object that represents all the borders for the style.
borders?: Word.Interfaces.BorderCollectionUpdateData;Property Value
Remarks
font
Gets a Font object that represents the character formatting of the style.
font?: Word.Interfaces.FontUpdateData;Property Value
Remarks
listTemplate
Gets a ListTemplate object that represents the list formatting for the style.
listTemplate?: Word.Interfaces.ListTemplateUpdateData;Property Value
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.ParagraphFormatUpdateData;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.ShadingUpdateData;Property Value
Remarks
tableStyle
Gets a TableStyle object representing style properties that can be applied to a table.
tableStyle?: Word.Interfaces.TableStyleUpdateData;Property Value
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