Aspose::Cells::ConditionalFormattingIconCollection class

ConditionalFormattingIconCollection class

Represents a collection of ConditionalFormattingIcon objects.

class ConditionalFormattingIconCollection

Methods

MethodDescription
Add(IconSetType type, int32_t index)Adds ConditionalFormattingIcon object.
Add(const ConditionalFormattingIcon& cficon)(Deprecated) Adds ConditionalFormattingIcon object.
begin()Returns an iterator to the beginning of the ConditionalFormattingIconCollection.
ConditionalFormattingIconCollection(ConditionalFormattingIconCollection_Impl* impl)Constructs from an implementation object.
ConditionalFormattingIconCollection(const ConditionalFormattingIconCollection& src)Copy constructor.
end()Returns an iterator to the end of the ConditionalFormattingIconCollection.
Get(int32_t index)Gets the ConditionalFormattingIcon element at the specified index.
GetCount()Gets the number of elements contained in the instance.
IsNull() constChecks whether the implementation object is nullptr.
explicit operator bool() constoperator bool()
operator=(const ConditionalFormattingIconCollection& src)operator=
~ConditionalFormattingIconCollection()Destructor.

Fields

FieldDescription
_implThe implementation object.

Examples

Aspose::Cells::Startup();
//Instantiating a Workbook object
Workbook 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;
ca.StartRow = 0;
ca.EndRow = 0;
ca.StartColumn = 0;
ca.EndColumn = 0;
fcs.AddArea(ca);

ca = 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.Get(idx);

//Sets condition's type
cond.GetIconSet().SetType(IconSetType::ArrowsGray3);

//Add custom iconset condition.
ConditionalFormattingIcon cfIcon = cond.GetIconSet().GetCfIcons().Get(0);

cfIcon.SetType(IconSetType::Arrows3);

cfIcon.SetIndex(0);

ConditionalFormattingIcon cfIcon1 = cond.GetIconSet().GetCfIcons().Get(1);

cfIcon1.SetType(IconSetType::ArrowsGray3);

cfIcon1.SetIndex(1);

ConditionalFormattingIcon cfIcon2 = cond.GetIconSet().GetCfIcons().Get(2);

cfIcon2.SetType(IconSetType::Boxes5);

cfIcon2.SetIndex(2);

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

Aspose::Cells::Cleanup();

See Also