Paper Office
paper-docxAPI referenceoxml.document

CT_Document

paper-docx 0.2.0 API reference

<w:document> element, the root element of a document.xml file.

Attributes

body

attributebodyCT_Body
= ZeroOrOne('w:body')

sectPr_lst

attributesectPr_lstList[CT_SectPr]

All w:sectPr elements directly accessible from document element.

Note this does not include a sectPr child in a paragraphs wrapped in revision marks or other intervening layer, perhaps w:sdt or customXml elements.

w:sectPr elements appear in document order. The last one is always w:body/w:sectPr, all preceding are w:p/w:pPr/w:sectPr.

xml

attributexmlstr

XML string for this element, suitable for testing purposes.

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

Functions

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

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