Aspose.Words for C++ 21.8 Release Notes

Major Features

Starting from this release, we are beginning to publish the macOS version of Aspose.Words for C++. The minimum requirements for macOS version are the following:

• A 64-bit Intel Mac with Big Sur or later (11.5+)
• Xcode
• Clang and libc++ (which are shipped by default with Xcode).

Examples are depend on the following libraries:

• fontconfig
• mesa-glu

We can lower macOS version requirements on request in the next releases.

It is the first version for macOS, so there may be artifacts and differences in behavior from both the Windows version of Aspose.Words for C++ and Aspose.Words for .NET. We continue to work on improving the product and adding features from .NET

Added support for macOS platfrom

We have added the following features from Aspose.Words for .NET on this regular monthly release:

• Added an ability to insert GIF images into the document.
• Added new Pdf save option - ExportLanguageToSpanTag.
• Implemented field updating public callback.

Limitations and API Differences

Aspose.Words for C++ has some differences as compared to its equivalent .NET version of the API. This section contains information about all such functionality that is not available in the current release. The missing features will be added in future releases.

• The current release does not support Metered license.
• The current release does not support LINQ and Reporting features.
• The current release does not support OpenGL 3D Shapes rendering.
• The current release does not support loading PDF documents.
• The current release has limited support for database features - C++ doesn’t have common API for DB like .NET System.Data.
• The current release supports Microsoft Visual C++ version 2017 or higher.
• The current release supports GCC 6.3 or higher and Clang 3.9.1 or higher on Linux and only for the x86_x64 platform.

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 21.8. 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 ability to insert GIF image into the document

Related issue: WORDSNET-1786

Introduced ability to insert a GIF image into the model using “DocumentBuilder::InsertImage” method.

Limitations:

• Access to the image bytes causes conversion GIF to PNG;

• Saving to formats differ from the DOCX, DOTX, DOCM, DOTM, FOPC causes conversion GIF to PNG;

• DocumentBuilder must be optimized to Word 2007 or higher (Word 2007 is default option).

Use Case: Explains how to insert a GIF image.

auto doc = System::MakeObject<Document>();
auto builder = System::MakeObject<DocumentBuilder>(doc);
auto image = builder->InsertImage(u"image.gif");

Added new Pdf save option - ExportLanguageToSpanTag

The new save option allows to customize how the Lang entry should be exported. It can be useful for compatibility with some screen readers.

/// <summary>
/// Gets or sets a value determining whether or not to create a "Span" tag in the document structure to export the text language.
/// </summary>
/// <remarks>
/// <para> Default value is <c>false</c> and "Lang" attribute is attached to a marked-content sequence in a page content stream.</para>
/// <para> When the value is <c>true</c> "Span" tag is created for the text with non-default language and "Lang" attribute is attached to this tag.</para>
/// <para> This value is ignored when <see cref="ExportDocumentStructure"/> is <c>false</c>. </para>
/// </remarks>
public bool ExportLanguageToSpanTag

Use Case:

auto doc = System::MakeObject<Document>(u"input.docx");
 
auto options = System::MakeObject<PdfSaveOptions>();
options->set_ExportDocumentStructure(true);
options->set_ExportLanguageToSpanTag(true);
 
doc->Save(u"output.pdf", options);

Implemented field updating public callback

Related issue: WORDSNET-22408

As a part of customer driven development, we have implemented a field updating public callback interface:

/// <summary>
/// Implement this interface if you want to have your own custom methods called during a field update.
/// </summary>
public interface IFieldUpdatingCallback
{
    /// <summary>
    /// A user defined method that is called just before a field is updated.
    /// </summary>
    void FieldUpdating(Field field);
 
    /// <summary>
    /// A user defined method that is called just after a field is updated.
    /// </summary>
    void FieldUpdated(Field field);
}

And a FieldOptions property:

/// <summary>
/// Gets or sets <see cref="IFieldUpdatingCallback"/> implementation
/// </summary>
public IFieldUpdatingCallback FieldUpdatingCallback { get; set; }

Use case:

document->get_FieldOptions()->set_FieldUpdatingCallback(System::MakeObject<FieldUpdatingCallback>());
 
class FieldUpdatingCallback : public IFieldUpdatingCallback
{
public:
    void FieldUpdating(System::SharedPtr<Aspose::Words::Fields::Field> field) override
    {
        // Do something on field updating.
    }
 
    void FieldUpdated(System::SharedPtr<Aspose::Words::Fields::Field> field) override
    {
        // Do something on field updated.
    }
};

Added new public property SaveOptions::FlatOpcXmlMappingOnly

Related issue: WORDSNET-22507

New public FlatOpcXmlMappingOnly option has been implemented.

/// <summary>
/// Gets or sets value determining which document formats are allowed to be mapped by <see cref="StructuredDocumentTag.XmlMapping"/>.
/// By default only <see cref="LoadFormat.FlatOpc"/> document format is allowed to be mapped.
/// </summary>
public bool FlatOpcXmlMappingOnly { get; set; }

By default MS Word allows to bind structured document tags to FlatOpc documents only. This option allows to control this behavior and bind documents in any format.

Use case:

auto doc = System::MakeObject<Document>(u"filename"); // a document containing SDT mapped to document, for example, in HTML format
doc->Save(u"out_1.pdf"); // the default behavior - SDT will contain raw HTML text
 
auto so = SaveOptions::CreateSaveOptions(SaveFormat::Pdf);
so->set_FlatOpcXmlMappingOnly(false);

doc->Save(u"out_2.pdf", so); // mapped HTML will be parsed and resulting document is inserted into SDT content