Back to Devexpress

TreeViewControl.DragRecordOver Event

wpf-devexpress-dot-xpf-dot-grid-dot-treeviewcontrol-90b8158d.md

latest7.5 KB
Original Source

TreeViewControl.DragRecordOver Event

Occurs continuously while a drag-and-drop operation is in progress.

Namespace : DevExpress.Xpf.Grid

Assembly : DevExpress.Xpf.Grid.v25.2.dll

NuGet Package : DevExpress.Wpf.Grid.Core

Declaration

csharp
public event EventHandler<DragRecordOverEventArgs> DragRecordOver
vb
Public Event DragRecordOver As EventHandler(Of DragRecordOverEventArgs)

Event Data

The DragRecordOver event's data class is DragRecordOverEventArgs. The following properties provide information specific to this event:

PropertyDescription
AllowedEffectsGets a member of the DragDropEffects enumeration that specifies which operations are allowed by the originator of the drag event. Inherited from DragEventArgsBase.
DataGets or sets a data object that contains the data associated with the corresponding drag event. Inherited from DragEventArgsBase.
DropPositionGets a drop position that specifies how a record is placed after it has been dropped. Inherited from DragEventArgsBase.
DropPositionRelativeCoefficientGets a number between 0 and 1, presenting a drop position relative to the target record.
EffectsGets or sets the target drag-and-drop operation. Inherited from DragEventArgsBase.
HandledGets or sets a value that indicates the present state of the event handling for a routed event as it travels the route. Inherited from RoutedEventArgs.
IsFromOutsideGets whether the dragged record is from another control. Inherited from DragEventArgsBase.
KeyStatesGets a flag enumeration indicating the current state of the SHIFT, CTRL, and ALT keys, as well as the state of the mouse buttons. Inherited from DragEventArgsBase.
OriginalSourceGets the original reporting source as determined by pure hit testing, before any possible Source adjustment by a parent class. Inherited from RoutedEventArgs.
RoutedEventGets or sets the RoutedEvent associated with this RoutedEventArgs instance. Inherited from RoutedEventArgs.
SourceGets or sets a reference to the object that raised the event. Inherited from RoutedEventArgs.
TargetRecordGets a record that is drop target. Inherited from DragEventArgsBase.
TargetRowHandleGets the target row handle. Inherited from DragEventArgsBase.

The event data class exposes the following methods:

MethodDescription
GetRecordType()Gets the Type of the transferred records. Inherited from DragEventArgsBase.
InvokeEventHandler(Delegate, Object)When overridden in a derived class, provides a way to invoke event handlers in a type-specific way, which can increase efficiency over the base implementation. Inherited from RoutedEventArgs.
OnSetSource(Object)When overridden in a derived class, provides a notification callback entry point whenever the value of the Source property of an instance changes. Inherited from RoutedEventArgs.

Remarks

The following code sample does not allow users to drop records to the root level.

xaml
<dxg:TreeViewControl x:Name="treeview"
                     AllowDragDrop="True"
                     DragRecordOver="treeview_DragRecordOver"/>
csharp
void treeview_DragRecordOver(object sender, DevExpress.Xpf.Core.DragRecordOverEventArgs e) {
    TreeListNode node = treeview.GetNodeByRowHandle(e.TargetRowHandle);
    if (node != null && node.Level == 0) {
        e.Effects = DragDropEffects.None;
        e.Handled = true;
    }
}
vb
Private Sub treeview_DragRecordOver(ByVal sender As Object, ByVal e As DevExpress.Xpf.Core.DragRecordOverEventArgs)
    Dim node As TreeListNode = treeview.GetNodeByRowHandle(e.TargetRowHandle)

    If node IsNot Nothing AndAlso node.Level = 0 Then
        e.Effects = DragDropEffects.None
        e.Handled = True
    End If
End Sub

For information about drag-and-drop operations, refer to the following DevExpress WPF Grid help topic: Drag-and-Drop.

See Also

TreeViewControl Class

TreeViewControl Members

DevExpress.Xpf.Grid Namespace