New to Telerik UI for WinForms? Start a free 30-day trial

Represents event arguments when the sort order is changing.

Definition

Namespace:Telerik.WinControls.UI

Assembly:Telerik.WinControls.GridView.dll

Syntax:

C#
public class SortChangingEventArgs : CancelEventArgs

Inheritance: objectEventArgsCancelEventArgsSortChangingEventArgs

Inherited Members CancelEventArgs.CancelEventArgs.Empty

Constructors

Initializes a new instance of the SortChangingEventArgs class.

C#
public SortChangingEventArgs(SortChangeType sortChangeType, GridSortField oldSortExpression, GridSortField newSortExpression, int oldIndex, int newIndex)
Parameters:sortChangeTypeSortChangeType

Type of the sort change.

oldSortExpressionGridSortField

The old sort expression.

newSortExpressionGridSortField

The new sort expression.

oldIndexint

The old index.

newIndexint

The new index.

Initializes a new instance of the SortChangingEventArgs class.

C#
public SortChangingEventArgs(SortChangeType sortChangeType, GridSortField oldSortExpression, GridSortField newSortExpression, int index)
Parameters:sortChangeTypeSortChangeType

Type of the sort change.

oldSortExpressionGridSortField

The old sort expression.

newSortExpressionGridSortField

The new sort expression.

indexint

The index.

Initializes a new instance of the SortChangingEventArgs class.

C#
public SortChangingEventArgs(SortChangeType sortChangeType, GridSortField sortExpression, int oldIndex, int newIndex)
Parameters:sortChangeTypeSortChangeType

Type of the sort change.

sortExpressionGridSortField

The sort expression.

oldIndexint

The old index.

newIndexint

The new index.

Initializes a new instance of the SortChangingEventArgs class.

C#
public SortChangingEventArgs(SortChangeType sortChangeType, GridSortField sortExpression, int index)
Parameters:sortChangeTypeSortChangeType

Type of the sort change.

sortExpressionGridSortField

The sort expression.

indexint

The index.

Initializes a new instance of the SortChangingEventArgs class.

C#
public SortChangingEventArgs(SortChangeType sortChangeType, GridSortField sortExpression)
Parameters:sortChangeTypeSortChangeType

Type of the sort change.

sortExpressionGridSortField

The sort expression.

Initializes a new instance of the SortChangingEventArgs class.

C#
public SortChangingEventArgs(SortChangeType sortChangeType)
Parameters:sortChangeTypeSortChangeType

Type of the sort change.

Fields

Gets the sort expression's position after the change, or -1 when no new index was supplied.

C#
public readonly int NewIndex

Gets the sort expression after the change, when supplied by the constructor.

C#
public readonly GridSortField NewSortExpression

Gets the sort expression's position before the change, or -1 when no old index was supplied.

C#
public readonly int OldIndex

Gets the sort expression before the change, when supplied by the constructor.

C#
public readonly GridSortField OldSortExpression

Identifies the collection operation represented by the notification.

C#
public readonly SortChangeType SortChangeType

Properties

Gets the index.

C#
public int Index { get; }
Property Value:

The index.

Gets the is updated.

C#
public bool IsUpdated { get; }
Property Value:

The is updated.

Gets the sort expression.

C#
public GridSortField SortExpression { get; }
Property Value:

The sort expression.

Methods

Begins the item update.

C#
public virtual void BeginItemUpdate()

Begins the update.

C#
public virtual void BeginUpdate()

Ends the item update.

C#
public void EndItemUpdate()

Resumes event notification.

C#
public virtual void EndItemUpdate(bool notifyUpdates)
Parameters:notifyUpdatesbool

Ends the update.

C#
public void EndUpdate()

Resumes event notification.

C#
public virtual void EndUpdate(bool notifyUpdates)
Parameters:notifyUpdatesbool

Does not move a sort expression or update the event arguments.

C#
public void Move(int oldIndex, int newIndex)
Parameters:oldIndexint

An index that is not used by the current implementation.

newIndexint

An index that is not used by the current implementation.