ConditionalFormattingCollection
Contents
[
Hide
]ConditionalFormattingCollection class
Encapsulates a collection of FormatCondition objects.
class ConditionalFormattingCollection;
Example
const { Workbook, CellArea, FormatConditionType, OperatorType, Color, SaveFormat } = AsposeCells;
//Instantiating a Workbook object
var workbook = new Workbook();
var sheet = workbook.worksheets.get(0);
//Get Conditional Formattings
var cformattings = sheet.conditionalFormattings;
//Adds an empty conditional formatting
var index = cformattings.add();
//Get newly added Conditional formatting
var fcs = cformattings.get(index);
//Sets the conditional format range.
var ca = new CellArea();
ca.startRow = 0;
ca.endRow = 0;
ca.startColumn = 0;
ca.endColumn = 0;
fcs.addArea(ca);
ca = new CellArea();
ca.startRow = 1;
ca.endRow = 1;
ca.startColumn = 1;
ca.endColumn = 1;
fcs.addArea(ca);
//Add condition.
var conditionIndex = fcs.addCondition(FormatConditionType.CellValue, OperatorType.Between, "=A2", "100");
//Add condition.
var conditionIndex2 = fcs.addCondition(FormatConditionType.CellValue, OperatorType.Between, "50", "100");
//Sets the background color.
var fc = fcs.get(conditionIndex);
fc.style.backgroundColor = Color.Red;
//Saving the Excel file
var uint8Array = workbook.save(SaveFormat.Xlsx);
Methods
| Method | Description |
|---|---|
| get(number) | Gets the FormatConditions element at the specified index. |
| removeArea(number, number, number, number) | Remove all conditional formatting in the range. |
| copy(ConditionalFormattingCollection) | Copies conditional formatting. |
| add() | Adds a FormatConditions to the collection. |
get(number)
Gets the FormatConditions element at the specified index.
get(index: number) : FormatConditionCollection;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| index | number | The zero based index of the element. |
Returns
removeArea(number, number, number, number)
Remove all conditional formatting in the range.
removeArea(startRow: number, startColumn: number, totalRows: number, totalColumns: number) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| startRow | number | The start row of the range. |
| startColumn | number | The start column of the range. |
| totalRows | number | The number of rows of the range. |
| totalColumns | number | The number of columns of the range. |
copy(ConditionalFormattingCollection)
Copies conditional formatting.
copy(cfs: ConditionalFormattingCollection) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| cfs | ConditionalFormattingCollection | The conditional formatting |
add()
Adds a FormatConditions to the collection.
add() : number;
Returns
FormatConditions object index.