IsIncludeEquals Property

Gets or sets a value that indicates whether this conditional formatting rule accepts a value that equals the average.

Syntax

Visual Basic
C#

'Declaration
 
Public Property IsIncludeEquals As Boolean

'Usage
 
Dim instance As AverageConditionalFormattingRule
Dim value As Boolean
 
instance.IsIncludeEquals = value
 
value = instance.IsIncludeEquals

public bool IsIncludeEquals {get; set;}

Property Value

true if this instance equals the average; otherwise, false.

Example

This example creates a conditional rule.

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.NET

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 Server 2012 R2, Windows 2008, Windows XP (SP2), Windows Vista, Windows 7, Windows 8, Windows 8.1, Windows 10

Reference

AverageConditionalFormattingRule Class
AverageConditionalFormattingRule Members