python-docx

https://python-docx.readthedocs.io/en/latest/
Admin
python-docx is a Python library for creating and updating Microsoft Word (.docx) files...
Tokens:112,991
Snippets:1,203
Trust Score:8.3
Update:5 days ago
Show doc for...
Tokens:
Raw
### Install python-docx using easy_install

Source: https://python-docx.readthedocs.io/en/latest/user/install.html

Install python-docx using easy_install, though this installation method is discouraged.

```bash
easy_install python-docx

```

--------------------------------

### Install python-docx manually from source

Source: https://python-docx.readthedocs.io/en/latest/user/install.html

Unpack the downloaded tarball from PyPI and run setup.py manually. Note that dependencies like lxml must be installed manually when using this method.

```bash
tar xvzf python-docx-{version}.tar.gz
cd python-docx-{version}
python setup.py install

```

--------------------------------

### Install python-docx using pip

Source: https://python-docx.readthedocs.io/en/latest/user/install.html

Install python-docx using pip, which automatically handles dependencies such as lxml.

```bash
pip install python-docx

```

--------------------------------

### Example w:styles XML structure

Source: https://python-docx.readthedocs.io/en/latest/dev/analysis/features/styles/styles.html

Displays the OpenXML styles definition containing docDefaults, latentStyles, and style elements for paragraph, character, table, and numbering types.

```xml
<?xml version='1.0' encoding='UTF-8' standalone='yes'?>
<w:styles
    xmlns:mc="http://schemas.openxmlformats.org/markup-compatibility/2006"
    xmlns:r="http://schemas.openxmlformats.org/officeDocument/2006/relationships"
    xmlns:w14="http://schemas.microsoft.com/office/word/2010/wordml"
    xmlns:w="http://schemas.openxmlformats.org/wordprocessingml/2006/main"
    mc:Ignorable="w14"
    >

  <w:docDefaults>
    <w:rPrDefault>
      <w:rPr>
        <w:rFonts w:asciiTheme="minorHAnsi" w:eastAsiaTheme="minorEastAsia"
                  w:hAnsiTheme="minorHAnsi" w:cstheme="minorBidi"/>
        <w:sz w:val="24"/>
        <w:szCs w:val="24"/>
        <w:lang w:val="en-US" w:eastAsia="en-US" w:bidi="ar-SA"/>
      </w:rPr>
    </w:rPrDefault>
    <w:pPrDefault/>
  </w:docDefaults>

  <w:latentStyles w:defLockedState="0" w:defUIPriority="99" w:defSemiHidden="1"
                  w:defUnhideWhenUsed="1" w:defQFormat="0" w:count="276">
    <w:lsdException w:name="Normal" w:semiHidden="0" w:uiPriority="0"
                    w:unhideWhenUsed="0" w:qFormat="1"/>
    <w:lsdException w:name="heading 1" w:semiHidden="0" w:uiPriority="9"
                    w:unhideWhenUsed="0" w:qFormat="1"/>
    <w:lsdException w:name="heading 2" w:uiPriority="9" w:qFormat="1"/>
    <w:lsdException w:name="Default Paragraph Font" w:uiPriority="1"/>
  </w:latentStyles>

  <w:style w:type="paragraph" w:default="1" w:styleId="Normal">
    <w:name w:val="Normal"/>
    <w:qFormat/>
  </w:style>
  <w:style w:type="character" w:default="1" w:styleId="DefaultParagraphFont">
    <w:name w:val="Default Paragraph Font"/>
    <w:uiPriority w:val="1"/>
    <w:semiHidden/>
    <w:unhideWhenUsed/>
  </w:style>
  <w:style w:type="table" w:default="1" w:styleId="TableNormal">
    <w:name w:val="Normal Table"/>
    <w:uiPriority w:val="99"/>
    <w:semiHidden/>
    <w:unhideWhenUsed/>
    <w:tblPr>
      <w:tblInd w:w="0" w:type="dxa"/>
      <w:tblCellMar>
        <w:top w:w="0" w:type="dxa"/>
        <w:left w:w="108" w:type="dxa"/>
        <w:bottom w:w="0" w:type="dxa"/>
        <w:right w:w="108" w:type="dxa"/>
      </w:tblCellMar>
    </w:tblPr>
  </w:style>
  <w:style w:type="numbering" w:default="1" w:styleId="NoList">
    <w:name w:val="No List"/>
    <w:uiPriority w:val="99"/>
    <w:semiHidden/>
    <w:unhideWhenUsed/>
  </w:style>
  <w:style w:type="paragraph" w:customStyle="1" w:styleId="Foobar">
    <w:name w:val="Foobar"/>
    <w:qFormat/>
    <w:rsid w:val="004B54E0"/>
  </w:style>

</w:styles>

```

--------------------------------

### Get and set paragraph spacing

Source: https://python-docx.readthedocs.io/en/latest/dev/analysis/features/text/paragraph-format.html

Demonstrates inspecting and configuring space_before on a style's paragraph_format using Pt length values.

```python
>>> paragraph_format = document.styles['Normal'].paragraph_format
>>> paragraph_format.space_before
None
>>> paragraph_format.space_before = Pt(12)
>>> paragraph_format.space_before.pt
12.0

```

--------------------------------

### Specimen XML for w:latentStyles

Source: https://python-docx.readthedocs.io/en/latest/dev/analysis/features/styles/latent-styles.html

Example of the w:latentStyles element from the default Word 2011 template.

```xml
<w:latentStyles w:defLockedState="0" w:defUIPriority="99" w:defSemiHidden="1"
                w:defUnhideWhenUsed="1" w:defQFormat="0" w:count="276">

```

--------------------------------

### Getting and setting line spacing with ParagraphFormat

Source: https://python-docx.readthedocs.io/en/latest/dev/analysis/features/text/paragraph-format.html

Interactive Python session showing how assigning Length instances versus numbers affects line_spacing and line_spacing_rule.

```python
>>> paragraph_format.line_spacing, paragraph_format.line_spacing_rule
(None, None)

>>> paragraph_format.line_spacing = Pt(18)
>>> paragraph_format.line_spacing, paragraph_format.line_spacing_rule
(228600, WD_LINE_SPACING.EXACTLY (4))

>>> paragraph_format.line_spacing = 1
>>> paragraph_format.line_spacing, paragraph_format.line_spacing_rule
(152400, WD_LINE_SPACING.SINGLE (0))

>>> paragraph_format.line_spacing = 0.9
>>> paragraph_format.line_spacing, paragraph_format.line_spacing_rule
(137160, WD_LINE_SPACING.MULTIPLE (5))

```

--------------------------------

### Setting section start type

Source: https://python-docx.readthedocs.io/en/latest/user/sections.html

Inspect and update the section start break type using the start_type property with WD_SECTION_START enumeration values.

```python
>>> section.start_type
NEW_PAGE (2)
>>> section.start_type = WD_SECTION.ODD_PAGE
>>> section.start_type
ODD_PAGE (4)
```

--------------------------------

### Open and save a document using file-like objects

Source: https://python-docx.readthedocs.io/en/latest/user/documents.html

Demonstrates opening and saving documents via open file handles or StringIO/BytesIO streams. Binary read mode ('rb') is required on Windows and some Linux versions.

```python
f = open('foobar.docx', 'rb')
document = Document(f)
f.close()

# or

with open('foobar.docx', 'rb') as f:
    source_stream = StringIO(f.read())
document = Document(source_stream)
source_stream.close()
...
target_stream = StringIO()
document.save(target_stream)

```

--------------------------------

### Get and set paragraph indentation with ParagraphFormat

Source: https://python-docx.readthedocs.io/en/latest/dev/analysis/features/text/paragraph-format.html

Demonstrates getting and assigning `left_indent`, `right_indent`, and `first_line_indent`. Positive values for `first_line_indent` produce an indented first line, while negative values produce a hanging indent.

```python
>>> paragraph_format.left_indent
None
>>> paragraph_format.right_indent
None
>>> paragraph_format.first_line_indent
None

>>> paragraph_format.left_indent = Pt(36)
>>> paragraph_format.left_indent.pt
36.0

>>> paragraph_format.right_indent = Inches(0.25)
>>> paragraph_format.right_indent.pt
18.0

>>> paragraph_format.first_line_indent = Pt(-18)
>>> paragraph_format.first_line_indent.pt
-18.0

```

--------------------------------

### Create and Save a Document with python-docx

Source: https://python-docx.readthedocs.io/en/latest?__cf_chl_rt_tk=fbasvHJ4PR08AmlCiHDf1vdnKjBz8S7IYWlEJ0n1gyM-1777048606-1.0.1.1-YrggdREybJsW1zVBfSIJWQfrlijZc8FpHGTZIaMTpis

Demonstrates creating a new document, adding styled paragraphs, headings, inline images, tables, and page breaks, then saving the document to a file.

```python
from docx import Document
from docx.shared import Inches

document = Document()

document.add_heading('Document Title', 0)

p = document.add_paragraph('A plain paragraph having some ')
p.add_run('bold').bold = True
p.add_run(' and some ')
p.add_run('italic.').italic = True

document.add_heading('Heading, level 1', level=1)
document.add_paragraph('Intense quote', style='Intense Quote')

document.add_paragraph(
    'first item in unordered list', style='List Bullet'
)
document.add_paragraph(
    'first item in ordered list', style='List Number'
)

document.add_picture('monty-truth.png', width=Inches(1.25))

records = (
    (3, '101', 'Spam'),
    (7, '422', 'Eggs'),
    (4, '631', 'Spam, spam, eggs, and spam')
)

table = document.add_table(rows=1, cols=3)
hdr_cells = table.rows[0].cells
hdr_cells[0].text = 'Qty'
hdr_cells[1].text = 'Id'
hdr_cells[2].text = 'Desc'
for qty, id, desc in records:
    row_cells = table.add_row().cells
    row_cells[0].text = str(qty)
    row_cells[1].text = id
    row_cells[2].text = desc

document.add_page_break()

document.save('demo.docx')
```

--------------------------------

### Configure Row height and height_rule in Python

Source: https://python-docx.readthedocs.io/en/latest/dev/analysis/features/table/table-row.html

Demonstrates the candidate protocol for accessing and setting row height and height rules on a table row instance.

```python
>>> from docx.enum.table import WD_ROW_HEIGHT
>>> row = table.add_row()
>>> row
<docx.table._Row object at 0x...>
>>> row.height_rule
None
>>> row.height_rule = WD_ROW_HEIGHT.EXACTLY
>>> row.height
None
>>> row.height = Pt(24)

```

--------------------------------

### Section.start_type

Source: https://python-docx.readthedocs.io/en/latest/_modules/docx/section.html

Read/write property indicating the type of page break inserted at the start of this section.

```APIDOC
### Property: Section.start_type

**Type**: `WD_SECTION_START` (Read/write)

Type of page-break (if any) inserted at the start of this section (for example, `WD_SECTION_START.ODD_PAGE`).
```

--------------------------------

### Open a blank document with Document()

Source: https://python-docx.readthedocs.io/en/latest/user/quickstart.html

Opens a blank document based on the default Word template.

```python
from docx import Document

document = Document()

```

--------------------------------

### _LatentStyle.priority

Source: https://python-docx.readthedocs.io/en/latest/_modules/docx/styles/latent.html

Gets or sets the integer sort key for this latent style in the Word UI.

```APIDOC
### Property: `priority`

**Type**: `int | None`

#### Description
The integer sort key for this latent style in the Word UI.

#### Getter
Returns the integer UI priority.

#### Setter
- **value** (`int | None`) - Sets the UI priority sort key.
```

--------------------------------

### Getting and setting load_count on LatentStyles

Source: https://python-docx.readthedocs.io/en/latest/dev/analysis/features/styles/latent-styles.html

Inspect and update the load_count property on LatentStyles. Assignment of None is not permitted.

```python
>>> latent_styles.load_count
276
>>> latent_styles.load_count = 242
>>> latent_styles.load_count
242

```

--------------------------------

### Open a new document and save to file

Source: https://python-docx.readthedocs.io/en/latest/user/documents.html

Creates a new document using python-docx's built-in default template and saves it to a specified filename.

```python
from docx import Document

document = Document()
document.save('test.docx')

```

--------------------------------

### Adding a new section

Source: https://python-docx.readthedocs.io/en/latest/user/sections.html

Use Document.add_section() to create a new section at the end of the document with a specified start type.

```python
>>> current_section = document.sections[-1]  # last section in document
>>> current_section.start_type
NEW_PAGE (2)
>>> new_section = document.add_section(WD_SECTION.ODD_PAGE)
>>> new_section.start_type
ODD_PAGE (4)
```

--------------------------------

### Set style inheritance using Style.base_style

Source: https://python-docx.readthedocs.io/en/latest/dev/analysis/features/styles/style.html

Demonstrates setting and inspecting the base style for inheritance via `Style.base_style`.

```python
>>> style = styles.add_style('Citation', WD_STYLE_TYPE.PARAGRAPH)
>>> style.base_style
None
>>> style.base_style = styles['Normal']
>>> style.base_style
<docx.styles.style._ParagraphStyle object at 0x10a7a9550>
>>> style.base_style.name
'Normal'

```

--------------------------------

### Get a comment by ID using comments.get()

Source: https://python-docx.readthedocs.io/en/latest/user/comments.html

Retrieves a specific comment from the comments collection using random access by its ID.

```python
>>> comment = comments.get(0)
>>> comment
<docx.comments.Comment object at 0x02468ACE>

```

--------------------------------

### Set and clear Font.highlight_color using WD_COLOR_INDEX

Source: https://python-docx.readthedocs.io/en/latest/dev/analysis/features/text/font-highlight-color.html

Demonstrates inspecting, assigning, changing, and clearing the highlight color of a font run using WD_COLOR_INDEX members.

```python
>>> font = paragraph.add_run().font
>>> font.highlight_color
None
>>> font.highlight_color = WD_COLOR_INDEX.YELLOW
>>> font.highlight_color
YELLOW (7)
>>> font.highlight_color = WD_COLOR_INDEX.TURQUOISE
>>> font.highlight_color
TURQUOISE (3)
>>> font.highlight_color = None
>>> font.highlight_color
None

```

--------------------------------

### Get and set paragraph alignment

Source: https://python-docx.readthedocs.io/en/latest/dev/analysis/features/text/paragraph-format.html

Demonstrates reading and setting the alignment property on a paragraph using WD_ALIGN_PARAGRAPH or resetting it to None.

```python
>>> paragraph = body.add_paragraph()
>>> paragraph.alignment
None
>>> paragraph.alignment = WD_ALIGN_PARAGRAPH.RIGHT
>>> paragraph.alignment
RIGHT (2)
>>> paragraph.alignment = None
>>> paragraph.alignment
None

```

--------------------------------

### Getting and setting Boolean properties on LatentStyles

Source: https://python-docx.readthedocs.io/en/latest/dev/analysis/features/styles/latent-styles.html

Demonstrates the protocol shared by boolean properties such as default_to_hidden, default_to_locked, default_to_quick_style, and default_to_unhide_when_used.

```python
>>> latent_styles.default_to_hidden
False
>>> latent_styles.default_to_hidden = True
>>> latent_styles.default_to_hidden
True

```

--------------------------------

### Inspect PageSetup header and footer properties

Source: https://python-docx.readthedocs.io/en/latest/dev/analysis/features/header.html

Read/write properties available on PageSetup for controlling different first page or odd/even page headers and footers.

```text
DifferentFirstPageHeaderFooter: Read/write {True, False, WD_UNDEFINED}
OddAndEvenPagesHeaderFooter: Read/write {True, False, WD_UNDEFINED}

```

--------------------------------

### Construct a paragraph entirely from runs

Source: https://python-docx.readthedocs.io/en/latest/user/quickstart.html

Initializes an empty paragraph and builds formatted content sequentially using add_run.

```python
paragraph = document.add_paragraph()
paragraph.add_run('Lorem ipsum ')
paragraph.add_run('dolor').bold = True
paragraph.add_run(' sit amet.')

```

--------------------------------

### _LatentStyle.quick_style

Source: https://python-docx.readthedocs.io/en/latest/_modules/docx/styles/latent.html

Gets or sets a tri-state value specifying whether this latent style should appear in the Word styles gallery when not hidden.

```APIDOC
### Property: `quick_style`

**Type**: `bool | None` (Tri-state)

#### Description
Tri-state value specifying whether this latent style should appear in the Word styles gallery when not hidden. `None` indicates the effective value should be inherited from the default values in its parent `LatentStyles` object.

#### Getter
Returns `bool | None`.

#### Setter
- **value** (`bool | None`) - Sets the qFormat on/off property.
```

--------------------------------

### Access Font object from a Run

Source: https://python-docx.readthedocs.io/en/latest/user/text.html

Access the read-only font property of a Run object to get or set character formatting properties.

```python
>>> from docx import Document
>>> document = Document()
>>> run = document.add_paragraph().add_run()
>>> font = run.font

```

--------------------------------

### Enable even and odd headers in settings.xml

Source: https://python-docx.readthedocs.io/en/latest/dev/analysis/features/header.html

Configures settings.xml with w:evenAndOddHeaders set to 1 to enable distinct even and odd headers while keeping the same default section header reference.

```xml
<w:settings xmlns:w="http://schemas.openxmlformats.org/wordprocessingml/2006/main">
   ...
   <w:evenAndOddHeaders w:val="1"/>
   ...
</w:settings>

```

--------------------------------

### Set and inspect Font size with Pt

Source: https://python-docx.readthedocs.io/en/latest/api/text.html

Demonstrates setting font height using `docx.shared.Pt` and retrieving it in English Metric Units (EMU) and points (`.pt`).

```python
>>> font.size = Pt(24)
>>> font.size
304800
>>> font.size.pt
24.0

```

--------------------------------

### Access a Style's Font Object

Source: https://python-docx.readthedocs.io/en/latest/user/styles-using.html

Access the Font object of a style via its font attribute to get or set character formatting.

```python
>>> from docx import Document
>>> document = Document()
>>> style = document.styles['Normal']
>>> font = style.font

```

--------------------------------

### _LatentStyle.unhide_when_used

Source: https://python-docx.readthedocs.io/en/latest/_modules/docx/styles/latent.html

Gets or sets a tri-state value specifying whether this style should have its hidden attribute set to False the next time it is applied to content.

```APIDOC
### Property: `unhide_when_used`

**Type**: `bool | None` (Tri-state)

#### Description
Tri-state value specifying whether this style should have its `hidden` attribute set `False` the next time the style is applied to content. `None` indicates the effective value should be inherited from the default specified by its parent `LatentStyles` object.

#### Getter
Returns `bool | None`.

#### Setter
- **value** (`bool | None`) - Sets the unhideWhenUsed on/off property.
```

--------------------------------

### XML representation when style.quick_style is True

Source: https://python-docx.readthedocs.io/en/latest/dev/analysis/features/styles/style.html

Shows the WordprocessingML w:style element containing w:qFormat when quick_style is enabled.

```xml
<w:style w:type="paragraph" w:styleId="Foo">
  <w:name w:val="Foo"/>
  <w:qFormat/>
</w:style>

```

--------------------------------

### Add a comment directly from a Run object using Run.add_comment()

Source: https://python-docx.readthedocs.io/en/latest/dev/analysis/features/comments.html

Invokes add_comment directly on a starting Run object and specifies the last run in the sequence.

```python
>>> runs = find_sequence_of_one_or_more_runs_to_comment_on()
>>> runs[0].add_comment(
...     last_run=runs[-1],
...     text="The AI model will replace this placeholder with a summary",
... )
<docx.comments.Comment object at 0x02468ACE>

```

--------------------------------

### Alternate XML constructions for w:qFormat

Source: https://python-docx.readthedocs.io/en/latest/dev/analysis/features/styles/style.html

Shows alternative w:qFormat XML attribute values that should be parsed accurately but avoided when writing XML.

```xml
<w:style w:type="paragraph" w:styleId="Foo">
  <w:name w:val="Foo"/>
  <w:qFormat w:val="0"/>  <!-- style.quick_style is False -->
</w:style>

<w:style w:type="paragraph" w:styleId="Foo">
  <w:name w:val="Foo"/>
  <w:qFormat w:val="1"/>  <!-- style.quick_style is True -->
</w:style>

```

--------------------------------

### Create footer using MS Word API

Source: https://python-docx.readthedocs.io/en/latest/dev/analysis/features/header.html

Demonstrates accessing the Footers collection of a section and setting text on the primary footer.

```python
section = Document.Sections(1)
footers = section.Footers  # a HeadersFooters collection object
default_footer = footers(wdHeaderFooterPrimary)
default_footer.Range.Text = "Footer text"

```

--------------------------------

### Set section break start type using WD_SECTION

Source: https://python-docx.readthedocs.io/en/latest/api/enum/WdSectionStart.html

Imports WD_SECTION from docx.enum.section and assigns a section break type, such as NEW_PAGE, to a document section.

```python
from docx.enum.section import WD_SECTION

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

```

--------------------------------

### Accessing and checking style type with WD_STYLE_TYPE

Source: https://python-docx.readthedocs.io/en/latest/api/enum/WdStyleType.html

Demonstrates how to import WD_STYLE_TYPE and verify the type of a style in a document.

```python
from docx import Document
from docx.enum.style import WD_STYLE_TYPE

styles = Document().styles
assert styles[0].type == WD_STYLE_TYPE.PARAGRAPH
```

--------------------------------

### Access and modify style.quick_style

Source: https://python-docx.readthedocs.io/en/latest/dev/analysis/features/styles/style.html

Demonstrates checking and updating the quick_style property on a Document style object.

```python
>>> style = document.styles['Foo']
>>> style.quick_style
False
>>> style.quick_style = True
>>> style.quick_style
True

```

--------------------------------

### Get Run Character Style in Python

Source: https://python-docx.readthedocs.io/en/latest/dev/analysis/features/styles/character-style.html

Inspects the style property and name of a Run object. Defaults to 'Default Paragraph Font' if no specific character style is set.

```python
>>> run = p.add_run()

>>> run.style
<docx.styles.style._CharacterStyle object at 0x1053ab5d0>
>>> run.style.name
'Default Paragraph Font'

```

--------------------------------

### Add a new style using Styles.add_style()

Source: https://python-docx.readthedocs.io/en/latest/dev/analysis/features/styles/styles.html

Create a new custom style with a given name and WD_STYLE_TYPE, verifying properties such as name, type, and builtin status.

```python
>>> style = styles.add_style('Citation', WD_STYLE_TYPE.PARAGRAPH)
>>> style.name
'Citation'
>>> style.type
PARAGRAPH (1)
>>> style.builtin
False

```

--------------------------------

### docx.section.Section

Source: https://python-docx.readthedocs.io/en/latest/api/section.html

Represents a document section, providing access to section and page setup settings including page margins, dimensions, orientation, headers, footers, and content iteration.

```APIDOC
### Class: `docx.section.Section`

Document section, providing access to section and page setup settings, as well as headers and footers.

#### Constructor
`docx.section.Section(_sectPr: CT_SectPr_, _document_part: DocumentPart_)`

#### Properties
- **`bottom_margin`** *(Length | None)* - Read/write. Bottom margin for pages in this section, in EMU. `None` when no bottom margin has been specified. Assigning `None` removes any bottom-margin setting.
- **`different_first_page_header_footer`** *(bool)* - Read/write. `True` if this section displays a distinct first-page header and footer.
- **`even_page_footer`** *(`_Footer`)* - `_Footer` object defining footer content for even pages. Ignored unless `odd_and_even_pages_header_footer` is `True`.
- **`even_page_header`** *(`_Header`)* - `_Header` object defining header content for even pages. Ignored unless `odd_and_even_pages_header_footer` is `True`.
- **`first_page_footer`** *(`_Footer`)* - `_Footer` object defining footer content for the first page of this section. Ignored unless `different_first_page_header_footer` is `True`.
- **`first_page_header`** *(`_Header`)* - `_Header` object defining header content for the first page of this section. Ignored unless `different_first_page_header_footer` is `True`.
- **`footer`** *(`_Footer`)* - `_Footer` object representing default page footer for this section.
- **`footer_distance`** *(Length | None)* - Read/write. Distance from bottom edge of page to bottom edge of the footer. `None` if no setting is present in the XML.
- **`gutter`** *(Length)* - Read/write. `Length` object representing page gutter size in English Metric Units.
- **`header`** *(`_Header`)* - `_Header` object representing default page header for this section.
- **`header_distance`** *(Length | None)* - Read/write. Distance from top edge of page to top edge of header. `None` if no setting is present in the XML. Assigning `None` causes default value to be used.
- **`left_margin`** *(Length)* - `Length` object representing the left margin for all pages in this section in English Metric Units.
- **`orientation`** *(WD_ORIENTATION)* - Member of `WD_ORIENTATION` specifying page orientation (`WD_ORIENT.PORTRAIT` or `WD_ORIENT.LANDSCAPE`).
- **`page_height`** *(Length)* - Total page height used for this section, inclusive of edge spacing and taking orientation into account.
- **`page_width`** *(Length)* - Total page width used for this section, inclusive of edge spacing and taking orientation into account.
- **`right_margin`** *(Length)* - `Length` object representing the right margin for all pages in this section in English Metric Units.
- **`start_type`** *(WD_SECTION_START)* - Type of page-break (if any) inserted at the start of this section (e.g., `WD_SECTION_START.ODD_PAGE`).
- **`top_margin`** *(Length)* - `Length` object representing the top margin for all pages in this section in English Metric Units.

#### Methods
- **`iter_inner_content()`** -> `Iterator[Paragraph | Table]`
  - Generates each `Paragraph` or `Table` object in this section in document order.
```

--------------------------------

### Set run underline using boolean and WD_UNDERLINE values

Source: https://python-docx.readthedocs.io/en/latest/dev/analysis/features/text/underline.html

Demonstrates the call protocol for the overloaded `.underline` property on a run, supporting boolean values (True, False, None) and WD_UNDERLINE enumerations (SINGLE, DOUBLE, NONE).

```python
>>> run = paragraph.add_run()
>>> run.underline
None
>>> run.underline = True
>>> run.underline
True
>>> run.underline = WD_UNDERLINE.SINGLE
>>> run.underline
True
>>> run.underline = WD_UNDERLINE.DOUBLE
>>> str(run.underline)
DOUBLE (3)
>>> run.underline = False
>>> run.underline
False
>>> run.underline = WD_UNDERLINE.NONE
>>> run.underline
False
>>> run.underline = None
>>> run.underline
None

```

--------------------------------

### _LatentStyle.locked

Source: https://python-docx.readthedocs.io/en/latest/_modules/docx/styles/latent.html

Gets or sets a tri-state value specifying whether the latent style is locked. A locked style does not appear in the styles panel or gallery and cannot be applied when formatting protection is enabled.

```APIDOC
### Property: `locked`

**Type**: `bool | None` (Tri-state)

#### Description
Tri-state value specifying whether this latent style is locked. A locked style does not appear in the styles panel or the style gallery and cannot be applied to document content. This behavior is only active when formatting protection is turned on for the document.

#### Getter
Returns `bool | None`.

#### Setter
- **value** (`bool | None`) - Sets the locked on/off property.
```

--------------------------------

### Configure Font Underline using Booleans and WD_UNDERLINE

Source: https://python-docx.readthedocs.io/en/latest/user/styles-using.html

Set single underlining with True or specify advanced styles such as dashed or dotted underlines using members of the WD_UNDERLINE enumeration.

```python
>>> font.underline
None
>>> font.underline = True
>>> # or perhaps
>>> font.underline = WD_UNDERLINE.DOT_DASH

```

--------------------------------

### Getting and setting default_priority on LatentStyles

Source: https://python-docx.readthedocs.io/en/latest/dev/analysis/features/styles/latent-styles.html

Read or assign the default_priority property. Returns None if the XML attribute is omitted, though default Word templates typically set it explicitly to 99.

```python
>>> # return None if attribute is omitted
>>> latent_styles.default_priority
None
>>> # but expect is will almost always be explicitly 99
>>> latent_styles.default_priority
99
>>> latent_styles.default_priority = 42
>>> latent_styles.default_priority
42

```

--------------------------------

### _LatentStyle.hidden

Source: https://python-docx.readthedocs.io/en/latest/_modules/docx/styles/latent.html

Gets or sets a tri-state value specifying whether the latent style appears in the recommended list. A value of None indicates the setting is inherited from the parent <w:latentStyles> element.

```APIDOC
### Property: `hidden`

**Type**: `bool | None` (Tri-state)

#### Description
Tri-state value specifying whether this latent style should appear in the recommended list. `None` indicates the effective value is inherited from the parent `<w:latentStyles>` element.

#### Getter
Returns `bool | None`.

#### Setter
- **value** (`bool | None`) - Sets the semiHidden on/off property.
```

--------------------------------

### Configure distinct first page header with w:titlePg

Source: https://python-docx.readthedocs.io/en/latest/dev/analysis/features/header.html

Applies a distinct first page header reference and default header for subsequent pages using w:titlePg.

```xml
<w:sectPr>
    <w:headerReference w:type="default" r:id="rId3"/>
    <w:headerReference w:type="first" r:id="rId4"/>
    <w:titlePg/>
    ...
</w:sectPr>

```

--------------------------------

### Configure Odd and Even Page Headers via document.settings

Source: https://python-docx.readthedocs.io/en/latest/dev/analysis/features/header.html

Enable distinct odd and even page headers using document.settings.odd_and_even_pages_header_footer without automatically creating new header definitions.

```python
>>> document.settings.odd_and_even_pages_header_footer
False
>>> document.settings.odd_and_even_pages_header_footer = True
>>> section.even_page_header.is_linked_to_previous
True

```

--------------------------------

### Inspect and set page placement properties on ParagraphFormat

Source: https://python-docx.readthedocs.io/en/latest/dev/analysis/features/text/paragraph-format.html

Getting and setting tri-state boolean page placement properties such as keep_with_next, keep_together, page_break_before, and widow_control. A value of None indicates the property inherits from the style hierarchy.

```python
>>> paragraph_format.keep_with_next
None
>>> paragraph_format.keep_together
None
>>> paragraph_format.page_break_before
None
>>> paragraph_format.widow_control
None

>>> paragraph_format.keep_with_next = True
>>> paragraph_format.keep_with_next
True

>>> paragraph_format.keep_together = False
>>> paragraph_format.keep_together
False

>>> paragraph_format.page_break_before = True
>>> paragraph_format.widow_control = None

```

--------------------------------

### Add an explicit header definition by setting is_linked_to_previous to False

Source: https://python-docx.readthedocs.io/en/latest/user/hdrftr.html

Assign False to .is_linked_to_previous to add a distinct header definition to a section that inherits from a prior section. The new header definition starts with a single empty paragraph.

```python
>>> header.is_linked_to_previous
True
>>> header.is_linked_to_previous = False
>>> header.is_linked_to_previous
False
```
Tokens:
Raw