paper-docxAPI referenceoxml.text.hyperlink
CT_Hyperlink
paper-docx 0.2.0 API reference
<w:hyperlink> element, containing the text and address for a hyperlink.
Attributes
anchor
attributeanchorstr | None= OptionalAttribute('w:anchor', ST_String)history
attributehistorybool= OptionalAttribute('w:history', ST_OnOff, default=True)lastRenderedPageBreaks
attributelastRenderedPageBreaksList[CT_LastRenderedPageBreak]All w:lastRenderedPageBreak descendants of this hyperlink.
r
attributer= ZeroOrMore('w:r')rId
attributerIdstr | None= OptionalAttribute('r:id', XsdString)r_lst
attributer_lstList[CT_R]text
attributetextstrThe textual content of this hyperlink.
CT_Hyperlink stores the hyperlink-text as one or more w:r children.
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