ooodev.format.inner.common.abstract.abstract_document module

Abstract Document Module

class ooodev.format.inner.common.abstract.abstract_document.AbstractDocument(**kwargs)[source]

Bases: StyleBase

Abstract Document.

Contains method related to Document Specific methods

New in version 0.9.0.

get_doc_settings()[source]

Gets the document settings

Returns:

Properties

Return type:

XPropertySet

New in version 0.9.7.

get_page_size()[source]

Get page size in 1/100 mm units.

Raises:
  • PropertiesError – If unable to access properties

  • Exception – If unable to get page size

Returns:

Page Size in 1/100 mm units.

Return type:

Size

get_page_text_size()[source]

Get page text size in 1/100 mm units.

Raises:
  • PropertiesError – If unable to access properties

  • Exception – If unable to get page size

Returns:

Page text Size in 1/100 mm units.

Return type:

Size

New in version 0.9.0.

get_text_frames()[source]

Gets document Text Frames.

Parameters:

doc (XComponent) – Document

Raises:

MissingInterfaceError – if doc does not implement XTextFramesSupplier interface

Returns:

Text Frames on success, Otherwise, None

Return type:

XNameAccess | None

get_write_doc()[source]

Gets current Writer active document

Return type:

XTextDocument