Class ConditionalFormattingCollection
Namespace: Aspose.Cells
Assembly: Aspose.Cells.dll (25.2.0)
Encapsulates a collection of Aspose.Cells.FormatCondition objects.
public class ConditionalFormattingCollection : CollectionBase<formatconditioncollection>, IList<formatconditioncollection>, ICollection<formatconditioncollection>, IEnumerable<formatconditioncollection>, ICollection, IEnumerable
Inheritance
object ← CollectionBase<formatconditioncollection> ← ConditionalFormattingCollection
Implements
IList<formatconditioncollection>, ICollection<formatconditioncollection>, IEnumerable<formatconditioncollection>, ICollection, IEnumerable
Inherited Members
CollectionBase<formatconditioncollection>.BinarySearch(FormatConditionCollection), CollectionBase<formatconditioncollection>.BinarySearch(FormatConditionCollection, IComparer<formatconditioncollection>), CollectionBase<formatconditioncollection>.BinarySearch(int, int, FormatConditionCollection, IComparer<formatconditioncollection>), CollectionBase<formatconditioncollection>.Contains(FormatConditionCollection), CollectionBase<formatconditioncollection>.CopyTo(FormatConditionCollection[]), CollectionBase<formatconditioncollection>.CopyTo(FormatConditionCollection[], int), CollectionBase<formatconditioncollection>.CopyTo(int, FormatConditionCollection[], int, int), CollectionBase<formatconditioncollection>.Exists(Predicate<formatconditioncollection>), CollectionBase<formatconditioncollection>.Find(Predicate<formatconditioncollection>), CollectionBase<formatconditioncollection>.FindAll(Predicate<formatconditioncollection>), CollectionBase<formatconditioncollection>.FindIndex(Predicate<formatconditioncollection>), CollectionBase<formatconditioncollection>.FindIndex(int, Predicate<formatconditioncollection>), CollectionBase<formatconditioncollection>.FindIndex(int, int, Predicate<formatconditioncollection>), CollectionBase<formatconditioncollection>.FindLast(Predicate<formatconditioncollection>), CollectionBase<formatconditioncollection>.FindLastIndex(Predicate<formatconditioncollection>), CollectionBase<formatconditioncollection>.FindLastIndex(int, Predicate<formatconditioncollection>), CollectionBase<formatconditioncollection>.FindLastIndex(int, int, Predicate<formatconditioncollection>), CollectionBase<formatconditioncollection>.IndexOf(FormatConditionCollection), CollectionBase<formatconditioncollection>.IndexOf(FormatConditionCollection, int), CollectionBase<formatconditioncollection>.IndexOf(FormatConditionCollection, int, int), CollectionBase<formatconditioncollection>.LastIndexOf(FormatConditionCollection), CollectionBase<formatconditioncollection>.LastIndexOf(FormatConditionCollection, int), CollectionBase<formatconditioncollection>.LastIndexOf(FormatConditionCollection, int, int), CollectionBase<formatconditioncollection>.GetEnumerator(), CollectionBase<formatconditioncollection>.Clear(), CollectionBase<formatconditioncollection>.RemoveAt(int), CollectionBase<formatconditioncollection>.OnClearComplete(), CollectionBase<formatconditioncollection>.OnClear(), CollectionBase<formatconditioncollection>.Capacity, CollectionBase<formatconditioncollection>.Count, CollectionBase<formatconditioncollection>.InnerList, CollectionBase<formatconditioncollection>.this[int], object.GetType(), object.MemberwiseClone(), object.ToString(), object.Equals(object?), object.Equals(object?, object?), object.ReferenceEquals(object?, object?), object.GetHashCode()
Examples
csharp
[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");
'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")
Properties
this[int]
Gets the FormatConditions element at the specified index.
public FormatConditionCollection this[int index] { get; }
Property Value
Methods
Add()
Adds a FormatConditions to the collection.
public int Add()
Returns
FormatConditions object index.
Copy(ConditionalFormattingCollection)
Copies conditional formatting.
public void Copy(ConditionalFormattingCollection cfs)
Parameters
cfs
ConditionalFormattingCollection
The conditional formatting
RemoveArea(int, int, int, int)
Remove all conditional formatting in the range.
public void RemoveArea(int startRow, int startColumn, int totalRows, int totalColumns)
Parameters
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. </formatconditioncollection></formatconditioncollection></formatconditioncollection></formatconditioncollection></formatconditioncollection></formatconditioncollection></formatconditioncollection></formatconditioncollection></formatconditioncollection></formatconditioncollection></formatconditioncollection></formatconditioncollection></formatconditioncollection></formatconditioncollection></formatconditioncollection></formatconditioncollection></formatconditioncollection></formatconditioncollection></formatconditioncollection></formatconditioncollection></formatconditioncollection></formatconditioncollection></formatconditioncollection></formatconditioncollection></formatconditioncollection></formatconditioncollection></formatconditioncollection></formatconditioncollection></formatconditioncollection></formatconditioncollection></formatconditioncollection></formatconditioncollection></formatconditioncollection></formatconditioncollection></formatconditioncollection></formatconditioncollection></formatconditioncollection></formatconditioncollection></formatconditioncollection></formatconditioncollection></formatconditioncollection></formatconditioncollection></formatconditioncollection></formatconditioncollection></formatconditioncollection></formatconditioncollection></formatconditioncollection></formatconditioncollection>