Spread Windows Forms 13.0 Product Documentation
FarPoint.Win.Spread Assembly / FarPoint.Win.Spread Namespace / FpSpread Class / AutoSortingColumn Event
Example


In This Topic
    AutoSortingColumn Event
    In This Topic
    Occurs when a column is about to be automatically sorted.
    Syntax
    'Declaration
     
    Public Event AutoSortingColumn As AutoSortingColumnEventHandler
    'Usage
     
    Dim instance As FpSpread
    Dim handler As AutoSortingColumnEventHandler
     
    AddHandler instance.AutoSortingColumn, handler
    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
    Gets or sets whether the automatic sort is ascending.  
    Gets or sets whether to cancel the default processing of automatically sorting columns.  
    Gets the index of the column to be automatically sorted.  
    Gets the sheet whose rows are to be automatically sorted.  
    Gets whether the sort indicator is displayed.  
    Gets or sets whether frozen rows sort.  
    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.
    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;
    }
    
    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
    See Also