AutoFilteredColumn Event

Occurs when a column has just been automatically filtered.

Syntax

Visual Basic
C#

'Declaration
 
Public Event AutoFilteredColumn As AutoFilteredColumnEventHandler

'Usage
 
Dim instance As FpSpread
Dim handler As AutoFilteredColumnEventHandler
 
AddHandler instance.AutoFilteredColumn, handler

public event AutoFilteredColumnEventHandler AutoFilteredColumn

Event Data

The event handler receives an argument of type AutoFilteredColumnEventArgs containing data related to this event. The following AutoFilteredColumnEventArgs properties provide information specific to this event.

Property	Description
Column	Gets the index of the column that was automatically filtered.
FilterString	Gets the string the column was filtered by.
Sheet	Gets the sheet whose rows were just automatically filtered.

Remarks

This event is raised by the OnAutoFilteredColumn method when a column has just been automatically filtered.

For more details on the individual event arguments, refer to AutoFilteredColumnEventArgs members.

Example

This example changes the background color of the filtered column and returns the filter string.

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 Basic

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

Reference

FpSpread Class
FpSpread Members
AutoFilteredColumnEventArgs Class

User-Task Documentation

Managing Filtering of Rows