com.aspose.cells

Class FormatConditionCollection

java.lang.Object

com.aspose.cells.FormatConditionCollection

public class FormatConditionCollection
extends java.lang.Object

Represents conditional formatting. The FormatConditions can contain up to three conditional formats.

Example

 
         //Create a new Workbook.
         Workbook workbook = new Workbook();
 
         //Get the first worksheet.
         Worksheet sheet = workbook.getWorksheets().get(0);
 
         //Adds an empty conditional formatting
         int index = sheet.getConditionalFormattings().add();
         FormatConditionCollection fcs = sheet.getConditionalFormattings().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);
         //Adds condition.
         int conditionIndex = fcs.addCondition(FormatConditionType.CELL_VALUE, OperatorType.BETWEEN, "=A2", "100");
         //Adds 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(CellArea cellArea, int type, int operatorType, java.lang.String formula1, java.lang.String formula2) Adds a formatting condition and effected cell rang to the FormatConditions The FormatConditions can contain up to three conditional formats.
int	addArea(CellArea cellArea) Adds a conditional formatted cell range.
int	addCondition(int type) Add a format condition.
int	addCondition(int type, int operatorType, java.lang.String formula1, java.lang.String formula2) Adds a formatting condition.
FormatCondition	get(int index) Gets the formatting condition by index.
CellArea	getCellArea(int index) Gets the conditional formatted cell range by index.
int	getCount() Gets the count of the conditions.
int	getRangeCount() Gets count of conditionally formatted ranges.
void	removeArea(int index) Removes conditional formatted cell range by index.
boolean	removeArea(int startRow, int startColumn, int totalRows, int totalColumns) Remove conditional formatting int the range.
void	removeCondition(int index) Removes the formatting condition by index.

Methods inherited from class java.lang.Object

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

Method Detail

add

public int[] add(CellArea cellArea,
        int type,
        int operatorType,
        java.lang.String formula1,
        java.lang.String formula2)

Adds a formatting condition and effected cell rang to the FormatConditions The FormatConditions can contain up to three conditional formats. References to the other sheets are not allowed in the formulas of conditional formatting.

Parameters:

cellArea - Conditional formatted cell range.

type - FormatConditionType. Type of conditional formatting.It could be one of the members of FormatConditionType.

operatorType - OperatorType. Comparison operator.It could be one of the members of OperatorType.

formula1 - The value or expression associated with conditional formatting.

formula2 - The value or expression associated with conditional formatting

Returns:

[0]:Formatting condition object index;[1] Effected cell rang index.

addArea

public int addArea(CellArea cellArea)

Adds a conditional formatted cell range.

Parameters:

cellArea - Conditional formatted cell range.

Returns:

Conditional formatted cell rang index.

addCondition

public int addCondition(int type,
               int operatorType,
               java.lang.String formula1,
               java.lang.String formula2)

Adds a formatting condition.

Parameters:

type - FormatConditionType. The type of format condition.

operatorType - OperatorType. The operator type

formula1 - The value or expression associated with conditional formatting. If the input value starts with '=', then it will be taken as formula. Otherwise it will be taken as plain value(text, number, bool). For text value that starts with '=', user may input it as formula in format: "=\"=...\"".

formula2 - The value or expression associated with conditional formatting. The input format is same with formula1

Returns:

Formatting condition object index;

addCondition

public int addCondition(int type)

Add a format condition.

Parameters:

type - FormatConditionType. Format condition type.

Returns:

Formatting condition object index;

getCount

public int getCount()

Gets the count of the conditions.

getRangeCount

public int getRangeCount()

Gets count of conditionally formatted ranges.

get

public FormatCondition get(int index)

Gets the formatting condition by index.

Parameters:

index - the index of the formatting condition to return.

Returns:

the formatting condition

getCellArea

public CellArea getCellArea(int index)

Gets the conditional formatted cell range by index.

Parameters:

index - the index of the conditional formatted cell range.

Returns:

the conditional formatted cell range

removeArea

public void removeArea(int index)

Removes conditional formatted cell range by index.

Parameters:

index - The index of the conditional formatted cell range to be removed.

removeArea

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

Remove conditional formatting int the range.

Parameters:

startRow - The startRow of the range.

startColumn - The startColumn of the range.

totalRows - The number of rows of the range.

totalColumns - The number of columns of the range.

Returns:

Returns TRUE, this FormatCondtionCollection should be removed.

removeCondition

public void removeCondition(int index)

Removes the formatting condition by index.

Parameters:

index - The index of the formatting condition to be removed.