Aspose.Words for .NET 16.6.0 Release Notes

Major Features

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

• Fast extraction from DOC format via PlainTextDocument class is faster by a factor of ten (at a cost).
• Saving DOCX as ISO 29500 Strict OOXML format is available now.
• Added support for outer document insertion to LINQ Reporting Engine.
• Added feature to insert empty values in chart series.
• HTML radio input fields are imported to AW as HtmlOleControl nodes/HtmlOleControl nodes are exported to HTML as HTML input tags.
• Implemented support for “show revisions in balloons” option.
• Implemented “suppress endnotes” property.
• Numerous Complex Script improvements, asian typography detection, kinsoku rule handling.
• Improved PDF export to support Acrobat PDF IFilter.
• Field.GetFieldCode() improved to work with nested fields’ codes that spanned among paragraphs or sections.
• Introduced a Field.GetFieldCode(bool) overload that controlling whether to include child field codes.
• Added the MailMerge.GetRegionsByName() method so that the user can obtain a list of regions by the specified name.
• Added the MailMergeRegionInfo.Level property that allows to get the nesting level of a mail merge region.

Full List of Issues Covering all Changes in this Release

Public API and Backward Incompatible Changes

This section lists public API changes that were introduced in Aspose.Words 16.6.0. 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 a regression and modifies existing behavior is especially important and is documented here.

Added Support for Outer Document Insertion to LINQ Reporting Engine

WORDSNET-13329 has been resolved. The Inserting Documents Dynamically section was added to the LINQ Reporting Engine’s documentation.

Fast Extraction from DOC Format via PlainTextDocument Class is Faster by a Factor of Ten (at a cost)

WORDSNET-13498 has been resolved. We’ve improved the speed of fast text indexing method for DOC format available via public API as PlainTextDocument. However to do this a special DOC reader had to be written which only guarantees the order of plain text within a story upon reading. This means that document sections may be swapped around, and their order is not guaranteed. However the order of paragraphs words and so forth within is section will be as usual.

RevisionOptions has ShowRevisionBalloons Option now

WORDSNET-13739 has been resolved. ShowRevisionBalloons property has been added to the RevisionOptions class. This option lets a user to show formatting changes in the balloons. NOTE: Now it works only for delete revisions.

/// <summary>
/// Allows to specify whether the formatting changes are rendered in the balloons.
/// Default value for this property is <c>false</c>.
/// <remarks>
/// <para>
/// Only works for <see cref="RevisionType.Deletion"/>.
/// For <see cref="RevisionType.FormatChange"/> and <see cref="RevisionType.Insertion"/> is not supported yet.
/// </para>
/// </remarks>
/// </summary>
public bool ShowRevisionBalloons
{
    get { return mShowRevisionBalloons; }
    set
    {
        mHasChanged = true;
        mShowRevisionBalloons = value;
    }
}

Example of how to use:

Document doc = new Document(@"Document.docx");
doc.LayoutOptions.RevisionOptions.ShowRevisionBalloons = true;
string outFileName = (@"Out.pdf");
doc.Save(outFileName);

Saving DOCX as ISO 29500 Strict OOXML Format is Available now

A new member Iso29500_2008_Strict is added into the OoxmlCompliance enum type. UseCase to save as Strict OOXML:

Document doc = new Document();
OoxmlSaveOptions saveOptions = new OoxmlSaveOptions();
saveOptions.Compliance = OoxmlCompliance.Iso29500_2008_Strict;
doc.Save(@"C:\MyDir\strict_OOXML.docx", saveOptions);

Limitations:

• ISO 29500 Strict forbids VML, so we had to do a quick conversion hack by rendering VML shapes into pictures and storing them as DML Pictures. Proper VML->DML conversion is a big task without an ETA
• Testing has been done on documents mostly from our TestBase, so Support people please be prepared to receive a number of non-conformant, non-compliant and generally bad smelling documents that will violate our model assumptions in one way or another.

Added Feature to Insert Empty Values in Chart Series.

WORDSNET-13428 has been resolved. Starting from 16.6.0 Version, Aspose.Words supports an empty values in chart data series and categories upon creating. For example, you are going to create the chart with the following data:

In this case you have to use the code provided below: double.NaN value is used as empty data value. null is used as empty category name.

// Add chart with default data.
Shape shape = builder.InsertChart(ChartType.Line, 432, 252);
Chart chart = shape.Chart;
ChartSeriesCollection seriesColl = chart.Series;
seriesColl.Clear();

// Create category names array, second category will be null.
string[] categories = new string[] { "Cat1", null, "Cat3", "Cat4", "Cat5" };

// Adding new series with empty (double.NaN) values.
seriesColl.Add("AW Series 1", categories, new double[] { 1, 2, double.NaN, 4, 5 });
seriesColl.Add("AW Series 2", categories, new double[] { 2, 3, double.NaN, 5, 6 });
seriesColl.Add("AW Series 3", categories, new double[] { double.NaN, 4, 5, double.NaN, double.NaN });

The resulted chart looks like this:

Added MailMergeRegionInfo.Level Property

WORDSNET-13432 has been resolved. We have added the MailMergeRegionInfo.Level property to satisfy customer’s requirements logged in WORDSNET-13432. Following property for getting/setting level number will be added to public API for Aspose.Words.MailMerging.MailMergeRegionInfo class:

namespace Aspose.Words.MailMerging
{
    /// <summary>
    /// Contains information about a mail merge region.
    /// </summary>
    public class MailMergeRegionInfo
    {
...
        /// <summary>
        /// Return nesting level for the region.
        /// </summary>
        public int Level
        {
            get { return mRegionLevel; }
        }
        /// <summary>
        /// Sets nesting level for the region.
        /// </summary>
        internal void SetRegionLevel(int val)
        {
            mRegionLevel = val;
        }
...
        private int mRegionLevel = 0;
...
}

Added MailMerge.GetRegionsByName() Method

WORDSNET-13433 has been resolved. We have added the MailMerge.GetRegionsByName() method so that the user can obtain a list of regions by the specified name as follows:

public class MailMerge
{
...
        /// <summary>
        /// Returns a collection of mail merge regions with given name.
        /// </summary>
        /// <param name="regionName">Region name (case-insensitive).</param>
        /// <returns>The list of regions.</returns>
        public ArrayList GetRegionsByName(string regionName)

XpsSaveOptions.OptimizeOutput Option Added

WORDSNET-13572 has been resolved. Following new option is available in XpsSaveOptions:

/// <summary>
/// Flag indicates whether it is required to optimize output of XPS.
/// If this flag is set redundant nested canvases and empty canvases are removed,
/// also neighbor glyphs with the same formating are concatenated.
///
/// Default is false.
/// </summary>
public bool OptimizeOutput

Field.GetFieldCode() Improved, Added Field.GetFieldCode() Overload

As a resolution for WORDSNET-13583, we decided to improve the method Field.GetFieldCode(). Now it collects field’s code properly: the returned string includes all nested fields’ codes and results regardless of how the parent field is spanned among paragraphs or sections. Additionally, we have introduced a Field.GetFieldCode(bool) overload that accepts a parameter controlling whether to include child field codes into the resulting string. The user can pass false if they want to see nested fields’ results only.