Insert Method (FilterItemCollection)

Inserts a filter item into the collection at a specified location.

Syntax

Visual Basic
C#

'Declaration
 
Public Sub Insert( _
   ByVal index As Integer, _
   ByVal filterItem As IFilterItem _
)

'Usage
 
Dim instance As FilterItemCollection
Dim index As Integer
Dim filterItem As IFilterItem
 
instance.Insert(index, filterItem)

public void Insert( 
   int index,
   IFilterItem filterItem
)

Parameters

index: Index in the collection at which to add the filter
filterItem: Custom filter item to add

Exceptions

Exception	Description
System.ArgumentOutOfRangeException	Specified index is out of range; must be between 0 and the total number of filters in the collection
System.ArgumentException	No display name or length of the display name of the specified custom filter is zero
System.ArgumentException	No specified custom filter or specified custom filter is null
System.ArgumentException	Specified custom filter display name already exists in the collection; the name must be unique

Example

This example returns the filters applied for filtering.

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; 

FarPoint.Win.Spread.DefaultFilterItem df;
df = (FarPoint.Win.Spread.DefaultFilterItem)fcd.Filters[0];
fc.Insert(0, df);

Visual Basic

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
df = fcd.Filters(0)
fc.Insert(0, df)

Reference

FilterItemCollection Class
FilterItemCollection Members