Paper Office
paper-docxAPI referenceenum.base

BaseXmlEnum

paper-docx 0.2.0 API reference

Base class for Enums that also map XML attr values.

The enum's value will be an integer, corresponding to the integer assigned the corresponding member in the MS API enum of the same name.

Attributes

xml_value

attributexml_valuestr | None

Functions

from_xml

funcfrom_xml(xml_value: str | None) -> Self

Enumeration member corresponding to XML attribute value xml_value.

Example::

WD_PARAGRAPH_ALIGNMENT.from_xml("center") WD_PARAGRAPH_ALIGNMENT.CENTER

paramxml_valuestr | None

Returns

typing_extensions.Self

to_xml

functo_xml(value: int | _T | None) -> str | None

XML value of this enum member, generally an XML attribute value.

paramvalueint | _T | None

Returns

str | None

On this page