hdrftr

hdrftr

Header and footer part objects.

FooterPart

FooterPart(
    partname: PackURI,
    content_type: str,
    element: BaseOxmlElement,
    package: Package,
)

Bases: StoryPart

Definition of a section footer.

Source code in src/docx/opc/part.py

def __init__(
    self, partname: PackURI, content_type: str, element: BaseOxmlElement, package: Package
):
    super(XmlPart, self).__init__(partname, content_type, package=package)
    self._element = element

new classmethod

new(package: Package)

Return newly created footer part.

Source code in src/docx/parts/hdrftr.py

@classmethod
def new(cls, package: Package):
    """Return newly created footer part."""
    partname = package.next_partname("/word/footer%d.xml")
    content_type = CT.WML_FOOTER
    element = parse_xml(cls._default_footer_xml())
    return cls(partname, content_type, element, package)

HeaderPart

HeaderPart(
    partname: PackURI,
    content_type: str,
    element: BaseOxmlElement,
    package: Package,
)

Bases: StoryPart

Definition of a section header.

Source code in src/docx/opc/part.py

def __init__(
    self, partname: PackURI, content_type: str, element: BaseOxmlElement, package: Package
):
    super(XmlPart, self).__init__(partname, content_type, package=package)
    self._element = element

new classmethod

new(package: Package)

Return newly created header part.

Source code in src/docx/parts/hdrftr.py

@classmethod
def new(cls, package: Package):
    """Return newly created header part."""
    partname = package.next_partname("/word/header%d.xml")
    content_type = CT.WML_HEADER
    element = parse_xml(cls._default_header_xml())
    return cls(partname, content_type, element, package)