DesktopUIControl.MouseDown

Event

DesktopUIControl.MouseDown(x as Integer, y as Integer) As Boolean

New in 2021r3

Supported for all project types and targets.

The mouse button was pressed inside the control's region at the location passed in to x, y.

Notes

The coordinates x and y are local to the control, i.e. they represent the position of the mouse click relative to the upper-left corner or the control.

Return True if you are going to handle the MouseDown. In such a case:

• The Pressed event, if any, will not execute and the state of the object will not change.
• You will receive theMouseUp event.

If you return False, the system handles the MouseDown so the MouseUp event handler do not get called.

Sample Code

The MouseDown event uses the DragItem constructor when the user drags the contents of the control. It is:

Var d As DragItem
d = New DragItem(Self, Me.Left, Me.Top, Me.Width, Me.Height)
d.Picture = Me.Image
d.Drag // Allow the drag

See Also

DragItem class; IsContextualClick method