.NET MAUI TreeDataGrid Columns Reordering

The .NET MAUI TreeDataGrid exposes a reordering feature allowing the user to drag and drop columns and change their order.

The following properties control the reordering feature:

• CanUserReorderColumns(bool)—Defines whether the user can reorder the DataGridColumns. The default value is true.
• ColumnReorderIndicatorTemplate(DataTemplate)—Defines the template that presents the indicator that is displayed between two columns during reordering.
• ColumnHeaderDragVisualTemplate (DataTemplate)—Specifies the template that presents the drag visual of the dragged column header.

Events

The TreeDataGrid inherits the following events related to the DataGrid reordering operation:

• ColumnReorderStarting—Raised when the user starts to drag a column to reorder it. The ColumnReorderStarting event handler receives the following parameters:

  • A sender argument, which is of type object, but can be cast to the RadDataGrid type.
  • A ColumnReorderStartingEventArgs object, which has a reference to the following properties:
    • Column (DataGridColumn)—Gets the column that will be reordered.
    • Index (int) —Gets the index of the column that will be reordered. The Index is the index of the item inside the FrozenColumns or UnfrozenColumns collection, depending on the value of Column.IsFrozen.
    • Cancel (bool)—Defines a value indicating whether the reordering operation is canceled.

• ColumnReordering—Raised continuously while the column is being dragged. The ColumnReordering event handler receives the following parameters:

  • A sender argument, which is of type object, but can be cast to the RadDataGrid type.
  • A ColumnReorderingEventArgs object, which has a reference to the following properties:
    • Column (DataGridColumn)—Gets the column that will be reordered.
    • OldIndex (int) —Gets the initial index of the column that is being reordered. The OldIndex is the old index of the item inside the FrozenColumns or UnfrozenColumns collection, depending on the value of Column.IsFrozen.
    • NewIndex (int) —Gets the new potential index of the column that is being reordered. The NewIndex is the new index of the item inside the FrozenColumns or UnfrozenColumns collection, depending on the value of NewIsFrozen.
    • NewIsFrozen (bool)—Gets the new potential Telerik.Maui.Controls.DataGrid.DataGridColumn.IsFrozen value of the column that is being reordered.
    • CanDrop (bool)—Defines a value indicating whether dropping the column at this specific location is allowed. The default value is true.

• ColumnReorderCompleting—Raised when the user drops the column. This doesn't mean the column is reordered. The ColumnReorderCompleting event handler receives the following parameters:

  • A sender argument, which is of type object, but can be cast to the RadDataGrid type.
  • A ColumnReorderCompletingEventArgs object, which has a reference to the following properties:
    • Column (DataGridColumn)—Gets the column that is being reordered.
    • OldIndex (int) —Gets the initial index of the column that is being reordered. The OldIndex is the old index of the item inside the FrozenColumns or UnfrozenColumns collection, depending on the value of Column.IsFrozen.
    • NewIndex (int) —Gets the new potential index of the column that is being reordered. The NewIndex is the new index of the item inside the FrozenColumns or UnfrozenColumns collection, depending on the value of NewIsFrozen.
    • NewIsFrozen (bool)—Gets the new potential Telerik.Maui.Controls.DataGrid.DataGridColumn.IsFrozen value of the column that is being reordered.
    • IsDropAllowed (bool)—Gets a value that indicates whether the column was dropped at a valid location. A valid location means that the column has changed its index and/or the value of its IsFrozen property and the drop at this location was not forbidden by setting the Telerik.Maui.Controls.DataGrid.ColumnReorderingEventArgs.CanDrop property of the Telerik.Maui.Controls.DataGrid.ColumnReorderingEventArgs to false. The default value is true.
    • Cancel (bool)—Defines a value indicating whether the reordering operation is canceled.

• ColumnReordered—Raised when a column has been successfully reordered. The ColumnReordered event handler receives the following parameters:

  • A sender argument which is of type object, but can be cast to the RadDataGrid type.
  • A ColumnReorderCompletingEventArgs object, which has a reference to the following properties:
    • Column (DataGridColumn)—Gets the column that has been reordered.
    • OldIndex (int) —Gets the initial index of the column that has been reordered. The OldIndex is the old index of the item inside the FrozenColumns or UnfrozenColumns collection, depending on the value of OldIsFrozen.
    • OldIsFrozen (bool)—Gets the initial Telerik.Maui.Controls.DataGrid.DataGridColumn.IsFrozen value of the column that has been reordered.
    • NewIndex (int) —Gets the new index of the column that has been reordered. The NewIndex is the new index of the item inside the FrozenColumns or UnfrozenColumns collection, depending on the value of Column.IsFrozen.

As the TreeDataGrid inherits from DataGrid, ror the runnable example representing the Drag Templates, see the SDKBrowser Demo Application and go to DataGrid > Columns.

See Also

• Picker Column
• Template Column
• Text Column