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


Glossary Item Box

Occurs when a column has just been automatically filtered.

Syntax

Visual Basic (Declaration) 
Public Event AutoFilteredColumn As AutoFilteredColumnEventHandler
Visual Basic (Usage)Copy Code
Dim instance As FpSpread
Dim handler As AutoFilteredColumnEventHandler
 
AddHandler instance.AutoFilteredColumn, handler
C# 
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.

PropertyDescription
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.
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 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

See Also

© 2002-2012 ComponentOne, a division of GrapeCity. All Rights Reserved.