FilterString Property (AutoFilteringColumnEventArgs)

Gets or sets the string to filter the column by.

Syntax

Visual Basic
C#

'Declaration
 
Public Property FilterString As String

'Usage
 
Dim instance As AutoFilteringColumnEventArgs
Dim value As String
 
instance.FilterString = value
 
value = instance.FilterString

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.

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 Basic

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 2000 Professional (SP4), Windows 2000 Server, Windows 2003 Server (SP1), Windows Server 2012 R2, Windows 2008, Windows XP (SP2), Windows Vista, Windows 7, Windows 8, Windows 8.1, Windows 10

Reference

AutoFilteringColumnEventArgs Class
AutoFilteringColumnEventArgs Members