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


Glossary Item Box

Removes all the filter column definitions from the collection.

Syntax

Visual Basic (Declaration) 
Public Shadows Sub Clear() 
Visual Basic (Usage)Copy Code
Dim instance As FilterColumnDefinitionCollection
 
instance.Clear()
C# 
public new void Clear()

Example

This example clears the filter collection.
C#Copy Code
FarPoint.Win.Spread.FilterColumnDefinitionCollection fcdc = new FarPoint.Win.Spread.FilterColumnDefinitionCollection();

FarPoint.Win.Spread.FilterColumnDefinition fcd = new FarPoint.Win.Spread.FilterColumnDefinition(0, FarPoint.Win.Spread.FilterListBehavior.SortByMostOccurrences | FarPoint.Win.Spread.FilterListBehavior.Default);
FarPoint.Win.Spread.FilterColumnDefinition fcd1 = new FarPoint.Win.Spread.FilterColumnDefinition(1, FarPoint.Win.Spread.FilterListBehavior.Default);
FarPoint.Win.Spread.FilterColumnDefinition fcd2 = new FarPoint.Win.Spread.FilterColumnDefinition(2);

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

private void button1Click(object sender, System.EventArgs e)
{
      fcdc.Clear();
}
Visual BasicCopy Code
Dim fcdc As New FarPoint.Win.Spread.FilterColumnDefinitionCollection

Dim fcd As New FarPoint.Win.Spread.FilterColumnDefinition(0, FarPoint.Win.Spread.FilterListBehavior.SortByMostOccurrences Or FarPoint.Win.Spread.FilterListBehavior.Default)
Dim fcd1 As New FarPoint.Win.Spread.FilterColumnDefinition(1, FarPoint.Win.Spread.FilterListBehavior.Default)
Dim fcd2 As New FarPoint.Win.Spread.FilterColumnDefinition(2)

Dim instyle As New FarPoint.Win.Spread.NamedStyle
Dim outstyle As New FarPoint.Win.Spread.NamedStyle
instyle.BackColor = Color.Yellow
outstyle.BackColor = Color.Aquamarine

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

Private Sub Button1Click(ByVal sender As System.Object, ByVal e As System.EventArgs) Handles Button1.Click
      fcdc.Clear()
End Sub

Requirements

Target Platforms: Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

See Also

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