Public API Changes in Aspose.Cells 8.8.1

Added APIs

Filter the Data for Loading

Aspose.Cells for Java 8.8.1 has exposed the LoadDataFilterOptions enumeration along with the LoadOptions.LoadDataFilterOptions property, which can be used to specify the types of data that should be loaded when building the workbook from a template file. Filtering loaded data can improve performance for special purposes, especially when using LightCells APIs.

The LoadDataFilterOptions enumeration provides the following selections.

  1. ALL to load everything from the spreadsheet.
  2. NONE to load nothing from the spreadsheet.
  3. CELL_BLANK loads cells whose values are blank.
  4. CELL_BOOL loads cells whose values are Boolean.
  5. CELL_DATA loads cell data, including values, formulas and formatting.
  6. CELL_ERROR loads cells whose values are errors.
  7. CELL_NUMERIC loads cells whose values are numeric (including Date & Time).
  8. CELL_STRING loads cells whose values are text/string.
  9. CELL_VALUE loads only cell values (all types).
  10. CHART loads only charts.
  11. CONDITIONAL_FORMATTING loads only conditional formatting rules.
  12. DATA_VALIDATION loads only data validation rules.
  13. DOCUMENT_PROPERTIES loads only document properties.
  14. FORMULA loads formulas including defined names.
  15. MERGED_AREA loads only merged cells.
  16. PIVOT_TABLE loads Pivot Tables.
  17. SETTINGS loads only Workbook & Worksheet settings.
  18. SHAPE loads only shapes.
  19. STYLE loads cells formatting.
  20. TABLE loads Excel tables/List Objects.

Following is a simple usage scenario.

Java

 // Create an instance of LoadOptions and initialize it with the type of template to be loaded
LoadOptions options = new LoadOptions(LoadFormat.XLSX);

// Set LoadDataFilterOptions to load only shapes
options.setLoadDataFilterOptions(LoadDataFilterOptions.SHAPE);

// Create an instance of Workbook from an existing spreadsheet using an instance of LoadOptions
Workbook book = new Workbook(filePath, options);

Directly Convert Chart to PDF

Aspose.Cells APIs have already provided the facility to render charts to PDF using the Chart.toPdf method. With this release, the API has exposed another overloaded version of the method that can accept an instance of OutputStream, allowing users to save the chart’s PDF in a ByteArrayOutputStream.

Following is a simple usage scenario.

Java

 // Create an instance of Workbook and load an existing spreadsheet with a chart
Workbook workbook = new Workbook(filePath);

// Access the first worksheet containing a chart
Worksheet worksheet = workbook.getWorksheets().get(0);

// Access the first chart from the worksheet
Chart chart = worksheet.getCharts().get(0);

// Save the chart to PDF as a stream
ByteArrayOutputStream outStream = new ByteArrayOutputStream();
chart.toPdf(outStream);

Added WorkbookSettings.PaperSize Property

Aspose.Cells for Java 8.8.1 has exposed the WorkbookSettings.PaperSize property in order to set the default printing paper size for the whole spreadsheet. The WorkbookSettings.PaperSize property accepts a value from the PaperSizeType enumeration, which contains predefined sizes for the most widely used printing paper types.

Java

// Create an instance of Workbook
// Optionally load an existing spreadsheet
Workbook book = new Workbook();

// Access WorkbookSettings from the Workbook
WorkbookSettings settings = book.getSettings();

// Set the default printing paper size for the Workbook
settings.setPaperSize(PaperSizeType.PAPER_A_4);

Added Shape.TextBody Property

This release of Aspose.Cells for Java API has exposed the Shape.TextBody property in order to manipulate the aspects of the text in a shape. The following snippet uses the property to set the shadow effect of the text in a TextBox.

Java

// Create an instance of Workbook
Workbook book = new Workbook();

// Access the first worksheet of the Workbook
Worksheet sheet = book.getWorksheets().get(0);

// Add a TextBox to the ShapeCollection
int index = sheet.getTextBoxes().add(2, 2, 100, 400);
TextBox textBox = sheet.getTextBoxes().get(index);

// Set the text of the TextBox
textBox.setText("This text has the following settings.\n\nText Effects > Shadow > Offset Bottom");

// Set shadow effect for text
for (int i = 0; i < textBox.getTextBody().getCount(); i++) {
    textBox.getTextBody().get(i).getShapeFont().getFillFormat().getShadowEffect()
            .setPresetType(PresetShadowType.OFFSET_BOTTOM);
}

Added Worksheet.calculateFormula(string formula, CalculationOptions opts) Method

Aspose.Cells for Java 8.8.1 has exposed another overload for the Worksheet.calculateFormula method, which provides the ability to calculate a given formula directly with custom options.

Added GridCell.createValidation Method

Aspose.Cells.GridWeb has provided the ability to directly add a validation rule to a single cell using the GridCell.createValidation method. The method requires two parameters. The first is of type GridValidationType, which determines the validation type, whereas the second parameter (isRequired) is of type Boolean.

Java

// Access the first worksheet
GridWorksheet sheet = gridweb.getWorkSheets().get(0);

// Access cell B3
GridCell cell = sheet.getCells().get("B3");

// Add validation inside the GridCell
// Any value which is not between 20 and 40 will cause an error in the GridCell
GridValidation val = cell.createValidation(GridValidationType.WHOLE_NUMBER, true);
val.setFormula1("=20");
val.setFormula2("=40");
val.setOperator(OperatorType.BETWEEN);
val.setShowError(true);
val.setShowInput(true);

Added GridCell.removeValidation Method

Aspose.Cells.GridWeb has also provided the ability to remove the data validation rule from a GridCell using the GridCell.removeValidation method.

Obsoleted APIs

Obsoleted Shape.TextFrame Property

It is advised to use the Shape.TextBody.TextAlignment property instead.

Public API Changes in Aspose.Cells 8.8.0 Public API Changes in Aspose.Cells 8.8.2