Class ConditionalFormattingCollection

ConditionalFormattingCollection class

Encapsulates a collection of FormatCondition objects.

public class ConditionalFormattingCollection : CollectionBase<FormatConditionCollection>

Properties

NameDescription
Capacity { get; set; }
Count { get; }
Item { get; }Gets the FormatConditions element at the specified index.
Item { get; set; }

Methods

NameDescription
Add()Adds a FormatConditions to the collection.
BinarySearch(FormatConditionCollection)
BinarySearch(FormatConditionCollection, IComparer<FormatConditionCollection>)
BinarySearch(int, int, FormatConditionCollection, IComparer<FormatConditionCollection>)
Clear()
Contains(FormatConditionCollection)
Copy(ConditionalFormattingCollection)Copies conditional formatting.
CopyTo(FormatConditionCollection[])
CopyTo(FormatConditionCollection[], int)
CopyTo(int, FormatConditionCollection[], int, int)
Exists(Predicate<FormatConditionCollection>)
Find(Predicate<FormatConditionCollection>)
FindAll(Predicate<FormatConditionCollection>)
FindIndex(Predicate<FormatConditionCollection>)
FindIndex(int, Predicate<FormatConditionCollection>)
FindIndex(int, int, Predicate<FormatConditionCollection>)
FindLast(Predicate<FormatConditionCollection>)
FindLastIndex(Predicate<FormatConditionCollection>)
FindLastIndex(int, Predicate<FormatConditionCollection>)
FindLastIndex(int, int, Predicate<FormatConditionCollection>)
GetEnumerator()
IndexOf(FormatConditionCollection)
IndexOf(FormatConditionCollection, int)
IndexOf(FormatConditionCollection, int, int)
LastIndexOf(FormatConditionCollection)
LastIndexOf(FormatConditionCollection, int)
LastIndexOf(FormatConditionCollection, int, int)
RemoveArea(int, int, int, int)Remove all conditional formatting in the range.
RemoveAt(int)

Examples


[C#]

//Instantiating a Workbook object
Workbook workbook = new Workbook();
Worksheet sheet = workbook.Worksheets[0];

//Get Conditional Formatting
ConditionalFormattingCollection cformattings = sheet.ConditionalFormattings;
//Adds an empty conditional formatting
int index = cformattings.Add();
//Get newly added Conditional formatting
FormatConditionCollection fcs = cformattings[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.CellValue, OperatorType.Between, "=A2", "100");
//Add condition.
int conditionIndex2 = fcs.AddCondition(FormatConditionType.CellValue, OperatorType.Between, "50", "100");
//Sets the background color.
FormatCondition fc = fcs[conditionIndex];
fc.Style.BackgroundColor = Color.Red;
//Saving the Excel file
workbook.Save("output.xls");

[VB.NET]

'Instantiating a Workbook object
DDim workbook As Workbook = New Workbook()
Dim sheet As Worksheet = workbook.Worksheets(0)
'Get Conditional Formatting
Dim cformattings As ConditionalFormattingCollection = sheet.ConditionalFormattings

'Adds an empty conditional formatting
Dim index As Integer = cformattings.Add()
'Get newly added Conditional formatting
Dim fcs As FormatConditionCollection = cformattings(index)
'Sets the conditional format range.
Dim ca As 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.
Dim conditionIndex As Integer = fcs.AddCondition(FormatConditionType.CellValue, OperatorType.Between, "=A2", "100")
'Add condition.
Dim conditionIndex2 As Integer = fcs.AddCondition(FormatConditionType.CellValue, OperatorType.Between, "50", "100")
'Sets the background color.
Dim fc As FormatCondition = fcs(conditionIndex)
fc.Style.BackgroundColor = Color.Red
'Saving the Excel file
workbook.Save("output.xls")

See Also