Aspose.Words for Python via .NET 22.10 Release Notes

This page contains release notes for Aspose.Words for Python via .NET 22.10.0.

Major Features

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

Implemented an ability to ignore StructuredDocumentTags upon FindReplace.
HtmlSaveOptions.metafile_format now affects OLE objects and controls.

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

Key	Summary	Category
WORDSNET-19205	Add feature to export Shape into SVG and DIV tag in output HTML	New Feature
WORDSNET-19780	Render correct indentation in Text format against HTML blockquote Tags	New Feature
WORDSNET-23920	Consider providing a way to move DocumentBuilder cursor inside SDT	New Feature
WORDSNET-23530	Check Boxes (Content Control) are checked after UpdatingFields	Enhancement
WORDSNET-24237	Redundant revisions are rendered in PDF	Enhancement
WORDSNET-24393	The document appears to be corrupted and cannot be loaded message on loading a doc file	Enhancement
WORDSNET-11419	Issue with table border when saving as PDF	Bug
WORDSNET-12476	Shape’s hyperlink is removed after saving to HTML	Bug
WORDSNET-18387	Incorrect conversion to PDF page numbers	Bug
WORDSNET-19584	Page numbering is off when converting to PDF	Bug
WORDSNET-19698	Page numbering in footer gets corrupted in PDF	Bug
WORDSNET-20416	Use DML shapes instead VML for DOCX to HTML conversion	Bug
WORDSNET-20600	DOCX to PDF conversion issue with chart’s Y-Axis	Bug
WORDSNET-20723	Conversion issue with page numbers	Bug
WORDSNET-20724	Conversion issue with page number upon DOCX to PDF	Bug
WORDSNET-20725	Incorrect page numbers	Bug
WORDSNET-20726	Issue with page numbers when DOCX to PDF	Bug
WORDSNET-21887	Node is internally removed from the DOM tree after table serialization	Bug
WORDSNET-21964	Nested content control not deleted from document	Bug
WORDSNET-22706	Issue when converting a Word Cell to text	Bug
WORDSNET-23435	Revisions changed after adding CustomXmlPart	Bug
WORDSNET-23629	PAGE field is updated improperly upon rendering	Bug
WORDSNET-23638	HtmlSaveOptionsMetafileFormat does not work as expected	Bug
WORDSNET-23647	Alpha list is reset to numbered list after conversion from HTML to DOCX	Bug
WORDSNET-23679	Table layout is broken after rendering document	Bug
WORDSNET-23850	Incorrect cell margins on html to docx conversion	Bug
WORDSNET-23923	Incorrect table indent on rtf to docx conversion	Bug
WORDSNET-24004	Gradient fill is rendered improperly	Bug
WORDSNET-24012	Built in styles are written as custom styles after open/save DOCX	Bug
WORDSNET-24138	Text is truncated when rendering metafile to PDF	Bug
WORDSNET-24148	Encoding of a HTML document is incorrectly detected as UTF-7	Bug
WORDSNET-24149	Garbage text is loaded from a EPUB document	Bug
WORDSNET-24150	Document title is incorrectly imported from EPUB	Bug
WORDSNET-24172	Set correct values for UseFELayout and DefaultFontLocalIdFarEast when Chinese is specified in LoadOptions	Bug
WORDSNET-24238	Strikethrough text format is changed to underline on PDF import	Bug
WORDSNET-24250	SystemArgumentOutOfRangeException: “Length cannot be less than zero” unhandled exception	Bug
WORDSNET-24267	Legend gradient fill is not rendered	Bug
WORDSNET-24269	DOCX to PDF: Chart rendered incorrectly	Bug
WORDSNET-24272	Reflection effect is not rendered in Html Fixed	Bug
WORDSNET-24286	Shape flip is not taken into account when rendering a gradient fill	Bug
WORDSNET-24291	Resaving the document changes checkbox state	Bug
WORDSNET-24298	DOCX to PDF: Border around objects does not retain after conversion	Bug
WORDSNET-24299	InvalidOperationException: Operator should take n operands: Incorrect stream content	Bug
WORDSNET-24300	InvalidOperationException: Operator should take n operands: too big integer value	Bug
WORDSNET-24301	ExtractPages throws NullReferenceException	Bug
WORDSNET-24308	Invalid DOCX document	Bug
WORDSNET-24319	NullReferenceException on saving to PDF	Bug
WORDSNET-24331	Incorrect reflection direction when rendering 3D effects	Bug
WORDSNET-24344	Date format of SDT is ignored when FindReplaceOptions.IgnoreStructuredDocumentTags is used	Bug
WORDSNET-24345	SDTs are not replaced when FindReplaceOptions.IgnoreStructuredDocumentTags is used	Bug
WORDSNET-24358	Redundant whitespaces appears after importing table from PDF with RTL content	Bug
WORDSNET-24369	InvalidOperationException is thrown upon comparing document	Bug
WORDSNET-24398	Ideographic text in text box incorrectly rotated	Bug
WORDSNET-24401	Saving document throws “InvalidOperationException” error	Bug
WORDSNET-24403	Incorrect rendering of text box content reflection when shape has a pattern fill	Bug
WORDSNET-24420	CenteredParagraphCorrector throws NullReferenceException	Bug

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

Key	Summary	Category
WORDSNET-24142	Getter for AbstractNumId	New Feature
WORDSNET-19361	Page and NUMPAGES fields have incorrect values in PDF	Bug
WORDSNET-19825	Value of NUMPAGES in output PDF is incorrect after mail merge	Bug
WORDSNET-21000	Incorrect font formatting applied to Hebrew text in PDF	Bug
WORDSNET-22838	HTML styles are lost after HTML to DOCX conversion	Bug
WORDSNET-22871	DOCX to PDF - List numbers disappearing	Bug
WORDSNET-23755	Footnote reference character is rendered as tofu	Bug
WORDSNET-23758	OutOfMemoryException is thrown upon comparing documents	Bug
WORDSNET-23926	Metafile image is converted to PNG after validation with HtmlSaveOptions	Bug
WORDSNET-24030	DOCX to PDF: Checkbox state changed after conversion	Bug
WORDSNET-24090	Aspose.Words returns incorrect words count	Bug
WORDSNET-24159	DocumentVariables are not updated on DocumentCompare method	Bug
WORDSNET-24212	HTM to PDF: text-indentation has no effect	Bug
WORDSNET-24213	Floating table is rendered improperly	Bug
WORDSNET-24216	Track revisions works improperly ParagraphAppendField method is used	Bug
WORDSNET-24241	Find/Replace does not work if searched text contain SDT	Bug
WORDSNET-24278	InvalidOperationException upon rendering shape	Bug
WORDSNET-24281	Comparing documents throws the “comasposewordsSpecialChar” error	Bug
WORDSNET-24288	Data labels values values are not rendered	Bug
WORDSNET-24346	Footnote mark is rendered as toffu	Bug
WORDSNET-24374	List item number is incorrect after comparing	Bug
WORDSNET-24404	XML to DOCX: Footnotes numbers separated from text	Bug

Public API and Backward Incompatible Changes

This section lists public API changes that were introduced in Aspose.Words 22.10. 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 new FindReplaceOptions.ignore_structured_document_tags property

Related issue: WORDSNET-24241

The following public property is added to FindReplaceOptions class:

class FindReplaceOptions:
    ...
    @property
    def ignore_structured_document_tags(self) -> bool:
        """Gets or sets a boolean value indicating either to ignore content of StructuredDocumentTag.
        The default value is False.
        
        When this option is set to True, the content of StructuredDocumentTag
        will be treated as a simple text.
        
        Otherwise, StructuredDocumentTag will be processed as standalone Story
        and replacing pattern will be searched separately for each StructuredDocumentTag,
        so that if pattern crosses a StructuredDocumentTag, then replacement will not
        be performed for such pattern."""
        ...

Use Case: Explains how to ignore StructuredDocumentTags while finding and replacing text.

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

# Set options to ignore StructuredDocumentTags.
options = aw.replacing.FindReplaceOptions()
options.ignore_structured_document_tags = True
doc.range.replace("searchText", "replacement", options)

HtmlSaveOptions.metafile_format now affects OLE objects and controls

Related issue: WORDSNET-23562.

OLE objects and controls (shapes whose type is ShapeType.OLE_OBJECT or ShapeType.OLE_CONTROL) usually contain a metafile as a fallback image. Saving of such shapes to HTML has been changed in the following way:

The option HtmlSaveOptions.metafile_format can be used to choose the format which images of the shapes are saved to.
The option HtmlSaveOptions.export_shapes_as_svg no longer affects the shapes.

In other words, OLE objects and controls are now treated as metafile images when a document is converted to HTML.

Implemented ability to move DocumentBuilder cursor inside structured document tag

Related issue: WORDSNET-23920

Now it is possible to move cursor of DocumentBuilder inside a structured document tag. To do this, the following new members of the DocumentBuilder class have been added:

class DocumentBuilder:
    ...
    def move_to_structured_document_tag(self, structured_document_tag_index: int, character_index: int):
        """Moves the cursor to a structured document tag in the current section.
        
        The navigation is performed inside the current story of the current section. That is, if you moved the
        cursor to the primary header of the first section, then structured_document_tag_index
        specified the index of the structured document tag inside that header of that section.
        When structured_document_tag_index is greater than or equal to 0, it specifies an index
        from the beginning of the section with 0 being the first structured document tag. When
        structured_document_tag_index is less than 0, it specified an index from the end of the
        section with -1 being the last structured document tag.

        :param structured_document_tag_index: The index of the structured document tag to move to.
        :param character_index: The index of the character inside the structured document tag.
                                A negative value allows you to specify a position from the end of the structured document tag. Use -1 to
                                move to the end of the structured document tag. If the structured document tag is at the block level, and
                                you want to move the cursor to the end of its last paragraph, specify -2.
        """
        ...

    def move_to_structured_document_tag(self, structured_document_tag: StructuredDocumentTag, character_index: int):
        """Moves the cursor to the structured document tag.
            
        :param structured_document_tag: The structured document tag to move to.
        :param character_index: The index of the character inside the structured document tag.
                                A negative value allows you to specify a position from the end of the structured document tag. Use -1 to
                                move to the end of the structured document tag. If the structured document tag is at the block level, and
                                you want to move the cursor to the end of its last paragraph, specify -2.
        """
        ...

    @property
    def is_at_end_of_structured_document_tag(self) -> bool:
        """Returns True if the cursor is at the end of a structured document tag."""
        ...

    @property
    def current_structured_document_tag(self) -> StructuredDocumentTag:
        """Gets the structured document tag that is currently selected in this DocumentBuilder."""
        ...

Use Case: Moving cursor to end of inline-level structured document tag and getting currently selected structured document tag.

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

# Move to the end of the second structured document tag.
builder.move_to_structured_document_tag(1, -1)

builder.write(" Text at end of structured document tag.")

# Get currently selected structured document tag.
builder.current_structured_document_tag.color = drawing.Color.green

doc.save("output.docx")

Added new public method List.has_same_template

Related issue: WORDSNET-24142

A new List.has_same_template public method has been added:

class List:
    ...
    def has_same_template(self, other: List) -> bool:
        """Returns True if the current list and the given list are created from the same template."""
        ...

Use Case: Explains how to work with List.has_same_template.

list1 = document.lists[0]
list2 = document.lists[1]
list3 = document.lists[2]

if list1.has_same_template(list2):
    print("These lists have the same list template.")

if not list2.has_same_template(list3):
    print("These lists have different list templates.")

Obsolete LoadOptions.flat_opc_xml_mapping_only and SaveOptions.flat_opc_xml_mapping_only options were removed

Related issue: WORDSNET-21455

These options caused unexpected side-effects and decided to be removed eventually. Instead, it was suggested to convert the mapped document to FlatOpc file format directly. This approach has no side-effect and provides better output.

SaveOptions.update_sdt_content default value changed and marked as obsolete.

Related issue: WORDSNET-24030

Default value of SaveOptions.update_sdt_content has been changed to False to follow MS Word behavoir, MS Word does not update content of common (not mapped) SDT from SDT values.

Also we decided to remove this option later as it causes unexpected side-effects similar to flat_opc_xml_mapping_only load/save option.

Instead we going to provide new method which should be called explicitly to update SDT content according to the values.

22.11 Release Notes 22.9 Release Notes