New to Telerik UI for WPFStart a free 30-day trial

Represents the drag behavior for the internal window functionality. This behavior allows the window to be draggable by the user, enhancing the UI interaction.

Definition

Namespace:Telerik.Windows.Controls.InternalWindow

Assembly:Telerik.Windows.Controls.Navigation.dll

Syntax:

C#
public class DragBehavior

Inheritance: objectDragBehavior

Properties

Gets a value indicating whether the window is currently being dragged.

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

true if the window is being dragged; otherwise, false.

Methods

Initializes the drag operation for the specified UI element, allowing it to be moved within a defined area.

C#
public static DragBehavior BeginDrag(UIElement element, IDragAware aware, Point globalMousePosition, Rect initialRect, Action<Rect> positionUpdatedCallback, bool forceCapture)
Parameters:elementUIElement

The UI element that will be dragged.

awareIDragAware

An object that implements IDragAware, providing necessary context for the drag operation.

globalMousePositionPoint

The initial point where the drag operation begins.

initialRectRect

The rectangle that defines the allowed area for the dragging operation.

positionUpdatedCallbackAction<Rect>

An action to be executed once the drag operation is complete, taking the final rectangle position as a parameter.

forceCapturebool

A boolean indicating whether the dragging operation is modal.

Returns:

DragBehavior

A boolean value indicating whether the drag operation was successfully initiated.

Initiates the drag operation for the specified window.

C#
public static DragBehavior BeginDrag(WindowBase window, Point globalMousePosition, bool forceCapture)
Parameters:windowWindowBase

The window that is being dragged.

globalMousePositionPoint

The point where the drag operation starts, relative to the screen.

forceCapturebool

Indicates whether the drag operation is for a modal window.

Returns:

DragBehavior

Returns a boolean value indicating whether the drag operation was successfully initiated.

Finalizes the drag operation by releasing the dragged element and updating the necessary state.

C#
public void FinishDrag(Point globalMousePosition, bool isCancel)
Parameters:globalMousePositionPoint

The current position of the mouse, represented as a Point.

isCancelbool

A boolean value indicating whether to cancel the drag operation.