Public API Changes in Aspose.Cells 9.0.0

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

Added APIs

Added Shape.TextOptions Property

Aspose.Cells for .NET has exposed the TextOptions property for the Shape class in order to control the appearance of textual parts of a Shape.

Here is a simple usage scenario of the Shape.TextOptions property.

C#

 // Initialize an instance of Workbook

var book = new Workbook();

// Get the default Worksheet from the Workbook

var sheet = book.Worksheets[0];

// Add a TextBox to the collection

var textboxIndex = sheet.TextBoxes.Add(2, 1, 160, 200);

// Get the TextBox object

var textbox = sheet.TextBoxes[textboxIndex];

// Add text to the TextBox

textbox.Text = "Hello Aspose!";

// Format the textual contents

textbox.TextOptions.Color = System.Drawing.Color.Red;

textbox.TextOptions.IsItalic = true;

Added LoadOptions.CultureInfo Property

Aspose.Cells for .NET 9.0.0 has exposed the LoadOptions.CultureInfo property which allows injecting an instance of CultureInfo at the time of loading a document into an instance of Workbook.

Here is a simple usage scenario of the aforementioned property.

Check the detailed article on Loading Spreadsheet with Specific CultureInfo.

C#

 // Create an instance of CultureInfo and populate its properties

var culture = new CultureInfo("en-GB");

culture.NumberFormat.NumberDecimalSeparator = ",";

culture.DateTimeFormat.DateSeparator = "-";

culture.DateTimeFormat.ShortDatePattern = "dd-MM-yyyy";

// Create an instance of LoadOptions and set the CultureInfo property

var options = new LoadOptions(LoadFormat.Html);

options.CultureInfo = culture;

// Load a HTML or TXT file in an instance of Workbook with instance of  LoadOptions

var book = new Workbook(dir + "input.html", options);

Added ChartPoint.IsInSecondaryPlot Property

Aspose.Cells for .NET has exposed the ChartPoint.IsInSecondaryPlot property which can be used to detect if a ChartPoint resides on a secondary plot of a Pie or Bar chart.

Here is a simple usage scenario of the ChartPoint.IsInSecondaryPlot property.

Check the detailed article on Finding a DataPoint that resides on the Second Plot.

C#

 // Load an existing spreadsheet containing a Pie chart

var book = new Workbook(dir + "PieBar.xlsx");

// Load the Worksheet at 0 index

var sheet = book.Worksheets[0];

// Load the first chart from the collection

var chart = sheet.Charts[0];

// Calculate the chart before accessing its properties

chart.Calculate();

// Accessing chart's first series

var series = chart.NSeries[0];

// Loop over the ChartPoint collection

foreach (ChartPoint point in series.Points)

{

    // Detect if ChartPoint resides on secondary plot

    Console.WriteLine(point.IsInSecondaryPlot);

}

Added OleObject.ClassIdentifier Property

Aspose.Cells for .NET 9.0.0 has exposed the OleObject.ClassIdentifier property which can be used to specify the application behavior for loading an OleObject. For instance, a PPT file can be embedded in a spreadsheet with two different views, that is, presentation view or slide view, each having different class identifier values.

The following is a simple usage scenario of the OleObject.ClassIdentifier property.

Check the detailed article on Using OleObject.ClassIdentifier.

C#

 // Load a spreadsheet containing a presentation as OleObject

var book = new Workbook(dir + "embeddedPresentation.xls");

// Initialize variables to store properties of OleObject

int upperLeftRow = 0;

int upperLeftColumn = 0;

int height = 0;

int width = 0;

byte[] imageData = null;

int x = 0;

int y = 0;

byte[] objData = null;

string progID = "";

FileFormatType fileFormatType = FileFormatType.Unknown;

string sourceFullName = "";

bool isDisplayAsIcon = false;

byte[] classId = null;

// Get the first worksheet from the collection

var sheet = book.Worksheets[0];

// Get the first OleObject from the collection

var frame = sheet.OleObjects[0];

// Store the properties in variables

upperLeftRow = frame.UpperLeftRow;

upperLeftColumn = frame.UpperLeftColumn;

height = frame.Height;

width = frame.Width;

imageData = frame.ImageData;

x = frame.X;

y = frame.Y;

objData = frame.ObjectData;

progID = frame.ProgID;

fileFormatType = frame.FileFormatType;

sourceFullName = frame.ObjectSourceFullName;

isDisplayAsIcon = frame.DisplayAsIcon;

classId = frame.ClassIdentifier;

// Initialize a new Workbook instance

book = new Workbook();

// Access first worksheet from the collection

sheet = book.Worksheets[0];

// Insert the OleObject to the worksheet

int oleNumber = sheet.OleObjects.Add(upperLeftRow, upperLeftColumn, height, width, imageData);

// Access newly inserted OleObject

var embeddedObject = sheet.OleObjects[oleNumber];

// Assign previously stored properties to new OleObject

embeddedObject.X = x;

embeddedObject.Y = y;

embeddedObject.ObjectData = objData;

embeddedObject.ProgID = progID;

embeddedObject.FileFormatType = fileFormatType;

embeddedObject.DisplayAsIcon = isDisplayAsIcon;

embeddedObject.ObjectSourceFullName = sourceFullName;

embeddedObject.IsAutoSize = false;

if (classId != null)

{

    embeddedObject.ClassIdentifier = classId;

}

// Save the resultant spreadsheet

book.Save(dir  + "output.xls");

Obsoleted APIs

Obsoleted Worksheet.SetBackground Method

Please use Worksheet.BackgroundImage property instead.

Obsoleted LineShape.BeginArrowheadStyle & ArcShape.BeginArrowheadStyle Properties

Please use Shape.Line.BeginArrowheadStyle property as an alternative.

Obsoleted LineShape.EndArrowheadStyle & ArcShape.EndArrowheadStyle Properties

Please use Shape.Line.EndArrowheadStyle property as an alternative.

Obsoleted LineShape.BeginArrowheadWidth & ArcShape.BeginArrowheadWidth Properties

Please use Shape.Line.BeginArrowheadWidth property as an alternative.

Obsoleted LineShape.BeginArrowheadLength & ArcShape.BeginArrowheadLength Properties

Please use Shape.Line.BeginArrowheadLength property instead.

Obsoleted LineShape.EndArrowheadWidth & ArcShape.EndArrowheadWidth Properties

Please use Shape.Line.EndArrowheadWidth property as an alternative.

Obsoleted LineShape.EndArrowheadLength & ArcShape.EndArrowheadLength Properties

Please use Shape.Line.EndArrowheadLength property as an alternative.

Deleted APIs

Deleted Worksheet.CopyConditionalFormatting Method

Deleted Workbook.CheckWriteProtectedPassword Method

Renamed APIs

Renamed Workbook.RemoveDigitallySign Method

The Workbook.RemoveDigitallySign method has been renamed to Workbook.RemoveDigitalSignature.