Spread Windows Forms 6.0 Product Documentation
FilterString Property
See Also  Example Support Options
FarPoint.Win.Spread Assembly > FarPoint.Win.Spread Namespace > AutoFilteringColumnEventArgs Class : FilterString Property


Glossary Item Box

Gets or sets the string to filter the column by.

Syntax

Visual Basic (Declaration) 
Public Property FilterString As String
Visual Basic (Usage)Copy Code
Dim instance As AutoFilteringColumnEventArgs
Dim value As String
 
instance.FilterString = value
 
value = instance.FilterString
C# 
public string FilterString {get; set;}

Property Value

String containing the filter

Example

This example changes the background color of the filtered column and returns the filter string.
C#Copy Code
private void fpSpread1_AutoFilteringColumn(object sender, FarPoint.Win.Spread.AutoFilteringColumnEventArgs e) 
{ 
e.Sheet.Columns(e.Column).BackColor = Color.Yellow;
MessageBox.Show("The column was filtered by " + e.FilterString);
} 
Visual BasicCopy Code
Private Sub FpSpread1_AutoFilteringColumn(ByVal sender As Object, ByVal e As
FarPoint.Win.Spread.AutoFilteringColumnEventArgs) Handles FpSpread1.AutoFilteringColumn
e.Sheet.Columns(e.Column).BackColor = Color.Yellow
MessageBox.Show("The column was filtered by " & e.FilterString)
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.