Adds a filter item to the collection.

Syntax

Visual Basic (Declaration)
Public Function Add( _ ByVal filterItem As IFilterItem _ ) As Integer

Visual Basic (Usage)	Copy Code
Dim instance As FilterItemCollection Dim filterItem As IFilterItem Dim value As Integer value = instance.Add(filterItem)

C#
public int Add( IFilterItem filterItem )

Parameters

filterItem: Custom filter item to add

Return Value

Integer item number of the custom filter in the collection

Exceptions

Exception	Description
System.ArgumentException	No display name or length of the display name of the specified filter is zero
System.ArgumentException	No specified custom filter or specified custom filter is null

Example

This example returns the filters applied for filtering.

C#	Copy Code
FarPoint.Win.Spread.NamedStyle instyle = new FarPoint.Win.Spread.NamedStyle(); FarPoint.Win.Spread.NamedStyleim outstyle = new FarPoint.Win.Spread.NamedStyle(); instyle.BackColor = Color.Yellow; outstyle.BackColor = Color.Aquamarine; FarPoint.Win.Spread.FilterColumnDefinition fcd = new FarPoint.Win.Spread.FilterColumnDefinition(1, FarPoint.Win.Spread.FilterListBehavior.SortByMostOccurrences \| FarPoint.Win.Spread.FilterListBehavior.Default); FarPoint.Win.Spread.FilterColumnDefinition fcd1 = new FarPoint.Win.Spread.FilterColumnDefinition(2); FarPoint.Win.Spread.FilterColumnDefinition fcd2 = new FarPoint.Win.Spread.FilterColumnDefinition(); FarPoint.Win.Spread.StyleRowFilter sf = new FarPoint.Win.Spread.StyleRowFilter(fpSpread1.ActiveSheet, instyle, outstyle); sf.AddColumn(fcd); sf.AddColumn(fcd1); sf.AddColumn(fcd2); fpSpread1.ActiveSheet.RowFilter = sf; FarPoint.Win.Spread.FilterItemCollection fc; fc = fcd.Filters; foreach(FarPoint.Win.Spread.DefaultFilterItem df in fc) { fc.Add(df); }

Copy Code

FarPoint.Win.Spread.NamedStyle instyle = new FarPoint.Win.Spread.NamedStyle(); 
FarPoint.Win.Spread.NamedStyleim outstyle = new FarPoint.Win.Spread.NamedStyle(); 
instyle.BackColor = Color.Yellow; 
outstyle.BackColor = Color.Aquamarine; 
FarPoint.Win.Spread.FilterColumnDefinition fcd = new FarPoint.Win.Spread.FilterColumnDefinition(1, FarPoint.Win.Spread.FilterListBehavior.SortByMostOccurrences
| FarPoint.Win.Spread.FilterListBehavior.Default); 
FarPoint.Win.Spread.FilterColumnDefinition fcd1 = new FarPoint.Win.Spread.FilterColumnDefinition(2); 
FarPoint.Win.Spread.FilterColumnDefinition fcd2 = new FarPoint.Win.Spread.FilterColumnDefinition(); 
FarPoint.Win.Spread.StyleRowFilter sf = new FarPoint.Win.Spread.StyleRowFilter(fpSpread1.ActiveSheet, instyle, outstyle);

sf.AddColumn(fcd); 
sf.AddColumn(fcd1); 
sf.AddColumn(fcd2);  
fpSpread1.ActiveSheet.RowFilter = sf; 
FarPoint.Win.Spread.FilterItemCollection fc; 
fc = fcd.Filters; 

foreach(FarPoint.Win.Spread.DefaultFilterItem df in fc)
{
     fc.Add(df);
}

Visual Basic	Copy Code
Dim instyle As New FarPoint.Win.Spread.NamedStyle Dim outstyle As New FarPoint.Win.Spread.NamedStyle instyle.BackColor = Color.Yellow outstyle.BackColor = Color.Aquamarine Dim fcd As New FarPoint.Win.Spread.FilterColumnDefinition(1, FarPoint.Win.Spread.FilterListBehavior.SortByMostOccurrences Or FarPoint.Win.Spread.FilterListBehavior.Default) Dim fcd1 As New FarPoint.Win.Spread.FilterColumnDefinition(2) Dim fcd2 As New FarPoint.Win.Spread.FilterColumnDefinition Dim sf As New FarPoint.Win.Spread.StyleRowFilter(FpSpread1.ActiveSheet, instyle, outstyle) sf.AddColumn(fcd) sf.AddColumn(fcd1) sf.AddColumn(fcd2) FpSpread1.ActiveSheet.RowFilter = sf Dim fc As FarPoint.Win.Spread.FilterItemCollection fc = fcd.Filters Dim df As FarPoint.Win.Spread.DefaultFilterItem For Each df In fc fc.Add(df) Next

Visual Basic

Copy Code

Dim instyle As New FarPoint.Win.Spread.NamedStyle
Dim outstyle As New FarPoint.Win.Spread.NamedStyle
instyle.BackColor = Color.Yellow
outstyle.BackColor = Color.Aquamarine
Dim fcd As New FarPoint.Win.Spread.FilterColumnDefinition(1, FarPoint.Win.Spread.FilterListBehavior.SortByMostOccurrences
Or FarPoint.Win.Spread.FilterListBehavior.Default)
Dim fcd1 As New FarPoint.Win.Spread.FilterColumnDefinition(2)
Dim fcd2 As New FarPoint.Win.Spread.FilterColumnDefinition

Dim sf As New FarPoint.Win.Spread.StyleRowFilter(FpSpread1.ActiveSheet, instyle, outstyle)
sf.AddColumn(fcd)
sf.AddColumn(fcd1)
sf.AddColumn(fcd2)
FpSpread1.ActiveSheet.RowFilter = sf

Dim fc As FarPoint.Win.Spread.FilterItemCollection
fc = fcd.Filters
Dim df As FarPoint.Win.Spread.DefaultFilterItem
For Each df In fc
      fc.Add(df)
Next

Requirements

Target Platforms: Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2