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

Example

This example sets a row filter.

FarPoint.Web.Spread.FilterColumnDefinitionCollection fcdc = new FarPoint.Web.Spread.FilterColumnDefinitionCollection(); 
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.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.Add(fcd); 
fcdc.Add(fcd1); 
fcdc.Add(fcd2); 
FarPoint.Web.Spread.StyleRowFilter sf = new FarPoint.Web.Spread.StyleRowFilter(FpSpread1.Sheets[0], instyle, outstyle); 
foreach(FarPoint.Web.Spread.FilterColumnDefinition x in fcdc) 
{ 
    sf.AddColumn(x); 
} 
FpSpread1.Sheets[0].RowFilter = sf;

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.Add(fcd)
fcdc.Add(fcd1)
fcdc.Add(fcd2)
Dim sf As New FarPoint.Web.Spread.StyleRowFilter(FpSpread1.Sheets(0), instyle, outstyle)
Dim x As FarPoint.Web.Spread.FilterColumnDefinition
For Each x In fcdc
     sf.AddColumn(x)
Next
FpSpread1.Sheets(0).RowFilter = sf

Reference

FilterColumnDefinitionCollection Class
FilterColumnDefinitionCollection Members

Product Support Forum | Print this page