Paper Office
paper-docxAPI referenceoxml.numbering

CT_Num

paper-docx 0.2.0 API reference

<w:num> element, which represents a concrete list definition instance, having a required child <w:abstractNumId> that references an abstract numbering definition that defines most of the formatting details.

Attributes

abstractNumId

attributeabstractNumId
= OneAndOnlyOne('w:abstractNumId')

lvlOverride

attributelvlOverride
= ZeroOrMore('w:lvlOverride')

numId

attributenumId
= RequiredAttribute('w:numId', ST_DecimalNumber)

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_lvlOverride

funcadd_lvlOverride(ilvl)

Return a newly added CT_NumLvl (<w:lvlOverride>) element having its ilvl attribute set to ilvl.

paramilvl

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

insert_element_before

funcinsert_element_before(elm: ElementBase, *tagnames: str)
paramelmElementBase
paramtagnamesstr
= ()

new

funcnew(num_id, abstractNum_id)

Return a new <w:num> element having numId of num_id and having a <w:abstractNumId> child with val attribute set to abstractNum_id.

paramnum_id
paramabstractNum_id

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