section

section

Enumerations related to the main document in WordprocessingML files.

WD_HEADER_FOOTER_INDEX

Bases: BaseXmlEnum

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

PRIMARY class-attribute instance-attribute

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

Header for odd pages or all if no even header.

FIRST_PAGE class-attribute instance-attribute

FIRST_PAGE = (
    2,
    "first",
    "Header for first page of section.",
)

Header for first page of section.

EVEN_PAGE class-attribute instance-attribute

EVEN_PAGE = (
    3,
    "even",
    "Header for even pages of recto/verso section.",
)

Header for even pages of recto/verso section.

WD_ORIENTATION

Bases: BaseXmlEnum

Alias: WD_ORIENT

Specifies the page layout orientation.

Example:

from docx.enum.section import WD_ORIENT

section = document.sections[-1] section.orientation = WD_ORIENT.LANDSCAPE

MS API name: WdOrientation MS API URL: http://msdn.microsoft.com/en-us/library/office/ff837902.aspx

PORTRAIT class-attribute instance-attribute

PORTRAIT = (0, 'portrait', 'Portrait orientation.')

Portrait orientation.

LANDSCAPE class-attribute instance-attribute

LANDSCAPE = (1, 'landscape', 'Landscape orientation.')

Landscape orientation.

WD_SECTION_START

Bases: BaseXmlEnum

Alias: WD_SECTION

Specifies the start type of a section break.

Example:

from docx.enum.section import WD_SECTION

section = document.sections[0] section.start_type = WD_SECTION.NEW_PAGE

MS API name: WdSectionStart MS API URL: http://msdn.microsoft.com/en-us/library/office/ff840975.aspx

CONTINUOUS class-attribute instance-attribute

CONTINUOUS = (0, 'continuous', 'Continuous section break.')

Continuous section break.

NEW_COLUMN class-attribute instance-attribute

NEW_COLUMN = (1, 'nextColumn', 'New column section break.')

New column section break.

NEW_PAGE class-attribute instance-attribute

NEW_PAGE = (2, 'nextPage', 'New page section break.')

New page section break.

EVEN_PAGE class-attribute instance-attribute

EVEN_PAGE = (3, 'evenPage', 'Even pages section break.')

Even pages section break.

ODD_PAGE class-attribute instance-attribute

ODD_PAGE = (
    4,
    "oddPage",
    "Section begins on next odd page.",
)

Section begins on next odd page.