RemoveAt Method (FilterColumnDefinitionCollection)

Removes a filter column definition from the collection at the specified index.

Syntax

Visual Basic
C#

'Declaration
 
Public Shadows Sub RemoveAt( _
   ByVal index As Integer _
)

'Usage
 
Dim instance As FilterColumnDefinitionCollection
Dim index As Integer
 
instance.RemoveAt(index)

public new void RemoveAt( 
   int index
)

Parameters

index: Zero-based index of the filter column definition to remove from the collection

Exceptions

Exception	Description
System.IndexOutOfRangeException	Filter column definition index out of range; must be between 0 and the total number of filter column definitions in the collection

Example

This example removes the filter at the specified index from the collection.

FarPoint.Win.Spread.FilterColumnDefinitionCollection fcdc = new FarPoint.Win.Spread.FilterColumnDefinitionCollection();

FarPoint.Win.Spread.FilterColumnDefinition fcd = new FarPoint.Win.Spread.FilterColumnDefinition(0, FarPoint.Win.Spread.FilterListBehavior.SortByMostOccurrences | FarPoint.Win.Spread.FilterListBehavior.Default);
FarPoint.Win.Spread.FilterColumnDefinition fcd1 = new FarPoint.Win.Spread.FilterColumnDefinition(1, FarPoint.Win.Spread.FilterListBehavior.Default);
FarPoint.Win.Spread.FilterColumnDefinition fcd2 = new FarPoint.Win.Spread.FilterColumnDefinition(2);

FarPoint.Win.Spread.NamedStyle instyle = new FarPoint.Win.Spread.NamedStyle();
FarPoint.Win.Spread.NamedStyle outstyle = new FarPoint.Win.Spread.NamedStyle();
instyle.BackColor = Color.Yellow;
outstyle.BackColor = Color.Aquamarine;
fcdc.Add(fcd);
fcdc.Add(fcd1);
fcdc.Add(fcd2);
FarPoint.Win.Spread.StyleRowFilter sf = new FarPoint.Win.Spread.StyleRowFilter(fpSpread1.ActiveSheet, instyle, outstyle);
foreach (FarPoint.Win.Spread.FilterColumnDefinition x in fcdc) 
{
      sf.AddColumn(x);
}
fpSpread1.ActiveSheet.RowFilter = sf;

private void button1Click(object sender, System.EventArgs e)
{
      fcdc.RemoveAt(0);
}

Visual Basic

Dim fcdc As New FarPoint.Win.Spread.FilterColumnDefinitionCollection

Dim fcd As New FarPoint.Win.Spread.FilterColumnDefinition(0, FarPoint.Win.Spread.FilterListBehavior.SortByMostOccurrences Or FarPoint.Win.Spread.FilterListBehavior.Default)
Dim fcd1 As New FarPoint.Win.Spread.FilterColumnDefinition(1, FarPoint.Win.Spread.FilterListBehavior.Default)
Dim fcd2 As New FarPoint.Win.Spread.FilterColumnDefinition(2)

Dim instyle As New FarPoint.Win.Spread.NamedStyle
Dim outstyle As New FarPoint.Win.Spread.NamedStyle
instyle.BackColor = Color.Yellow
outstyle.BackColor = Color.Aquamarine

fcdc.Add(fcd)
fcdc.Add(fcd1)
fcdc.Add(fcd2)

Dim sf As New FarPoint.Win.Spread.StyleRowFilter(FpSpread1.ActiveSheet, instyle, outstyle)
Dim x As FarPoint.Win.Spread.FilterColumnDefinition
For Each x In fcdc
      sf.AddColumn(x)
Next
FpSpread1.ActiveSheet.RowFilter = sf

Private Sub Button1Click(ByVal sender As System.Object, ByVal e As System.EventArgs) Handles Button1.Click
      fcdc.RemoveAt(0)
End Sub

Reference

FilterColumnDefinitionCollection Class
FilterColumnDefinitionCollection Members