FormatRuleCollection<T, TColumnType>.Add3ColorScale(TColumnType, Color, Color, Color, FormatConditionValueType, FormatConditionValueType, FormatConditionValueType, Decimal, Decimal, Decimal) Method

Applies a format that uses a range of colors to illustrate data distribution. You can specify the minimum, maximum, and midpoint values, and colors for them.

Namespace: DevExpress.XtraEditors

Assembly: DevExpress.XtraEditors.v24.2.dll

Declaration

C#

public T Add3ColorScale(
    TColumnType column,
    Color minColor,
    Color midColor,
    Color maxColor,
    FormatConditionValueType minType = FormatConditionValueType.Automatic,
    FormatConditionValueType midType = FormatConditionValueType.Automatic,
    FormatConditionValueType maxType = FormatConditionValueType.Automatic,
    decimal minValue = 0M,
    decimal midValue = 0M,
    decimal maxValue = 0M
)

VB.NET

Public Function Add3ColorScale(
    column As TColumnType,
    minColor As Color,
    midColor As Color,
    maxColor As Color,
    minType As FormatConditionValueType = FormatConditionValueType.Automatic,
    midType As FormatConditionValueType = FormatConditionValueType.Automatic,
    maxType As FormatConditionValueType = FormatConditionValueType.Automatic,
    minValue As Decimal = 0D,
    midValue As Decimal = 0D,
    maxValue As Decimal = 0D
) As T

Parameters

Name	Type	Description
column	TColumnType	A {TColumnType} object that specifies a column (row in a vertical grid) to which the format should be applied.
minColor	Color	The color that corresponds to the minimum threshold. This value is assigned to the MinimumColor property.
midColor	Color	The color that corresponds to the midpoint of the target value range. This value is assigned to the MiddleColor property.
maxColor	Color	The color that corresponds to the maximum threshold. This value is assigned to the MaximumColor property.

Optional Parameters

Name	Type	Default	Description
minType	FormatConditionValueType	Automatic	A value that specifies whether the minimum value is automatically calculated or specified manually (as a number or percentage). This value is assigned to the MinimumType property.
midType	FormatConditionValueType	Automatic	A value that specifies whether the midpoint value is automatically calculated or specified manually (as a number or percentage). This value is assigned to the MiddleType property.
maxType	FormatConditionValueType	Automatic	A value that specifies whether the maximum value is automatically calculated or specified manually (as a number or percentage). This value is assigned to the MaximumType property.
minValue	Decimal	0	The minimum value of the target range. This value is assigned to the Minimum property.
midValue	Decimal	0	The midpoint of the target value range. This value is assigned to the Middle property.
maxValue	Decimal	0	The maximum value of the target range. This value is assigned to the Maximum property.

Returns

Type	Description
T	A {T} object that specifies a format.