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


Glossary Item Box

Gets the string the column was filtered by.

Syntax

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

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_AutoFilteredColumn(object sender, FarPoint.Win.Spread.AutoFilteredColumnEventArgs e) 
{ 
e.Sheet.Columns(e.Column).BackColor = Color.Yellow;
MessageBox.Show("The column was filtered by " + e.FilterString);
} 
Visual BasicCopy Code
Private Sub FpSpread1_AutoFilteredColumn(ByVal sender As Object, ByVal e As
FarPoint.Win.Spread.AutoFilteredColumnEventArgs) Handles FpSpread1.AutoFilteredColumn
e.Sheet.Columns(e.Column).BackColor = Color.Yellow
MessageBox.Show("The column was filtered by " & e.FilterString)
End Sub 

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.