CT_Styles

<w:styles> element, the root element of a styles part, i.e. styles.xml.

Attributes

`latentStyles`

attributelatentStyles

= ZeroOrOne('w:latentStyles', successors=(_tag_seq[2:]))

`style`

attributestyle

= ZeroOrMore('w:style', successors=())

`xml`

attributexmlstr

XML string for this element, suitable for testing purposes.

Pretty printed for readability and without an XML declaration at the top.

Functions

`add_style_of_type`

funcadd_style_of_type(name, style_type, builtin)

Return a newly added w:style element having name and style_type.

w:style/@customStyle is set based on the value of builtin.

paramname

paramstyle_type

parambuiltin

`default_for`

funcdefault_for(style_type)

Return w:style[@w:type="*{style_type}*][-1] or None if not found.

paramstyle_type

`first_child_found_in`

funcfirst_child_found_in(*tagnames: str) -> _Element | None

First child with tag in tagnames, or None if not found.

paramtagnamesstr

= ()

Returns

lxml.etree._Element | None

`get_by_id`

funcget_by_id(styleId: str) -> CT_Style | None

w:style child where @styleId = styleId.

None if not found.

paramstyleIdstr

Returns

docx.oxml.styles.CT_Style | None

`get_by_name`

funcget_by_name(name: str) -> CT_Style | None

w:style child with w:name grandchild having value name.

None if not found.

paramnamestr

Returns

docx.oxml.styles.CT_Style | None

`insert_element_before`

funcinsert_element_before(elm: ElementBase, *tagnames: str)

paramelmElementBase

paramtagnamesstr

= ()

`remove_all`

funcremove_all(*tagnames: str) -> None

Remove child elements with tagname (e.g. "a:p") in tagnames.

paramtagnamesstr

= ()

Returns

None

`xpath`

funcxpath(xpath_str: str) -> Any

Override of lxml _Element.xpath() method.

Provides standard Open XML namespace mapping (nsmap) in centralized location.

paramxpath_strstr

Returns

typing.Any

On this page