Class
DragBehavior

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:

cs-api-definition
public class DragBehavior

Inheritance: objectDragBehavior

Properties

IsDragging

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

Declaration

cs-api-definition
public bool IsDragging { get; }

Property Value

bool

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

Methods

BeginDrag(UIElement, IDragAware, Point, Rect, Action<Rect>, bool)

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

Declaration

cs-api-definition
public static DragBehavior BeginDrag(UIElement element, IDragAware aware, Point globalMousePosition, Rect initialRect, Action<Rect> positionUpdatedCallback, bool forceCapture)

Parameters

element

UIElement

The UI element that will be dragged.

aware

IDragAware

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

globalMousePosition

Point

The initial point where the drag operation begins.

initialRect

Rect

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

positionUpdatedCallback

Action<Rect>

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

forceCapture

bool

A boolean indicating whether the dragging operation is modal.

Returns

DragBehavior

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

BeginDrag(WindowBase, Point, bool)

Initiates the drag operation for the specified window.

Declaration

cs-api-definition
public static DragBehavior BeginDrag(WindowBase window, Point globalMousePosition, bool forceCapture)

Parameters

window

WindowBase

The window that is being dragged.

globalMousePosition

Point

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

forceCapture

bool

Indicates whether the drag operation is for a modal window.

Returns

DragBehavior

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

FinishDrag(Point, bool)

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

Declaration

cs-api-definition
public void FinishDrag(Point globalMousePosition, bool isCancel)

Parameters

globalMousePosition

Point

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

isCancel

bool

A boolean value indicating whether to cancel the drag operation.