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 Object, _
   ByVal minColor As Color, _
   ByVal midType As ScaleValueType, _
   ByVal midValue As Object, _
   ByVal midColor As Color, _
   ByVal maxType As ScaleValueType, _
   ByVal maxValue As Object, _
   ByVal maxColor As Color, _
   ByVal ParamArray ranges() As CellRange _
) As ThreeColorScaleRule

'Usage
 
Dim instance As ConditionalFormat
Dim minType As ScaleValueType
Dim minValue As Object
Dim minColor As Color
Dim midType As ScaleValueType
Dim midValue As Object
Dim midColor As Color
Dim maxType As ScaleValueType
Dim maxValue As Object
Dim maxColor As 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,
   object minValue,
   Color minColor,
   ScaleValueType midType,
   object midValue,
   Color midColor,
   ScaleValueType maxType,
   object maxValue,
   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.

C#
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.Xaml.SpreadSheet.Data.ScaleValueType.Number, 1, Windows.UI.Colors.Yellow, GrapeCity.Xaml.SpreadSheet.Data.ScaleValueType.Number, 50, Windows.UI.Colors.Blue, GrapeCity.Xaml.SpreadSheet.Data.ScaleValueType.Number, 100, Windows.UI.Colors.Red, new GrapeCity.Xaml.SpreadSheet.Data.CellRange[] { new GrapeCity.Xaml.SpreadSheet.Data.CellRange(0, 0, 20, 1) });

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.Xaml.SpreadSheet.Data.ScaleValueType.Number, 1, Windows.UI.Colors.Yellow, GrapeCity.Xaml.SpreadSheet.Data.ScaleValueType.Number, 50, Windows.UI.Colors.Blue, GrapeCity.Xaml.SpreadSheet.Data.ScaleValueType.Number, 100, Windows.UI.Colors.Red, New GrapeCity.Xaml.SpreadSheet.Data.CellRange() { New GrapeCity.Xaml.SpreadSheet.Data.CellRange(0, 0, 20, 1) })

Requirements

Target Platforms: Windows Server 2012, Windows RT

Reference

ConditionalFormat Class
ConditionalFormat Members