Spread Windows Forms 13.0 Product Documentation
FarPoint.Win.Spread Assembly / FarPoint.Win.Spread Namespace / AutoFilteringColumnEventArgs Class / FilterString Property
Example


In This Topic
    FilterString Property (AutoFilteringColumnEventArgs)
    In This Topic
    Gets or sets the string to filter the column by.
    Syntax
    '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);
    } 
    
    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 
    See Also