AddTop10Rule Method

Adds the top 10 rule or bottom 10 rule to the collection based on the Top10CondtionType.

Syntax

Visual Basic
C#

'Declaration
 
Public Function AddTop10Rule( _
   ByVal type As Top10ConditionType, _
   ByVal rank As Integer, _
   ByVal style As StyleInfo, _
   ByVal ParamArray ranges() As CellRange _
) As Top10Rule

'Usage
 
Dim instance As ConditionalFormat
Dim type As Top10ConditionType
Dim rank As Integer
Dim style As StyleInfo
Dim ranges() As CellRange
Dim value As Top10Rule
 
value = instance.AddTop10Rule(type, rank, style, ranges)

public Top10Rule AddTop10Rule( 
   Top10ConditionType type,
   int rank,
   StyleInfo style,
   params CellRange[] ranges
)

Parameters

type: The Top10ConditionType top 10 condition.
rank: The number of top or bottom items to apply the style to.
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 top 10 rule.

Example

This example creates a top 10 rule.

C#
VB.NET

GcSpreadSheet1.Sheets[0].SetValue(0, 0, 1);
GcSpreadSheet1.Sheets[0].SetValue(1, 0, 50);
GcSpreadSheet1.Sheets[0].SetValue(2, 0, 11);
GcSpreadSheet1.Sheets[0].SetValue(3, 0, 5);
var style2 = new GrapeCity.Xaml.SpreadSheet.Data.StyleInfo();
style2.Background = new SolidColorBrush(Windows.UI.Colors.Yellow);
GcSpreadSheet1.Sheets[0].ConditionalFormats.AddTop10Rule(GrapeCity.Xaml.SpreadSheet.Data.Top10ConditionType.Top, 2, style2, new GrapeCity.Xaml.SpreadSheet.Data.CellRange[] { new GrapeCity.Xaml.SpreadSheet.Data.CellRange(0, 0, 5, 1) });

GcSpreadSheet1.Sheets(0).SetValue(0, 0, 1)
GcSpreadSheet1.Sheets(0).SetValue(1, 0, 50)
GcSpreadSheet1.Sheets(0).SetValue(2, 0, 11)
GcSpreadSheet1.Sheets(0).SetValue(3, 0, 5)
Dim style2 As New GrapeCity.Xaml.SpreadSheet.Data.StyleInfo()
style2.Background = new SolidColorBrush(Windows.UI.Colors.Yellow)
GcSpreadSheet1.Sheets(0).ConditionalFormats.AddTop10Rule(GrapeCity.Xaml.SpreadSheet.Data.Top10ConditionType.Top, 2, style2, New GrapeCity.Xaml.SpreadSheet.Data.CellRange() { New GrapeCity.Xaml.SpreadSheet.Data.CellRange(0, 0, 5, 1) })

Requirements

Target Platforms: Windows Server 2012, Windows RT

Reference

ConditionalFormat Class
ConditionalFormat Members