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


Glossary Item Box

Occurs when a column is about to be automatically sorted.

Syntax

Visual Basic (Declaration) 
Public Event AutoSortingColumn As AutoSortingColumnEventHandler
Visual Basic (Usage)Copy Code
Dim instance As FpSpread
Dim handler As AutoSortingColumnEventHandler
 
AddHandler instance.AutoSortingColumn, handler
C# 
public event AutoSortingColumnEventHandler AutoSortingColumn

Event Data

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

PropertyDescription
Ascending Gets or sets whether the automatic sort is ascending.
Cancel Gets or sets whether to cancel the default processing of automatically sorting columns.
Column Gets the index of the column to be automatically sorted.
Sheet Gets the sheet whose rows are to be automatically sorted.
ShowIndicator Gets whether the sort indicator is displayed.
SortFrozenRows Gets or sets whether frozen rows sort.
SortTrailingFrozenRows Gets or sets whether trailing frozen rows sort.

Remarks

This event is raised by the OnAutoSortingColumn method when a column is about to be automatically sorted.

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

Example

This example raises the AutoSortingColumn event.
C#Copy Code
private void button1Click(object sender, System.EventArgs e)
{
     fpSpread1.ActiveSheet.AutoSortColumn(0);
}

private void fpSpread1_AutoSortingColumn(object sender, FarPoint.Win.Spread.AutoSortingColumnEventArgs e)
{
     e.Cancel = true;
}
Visual BasicCopy Code
Private Sub Button1Click(ByVal sender As System.Object, ByVal e As System.EventArgs) Handles Button1.Click
     FpSpread1.ActiveSheet.AutoSortColumn(0)
End Sub

Private Sub FpSpread1_AutoSortingColumn(ByVal sender As Object, ByVal e As FarPoint.Win.Spread.AutoSortingColumnEventArgs)
Handles FpSpread1.AutoSortingColumn
     e.Cancel = True
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

See Also

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