paper-docxAPI referenceoxml.section
CT_HdrFtr
paper-docx 0.2.0 API reference
w:hdr and w:ftr, the root element for header and footer part respectively.
Attributes
add_p
attributeadd_pCallable[[], CT_P]inner_content_elements
attributeinner_content_elementsList[CT_P | CT_Tbl]Generate all w:p and w:tbl elements in this header or footer.
Elements appear in document order. Elements shaded by nesting in a w:ins or
other "wrapper" element will not be included.
p
attributep= ZeroOrMore('w:p', successors=())p_lst
attributep_lstList[CT_P]tbl
attributetbl= ZeroOrMore('w:tbl', successors=())tbl_lst
attributetbl_lstList[CT_Tbl]xml
attributexmlstrXML 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 | NoneFirst child with tag in tagnames, or None if not found.
paramtagnamesstr= ()Returns
lxml.etree._Element | Noneinsert_element_before
funcinsert_element_before(elm: ElementBase, *tagnames: str)paramelmElementBaseparamtagnamesstr= ()remove_all
funcremove_all(*tagnames: str) -> NoneRemove child elements with tagname (e.g. "a:p") in tagnames.
paramtagnamesstr= ()Returns
Nonexpath
funcxpath(xpath_str: str) -> AnyOverride of lxml _Element.xpath() method.
Provides standard Open XML namespace mapping (nsmap) in centralized location.
paramxpath_strstrReturns
typing.Any