DocumentInfo class

DocumentInfo class

Provides read-only metadata about a loaded document, such as its format, page count, title, and encryption status.

Use MarkdownConverter.get_document_info or MarkdownConverter.get_info to obtain an instance of this class. The information is extracted from the source document without performing a full conversion, so it is a lightweight way to inspect a file before converting it.

The DocumentInfo type exposes the following members:

Properties

Property Description
author The document author extracted from its metadata, or an empty string if no author is available.
file_format The detected file format of the document.
is_encrypted The document is password-protected. Returns True if the document requires a password to open; otherwise, False.
page_count The number of pages in the document, or the number of worksheets for spreadsheets, as a non‑negative integer.
title The document title extracted from its metadata, or an empty string if no title is available.

See Also