Clear Method (FilterColumnDefinitionCollection)

Removes all the filter column definitions from the collection.

Syntax

Visual Basic
C#

'Declaration
 
Public Shadows Sub Clear()

'Usage
 
Dim instance As FilterColumnDefinitionCollection
 
instance.Clear()

public new void Clear()

Example

This example clears the collection.

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) { 
 fcdc.Clear(); 
}
bool b; 
foreach (FarPoint.Web.Spread.FilterColumnDefinition fc in fcdc) { 
 b = fcdc.Contains(fc); 
 if (b == true) { 
   string msg = "Column " + fc.ColumnIndex.ToString() + " has a filter on it."; 
   Response.Write("alert('" + msg + "')"); 
 } 
}

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
      fcdc.Clear()
Next

Dim b As Boolean
Dim fc As FarPoint.Web.Spread.FilterColumnDefinition
For Each fc In fcdc
b = fcdc.Contains(fc)
If b = True Then
Dim msg As String = "Column " & fc.ColumnIndex.ToString() & " has a filter on it."
Response.Write("alert('" & msg & "')")

Requirements

Target Platforms: Windows 7, Windows 8, Windows Vista, Windows Server 2000, Windows 2000 Professional, Windows XP Professional, Windows NT 4.0 Workstation, SP6, Windows NT 4.0 Server, SP6

Reference

FilterColumnDefinitionCollection Class
FilterColumnDefinitionCollection Members