BlockItemContainer

Base class for proxy objects that can contain block items.

These containers include _Body, _Cell, header, footer, footnote, endnote, comment, and text box objects. Provides the shared functionality to add a block item like a paragraph or table.

BlockItemContainer(element: BlockItemElement, parent: t.ProvidesStoryPart)

Attributes

`paragraphs`

attributeparagraphs

A list containing the paragraphs in this container, in document order.

Read-only.

`part`

attributepartStoryPart

The package part containing this object.

`tables`

attributetables

A list containing the tables in this container, in document order.

Read-only.

Functions

`add_paragraph`

funcadd_paragraph(text: str = '', style: str | ParagraphStyle | None = None) -> Paragraph

Return paragraph newly added to the end of the content in this container.

The paragraph has text in a single run if present, and is given paragraph style style.

If style is None, no paragraph style is applied, which has the same effect as applying the 'Normal' style.

paramtextstr

= ''

paramstylestr | ParagraphStyle | None

= None

Returns

docx.text.paragraph.Paragraph

`add_table`

funcadd_table(rows: int, cols: int, width: Length) -> Table

Return table of width having rows rows and cols columns.

The table is appended appended at the end of the content in this container.

width is evenly distributed between the table columns.

paramrowsint

paramcolsint

paramwidthLength

Returns

docx.table.Table

`iter_inner_content`

funciter_inner_content() -> Iterator[Paragraph | Table]

Generate each Paragraph or Table in this container in document order.

Returns

typing.Iterator[docx.text.paragraph.Paragraph | docx.table.Table]

On this page