Spread Windows Forms 7.0 Product Documentation
Contains Method
See Also  Example Support Options
FarPoint.Win.Spread Assembly > FarPoint.Win.Spread Namespace > FilterColumnDefinitionCollection Class : Contains Method


fcd
Filter column definition for which to check the collection

Glossary Item Box

Specifies whether the collection contains the specified filter column definition.

Syntax

Visual Basic (Declaration) 
Public Overridable Function Contains( _
   ByVal fcd As FilterColumnDefinition _
) As Boolean
Visual Basic (Usage)Copy Code
Dim instance As FilterColumnDefinitionCollection
Dim fcd As FilterColumnDefinition
Dim value As Boolean
 
value = instance.Contains(fcd)
C# 
public virtual bool Contains( 
   FilterColumnDefinition fcd
)

Parameters

fcd
Filter column definition for which to check the collection

Return Value

Boolean: true if the collection contains the filter column definition; false otherwise

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;

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

Dim b As Boolean
Dim fc As FarPoint.Win.Spread.FilterColumnDefinition
For Each fc In fcdc
b = fcdc.Contains(fc)
If b = True Then
MessageBox.Show("Column " & fc.ColumnIndex.ToString() & " has a filter on it.")
End If
Next

Requirements

Target Platforms: Windows 2000 Professional (SP4), Windows 2000 Server, Windows 2003 Server (SP1), Windows 2008, Windows XP (SP2), Windows Vista, Windows 7, Windows 8

See Also

© 2002-2014 ComponentOne, a division of GrapeCity. All Rights Reserved.