Spread Windows Forms 7.0 Product Documentation
AutoFilteringColumn Event
See Also  Example Support Options
FarPoint.Win.Spread Assembly > FarPoint.Win.Spread Namespace > FpSpread Class : AutoFilteringColumn Event

Glossary Item Box

Occurs when a column is about to be automatically filtered.


Visual Basic (Declaration) 
Public Event AutoFilteringColumn As AutoFilteringColumnEventHandler
Visual Basic (Usage)Copy Code
Dim instance As FpSpread
Dim handler As AutoFilteringColumnEventHandler
AddHandler instance.AutoFilteringColumn, handler
public event AutoFilteringColumnEventHandler AutoFilteringColumn

Event Data

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

Cancel Gets or sets whether to cancel the default processing of automatically filtering columns.
Column Gets the index of the column to be automatically filtered.
FilterString Gets or sets the string to filter the column by.
Sheet Gets the sheet whose rows are to be automatically filtered.


This event is raised by the OnAutoFilteringColumn method when a column is about to be automatically filtered.

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


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


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.