Share via

ListViewBase.CanReorderItems Property

  • Reference

Definition

Namespace:
Microsoft.UI.Xaml.Controls
Edit

Gets or sets a value that indicates whether items in the view can be reordered through user interaction.

public:
 property bool CanReorderItems { bool get(); void set(bool value); };
bool CanReorderItems();

void CanReorderItems(bool value);
public bool CanReorderItems { get; set; }
var boolean = listViewBase.canReorderItems;
listViewBase.canReorderItems = boolean;
Public Property CanReorderItems As Boolean
<listViewBase CanReorderItems="bool" />

Property Value

Boolean

bool

true if items in the view can be reordered through user interaction; otherwise, false. The default is false.

Examples

Here's a GridView that contains 6 rectangles that a user can reorder by drag-and-drop.

<GridView MaxHeight="310" 
          AllowDrop="True" 
          CanReorderItems="True">
    <Rectangle Height="100" Width="100" Fill="Blue"/>
    <Rectangle Height="100" Width="100" Fill="Red"/>
    <Rectangle Height="100" Width="100" Fill="Yellow"/>
    <Rectangle Height="100" Width="100" Fill="Green"/>
    <Rectangle Height="100" Width="100" Fill="Gray"/>
    <Rectangle Height="100" Width="100" Fill="LightBlue"/>
</GridView>

Remarks

To enable users to reorder items using drag-and-drop interaction, you must set both the CanReorderItems and AllowDrop properties to true.

Built in reordering is not supported when items are grouped, or when a VariableSizedWrapGrid is used as the ItemsPanel.

Setting IsSwipeEnabled to false disables some default touch interactions, so it should be set to true when these interactions are needed. For example:

  • If item selection is enabled and you set IsSwipeEnabled to false, a user can deselect items by right-clicking with the mouse, but can't deselect an item with touch by using a swipe gesture.
  • If you set CanDragItems to true and IsSwipeEnabled to false, a user can drag items with the mouse, but not with touch.
  • If you set CanReorderItems to true and IsSwipeEnabled to false, a user can reorder items with the mouse, but not with touch.

Important

In order to receive the DragItemsStarting and DragItemsCompleted events while reordering items, the CanDragItems property must be set to true.

Applies to

See also