Paper Office
paper-docxAPI referencestyles.latent

_LatentStyle

paper-docx 0.2.0 API reference

Proxy for an w:lsdException element, which specifies display behaviors for a built-in style when no definition for that style is stored yet in the styles.xml part.

The values in this element override the defaults specified in the parent w:latentStyles element.

Attributes

element

attributeelement

The lxml element proxied by this object.

hidden

attributehidden

Tri-state value specifying whether this latent style should appear in the recommended list.

None indicates the effective value is inherited from the parent <w:latentStyles> element.

locked

attributelocked

Tri-state value specifying whether this latent styles 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 name of the built-in style this exception applies to.

part

attributepartXmlPart

The package part containing this object.

priority

attributepriority

The integer sort key for this latent style in the Word UI.

quick_style

attributequick_style

Tri-state value specifying whether this latent style should appear in the Word styles gallery when not hidden.

None indicates the effective value should be inherited from the default values in its parent LatentStyles object.

unhide_when_used

attributeunhide_when_used

Tri-state value specifying whether this style should have its :attr:hidden attribute set False the next time the style is applied to content.

None indicates the effective value should be inherited from the default specified by its parent LatentStyles object.

Functions

delete

funcdelete()

Remove this latent style definition such that the defaults defined in the containing LatentStyles object provide the effective value for each of its attributes.

Attempting to access any attributes on this object after calling this method will raise AttributeError.

On this page