AddAverageRule Method

Visual Basic
C#

'Declaration
 
Public Function AddAverageRule( _
   ByVal type As AverageConditionType, _
   ByVal style As StyleInfo, _
   ByVal ParamArray ranges() As CellRange _
) As AverageRule

'Usage
 
Dim instance As ConditionalFormat
Dim type As AverageConditionType
Dim style As StyleInfo
Dim ranges() As CellRange
Dim value As AverageRule
 
value = instance.AddAverageRule(type, style, ranges)

public AverageRule AddAverageRule( 
   AverageConditionType type,
   StyleInfo style,
   params CellRange[] ranges
)

Parameters

type: The AverageConditionType average condition type.
style: The style that is applied to the cell when the condition is met.
ranges: The cell ranges where the rule is applied.

Return Value

Returns the new average rule.

This example creates an average 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;
var style2 = new GrapeCity.Windows.SpreadSheet.Data.StyleInfo();
style2.Background = new SolidColorBrush(Colors.Yellow);

GcSpreadSheet1.Sheets[0].ConditionalFormats.AddAverageRule(GrapeCity.Windows.SpreadSheet.Data.AverageConditionType.EqualOrAbove, style2, 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
Dim style2 As New GrapeCity.Windows.SpreadSheet.Data.StyleInfo()
style2.Background = New SolidColorBrush(Colors.Yellow)

GcSpreadSheet1.Sheets(0).ConditionalFormats.AddAverageRule(GrapeCity.Windows.SpreadSheet.Data.AverageConditionType.EqualOrAbove, style2, 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 (SP4), Windows XP (SP2), Windows 2008, Windows 2003 Server (SP1)

Reference

ConditionalFormat Class
ConditionalFormat Members