CopyTo Method (FilterColumnDefinitionCollection)

Copies the filter column definition in the collection to an array.

Syntax

Visual Basic
C#

'Declaration
 
Public Sub CopyTo( _
   ByVal array As Array, _
   ByVal arrayIndex As Integer _
)

'Usage
 
Dim instance As FilterColumnDefinitionCollection
Dim array As Array
Dim arrayIndex As Integer
 
instance.CopyTo(array, arrayIndex)

public void CopyTo( 
   Array array,
   int arrayIndex
)

Parameters

array: Array to which to copy the filter column definitions
arrayIndex: Array index at which to start pasting the filter column definitions

Example

This example copies a filter collection to an array. (Bound to Northwind.mdb, Employee table)

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;

bool b;
foreach(FarPoint.Win.Spread.FilterColumnDefinition fc in fcdc)
{
b = fcdc.Contains(fc);
if (b == true)
{
MessageBox.Show("Column " + fc.ColumnIndex.ToString() + " has a filter on it.");
}
}

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 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

Dim myarray(3)
fcdc.CopyTo(myarray, 0)
MessageBox.Show(myarray.GetValue(0).ToString())

Reference

FilterColumnDefinitionCollection Class
FilterColumnDefinitionCollection Members