Add Method (ConditionalFormatting)

Adds an item to the ICollection.

Syntax

Visual Basic
C#

'Declaration
 
Public Sub Add( _
   ByVal item As IConditionalFormattingRule _
)

'Usage
 
Dim instance As ConditionalFormatting
Dim item As IConditionalFormattingRule
 
instance.Add(item)

public void Add( 
   IConditionalFormattingRule item
)

Parameters

item: The object to add to the ICollection.

Exceptions

Exception	Description
System.NotSupportedException	The ICollection is read-only.

Example

This example uses the Add method.

protected void Page_Load(object sender, System.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;              
                       }

protected void Button1_Click(object sender, EventArgs e)
        {
            FarPoint.Web.Spread.UnaryComparisonConditionalFormattingRule unary = new FarPoint.Web.Spread.UnaryComparisonConditionalFormattingRule(FarPoint.Web.Spread.UnaryComparisonOperator.EqualTo,10);
            unary.Operator = FarPoint.Web.Spread.UnaryComparisonOperator.EqualTo;
            unary.Value = 10;
            unary.BackColor = Color.Red;
            unary.FontStyle = new FarPoint.Web.Spread.SpreadFontStyle(FarPoint.Web.Spread.UnderlineFontStyle.None);
            unary.FontStyle.RegularBoldItalic = FarPoint.Web.Spread.RegularBoldItalicFontStyle.Bold;

            FarPoint.Web.Spread.TopRankedValuesConditionalFormattingRule topRank = new FarPoint.Web.Spread.TopRankedValuesConditionalFormattingRule();
            topRank.IsDescending = true;
            topRank.BackColor = Color.Tomato;
            topRank.ForeColor = Color.Yellow;

            //CondtionalFormatting Construtor
            FarPoint.Web.Spread.ConditionalFormatting cf = new FarPoint.Web.Spread.ConditionalFormatting(new FarPoint.Web.Spread.Model.CellRange(0, 0, 2, 2));
            FarPoint.Web.Spread.ConditionalFormatting cf1 = new FarPoint.Web.Spread.ConditionalFormatting(new FarPoint.Web.Spread.Model.CellRange(0, 0, 2, 2), topRank, unary);
            FpSpread1.ActiveSheetView.ConditionalFormatting.Add(cf);
            FpSpread1.ActiveSheetView.ConditionalFormatting.Add(cf1);
            //OR
            //SetConditionalFormatting Overload
            //FpSpread1.ActiveSheetView.SetConditionalFormatting(cf, cf1);
        }

VB.NET

Private Sub Page_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

Protected Sub Button1_Click(sender As Object, e As EventArgs) Handles Button1.Click
            Dim unary As New FarPoint.Web.Spread.UnaryComparisonConditionalFormattingRule(FarPoint.Web.Spread.UnaryComparisonOperator.EqualTo, 10)
            unary.Operator = FarPoint.Web.Spread.UnaryComparisonOperator.EqualTo
            unary.Value = 10
            unary.BackColor = Drawing.Color.Red
            unary.FontStyle = New FarPoint.Web.Spread.SpreadFontStyle(FarPoint.Web.Spread.UnderlineFontStyle.None)
            unary.FontStyle.RegularBoldItalic = FarPoint.Web.Spread.RegularBoldItalicFontStyle.Bold

            Dim topRank As New FarPoint.Web.Spread.TopRankedValuesConditionalFormattingRule()
            topRank.IsDescending = True
            topRank.BackColor = Drawing.Color.Tomato
            topRank.ForeColor = Drawing.Color.Yellow

            'CondtionalFormatting Construtor
            Dim cf As New FarPoint.Web.Spread.ConditionalFormatting(New FarPoint.Web.Spread.Model.CellRange(0, 0, 2, 2))
            Dim cf1 As New FarPoint.Web.Spread.ConditionalFormatting(New FarPoint.Web.Spread.Model.CellRange(0, 0, 2, 2), topRank, unary)
            FpSpread1.ActiveSheetView.ConditionalFormatting.Add(cf)
            FpSpread1.ActiveSheetView.ConditionalFormatting.Add(cf1)
            'OR
            'SetConditionalFormatting Overload
            'FpSpread1.ActiveSheetView.SetConditionalFormatting(cf, cf1)
        End Sub

Requirements

Target Platforms: Windows 7, Windows 8, Windows Vista, Windows Server 2000, Windows 2000 Professional, Windows XP Professional, Windows NT 4.0 Workstation, SP6, Windows NT 4.0 Server, SP6

Reference

ConditionalFormatting Class
ConditionalFormatting Members