ConditionalFormattingCollection.CreateIconSetValue(ConditionalFormattingValueType, String, ConditionalFormattingValueOperator) Method

Specifies the threshold value for the icon set conditional formatting rule.

Namespace: DevExpress.Spreadsheet

Assembly: DevExpress.Spreadsheet.v24.1.Core.dll

NuGet Package: DevExpress.Spreadsheet.Core

Declaration

C#

ConditionalFormattingIconSetValue CreateIconSetValue(
    ConditionalFormattingValueType valueType,
    string value,
    ConditionalFormattingValueOperator comparisonOperator
)

VB.NET

Function CreateIconSetValue(
    valueType As ConditionalFormattingValueType,
    value As String,
    comparisonOperator As ConditionalFormattingValueOperator
) As ConditionalFormattingIconSetValue

Parameters

Name	Type	Description
valueType	ConditionalFormattingValueType	One of the ConditionalFormattingValueType enumeration values.
value	String	A string that is the threshold value.
comparisonOperator	ConditionalFormattingValueOperator	One of the ConditionalFormattingValueOperator enumeration values.

Returns

Type	Description
ConditionalFormattingIconSetValue	A ConditionalFormattingIconSetValue object that defines the threshold value and its ConditionalFormattingValueType type.

Remarks

If you use a formula to determine the threshold value (the valueType is set to ConditionalFormattingValueType.Formula), start it with an equals sign (=). The formula can include built-in spreadsheet functions. Note that use of relative references is not allowed.

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the CreateIconSetValue(ConditionalFormattingValueType, String, ConditionalFormattingValueOperator) method.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

C#

wpf-spreadsheet-how-to-apply-conditional-formatting-to-a-range-of-cells/CS/ConditionalFormatting_WPF_Examples/SpreadsheetActions/ConditionalFormatting.cs#L366

// Set the first threshold to the lowest value in the range of cells using the MIN() formula.
ConditionalFormattingIconSetValue minPoint = conditionalFormattings.CreateIconSetValue(ConditionalFormattingValueType.Formula, "=MIN($E$2:$E$15)", ConditionalFormattingValueOperator.GreaterOrEqual);
// Set the second threshold to 0.

spreadsheet-document-api-apply-conditional-formatting-to-cell-range/CS/ConditionalFormatting_Example/SpreadsheetActions/ConditionalFormatting.cs#L370

// Set the first threshold to the lowest value in the range of cells using the MIN() formula.
ConditionalFormattingIconSetValue minPoint = conditionalFormattings.CreateIconSetValue(ConditionalFormattingValueType.Formula, "=MIN($E$2:$E$15)", ConditionalFormattingValueOperator.GreaterOrEqual);
// Set the second threshold to 0.

winforms-spreadsheet-apply-conditional-formatting-to-a-range-of-cells/CS/SpreadsheetControl/SpreadsheetActions/ConditionalFormatting.cs#L368

// Set the first threshold to the lowest value in the range of cells using the MIN() formula.
ConditionalFormattingIconSetValue minPoint = conditionalFormattings.CreateIconSetValue(ConditionalFormattingValueType.Formula, "=MIN($E$2:$E$15)", ConditionalFormattingValueOperator.GreaterOrEqual);
// Set the second threshold to 0.

VB.NET

wpf-spreadsheet-how-to-apply-conditional-formatting-to-a-range-of-cells/VB/ConditionalFormatting_WPF_Examples/SpreadsheetActions/ConditionalFormatting.vb#L318

' Set the first threshold to the lowest value in the range of cells using the MIN() formula.
Dim minPoint As ConditionalFormattingIconSetValue = conditionalFormattings.CreateIconSetValue(ConditionalFormattingValueType.Formula, "=MIN($E$2:$E$15)", ConditionalFormattingValueOperator.GreaterOrEqual)
' Set the second threshold to 0.

spreadsheet-document-api-apply-conditional-formatting-to-cell-range/VB/ConditionalFormatting_Example/SpreadsheetActions/ConditionalFormatting.vb#L324

' Set the first threshold to the lowest value in the range of cells using the MIN() formula.
Dim minPoint As ConditionalFormattingIconSetValue = conditionalFormattings.CreateIconSetValue(ConditionalFormattingValueType.Formula, "=MIN($E$2:$E$15)", ConditionalFormattingValueOperator.GreaterOrEqual)
' Set the second threshold to 0.

winforms-spreadsheet-apply-conditional-formatting-to-a-range-of-cells/VB/SpreadsheetControl/SpreadsheetActions/ConditionalFormatting.vb#L321

' Set the first threshold to the lowest value in the range of cells using the MIN() formula.
    Dim minPoint As ConditionalFormattingIconSetValue = conditionalFormattings.CreateIconSetValue(ConditionalFormattingValueType.Formula, "=MIN($E$2:$E$15)", ConditionalFormattingValueOperator.GreaterOrEqual)
' Set the second threshold to 0.