IconSetCondition Class

Namespace:
GemBox.Spreadsheet.ConditionalFormatting
Assembly:
GemBox.Spreadsheet.dll

Represents a condition that formats all cells based on their values by displaying an icon from the specified icon set according to cell's value.

public sealed class IconSetCondition : FormatCondition
Public NotInheritable Class IconSetCondition
    Inherits FormatCondition
Inheritance:
System.Object
IconSetCondition
Remarks

IconSetCondition is not supported when writing to XLS file format.

Properties

ConditionType

Gets the IconSet value.

public override FormatConditionType ConditionType { get; }
Public Overrides ReadOnly Property ConditionType As FormatConditionType
Property Value
FormatConditionType

The IconSet value.

Overrides

Icons

Gets the icons.

public ConditionalIconCollection Icons { get; }
Public ReadOnly Property Icons As ConditionalIconCollection
Property Value
ConditionalIconCollection

The icons.

IconStyle

Gets or sets the icon style for all icons contained in the Icons collection.

If icons are of different SpreadsheetIconStyle or are not ordered, then Custom is returned.

public SpreadsheetIconStyle IconStyle { get; set; }
Public Property IconStyle As SpreadsheetIconStyle
Property Value
SpreadsheetIconStyle

The icon style for all icons contained in the Icons collection.

Exceptions
System.ArgumentException

Icon style is set to None or Custom.

ReverseIconOrder

Gets or sets a value indicating whether the order of icons should be reversed.

Default value is false.

public bool ReverseIconOrder { get; set; }
Public Property ReverseIconOrder As Boolean
Property Value
System.Boolean

true if the order of icons should be reversed; otherwise, false.

ShowIconOnly

Gets or sets a value indicating whether to show icon only.

Default value is false (cell value is shown together with icon).

public bool ShowIconOnly { get; set; }
Public Property ShowIconOnly As Boolean
Property Value
System.Boolean

true to show icon only; otherwise, false.

Methods

ToString()

Returns a System.String that represents this IconSetCondition instance.

public override string ToString()
Public Overrides Function ToString As String
Returns
System.String

A System.String that represents this IconSetCondition instance.

Overrides
Remarks

This method should be used primarily for debugging purposes and should be considered volatile (format of its return value might change in future versions).

Inherited Properties

Rule

Gets the conditional formatting rule associated with this condition.

(Inherited from FormatCondition)

Examples