Sign in Join
FPDoc Onlineexperiment

TDragImageListResolution.BeginDrag function

Member of TDragImageListResolutionpublicIn unit Controls

Starts display of images in the resolution for a Drag and Drop operation.

Declaration

pascal
function BeginDrag(Window: HWND; X: Integer; Y: Integer): Boolean

Description

BeginDrag is a Boolean function used to start display of images in the resolution for a Drag and Drop operation. The return value is True if the widgetset successfully received the BeginDrag notification.

No actions are performed in the method if the widgetset class does note successfully start the drag operation.

BeginDrag calls the DragLock method to lock the window handle for the control, and to start displaying the drag image for the operation. The current screen cursor is captured, and the DragCursor in ImageList is displayed for the operation.

See also

An experiment, built from Lazarus main 2dfa93c66e of 10-22-2026. Not the official Lazarus documentation.