Paper Office
paper-docxAPI referenceenum.section

WD_HEADER_FOOTER_INDEX

paper-docx 0.2.0 API reference

Alias: WD_HEADER_FOOTER

Specifies one of the three possible header/footer definitions for a section.

For internal use only; not part of the python-docx API.

MS API name: WdHeaderFooterIndex URL: https://docs.microsoft.com/en-us/office/vba/api/word.wdheaderfooterindex

Attributes

EVEN_PAGE

attributeEVEN_PAGE
= (3, 'even', 'Header for even pages of recto/verso section.')

Header for even pages of recto/verso section.

FIRST_PAGE

attributeFIRST_PAGE
= (2, 'first', 'Header for first page of section.')

Header for first page of section.

PRIMARY

attributePRIMARY
= (1, 'default', 'Header for odd pages or all if no even header.')

Header for odd pages or all if no even header.

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