Add Method (FilterColumnDefinitionCollection)

In This Topic

Adds a filter column definition to the collection.

Syntax

Visual Basic
C#

'Declaration
 
Public Function Add( _
   ByVal fcd As FilterColumnDefinition _
) As Integer

'Usage
 
Dim instance As FilterColumnDefinitionCollection
Dim fcd As FilterColumnDefinition
Dim value As Integer
 
value = instance.Add(fcd)

public int Add( 
   FilterColumnDefinition fcd
)

Parameters

fcd: Filter column definition to add to the collection

Return Value

Integer item number in the collection

Example

This example adds the filter definitions to the collection.

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;

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.Insert(0, fcd)
fcdc.Insert(1, fcd1)
fcdc.Insert(2, 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

Reference

FilterColumnDefinitionCollection Class
FilterColumnDefinitionCollection Members

Product Support Forum | Print this page