AddThreeScaleRule Method

Adds the three scale rule to the rule collection.

Syntax

Visual Basic
C#

'Declaration
 
Public Function AddThreeScaleRule( _
   ByVal minType As ScaleValueType, _
   ByVal minValue As System.Object, _
   ByVal minColor As System.Windows.Media.Color, _
   ByVal midType As ScaleValueType, _
   ByVal midValue As System.Object, _
   ByVal midColor As System.Windows.Media.Color, _
   ByVal maxType As ScaleValueType, _
   ByVal maxValue As System.Object, _
   ByVal maxColor As System.Windows.Media.Color, _
   ByVal ParamArray ranges() As CellRange _
) As ThreeColorScaleRule

'Usage
 
Dim instance As ConditionalFormat
Dim minType As ScaleValueType
Dim minValue As System.Object
Dim minColor As System.Windows.Media.Color
Dim midType As ScaleValueType
Dim midValue As System.Object
Dim midColor As System.Windows.Media.Color
Dim maxType As ScaleValueType
Dim maxValue As System.Object
Dim maxColor As System.Windows.Media.Color
Dim ranges() As CellRange
Dim value As ThreeColorScaleRule
 
value = instance.AddThreeScaleRule(minType, minValue, minColor, midType, midValue, midColor, maxType, maxValue, maxColor, ranges)

public ThreeColorScaleRule AddThreeScaleRule( 
   ScaleValueType minType,
   System.object minValue,
   System.Windows.Media.Color minColor,
   ScaleValueType midType,
   System.object midValue,
   System.Windows.Media.Color midColor,
   ScaleValueType maxType,
   System.object maxValue,
   System.Windows.Media.Color maxColor,
   params CellRange[] ranges
)

Parameters

minType: The minimum scale type.
minValue: The minimum scale value.
minColor: The minimum color scale.
midType: The midpoint scale type.
midValue: The midpoint scale value.
midColor: The midpoint scale color.
maxType: The maximum scale type.
maxValue: The maximum scale value.
maxColor: The maximum scale color.
ranges: The cell ranges where the rule is applied.

Return Value

Returns the new three color scale rule.

Example

This example creates a three scale rule.

GcSpreadSheet1.Sheets[0].Cells[0, 0].Value = -1;
GcSpreadSheet1.Sheets[0].Cells[1, 0].Value = 49;
GcSpreadSheet1.Sheets[0].Cells[2, 0].Value = 101;
GcSpreadSheet1.Sheets[0].ConditionalFormats.AddThreeScaleRule(GrapeCity.Windows.SpreadSheet.Data.ScaleValueType.Number, 1, Colors.Yellow, GrapeCity.Windows.SpreadSheet.Data.ScaleValueType.Number, 50, Colors.Blue, GrapeCity.Windows.SpreadSheet.Data.ScaleValueType.Number, 100, Colors.Red, new GrapeCity.Windows.SpreadSheet.Data.CellRange[] { new GrapeCity.Windows.SpreadSheet.Data.CellRange(0, 0, 20, 1) });

VB.NET

GcSpreadSheet1.Sheets(0).Cells(0, 0).Value = -1
GcSpreadSheet1.Sheets(0).Cells(1, 0).Value = 49
GcSpreadSheet1.Sheets(0).Cells(2, 0).Value = 101
GcSpreadSheet1.Sheets(0).ConditionalFormats.AddThreeScaleRule(GrapeCity.Windows.SpreadSheet.Data.ScaleValueType.Number, 1, Colors.Yellow, GrapeCity.Windows.SpreadSheet.Data.ScaleValueType.Number, 50, Colors.Blue, GrapeCity.Windows.SpreadSheet.Data.ScaleValueType.Number, 100, Colors.Red, New GrapeCity.Windows.SpreadSheet.Data.CellRange() { New GrapeCity.Windows.SpreadSheet.Data.CellRange(0, 0, 20, 1) })

Requirements

Target Platforms: Windows 7, Windows 8 Desktop, Windows Vista SP1 or later, Windows Server 2000, Windows 2000 Professional, Windows XP Professional, Windows NT 4.0 Workstation, SP6, Windows NT 4.0 Server, SP6

Reference

ConditionalFormat Class
ConditionalFormat Members