Paper Office
paper-docxAPI referenceoxml.shared

CT_String

paper-docx 0.2.0 API reference

Used for w:pStyle and w:tblStyle elements and others.

In those cases, it containing a style name in its val attribute.

Attributes

val

attributevalstr
= RequiredAttribute('w:val', ST_String)

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

new

funcnew(nsptagname: str, val: str)

A new CT_String`` element with tagname nsptagnameandvalattribute set toval`.

paramnsptagnamestr
paramvalstr

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