Public API Changes in Aspose.Cells 8.6.1

This document describes the changes to the Aspose.Cells API from version 8.6.0 to 8.6.1 that may be of interest to module/application developers. It includes not only new and updated public methods, added classes, but also a description of any changes in the behavior behind the scenes in Aspose.Cells.

Added APIs

Support for HTML Link Target Type

This release of Aspose.Cells for .NET API has exposed an enumeration namely HtmlLinkTargetType along with a new property HtmlSaveOptions.LinkTargetType that together allows to set the target type for the links in spreadsheet while conversion to HTML format. The possible values of the HtmlLinkTargetType enumeration as follow where the default value is Self.

HtmlLinkTargetType.Blank: Opens the linked document/page in a new window or tab.
HtmlLinkTargetType.Parent: Opens the linked document/page in parent frame.
HtmlLinkTargetType.Self: Opens the linked document/page in the same frame where the link was clinked.
HtmlLinkTargetType.Top: Opens the linked document/page in the full body of the window.

Following is the simple usage scenario.

C#

 //Load a spreadsheet

Workbook workbook = new Workbook(inputFilePath);

//Create an instance of HtmlSaveOptions

HtmlSaveOptions options = new HtmlSaveOptions();

//Set the LinkTargetType property to appropriate value

options.LinkTargetType = HtmlLinkTargetType.Blank;

//Convert the spreadsheet to HTML with preset HtmlSaveOptions

workbook.Save(outputFilePath, options);

Added VbaModuleCollection.Remove Method

Aspose.Cells for .NET 8.6.1 has exposed another overload of the VbaModuleCollection.Remove method that can now accept an instance of Worksheet to remove all the VBA modules associated with the specified Worksheet.

Following is the simple usage scenario.

C#

 //Load a spreadsheet

Workbook workbook = new Workbook(inputFilePath);

//Retrieve the VBA modules from the Workbook

VbaModuleCollection modules = workbook.VbaProject.Modules;

//Remove the VBA modules from specific Worksheet

modules.Remove(workbook.Worksheets[0]);

Added RangeCollection.Add Method

Aspose.Cells for .NET 8.6.1 has exposed the RangeCollection.Add method that can be used to add Range objects to the collection of ranges for a particular Worksheet.

Following is the simple usage scenario.

C#

 //Load a spreadsheet

Workbook workbook = new Workbook(inputFilePath);

//Retrieve the Cells of the first worksheet in the workbook

Cells cells = workbook.Worksheets[0].Cells;

//Retrieve the range collection from first worksheet of the Workbook

RangeCollection ranges = cells.Ranges;

//Add another range to the collection

ranges.Add(cells.CreateRange("A1:B4"));

Added Cell.SetCharacters Method

The Cell.SetCharacters method can be used to update the portions of the rich text of a given Cell object. The Cell.GetCharacters method is to be used to access the portions of the text and then amendments can be done using the Cell.SetCharacters method whereas the Get method returns an array of FontSetting objects which can be manipulated to set various properties font name, font color, boldness etc and Set method can be used to apply the changes.

Following is the simple usage scenario.

C#

 //Load a spreadsheet

Workbook workbook = new Workbook(inputFilePath);

//Access first worksheet of the workbook

Worksheet worksheet = workbook.Worksheets[0];

//Access the cells containing the Rich Text

Cell cell = worksheet.Cells["A1"];

//Retrieve the array of FontSetting from the cell

FontSetting[] settings = cell.GetCharacters();

//Modify the Font Name for the first FontSetting 

settings[0].Font.Name = "Arial";

//Set the updated FontSetting

cell.SetCharacters(settings);

Added VbaProject.IsSigned Property

Aspose.Cells for .NET 8.6.1 has exposed the VbaProject.IsSigned property that can be used to test if a VbaProject in a Workbook is signed or not. Boolean type property returns true if the project is signed.

Following is the simple usage scenario.

C#

 //Load a spreadsheet

Workbook workbook = new Workbook(inputFilePath);

//Retrieve the VbaProject from the Workbook

VbaProject project = workbook.VbaProject;

//Test if VbaProject is signed

if (project.IsSigned)

{

    Console.WriteLine("VBA Project is Signed");

}

else

{

    Console.WriteLine("VBA Project is not Signed");

}

Modified APIs

Modified Cell.GetFormatConditions Method

With the release of v8.6.1, the Aspose.Cells for .NET API has modified the return type of the Cell.GetFormatConditions method that now returns an array of type FormatConditionCollection.

Obsoleted APIs

Obsoleted Workbook.CheckWriteProtectedPassword Method

With the release of v8.6.1, the Workbook.CheckWriteProtectedPassword method has been marked depreciated. It is advised to use the WorkbookSettings.WriteProtection.ValidatePassword method that can accept a string value as parameter and returns Boolean if password matches the preset password of the spreadsheet.

Public API Changes in Aspose.Cells 8.6.0 Public API Changes in Aspose.Cells 8.6.2