ColorScaleCondition Class

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

Represents a condition that formats fill of all cells based on their values using a specified 2-point or 3-point color scale.

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

ColorScaleCondition is not supported when writing to XLS file format.

Properties

ConditionType

Gets the ColorScale value.

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

The ColorScale value.

Overrides

Maximum

Gets the maximum color point.

public ConditionalColor Maximum { get; }
Public ReadOnly Property Maximum As ConditionalColor
Property Value
ConditionalColor

The maximum color points.

Midpoint

Gets the midpoint color point or null if conditional formatting rule is '2-Color Scale'.

public ConditionalColor Midpoint { get; }
Public ReadOnly Property Midpoint As ConditionalColor
Property Value
ConditionalColor

The midpoint color point or null if conditional formatting rule is '2-Color Scale'.

Minimum

Gets the minimum color point.

public ConditionalColor Minimum { get; }
Public ReadOnly Property Minimum As ConditionalColor
Property Value
ConditionalColor

The minimum color point.

Methods

ToString()

Returns a System.String that represents this ColorScaleCondition instance.

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

A System.String that represents this ColorScaleCondition 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