Aspose.Words FOSS for Python API Reference

API reference for Aspose.Words FOSS for Python v26.5.0. 146 public types organized by module.

Core API

Class	Description
`Body`	Class with 2 properties.
`BookmarkEnd`	Class with 2 properties.
`BookmarkStart`	Marks the beginning of a Word bookmark (````).
`Border`	Border.line_style is an integer representing the border’s line style.
`Cell`	Cell.type returns the cell’s type as a string.
`CellFormat`	CellFormat.width specifies the absolute width of the table cell in points.
`ColorMode`	Color rendering mode.
`CompressionLevel`	Compression level for OOXML files.
`ConversionOptions`	Options for controlling DOCX to Markdown conversion.
`DocList`	DocList.list_id is the identifier of the list within the document.
`Document`	Represents a Word document.
`Document`	The Document class represents a Word document and provides the get_text() method to extract the full plain‑text content of the file.
`DocumentFormatReader`	Protocol defining the interface all document readers must implement.
`FieldEnd`	Class with 3 properties.
`FieldSeparator`	Class with 2 properties.
`FieldStart`	FieldStart.type is a string indicating the field’s type name.
`Font`	Font.name stores the font family name as a string.
`FrameFormat`	Floating text-frame definition.
`HeaderFooter`	HeaderFooter.type is a string representing the header/footer content type.
`ImageData`	ImageData.source_filename holds the original filename of the image.
`LdmMarkdownWriter`	Converts a `light_document_model.Document` to a Markdown string.
`ListFormat`	ListFormat.is_list_item indicates whether the paragraph is a list item.
`ListLabel`	Snapshot of a list-item’s rendered bullet/number label.
`ListLevel`	ListLevel.number_format specifies the numeric format string for the list level.
`ListLevelOverride`	One `inside a concrete`.
`LoadFormat`	Document load format constants.
`MarkdownEmptyParagraphExportMode`	Controls how empty paragraphs are exported.
`MarkdownExportAsHtml`	Controls which elements are exported as raw HTML.
`MarkdownFileReader`	Reads Markdown (.md) files and yields one Paragraph per line.
`MarkdownLinkExportMode`	Link export mode options.
`MarkdownListExportMode`	List export mode options.
`MarkdownSaveOptions`	Options for saving documents as Markdown.
`OoxmlCompliance`	OOXML standards compliance level.
`OoxmlSaveOptions`	Options for saving a document as DOCX (Office Open XML).
`OutlineOptions`	Controls how outlines (bookmarks panel) are generated in the PDF.
`PageSetup`	PageSetup.paper_size represents the predefined size of the page (e.g., A4, Letter).
`Paragraph`	A paragraph whose children — `Run`, `BookmarkStart` / `End`, `FieldStart` / `Separator` / `End` and inline `ShapeNode` — sit in a single ordered collection in document order.
`ParagraphFormat`	ParagraphFormat.alignment specifies the horizontal alignment of the paragraph.
`ParagraphInfo`	Information about a paragraph’s style and context.
`PdfCompliance`	PDF standards compliance level.
`PdfFontEmbeddingMode`	Font embedding mode in PDF.
`PdfImageCompression`	Image compression in PDF.
`PdfPageMode`	PDF page display mode.
`PdfSaveOptions`	Options for saving documents as PDF.
`PdfTextCompression`	Text compression in PDF.
`PdfZoomBehavior`	Mirrors public API.
`Row`	Row.type is a string that identifies the row’s type.
`RowFormat`	RowFormat.height specifies the row’s height in points.
`RtfFileReader`	Reads RTF files (OLE2-format) and produces the same data structures as DocumentReader (for .docx) and DocFileReader (for .doc).
`Run`	Run.text holds the literal text content of the run.
`RunFormatting`	Text run formatting properties.
`SaveFormat`	Document save format constants.
`Section`	Section.type is a string indicating the section’s classification or identifier.
`Shading`	Shading.background_color holds the background color value for the shading as a string.
`ShapeNode`	ShapeNode.type is a string indicating the node’s type identifier.
`Style`	Style.name is the identifier string of the style.
`TabStop`	Class with 4 properties.
`TabStopCollection`	TabStopCollection.add(position, alignment, leader) inserts a new tab stop with the specified alignment and leader character.
`Table`	Table.rows provides the collection of TableRow objects representing each row in the table.
`Table`	Represents a table structure.
`TableCell`	Represents a table cell.
`TableContentAlignment`	Table content alignment options.
`TableRow`	Represents a table row.
`TableStyleFormat`	Table-level properties stored on table styles (`w:tblPr` inside `w:style`).
`TextColumn`	Class with 2 properties.
`TextColumns`	TextColumns exposes properties count, evenly_spaced, spacing, line_between, and columns to configure multi‑column layout in a document.
`TextFileReader`	Reads plain-text (.txt) files and yields one Paragraph per line.
`UnknownNode`	Class with 1 property.
`Zip64Mode`	Controls when to use ZIP64 format extensions for OOXML files.

Enumerations

Enumeration	Description
`CodeBlockStyle`	Code block style preference.
`HeadingStyle`	Heading export style preference.
`ListMarker`	Bullet list marker style.

Converters

Class	Description
`ListHandler`	Handles parsing and conversion of lists.
`ParagraphConverter`	Handles conversion of paragraphs to Markdown.
`TableConverter`	Handles conversion of tables to Markdown.

Doc Reader

Class	Description
`BlipInfo`	Parsed BSE (Blip Store Entry) with location of image data.
`CharProps`	Properties extracted from CHPX for a text run.
`ChildAnchorInfo`	Position of a child shape within its parent group’s coordinate system.
`DocFileReader`	Full DOC reader with LDM (Light Document Model) building capability.
`DocFileReaderCore`	Core reader for Word 97-2003 (.doc) files.
`DocTableBuilderMixin`	Mixin that adds table-building helpers to the DOC reader.
`FibData`	Parsed FIB (File Information Block) data.
`GroupShapeInfo`	Coordinate system of a shape group (from Spgr record).
`ListDef`	Parsed list definition with full level information.
`ListLevelData`	One parsed LVL record (measurements in points).
`ParaProps`	Properties extracted from PAPX for a single paragraph.
`ShapeAnchor`	Parsed SPA (Shape Address) from PlcSpaMom / PlcSpaHdr.
`ShapeLineProps`	Escher line/fill properties for a shape (from FOpt records).
`StyleData`	Properties parsed from a style definition (STSH UPX).
`TableRowProps`	Properties extracted from PAPX SPRMs on table row-end paragraphs.

Docx Reader

Class	Description
`CellBuilder`	Build :class:`ldm.Cell` from a ```` element.
`CellData`	Table cell.
`DocumentReader`	Reads DOCX documents and produces abstracted data structures.
`FontBuilder`	Build a non-cascaded :class:`ldm.Font` from one ````.
`FontResolver`	Compose a fully cascaded :class:`ldm.Font`.
`LdmBuilderMixin`	Mixin that adds :meth:`to_light_document` to :class:`DocumentReader`.
`ListBuilder`	Translate ```` into a list of :class:`ldm.DocList`.
`NumberingInfo`	Numbering definition.
`NumberingLevel`	List level definition.
`PageSetupBuilder`	Build :class:`ldm.PageSetup` from a ```` element.
`ParagraphBuilder`	Build :class:`ldm.Paragraph` from a ```` element.
`ParagraphData`	Paragraph with style and content.
`ParagraphFormatBuilder`	Build a non-cascaded :class:`ldm.ParagraphFormat` from one ````.
`ParagraphFormatResolver`	Compose a fully cascaded :class:`ldm.ParagraphFormat`.
`ReaderContext`	Class extending Protocol.
`RowBuilder`	Build :class:`ldm.Row` from a ```` element.
`RowData`	Table row.
`RunBuilder`	Build a single :class:`ldm.Run` with a resolved font cascade.
`RunData`	Text run with formatting.
`SectionBuilder`	Split the body into :class:`ldm.Section`\ s at sectPr boundaries.
`ShapeParserMixin`	Mixin providing drawing/shape parsing methods for DocumentReader.
`StyleBuilder`	Translate ```` into a list of :class:`ldm.Style`.
`StyleChainResolver`	Walk the ```` graph for a styleId.
`TableBuilder`	Build :class:`ldm.Table` from a ```` element.
`TableData`	Table structure.

Docx Writer

Class	Description
`BookmarkState`	Hands out monotonically increasing bookmark ids and pairs starts/ends across paragraphs.
`DocxWriterLossyWarning`	Warns the caller that the writer is dropping known LDM constructs.
`ImageEntry`	One image to add to `word/media/` plus its relationship row.
`ImageRenderState`	Accumulator threaded through paragraph rendering for inline shapes.
`LdmDocxWriter`	Convert an :class:`ldm.Document` into a DOCX file.

Model

Class	Description
`CellMerge`	Specifies how a cell in a table is merged with other cells.
`CellVerticalAlignment`	Specifies vertical justification of text inside a table cell.
`HeightRule`	Specifies the rule for determining the height of an object.
`LineSpacingRule`	Specifies values for line spacing.
`LineStyle`	Specifies line style of a border.
`NumberStyle`	Specifies the number style for a list, footnotes, endnotes, page numbers.
`Orientation`	Specifies page orientation.
`ParagraphAlignment`	Specifies text alignment in a paragraph.
`SectionStart`	Specifies the type of break at the beginning of the section.
`StyleIdentifier`	Locale-independent built-in style identifier.
`StyleType`	Specifies type of the style.
`TabAlignment`	Tab stop alignment.
`TabLeader`	Tab stop leader character.
`Underline`	Specifies type of the underline applied to a font.
`WrapType`	Specifies how text is wrapped around a shape or picture.

Parsers

Class	Description
`ListInfo`	Information about a list.
`ListLevelInfo`	Information about a list level.
`NumberingParser`	Parser for DOCX numbering definitions.
`ParsedStyle`	Parsed style information.
`StyleParser`	Parser for DOCX style names and properties.

Pdf Writer

Class	Description
`LdmPdfWriter`	Converts a `light_document_model.Document` to a PDF file.
`PDFWriterContext`	Class with 1 property.
`ParagraphRenderer`	Renders LDM paragraphs into PDF.
`RunRenderer`	Renders formatted runs (text segments with fonts, colors, links).
`ShapeRenderer`	Renders shapes, images, and positioned elements.
`TableRenderer`	Renders LDM tables into PDF.

Aspose.Words FOSS for Python API Reference

Core API

Enumerations

Converters

Doc Reader

Docx Reader

Docx Writer

Model

Parsers

Pdf Writer

See Also