ConditionalFormattingCollection

Inheritance: java.lang.Object, com.aspose.cells.CollectionBase

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");

Methods

Method	Description
add()	Adds a FormatConditions to the collection.
add(Object o)	Adds an item to the CollectionBase instance.
clear()	Removes all objects from the CollectionBase instance.
contains(Object o)	Return whether instance contains this object
copy(ConditionalFormattingCollection cfs)	Copies conditional formatting.
equals(Object arg0)
get(int index)	Gets the FormatConditions element at the specified index.
getClass()
getCount()	Gets the number of elements contained in the CollectionBase instance.
hashCode()
indexOf(Object o)	Determines the index of a specific item in the CollectionBase instance.
iterator()	Returns an enumerator that iterates through the CollectionBase instance.
notify()
notifyAll()
removeArea(int startRow, int startColumn, int totalRows, int totalColumns)	Remove all conditional formatting in the range.
removeAt(int index)	Removes the item at the specified index.
toString()
wait()
wait(long arg0)
wait(long arg0, int arg1)

add()

public int add()

Adds a FormatConditions to the collection.

Returns: int - FormatConditions object index.

add(Object o)

public int add(Object o)

Adds an item to the CollectionBase instance.

Parameters:

Parameter	Type	Description
o	java.lang.Object	The Object to add to the CollectionBase instance.

Returns: int - The position into which the new element was inserted.

clear()

public void clear()

Removes all objects from the CollectionBase instance.

contains(Object o)

public boolean contains(Object o)

Return whether instance contains this object

Parameters:

Parameter	Type	Description
o	java.lang.Object	test object

Returns: boolean - Whether instance contains this object

copy(ConditionalFormattingCollection cfs)

public void copy(ConditionalFormattingCollection cfs)

Copies conditional formatting.

Parameters:

Parameter	Type	Description
cfs	ConditionalFormattingCollection	The conditional formatting

equals(Object arg0)

public boolean equals(Object arg0)

Parameters:

Parameter	Type	Description
arg0	java.lang.Object

Returns: boolean

get(int index)

public FormatConditionCollection get(int index)

Gets the FormatConditions element at the specified index.

Parameters:

Parameter	Type	Description
index	int	The zero based index of the element.

Returns: FormatConditionCollection

getClass()

public final native Class<?> getClass()

Returns: java.lang.Class

getCount()

public int getCount()

Gets the number of elements contained in the CollectionBase instance.

Returns: int - The number of elements contained in the CollectionBase instance.

hashCode()

public native int hashCode()

Returns: int

indexOf(Object o)

public int indexOf(Object o)

Determines the index of a specific item in the CollectionBase instance.

Parameters:

Parameter	Type	Description
o	java.lang.Object	Determines the index of a specific item in the CollectionBase instance.

Returns: int - The index of value if found in the list; otherwise, -1.

iterator()

public Iterator iterator()

Returns an enumerator that iterates through the CollectionBase instance.

Returns: java.util.Iterator - An iterator for the CollectionBase instance.

notify()

public final native void notify()

notifyAll()

public final native void notifyAll()

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

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

Remove all conditional formatting in the range.

Parameters:

Parameter	Type	Description
startRow	int	The start row of the range.
startColumn	int	The start column of the range.
totalRows	int	The number of rows of the range.
totalColumns	int	The number of columns of the range.

removeAt(int index)

public void removeAt(int index)

Removes the item at the specified index.

Parameters:

Parameter	Type	Description
index	int	The zero-based index of the item to remove.

toString()

public String toString()

Returns: java.lang.String

wait()

public final void wait()

wait(long arg0)

public final native void wait(long arg0)

Parameters:

Parameter	Type	Description
arg0	long

wait(long arg0, int arg1)

public final void wait(long arg0, int arg1)

Parameters:

Parameter	Type	Description
arg0	long
arg1	int