Spread WPF Documentation
AddTop10Rule Method
Example 


The Top10ConditionType top 10 condition.
The number of top or bottom items to apply the style to.
The style that is applied to the cell when the condition is met.
The cell ranges where the rule is applied.
Adds the top 10 rule or bottom 10 rule to the collection based on the Top10CondtionType.
Syntax
'Declaration
 
Public Function AddTop10Rule( _
   ByVal type As Top10ConditionType, _
   ByVal rank As System.Integer, _
   ByVal style As StyleInfo, _
   ByVal ParamArray ranges() As CellRange _
) As Top10Rule
'Usage
 
Dim instance As ConditionalFormat
Dim type As Top10ConditionType
Dim rank As System.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,
   System.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 adds a top 10 rule.
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.Windows.SpreadSheet.Data.StyleInfo();
style2.Background = new SolidColorBrush(Colors.Yellow);
GcSpreadSheet1.Sheets[0].ConditionalFormats.AddTop10Rule(GrapeCity.Windows.SpreadSheet.Data.Top10ConditionType.Top, 2, style2, new GrapeCity.Windows.SpreadSheet.Data.CellRange[] { new GrapeCity.Windows.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.Windows.SpreadSheet.Data.StyleInfo()
style2.Background = new SolidColorBrush(Colors.Yellow)
GcSpreadSheet1.Sheets(0).ConditionalFormats.AddTop10Rule(GrapeCity.Windows.SpreadSheet.Data.Top10ConditionType.Top, 2, style2, New GrapeCity.Windows.SpreadSheet.Data.CellRange() { New GrapeCity.Windows.SpreadSheet.Data.CellRange(0, 0, 5, 1) })  
Requirements

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)

See Also

Reference

ConditionalFormat Class
ConditionalFormat Members

 

 


Copyright © GrapeCity, inc. All rights reserved.