Aspose.Words for Python via .NET 22.5 Release Notes

Major Features

There are 126 improvements and fixes in this regular monthly release. The most notable are:

• Added support for loading EPUB documents.
• Added support for loading XML documents.
• Added support of “Envelope No. 10” page size for printing.
• Implemented rendering of a border box around the MathML formulas and the strike lines.
• Improved font detection when rendering characters in MathML formulas.
• Improved text wrapping for RTL paragraphs with custom left indent.

Full List of Issues Covering all Changes in this Release (Reported by .NET Users)

Full List of Issues Covering all Changes in this Release (Reported by Java Users)

Public API and Backward Incompatible Changes

This section lists public API changes that were introduced in Aspose.Words 22.5. It includes not only new and obsoleted public methods, but also a description of any changes in the behavior behind the scenes in Aspose.Words which may affect existing code. Any behavior introduced that could be seen as regression and modifies the existing behavior is especially important and is documented here.

Added support for loading EPUB documents

Related issue: WORDSNET-8838

Aspose.Words now can load EPUB 2.0 documents.

EPUB is an e-book file format that uses the “.epub” file extension. A EPUB document is a collection of XHTML documents. Currently, Aspose.Words always loads all XHTML files from a EPUB document in the order in which they appear in the content file (OPF).

The following publicly visible enum values were added:

• LoadFormat.EPUB
• WarningSource.EPUB

The FileFormatUtil class can now be used to determine if a file is a EPUB document. For example, the following call

info = aw.FileFormatUtil.detect_file_format("book.epub")

will return an info instance with the FileFormatInfo.load_format property set to LoadFormat.EPUB.

The use cases for loading EPUB documents are as follows:

doc = aw.Document("book.epub")

Added support for loading XML documents

Related issue: WORDSNET-22697

Aspose.Words now can load XML documents. The Extensible Markup Language (XML) is a simple text-based format for representing structured information: documents, data, configuration, books, transactions, invoices, and much more. Aspose.Words mimics MS Word behavior during import XML documents.

The following publicly visible enum value was added:

• LoadFormat.XML

The FileFormatUtil class can now be used to determine if a file is a XML document. For example, the following call

info = aw.FileFormatUtil.detect_file_format("sample.xml")

will return an info instance with the FileFormatInfo.load_format property set to LoadFormat.XML.

The use cases for loading XML documents are as follows:

doc = aw.Document("sample.xml")

Introduced ChapterPageSeparator enum and added PageSetup.chapter_page_separator and PageSetup.heading_level_for_chapter properties

Related issue: WORDSNET-10869

The ChapterPageSeparator enum is introduced:

class ChapterPageSeparator(enum.IntEnum):
    """Defines the separator character that appears between the chapter and page number."""

    # A colon.
    HYPHEN = 0
    
    # A period.
    PERIOD = 1
    
    # A colon.
    COLON = 2
    
    # An emphasized dash.
    EM_DASH = 3

    # A standard dash.
    EN_DASH = 4

The following public properties are added to PageSetup class:

class PageSetup:
    ...

    @property
    def heading_level_for_chapter(self) -> int:
        """Gets or sets the heading level style that is applied to the chapter titles in the document.
        
        Can be a number from 0 through 9. 0 means no chapter number if applied to page number.
        Before you can create page numbers that include chapter numbers, the document headings must have a numbered outline format applied."""
        ...

    @property
    def chapter_page_separator(self) -> ChapterPageSeparator:
        """Gets or sets the separator character that appears between the chapter number and the page number.
        
        Before you can create page numbers that include chapter numbers, the document headings must have a numbered outline format applied."""
        ...

Use Case:

doc = aw.Document(file_name);
 
page_setup = doc.first_section.page_setup
 
page_setup.page_number_style = aw.NumberStyle.UPPERCASE_ROMAN
page_setup.chapter_page_separator = aw.ChapterPageSeparator.COLON
page_setup.heading_level_for_chapter = 1

Slight changes in markup nodes typed collection

Related issue: WORDSNET-23774

The default indexer for markup nodes collection has been changed. Now it is the index number of a structured document tag in the collection.

class StructuredDocumentTagCollection:
    ...

    def __getitem__(self, index: int) -> IStructuredDocumentTag:
        """Returns the structured document tag at the specified index.
        
        :param index: An index into the collection."""
        ...

Along with this, it has become possible to remove a structured document tag at the specified index number, as well as remove a structured document tag by its identifier.

class StructuredDocumentTagCollection:
    ...

    def remove(self, id: int):
        """Removes the structured document tag with the specified identifier.
        
        :param id: The structured document tag identifier."""
        ...

    def remove_at(self, index: int):
        """Removes a structured document tag at the specified index.
        
        :param index: An index into the collection."""
        ...

The functionality that the indexer has previously performed by ID is now available through get_by_id() method.

class StructuredDocumentTagCollection:
    ...

    def get_by_id(self, id: int) -> IStructuredDocumentTag:
        """Returns the structured document tag by identifier.
        
        Returns None if the structured document tag with the specified identifier cannot be found.
        
        :param id: The structured document tag identifier."""

Use Case:

structured_document_tags = doc.range.structured_document_tags
# We iterate through all collection elements, getting each element by its index number.
for i in range(structured_document_tags.count):
    sdt = structured_document_tags[i]
    print(std.title)

# Get the structured document tag by its Id.
sdt = structured_document_tags.get_by_id(1160505028)
if sdt is not None:
    print(sdt.title)

# Remove the structured document tag by its Id.
structured_document_tags.remove(1160505028)

# Remove the structured document tag at position 0.
structured_document_tags.remove_at(0)

Added “NUMBER_10_ENVELOPE” value to PaperSize enum

Related issue: WORDSNET-23505

Added support of “Envelope No. 10” page size (4.125 x 9.5 inches) for printing.

Use Case:

# This value is used to set the page size as follows:
doc = aw.Document(file_name)
doc.first_section.page_setup.paper_size = aw.PaperSize.NUMBER_10_ENVELOPE
 
# Or in a similar way using DocumentBuilder:
builder = aw.DocumentBuilder(doc)
builder.page_setup.paper_size = aw.PaperSize.NUMBER_10_ENVELOPE

HtmlSaveOptions.export_text_box_as_svg was marked as obsolete

Related issue: WORDSNET-23514

The HtmlSaveOptions.export_text_box_as_svg property is now obsolete. The customers should use the HtmlSaveOptions.export_shapes_as_svg, which affects text boxes as well.