Spread Windows Forms 7.0 Product Documentation
AverageConditionalFormattingRule Constructor(Boolean,Boolean)
See Also  Example Support Options
FarPoint.Win.Spread Assembly > FarPoint.Win.Spread Namespace > AverageConditionalFormattingRule Class > AverageConditionalFormattingRule Constructor : AverageConditionalFormattingRule Constructor(Boolean,Boolean)


isAbove
if set to true, the conditional formatting rule accepts values that are above average.
isIncludedEquals
if set to true, the conditional formatting rule accepts values that equal the average.

Glossary Item Box

Initializes a new instance of the AverageConditionalFormattingRule class.

Syntax

Visual Basic (Declaration) 
Public Function New( _
   ByVal isAbove As Boolean, _
   ByVal isIncludedEquals As Boolean _
)
Visual Basic (Usage)Copy Code
Dim isAbove As Boolean
Dim isIncludedEquals As Boolean
 
Dim instance As New AverageConditionalFormattingRule(isAbove, isIncludedEquals)
C# 
public AverageConditionalFormattingRule( 
   bool isAbove,
   bool isIncludedEquals
)

Parameters

isAbove
if set to true, the conditional formatting rule accepts values that are above average.
isIncludedEquals
if set to true, the conditional formatting rule accepts values that equal the average.

Example

This example creates a conditional rule.
C#Copy Code
private void Form1_Load(object sender, EventArgs e)
        {
            fpSpread1.Sheets[0].Cells[0, 0].Value = 3;
            fpSpread1.Sheets[0].Cells[1, 0].Value = 2;
            fpSpread1.Sheets[0].Cells[1, 1].Value = 10;
            fpSpread1.Sheets[0].Cells[0, 2].Value = 1;            
        }

        private void button1_Click(object sender, EventArgs e)
        {
            //Average CF
            FarPoint.Win.Spread.AverageConditionalFormattingRule average = new FarPoint.Win.Spread.AverageConditionalFormattingRule(true, true);
            average.IsAbove = true;
            average.IsIncludeEquals = true;
            average.StandardDeviation = 2;
            average.FontStyle = new FarPoint.Win.Spread.SpreadFontStyle(RegularBoldItalicFontStyle.Bold);
            fpSpread1.ActiveSheet.SetConditionalFormatting(1, 1, average);
        }
VB.NETCopy Code
Private Sub Form1_Load(ByVal sender As System.Object, ByVal e As System.EventArgs) Handles MyBase.Load
        FpSpread1.Sheets(0).Cells(0, 0).Value = 3
        FpSpread1.Sheets(0).Cells(1, 0).Value = 2
        FpSpread1.Sheets(0).Cells(1, 1).Value = 10
        FpSpread1.Sheets(0).Cells(0, 2).Value = 1
    End Sub

    Private Sub Button1_Click(ByVal sender As System.Object, ByVal e As System.EventArgs) Handles Button1.Click
        'Average CF
        Dim average As New FarPoint.Win.Spread.AverageConditionalFormattingRule(True, True)
        average.IsAbove = True
        average.IsIncludeEquals = True
        average.StandardDeviation = 2
        average.FontStyle = New FarPoint.Win.Spread.SpreadFontStyle(RegularBoldItalicFontStyle.Bold)
        FpSpread1.ActiveSheet.SetConditionalFormatting(1, 1, average)
    End Sub

Requirements

Target Platforms: Windows 2000 Professional (SP4), Windows 2000 Server, Windows 2003 Server (SP1), Windows 2008, Windows XP (SP2), Windows Vista, Windows 7, Windows 8

See Also

© 2002-2014 ComponentOne, a division of GrapeCity. All Rights Reserved.