grab

Causes an object to follow the movements of the mouse.

# Metadata

Platforms: desktop, server, mobile OS: mac, windows, linux, ios, android Introduced: 1.0 Security:

# Syntax

grab object

# Params

- object : Any control on the current card.

# Examples

grab graphic 1

grab the mouseControl

grab me

# Description

Use the grab command within a mouseDown handler to drag an object around the stack window without select it.

You can only grab a control when the mouse pointer is within the control's rectangle at the time the mouse is clicked. If the mouse pointer is outside the control when the grab command is execute, nothing happens.

Although the grab command returns to the calling handler immediately, the target control will remain grabbed until the user releases the mouse button, at which point the control will receive a mouseUp message.

If a subsequent script action deletes the control, or if the control becomes invisible, the grab will be automatically cancelled and in this case no message will be sent to the control.

# Tags

ui,

# See

- **keyword:** control - **message:** mouseDown, moveStack, mouseMove - **command:** click, drag, move - **function:** mouseLoc - **glossary:** object, handler, select, mouse pointer, command, stack window, execute