AddIconSetCondition Method

Adds a new IconSetConditionalFormat instance to this collection.

Syntax

C#

public IconSetConditionalFormat AddIconSetCondition( 
   string regionAddress,
   FormatConditionIconSet iconSet
)

Parameters

regionAddress

A string identifying the region to which this conditional format applies.

iconSet

A Infragistics.Documents.Excel.FormatConditionIconSet value which identifies the icon set to use. This parameter is optional and defaults to IconSet3TrafficLights1.

Return Value

The resulting IconSetConditionalFormat instance.

Remarks

Each constant in the Infragistics.Documents.Excel.FormatConditionIconSet enumeration contains either 3, 4, or 5 in its name. This number identifies the number of thresholds supported by the condition.

A three-threshold condition supports thresholds of 33%, 67%, and 100%.

A four-threshold condition supports thresholds of 25%, 50%, 75%, and 100%.

A five-threshold condition supports thresholds of 20%, 40%, 60%, 80%, and 100%.

A ColorScaleCriterion object for each threshold, is returned from the IconSetConditionalFormat.IconCriteria collection.

These objects provide the ability to customize the values for the corresponding threshold. For example, the icon that is displayed for a given index can be overridden using the Icon property.

Requirements

Target Platforms: Android 4.4+, iOS 8+

Development Environments: Visual Studio 2015+, Visual Studio for Mac Preview, Xamarin for Visual Studio 4.2+