AddDataBarRule Method

Visual Basic
C#

'Declaration
 
Public Function AddDataBarRule( _
   ByVal minType As ScaleValueType, _
   ByVal minValue As System.Object, _
   ByVal maxType As ScaleValueType, _
   ByVal maxValue As System.Object, _
   ByVal setColor As System.Windows.Media.Color, _
   ByVal ParamArray ranges() As CellRange _
) As DataBarRule

'Usage
 
Dim instance As ConditionalFormat
Dim minType As ScaleValueType
Dim minValue As System.Object
Dim maxType As ScaleValueType
Dim maxValue As System.Object
Dim setColor As System.Windows.Media.Color
Dim ranges() As CellRange
Dim value As DataBarRule
 
value = instance.AddDataBarRule(minType, minValue, maxType, maxValue, setColor, ranges)

public DataBarRule AddDataBarRule( 
   ScaleValueType minType,
   System.object minValue,
   ScaleValueType maxType,
   System.object maxValue,
   System.Windows.Media.Color setColor,
   params CellRange[] ranges
)

Parameters

minType: The minimum scale type.
minValue: The minimum scale value.
maxType: The maximum scale type.
maxValue: The maximum scale value.
setColor: The color data bar to show on the view.
ranges: The cell ranges where the rule is applied.

Return Value

Returns the new data bar rule.

This example creates a data bar rule.

C#

GcSpreadSheet1.Sheets[0].Cells[0, 0].Value = 1;
GcSpreadSheet1.Sheets[0].Cells[1, 0].Value = 10;
GcSpreadSheet1.Sheets[0].Cells[2, 0].Value = 6;
GcSpreadSheet1.Sheets[0].Cells[3, 0].Value = 3;      
GcSpreadSheet1.Sheets[0].ConditionalFormats.AddDataBarRule(GrapeCity.Windows.SpreadSheet.Data.ScaleValueType.LowestValue, 0, GrapeCity.Windows.SpreadSheet.Data.ScaleValueType.HighestValue, 10, Colors.Yellow, new GrapeCity.Windows.SpreadSheet.Data.CellRange[] { new GrapeCity.Windows.SpreadSheet.Data.CellRange(0, 0, 5, 1) });

VB.NET

GcSpreadSheet1.Sheets(0).Cells(0, 0).Value = 1
GcSpreadSheet1.Sheets(0).Cells(1, 0).Value = 10
GcSpreadSheet1.Sheets(0).Cells(2, 0).Value = 6
GcSpreadSheet1.Sheets(0).Cells(3, 0).Value = 3

GcSpreadSheet1.Sheets(0).ConditionalFormats.AddDataBarRule(GrapeCity.Windows.SpreadSheet.Data.ScaleValueType.LowestValue, 0, GrapeCity.Windows.SpreadSheet.Data.ScaleValueType.HighestValue, 10, Colors.Yellow, New GrapeCity.Windows.SpreadSheet.Data.CellRange() {New GrapeCity.Windows.SpreadSheet.Data.CellRange(0, 0, 5, 1)})

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