Class ConditionalFormattingValueCollection

ConditionalFormattingValueCollection class

Describes a collection of CFValueObject. Use only for icon sets.

public class ConditionalFormattingValueCollection : CollectionBase<ConditionalFormattingValue>

Properties

NameDescription
Capacity { get; set; }
Count { get; }
Item { get; }Get the CFValueObject element at the specified index.
Item { get; set; }

Methods

NameDescription
Add(FormatConditionValueType, string)Adds ConditionalFormattingValue object.
BinarySearch(ConditionalFormattingValue)
BinarySearch(ConditionalFormattingValue, IComparer<ConditionalFormattingValue>)
BinarySearch(int, int, ConditionalFormattingValue, IComparer<ConditionalFormattingValue>)
Clear()
Contains(ConditionalFormattingValue)
CopyTo(ConditionalFormattingValue[])
CopyTo(ConditionalFormattingValue[], int)
CopyTo(int, ConditionalFormattingValue[], int, int)
Exists(Predicate<ConditionalFormattingValue>)
Find(Predicate<ConditionalFormattingValue>)
FindAll(Predicate<ConditionalFormattingValue>)
FindIndex(Predicate<ConditionalFormattingValue>)
FindIndex(int, Predicate<ConditionalFormattingValue>)
FindIndex(int, int, Predicate<ConditionalFormattingValue>)
FindLast(Predicate<ConditionalFormattingValue>)
FindLastIndex(Predicate<ConditionalFormattingValue>)
FindLastIndex(int, Predicate<ConditionalFormattingValue>)
FindLastIndex(int, int, Predicate<ConditionalFormattingValue>)
GetEnumerator()
IndexOf(ConditionalFormattingValue)
IndexOf(ConditionalFormattingValue, int)
IndexOf(ConditionalFormattingValue, int, int)
LastIndexOf(ConditionalFormattingValue)
LastIndexOf(ConditionalFormattingValue, int)
LastIndexOf(ConditionalFormattingValue, int, int)
RemoveAt(int)

Examples

[C#]

namespace Demos
{
    using Aspose.Cells;
    using System;

    public class ConditionalFormattingValueCollectionDemo
    {
        public static void ConditionalFormattingValueCollectionExample()
        {
            // Instantiating a Workbook object
            Workbook workbook = new Workbook();
            Worksheet sheet = workbook.Worksheets[0];

            // Adds an empty conditional formatting
            int index = sheet.ConditionalFormattings.Add();
            FormatConditionCollection fcs = sheet.ConditionalFormattings[index];

            // Sets the conditional format range
            CellArea ca = new CellArea
            {
                StartRow = 0,
                EndRow = 2,
                StartColumn = 0,
                EndColumn = 0
            };
            fcs.AddArea(ca);

            // Adds condition
            int conditionIndex = fcs.AddCondition(FormatConditionType.IconSet);
            FormatCondition cond = fcs[conditionIndex];

            // Get Icon Set
            IconSet iconSet = cond.IconSet;

            // Set Icon Type
            iconSet.Type = IconSetType.Arrows3;

            // Get the CFValueObjects instance
            ConditionalFormattingValueCollection cfvos = iconSet.Cfvos;

            // Add a new ConditionalFormattingValue to the collection
            int cfvIndex = cfvos.Add(FormatConditionValueType.Number, "50");

            // Access the newly added ConditionalFormattingValue
            ConditionalFormattingValue cfv = cfvos[cfvIndex];

            // Modify properties of the ConditionalFormattingValue
            cfv.Value = 75;
            cfv.Type = FormatConditionValueType.Percent;
            cfv.IsGTE = true;

            // Put Cell Values
            sheet.Cells["A1"].PutValue(10);
            sheet.Cells["A2"].PutValue(120);
            sheet.Cells["A3"].PutValue(260);

            // Saving the Excel file
            workbook.Save("ConditionalFormattingValueCollectionExample.xlsx");
            workbook.Save("ConditionalFormattingValueCollectionExample.pdf");
        }
    }
}

See Also