com.aspose.cells

Class ConditionalFormattingCollection

java.lang.Object

com.aspose.cells.CollectionBase

com.aspose.cells.ConditionalFormattingCollection

All Implemented Interfaces:

java.lang.Iterable

public class ConditionalFormattingCollection
extends CollectionBase

Encapsulates a collection of FormatCondition objects.

Example

 
         //Instantiating a Workbook object
         Workbook workbook = new Workbook();
         Worksheet sheet = workbook.getWorksheets().get(0);
 
         //Get Conditional Formatting
         ConditionalFormattingCollection cformattings = sheet.getConditionalFormattings();
         //Adds an empty conditional formatting
         int index = cformattings.add();
         //Get newly added Conditional formatting
         FormatConditionCollection fcs = cformattings.get(index);
 
         //Sets the conditional format range.
         CellArea 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.
         int conditionIndex = fcs.addCondition(FormatConditionType.CELL_VALUE, OperatorType.BETWEEN, "=A2", "100");
         //Add condition.
         int conditionIndex2 = fcs.addCondition(FormatConditionType.CELL_VALUE, OperatorType.BETWEEN, "50", "100");
         //Sets the background color.
         FormatCondition fc = fcs.get(conditionIndex);
         fc.getStyle().setBackgroundColor(Color.getRed());
         //Saving the Excel file
         workbook.save("output.xls");
 

Method Summary

Methods

Modifier and Type	Method and Description
int	add() Adds a FormatConditions to the collection.
void	copy(ConditionalFormattingCollection cfs) Copies conditional formatting.
FormatConditionCollection	get(int index) Gets the FormatConditions element at the specified index.
void	removeArea(int startRow, int startColumn, int totalRows, int totalColumns) Remove all conditional formatting in the range.

Methods inherited from class com.aspose.cells.CollectionBase

add, clear, contains, getCount, indexOf, iterator, removeAt

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

removeArea

public void removeArea(int startRow,
              int startColumn,
              int totalRows,
              int totalColumns)

Remove all conditional formatting in the range.

Parameters:

startRow - The start row of the range.

startColumn - The start column of the range.

totalRows - The number of rows of the range.

totalColumns - The number of columns of the range.

copy

public void copy(ConditionalFormattingCollection cfs)

Copies conditional formatting.

Parameters:

cfs - The conditional formatting

get

public FormatConditionCollection get(int index)

Gets the FormatConditions element at the specified index.

Overrides:

get in class CollectionBase

Parameters:

index - The zero based index of the element.

Returns:

The item at specified position.

add

public int add()

Adds a FormatConditions to the collection.

Returns:

FormatConditions object index.