Class GridSortColumnsChangingEventArgs
Provides data for SortColumnsChanging event.
Inherited Members
Namespace: Syncfusion.UI.Xaml.Grids
Assembly: Syncfusion.Grid.WinUI.dll
Syntax
public sealed class GridSortColumnsChangingEventArgs : GridCancelEventArgs
Constructors
GridSortColumnsChangingEventArgs(IList<SortColumnDescription>, IList<SortColumnDescription>, NotifyCollectionChangedAction, Object)
Initializes a new instance of GridSortColumnsChangingEventArgs class.
Declaration
public GridSortColumnsChangingEventArgs(IList<SortColumnDescription> addedItems, IList<SortColumnDescription> removedItems, NotifyCollectionChangedAction action, object originalSource)
Parameters
Type | Name | Description |
---|---|---|
System.Collections.Generic.IList<SortColumnDescription> | addedItems | The list of SortColumnDescription that are being sorted in view. |
System.Collections.Generic.IList<SortColumnDescription> | removedItems | The list of SortColumnDescription that are being unsorted in view. |
System.Collections.Specialized.NotifyCollectionChangedAction | action | Indicates the corresponding collection changed actions during sorting operation. |
System.Object | originalSource | The source of the event. |
Properties
Action
Gets the corresponding collection changed actions performed during sorting operation.
Declaration
public NotifyCollectionChangedAction Action { get; }
Property Value
Type | Description |
---|---|
System.Collections.Specialized.NotifyCollectionChangedAction | One of the System.Collections.Specialized.NotifyCollectionChangedAction performed during sorting operation. |
AddedItems
Gets the list of SortColumnDescription that are being sorted in view.
Declaration
public IList<SortColumnDescription> AddedItems { get; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.IList<SortColumnDescription> | The list of SortColumnDescription collection that were sorted in view. |
CancelScroll
Gets or sets a value indicating whether the SfDataGrid should scroll to CurrentItem after sorting.
Declaration
public bool CancelScroll { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean | true if the scrolling is cancelled while sorting; otherwise, false. |
RemovedItems
Gets the list of SortColumnDescription that are being unsorted in view.
Declaration
public IList<SortColumnDescription> RemovedItems { get; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.IList<SortColumnDescription> | The list of SortColumnDescription collection that were unsorted in view. |