Vcl.CategoryButtons.TCategoryButtons.DoBeginDrag

From RAD Studio API Documentation
Jump to: navigation, search

Delphi

procedure DoBeginDrag(Immediate: Boolean; Threshold: Integer); virtual;

C++

virtual void __fastcall DoBeginDrag(bool Immediate, int Threshold);

Properties

Type Visibility Source Unit Parent
procedure
function
protected
Vcl.CategoryButtons.pas
Vcl.CategoryButtons.hpp
Vcl.CategoryButtons TCategoryButtons

Description

Calls the BeginDrag method.

The DoBeginDrag method triggers the BeginDrag method that is used to start a drag operation.

The BeginDrag is called in application code only when the value of the control's DragMode is dmManual. If DragMode is dmAutomatic, BeginDrag is called automatically.

If the Immediate parameter is true, the mouse pointer changes to the value of the DragCursor property and dragging begins immediately. If Immediate is false, the mouse pointer does not change to the value of the DragCursor property and dragging does not begin until the user moves the mouse pointer the number of pixels specified by the Threshold parameter. If the caller passes a Threshold value less than 0 (such as the default value for this parameter), BeginDrag uses the DragThreshold property of the global Mouse variable.

Setting Immediate to false allows the control to accept mouse clicks without beginning a drag-and-drop or drag-and-dock operation.

See Also