Aspose.Words for Python via .NET 21.11 Release Notes

Major Features

There are 64 improvements and fixes in this release. The most notable are:

• New UseAttachments option has been implemented to display the attachments panel in the output PDF documents.
• Added a new ChmLoadOptions to get more control over CHM loading.
• Added new option to ignore field codes during find-replace operation.
• Added ability to save images as Base64 string to Markdown format.

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 21.11. 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 “USE_ATTACHMENTS” Mode for PDF Rendering

Related issue: WORDSNET-11453

An option has been implemented that allows to display the attachments panel in rendered PDF documents when opened in supporting readers.

The option is specified by setting PdfSaveOptions.page_mode to newly created PdfPageMode.USE_ATTACHMENTS value.

Use Case:

doc = aw.Document("input.docx")

# Specify the new page mode for PDF.
options = aw.saving.PdfSaveOptions();
options.page_mode = aw.saving.PdfPageMode.USE_ATTACHMENTS

doc.save("output.pdf", options)

Added a new ChmLoadOptions class

Related issue: WORDSNET-22513

Currently, this public class contains a single public property original_file_name. This property allows to specify the name of the CHM file. It is useful if a document is loaded from a stream and it contains links that reference the same document by the file name.

Use Case:

# The input document name.
filename = "myfile.chm"

# Create an input stream of the input document.
input_stream = open(filename, "rb")

# Specify the file name in CHM load options.
# This allows Aspose.Words to correctly resolve URLs like "ms-its:myfile.chm::/index.htm"
load_options = aw.loading.ChmLoadOptions()
load_options.original_file_name = filename

# Load the document.
doc = aw.Document(input_stream , load_options)

Added a new FindReplaceOptions.ignore_field_codes property

Related issue: WORDSNET-22686.

Use Case: Explains how to ignore text inside field codes.

# Create document.
doc = aw.Document()
builder = aw.DocumentBuilder(doc)

# Insert field.
builder.insert_field("INCLUDETEXT", "Text in field")

options = aw.replacing.FindReplaceOptions()

# Replace 'T' in document ignoring text inside field code.
options.ignore_field_codes = True
doc.range.replace_regex("T", u"*", options)
print(doc.get_text())

# Replace 'T' in document NOT ignoring text inside field code.
options.ignore_field_codes = False
doc.range.replace_regex("T", u"*", options)
print(doc.get_text())

# The code produces the following output:
# \u0013INCLUDETEXT\u0014*ext in field\u0015\u000c
# \u0013INCLUDE*EX*\u0014*ext in field\u0015\u000c

Added new export_images_as_base64 public option

Related issue: WORDSNET-22787

A new export_images_as_base64 public option has been added in MarkdownSaveOptions class.

Use case: Explains how to save Base64 encoded images directly inside a Markdown document.

doc = aw.Document("DocumentWithShape.docx")

mso = aw.saving.MarkdownSaveOptions()
mso.export_images_as_base64 = True

doc.save("DocumentWithShape.md", mso)

New style identifiers for Mention, Smart Hyperlink, Hashtag and Unresolved Mention have been added

Related issue: WORDSNET-22367

New style identifiers for Mention, Smart Hyperlink, Hashtag and Unresolved Mention have been added.

class StyleIdentifier(IntEnum):
    ...

    # The Mention style.
    MENTION = 372

    # The SmartHyperlink style.
    SMART_HYPERLINK = 373

    # The Hashtag style.
    HASHTAG = 374

    # The UnresolvedMention style.
    UNRESOLVED_MENTION = 375