Paper Office
paper-docxAPI referenceoxml.numbering

CT_Numbering

paper-docx 0.2.0 API reference

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

Attributes

num

attributenum
= ZeroOrMore('w:num', successors=('w:numIdMacAtCleanup',))

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_num

funcadd_num(abstractNum_id)

Return a newly added CT_Num (<w:num>) element referencing the abstract numbering definition identified by abstractNum_id.

paramabstractNum_id

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
= ()

num_having_numId

funcnum_having_numId(numId)

Return the <w:num> child element having numId attribute matching numId.

paramnumId

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