Gets or sets the filter column definition at the specified position in the collection.

Syntax

Visual Basic (Declaration)
Public Default Property Item( _ ByVal index As Integer _ ) As FilterColumnDefinition

Visual Basic (Usage)	Copy Code
Dim instance As FilterColumnDefinitionCollection Dim index As Integer Dim value As FilterColumnDefinition instance.Item(index) = value value = instance.Item(index)

C#
public FilterColumnDefinition this[ int index ]; {get; set;}

Parameters

index: Index of the filter column definition in the collection (zero based)

Property Value

FilterColumnDefinition object containing the definition

Exceptions

Exception	Description
System.Exception	Specified index is not valid; must be between 0 and total number in the collection
System.ArgumentNullException	Index not specified or specified index is null

Example

This example creates a filter collection for filtering. (Bound to Northwind.mdb, Employee table)

C#	Copy Code
FarPoint.Win.Spread.FilterColumnDefinitionCollection fcdc = new FarPoint.Win.Spread.FilterColumnDefinitionCollection(); 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; 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.FilterListBehavior.Default); FarPoint.Win.Spread.FilterColumnDefinition fcd2 = new FarPoint.Win.Spread.FilterColumnDefinition(3); 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; textBox1.Text = fcdc[0].ColumnIndex.ToString();

Copy Code

FarPoint.Win.Spread.FilterColumnDefinitionCollection fcdc = new FarPoint.Win.Spread.FilterColumnDefinitionCollection();
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;
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.FilterListBehavior.Default);
FarPoint.Win.Spread.FilterColumnDefinition fcd2 = new FarPoint.Win.Spread.FilterColumnDefinition(3);
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;

textBox1.Text = fcdc[0].ColumnIndex.ToString();

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 fcdc As New FarPoint.Win.Spread.FilterColumnDefinitionCollection 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, FarPoint.Win.Spread.FilterListBehavior.Default) Dim fcd2 As New FarPoint.Win.Spread.FilterColumnDefinition(3) 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 TextBox1.Text = fcdc.Item(0).ColumnIndex.ToString()

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 fcdc As New FarPoint.Win.Spread.FilterColumnDefinitionCollection
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, FarPoint.Win.Spread.FilterListBehavior.Default)
Dim fcd2 As New FarPoint.Win.Spread.FilterColumnDefinition(3)
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

TextBox1.Text = fcdc.Item(0).ColumnIndex.ToString()

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