Browse our Products

Aspose.Words for Python via .NET 23.1 Release Notes

Major Features

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

  • Significantly improved performance and quality of emulation of raster operations with metafiles.
  • Implemented an ability to work with shading theme colors.
  • Added the ability to generate TOC (table of contents) for AZW3 documents.
  • Provided the way to control how the list items are exported to the Markdown format.
  • Added support of R-squared coefficient in DML charts trendline labels when rendering.

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

Public API and Backward Incompatible Changes

This section lists public API changes that were introduced in Aspose.Words for Python via .NET 23.1. 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 Font property to ChartDataLabel and ChartDataLabelCollection classes

Related issue: WORDSNET-24652

The Font property has been added to the ChartDataLabel and ChartDataLabelCollection classes:

class ChartDataLabel:
    def font(self) -> aspose.words.Font:
        # Provides access to the font formatting of this data label.

class ChartDataLabelCollection:
    def font(self) -> aspose.words.Font:
        '''Provides access to the font formatting of the data labels of the entire series.
        Value defined for this property can be overridden for an individual data label with using the
        :attr:`ChartDataLabel.font` property.'''
doc = aw.Document()
builder = aw.DocumentBuilder(doc)

# Create a column chart.
shape = builder.insert_chart(aw.drawing.charts.ChartType.COLUMN, 432, 252)
series_collection = shape.chart.series

# Add a chart series.
series = series_collection.add("Series 1",
    ["Category 1", "Category 2", "Category 3", "Category 4", "Category 5"],
    [5.5, 2, 3.5, 6, 9])

# Display data labels.
series.has_data_labels = True
labels = series.data_labels
labels.show_value = True

# Set font size for all labels of the series.
labels.font.size = 12

# Let's use a constant for simplicity.
min_value_index = 1
# Let's use a constant for simplicity.
max_value_index = 4

# Mark the labels for the max and min values.
labels[min_value_index].font.size = 14
labels[min_value_index].font.color =
labels[max_value_index].font.size = 14
labels[max_value_index].font.color =

# Save the document."LabelFont.docx")

Added IgnoreOleData option into LoadOptions class

Related issue: WORDSNET-24477

The ignore_ole_data property has been added to the LoadOptions class. May be usefull when destination format does not support OLE.

class LoadOptions:
    def ignore_ole_data(self) -> bool:
        '''Specifies whether to ignore the OLE data.
        Ignoring OLE data may reduce memory consumption and increase performance without data lost in a case when destination format does not support OLE objects.
        The default value is ``False``.'''
lo = aw.loading.LoadOptions()
lo.ignore_ole_data = True
doc = aw.Document("Test.docx", lo)"Test.pdf")

Added MetafileRenderingOptions.UseGdiRasterOperationsEmulation and overall improvements in metafile raster operations emulation

Related issue: #WORDSNET-24003

Metafile raster operations emulations have been improved.

Also added an option to use GDI+ in raster operations emulation process.

def use_gdi_raster_operations_emulation(self) -> bool:
    '''Gets or sets a value determining whether or not to use the GDI+ for raster operations emulation.
    Windows GDI+ library could be used to emulate raster operations. It provides support for all raster operation
    comparing to Aspose.Words own emulation but performance may be slower in some cases.
    When this value is set to ``True``, Aspose.Words uses GDI+ for raster operations emulation.
    When this value is set to ``False``, Aspose.Words uses its own implementation of raster operations emulation.
    This option is used only when metafile is rendered as vector graphics.
    The default value is ``False``.'''

Added new public properties for working with shading theme colors

Related issue: WORDSNET-24456

A new public properties foreground_pattern_theme_color and 88background_pattern_theme_color** has been added to the Shading class.

def foreground_pattern_theme_color(self) -> aspose.words.themes.ThemeColor:
    '''Gets or sets the foreground pattern theme color in the applied color scheme that is associated with this :class:`Shading` object.'''

def foreground_pattern_theme_color(self, value: aspose.words.themes.ThemeColor):

def background_pattern_theme_color(self) -> aspose.words.themes.ThemeColor:
    '''Gets or sets the background pattern theme color in the applied color scheme that is associated with this :class:`Shading` object.'''

def background_pattern_theme_color(self, value: aspose.words.themes.ThemeColor):

A new public properties foreground_tint_and_shade and background_tint_and_shade has been added to the Shading class.

def foreground_tint_and_shade(self) -> float:
    #Gets or sets a double value that lightens or darkens a foreground theme color.

def foreground_tint_and_shade(self, value: float):

def background_tint_and_shade(self) -> float:
    #Gets or sets a double value that lightens or darkens a background theme color.

def background_tint_and_shade(self, value: float):
doc = aw.Document("c:\\Documents\\TestDocument.docx")

shading = doc.first_section.body.first_paragraph.paragraph_format.shading
# Gets and sets the values of theme colors.
if shading.foreground_pattern_theme_color == aw.themes.ThemeColor.ACCENT1:
    shading.foreground_pattern_theme_color = ThemeColor.DARK1

if shading.background_pattern_theme_color == aw.themes.ThemeColor.ACCENT2:
    shading.background_pattern_theme_color == aw.themes.ThemeColor.DARK2

# Gets and sets the lightens values.
if shading.foreground_tint_and_shade == 0:
    shading.ForegroundTintAndShade = 0.5

if shading.background_tint_and_shade == 0:
    shading.background_tint_and_shade = -0.2"output.docx")

Added public property Range.Revisions

Related issue: WORDSNET-24257

A new public property revisions has been added to the Range class:

def revisions(self) -> aspose.words.RevisionCollection:
    '''Gets a collection of revisions (tracked changes) that exist in this range.
    The returned collection is a "live" collection, which means if you remove parts of a document that contain
    revisions, the deleted revisions will automatically disappear from this collection.'''
doc = aw.Document("c:\\Documents\\TestDocument.docx")
# Getting the first paragraph revisions.
paragraph = doc.first_section.body.first_paragraph
for revision in paragraph.range.revisions:
    if revision.revision_type == aw.RevisionType.DELETION:
# Getting the first section revisions.

Added the ability to generate TOC (table of contents) for AZW3 documents

Related issue: WORDSNET-24389

Now Aspose.Words can generate TOC (table of contents) for AZW3 documents.

Desired depth of TOC can be specified same way as it’s done for EPUB documents using HtmlSaveOptions.epub_navigation_map_level property.

doc = aw.Document()

options = aw.saving.HtmlSaveOptions(aw.SaveFormat.AZW3)
options.epub_navigation_map_level = 2 + "DocumentWithTwoLevelTOC.azw3", options)

Added the ability to specify how list items will be written to the Markdown

Related issue: WORDSNET-24544

The following public enumeration is added to aspose.words.saving module:

class MarkdownListExportMode:
    '''Specifies how lists are exported into Markdown.'''

    # Export list items compatible with Markdown syntax.
    # Export list items as plain text.
    PLAIN_TEXT: int

The following public property is added to MarkdownSaveOptions class:

def list_export_mode(self) -> aspose.words.saving.MarkdownListExportMode:
    '''Specifies how list items will be written to the output file.
    Default value is :attr:`MarkdownListExportMode.MARKDOWN_SYNTAX`.
    When this property is set to :attr:`MarkdownListExportMode.PLAIN_TEXT` all list labels are
    updated using :meth:`aspose.words.Document.update_list_labels` and exported with their actual values. Such lists
    can be non-compatible with Markdown format and will be recognized as plain text upon importing in this case.
    When this property is set to :attr:`MarkdownListExportMode.MARKDOWN_SYNTAX`, writer tries to export
    list items in manner that allows to numerate list items in automatic mode by Markdown.'''

def list_export_mode(self, value: aspose.words.saving.MarkdownListExportMode):
doc = aw.Document("input.docx")

# Set option to export list items as plain text.
options = aw.saving.MarkdownSaveOptions()
options.list_export_mode = aw.saving.MarkdownListExportMode.PLAIN_TEXT"", options)

HtmlSaveOptions.ScaleImageToShapeSize now also affects grouped raster images

Related issue: WORDSNET-24065

Behavior of the HtmlSaveOptions.scale_image_to_shape_size property was changed to affect groups of raster images.

Previously, HtmlSaveOptions.scale_image_to_shape_size didn’t affect grouped raster images and they were always scaled to shape size and were rendered using the resolution value specified in HtmlSaveOptions.image_resolution. If grouped images were high resolution, their quality would reduce considerably because of scaling.

Now Aspose.Words tries to preserve quality of grouped high resolution images. If a group of raster images is saved to HTML and the HtmlSaveOptions.scale_image_to_shape_size property is set to false, Aspose.Words computes max intrinsic resolution among all images in the group and if it is greater than the value specified in HtmlSaveOptions.image_resolution, the group is rendered using the computed increased resolution. This doesn’t eliminate scaling completely but reduces its impact on grouped high resolution raster images.

OfficeMath.EquationXmlEncoding property was marked as obsolete

Related issue: WORDSNET-24770

The OfficeMath.equation_xml_encoding property has been marked as obsolete because it is not intended to be used in the API.

def equation_xml_encoding(self) -> str:
    '''Gets/sets an encoding that was used to encode equation XML, if this office math object is read from
    equation XML.'''

def equation_xml_encoding(self, value: str):