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.

FarPoint.Web.Spread.NamedStyle instyle = new FarPoint.Web.Spread.NamedStyle(); 
FarPoint.Web.Spread.NamedStyle outstyle = new FarPoint.Web.Spread.NamedStyle(); 
instyle.BackColor = Color.Yellow; 
outstyle.BackColor = Color.Aquamarine; 
FarPoint.Web.Spread.FilterColumnDefinitionCollection fcdc = new FarPoint.Web.Spread.FilterColumnDefinitionCollection(); 
FarPoint.Web.Spread.FilterColumnDefinition fcd = new FarPoint.Web.Spread.FilterColumnDefinition(1, FarPoint.Web.Spread.FilterListBehavior.SortByMostOccurrences
| FarPoint.Web.Spread.FilterListBehavior.Default); 
FarPoint.Web.Spread.FilterColumnDefinition fcd1 = new FarPoint.Web.Spread.FilterColumnDefinition(2, FarPoint.Web.Spread.FilterListBehavior.Default);

FarPoint.Web.Spread.FilterColumnDefinition fcd2 = new FarPoint.Web.Spread.FilterColumnDefinition(3); 
fcdc.Insert(0, fcd); 
fcdc.Insert(1, fcd1); 
fcdc.Insert(2, fcd2); 
FarPoint.Web.Spread.StyleRowFilter sf = new FarPoint.Web.Spread.StyleRowFilter(FpSpread1.ActiveSheetView, instyle, outstyle);


foreach (FarPoint.Web.Spread.FilterColumnDefinition x in fcdc) 
{ 
 sf.AddColumn(x); 
}
Object[] myarray = new Object[3];  
fcdc.CopyTo(((Array)(myarray)), 0);

Visual Basic

Dim instyle As New FarPoint.Web.Spread.NamedStyle
Dim outstyle As New FarPoint.Web.Spread.NamedStyle
instyle.BackColor = Color.Yellow
outstyle.BackColor = Color.Aquamarine
Dim fcdc As New FarPoint.Web.Spread.FilterColumnDefinitionCollection
Dim fcd As New FarPoint.Web.Spread.FilterColumnDefinition(1, FarPoint.Web.Spread.FilterListBehavior.SortByMostOccurrences
Or FarPoint.Web.Spread.FilterListBehavior.Default)
Dim fcd1 As New FarPoint.Web.Spread.FilterColumnDefinition(2, FarPoint.Web.Spread.FilterListBehavior.Default)
Dim fcd2 As New FarPoint.Web.Spread.FilterColumnDefinition(3)
fcdc.Insert(0, fcd)
fcdc.Insert(1, fcd1)
fcdc.Insert(2, fcd2)
Dim sf As New FarPoint.Web.Spread.StyleRowFilter(FpSpread1.ActiveSheetView, instyle, outstyle)
Dim x As FarPoint.Web.Spread.FilterColumnDefinition
For Each x In fcdc
      sf.AddColumn(x)
Next

Dim myarray(3)
fcdc.CopyTo(myarray, 0)

Requirements

Target Platforms: Windows 7, Windows 8, Windows 10, Windows Vista, Windows Server 2003, Windows Server 2008, Windows Server 2012, Windows XP Professional

Reference

FilterColumnDefinitionCollection Class
FilterColumnDefinitionCollection Members