Class ConditionalFormattingIconCollection

Class ConditionalFormattingIconCollection

Namespace: Aspose.Cells
Assembly: Aspose.Cells.dll (25.2.0)

Represents a collection of Aspose.Cells.ConditionalFormattingIcon objects.

public class ConditionalFormattingIconCollection : CollectionBase<conditionalformattingicon>, IList<conditionalformattingicon>, ICollection<conditionalformattingicon>, IEnumerable<conditionalformattingicon>, ICollection, IEnumerable

Inheritance

objectCollectionBase<conditionalformattingicon>ConditionalFormattingIconCollection

Implements

IList<conditionalformattingicon>, ICollection<conditionalformattingicon>, IEnumerable<conditionalformattingicon>, ICollection, IEnumerable

Inherited Members

CollectionBase<conditionalformattingicon>.BinarySearch(ConditionalFormattingIcon), CollectionBase<conditionalformattingicon>.BinarySearch(ConditionalFormattingIcon, IComparer<conditionalformattingicon>), CollectionBase<conditionalformattingicon>.BinarySearch(int, int, ConditionalFormattingIcon, IComparer<conditionalformattingicon>), CollectionBase<conditionalformattingicon>.Contains(ConditionalFormattingIcon), CollectionBase<conditionalformattingicon>.CopyTo(ConditionalFormattingIcon[]), CollectionBase<conditionalformattingicon>.CopyTo(ConditionalFormattingIcon[], int), CollectionBase<conditionalformattingicon>.CopyTo(int, ConditionalFormattingIcon[], int, int), CollectionBase<conditionalformattingicon>.Exists(Predicate<conditionalformattingicon>), CollectionBase<conditionalformattingicon>.Find(Predicate<conditionalformattingicon>), CollectionBase<conditionalformattingicon>.FindAll(Predicate<conditionalformattingicon>), CollectionBase<conditionalformattingicon>.FindIndex(Predicate<conditionalformattingicon>), CollectionBase<conditionalformattingicon>.FindIndex(int, Predicate<conditionalformattingicon>), CollectionBase<conditionalformattingicon>.FindIndex(int, int, Predicate<conditionalformattingicon>), CollectionBase<conditionalformattingicon>.FindLast(Predicate<conditionalformattingicon>), CollectionBase<conditionalformattingicon>.FindLastIndex(Predicate<conditionalformattingicon>), CollectionBase<conditionalformattingicon>.FindLastIndex(int, Predicate<conditionalformattingicon>), CollectionBase<conditionalformattingicon>.FindLastIndex(int, int, Predicate<conditionalformattingicon>), CollectionBase<conditionalformattingicon>.IndexOf(ConditionalFormattingIcon), CollectionBase<conditionalformattingicon>.IndexOf(ConditionalFormattingIcon, int), CollectionBase<conditionalformattingicon>.IndexOf(ConditionalFormattingIcon, int, int), CollectionBase<conditionalformattingicon>.LastIndexOf(ConditionalFormattingIcon), CollectionBase<conditionalformattingicon>.LastIndexOf(ConditionalFormattingIcon, int), CollectionBase<conditionalformattingicon>.LastIndexOf(ConditionalFormattingIcon, int, int), CollectionBase<conditionalformattingicon>.GetEnumerator(), CollectionBase<conditionalformattingicon>.Clear(), CollectionBase<conditionalformattingicon>.RemoveAt(int), CollectionBase<conditionalformattingicon>.OnClearComplete(), CollectionBase<conditionalformattingicon>.OnClear(), CollectionBase<conditionalformattingicon>.Capacity, CollectionBase<conditionalformattingicon>.Count, CollectionBase<conditionalformattingicon>.InnerList, CollectionBase<conditionalformattingicon>.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);

//Sets condition
 int idx = fcs.AddCondition(FormatConditionType.IconSet);

 FormatCondition cond = fcs[idx];

 //Sets condition's type
 cond.IconSet.Type = IconSetType.ArrowsGray3;

//Add custom iconset condition.
 ConditionalFormattingIcon cfIcon = cond.IconSet.CfIcons[0];

 cfIcon.Type = IconSetType.Arrows3;

 cfIcon.Index = 0;

 ConditionalFormattingIcon cfIcon1 = cond.IconSet.CfIcons[1];

  cfIcon1.Type = IconSetType.ArrowsGray3;

  cfIcon1.Index = 1;

  ConditionalFormattingIcon cfIcon2 = cond.IconSet.CfIcons[2];

  cfIcon2.Type = IconSetType.Boxes5;

  cfIcon2.Index = 2;

//Saving the Excel file
workbook.Save("output.xls");

'Instantiating a Workbook object
Dim 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)

//Sets condition
Dim idx As Integer =fcs.AddCondition(FormatConditionType.IconSet)

Dim cond As FormatCondition=fcs[idx]

//Sets condition's type
cfIcon.Type = IconSetType.ArrowsGray3

'Add custom iconset  condition.
Dim cfIcon As ConditionalFormattingIcon = cond.IconSet.CfIcons[0]

cfIcon.Type = IconSetType.Arrows3

cfIcon.Index=0

Dim cfIcon1 As ConditionalFormattingIcon = cond.IconSet.CfIcons[1]

cfIcon1.Type = IconSetType.ArrowsGray3

cfIcon1.Index=1

Dim cfIcon2 As ConditionalFormattingIcon = cond.IconSet.CfIcons[2]

cfIcon2.Type = IconSetType.Boxes5

cfIcon2.Index=2

'Saving the Excel file
workbook.Save("output.xls")

Properties

this[int]

Gets the ConditionalFormattingIcon element at the specified index.

public ConditionalFormattingIcon this[int index] { get; }

Property Value

ConditionalFormattingIcon

Methods

Add(IconSetType, int)

Adds Aspose.Cells.ConditionalFormattingIcon object.

public int Add(IconSetType type, int index)

Parameters

type IconSetType

The value type.

index int

The Index.

Returns

int

Returns the index of new object in the list.

Add(ConditionalFormattingIcon)

Adds Aspose.Cells.ConditionalFormattingIcon object.

public int Add(ConditionalFormattingIcon cficon)

Parameters

cficon ConditionalFormattingIcon

Returns the index of new object in the list.

Returns

int </conditionalformattingicon></conditionalformattingicon></conditionalformattingicon></conditionalformattingicon></conditionalformattingicon></conditionalformattingicon></conditionalformattingicon></conditionalformattingicon></conditionalformattingicon></conditionalformattingicon></conditionalformattingicon></conditionalformattingicon></conditionalformattingicon></conditionalformattingicon></conditionalformattingicon></conditionalformattingicon></conditionalformattingicon></conditionalformattingicon></conditionalformattingicon></conditionalformattingicon></conditionalformattingicon></conditionalformattingicon></conditionalformattingicon></conditionalformattingicon></conditionalformattingicon></conditionalformattingicon></conditionalformattingicon></conditionalformattingicon></conditionalformattingicon></conditionalformattingicon></conditionalformattingicon></conditionalformattingicon></conditionalformattingicon></conditionalformattingicon></conditionalformattingicon></conditionalformattingicon></conditionalformattingicon></conditionalformattingicon></conditionalformattingicon></conditionalformattingicon></conditionalformattingicon></conditionalformattingicon></conditionalformattingicon></conditionalformattingicon></conditionalformattingicon></conditionalformattingicon></conditionalformattingicon></conditionalformattingicon>