BaseStyle

Base class for the various types of style object, paragraph, character, table, and numbering.

These properties and methods are inherited by all style objects.

BaseStyle(style_elm: CT_Style)

True if this style is a built-in style. False indicates it is a custom (user-defined) style. Note this value is based on the presence of a customStyle attribute in the XML, not on specific knowledge of which styles are built into Word.

`element`

attributeelement

The lxml element proxied by this object.

`hidden`

attributehidden

True if display of this style in the style gallery and list of recommended styles is suppressed.

False otherwise. In order to be shown in the style gallery, this value must be False and :attr:.quick_style must be True.

`locked`

attributelocked

Read/write Boolean.

True if this style is locked. A locked style does not appear in the styles panel or the style gallery and cannot be applied to document content. This behavior is only active when formatting protection is turned on for the document (via the Developer menu).

`name`

attributename

The UI name of this style.

`part`

attributepartXmlPart

The package part containing this object.

`priority`

attributepriority

The integer sort key governing display sequence of this style in the Word UI.

None indicates no setting is defined, causing Word to use the default value of 0. Style name is used as a secondary sort key to resolve ordering of styles having the same priority value.

`quick_style`

attributequick_style

True if this style should be displayed in the style gallery when :attr:.hidden is False.

Read/write Boolean.

`style_id`

attributestyle_idstr

The unique key name (string) for this style.

This value is subject to rewriting by Word and should generally not be changed unless you are familiar with the internals involved.

`type`

attributetype

Member of :ref:WdStyleType corresponding to the type of this style, e.g. WD_STYLE_TYPE.PARAGRAPH.

`unhide_when_used`

attributeunhide_when_used

True if an application should make this style visible the next time it is applied to content.

False otherwise. Note that docx does not automatically unhide a style having True for this attribute when it is applied to content.

Functions

`delete`

funcdelete()

Remove this style definition from the document.

Note that calling this method does not remove or change the style applied to any document content. Content items having the deleted style will be rendered using the default style, as is any content with a style not defined in the document.

Attributes

`builtin`