All docs
V21.1
21.2 (EAP/Beta)
21.1
20.2
20.1
19.2
19.1
The page you are viewing does not exist in version 19.1. This link will take you to the root page.
18.2
The page you are viewing does not exist in version 18.2. This link will take you to the root page.
18.1
The page you are viewing does not exist in version 18.1. This link will take you to the root page.
17.2
The page you are viewing does not exist in version 17.2. This link will take you to the root page.
.NET Framework 4.5.2+
.NET Framework 4.5.2+
.NET Standard 2.0+
Row

ConditionalFormattingCollection.AddColorScale3ConditionalFormatting(CellRange, ConditionalFormattingValue, Color, ConditionalFormattingValue, Color, ConditionalFormattingValue, Color) Method

Applies the three-color scale conditional formatting rule.

Namespace: DevExpress.Spreadsheet

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

Declaration

ColorScale3ConditionalFormatting AddColorScale3ConditionalFormatting(
    CellRange range,
    ConditionalFormattingValue minPoint,
    Color minPointColor,
    ConditionalFormattingValue midPoint,
    Color midPointColor,
    ConditionalFormattingValue maxPoint,
    Color maxPointColor
)

Parameters

Name Type Description
range CellRange

A CellRange object that specifies a range of cells to which the conditional formatting rule is applied.

minPoint ConditionalFormattingValue

The ConditionalFormattingValue object that defines the minimum threshold and its ConditionalFormattingValueType type.

minPointColor Color

A Color object that defines a color representing the minimum value in the range of cells.

midPoint ConditionalFormattingValue

The ConditionalFormattingValue object that defines the midpoint threshold and its ConditionalFormattingValueType type.

midPointColor Color

A Color object that defines a color representing the midpoint value in the range of cells.

maxPoint ConditionalFormattingValue

The ConditionalFormattingValue object that defines the maximum threshold and its ConditionalFormattingValueType type.

maxPointColor Color

A Color object that defines a color representing the maximum value in the range of cells.

Returns

Type Description
ColorScale3ConditionalFormatting

A ColorScale3ConditionalFormatting object that represents the three-color scale conditional format.

Example

This example demonstrates how to apply a three-color scale conditional formatting rule.

  1. First of all, specify the minimum, midpoint and maximum thresholds of a range to which the rule will be applied. Threshold values are determined by the ConditionalFormattingValue object that can be accessed via the ConditionalFormattingCollection.CreateValue method. The type of the threshold value is specified by one of the ConditionalFormattingValueType enumeration values and can be a number, percent, formula, or percentile. Call the ConditionalFormattingCollection.CreateValue method with the ConditionalFormattingValueType.MinMax parameter to set the minimum and maximum thresholds to the lowest and highest values in a range of cells, respectively.
  2. To apply a conditional formatting rule represented by the ColorScale3ConditionalFormatting object, access the collection of conditional formats from the Worksheet.ConditionalFormattings property and call the ConditionalFormattingCollection.AddColorScale3ConditionalFormatting method with the following parameters:

    • A CellRange object that defines a range of cells to which the rule is applied.
    • A minimum threshold specified by the ConditionalFormattingValue object.
    • A color corresponding to the minimum value in a range of cells.
    • A midpoint threshold specified by the ConditionalFormattingValue object.
    • A color corresponding to the middle value in a range of cells.
    • A maximum threshold specified by the ConditionalFormattingValue object.
    • A color corresponding to the maximum value in a range of cells.

To remove the ColorScale3ConditionalFormatting object, use the ConditionalFormattingCollection.Remove, ConditionalFormattingCollection.RemoveAt or ConditionalFormattingCollection.Clear methods.

Dim conditionalFormattings As ConditionalFormattingCollection = worksheet.ConditionalFormattings
' Set the minimum threshold to the lowest value in the range of cells using the MIN() formula.
    Dim minPoint As ConditionalFormattingValue = conditionalFormattings.CreateValue(ConditionalFormattingValueType.Formula, "=MIN($C$2:$D$15)")
' Set the midpoint threshold to the 50th percentile.
    Dim midPoint As ConditionalFormattingValue = conditionalFormattings.CreateValue(ConditionalFormattingValueType.Percentile, "50")
' Set the maximum threshold to the highest value in the range of cells using the MAX() formula.
    Dim maxPoint As ConditionalFormattingValue = conditionalFormattings.CreateValue(ConditionalFormattingValueType.Number, "=MAX($C$2:$D$15)")
' Create the three-color scale rule to determine how values in cells C2 through D15 vary. Red represents the lower values, yellow represents the medium values and sky blue represents the higher values.
Dim cfRule As ColorScale3ConditionalFormatting = conditionalFormattings.AddColorScale3ConditionalFormatting(worksheet.Range("$C$2:$D$15"), minPoint, Color.Red, midPoint, Color.Yellow, maxPoint, Color.SkyBlue)
See Also