Drop Event

Requires: Base Development System

Class: Control Events

Type: Notify

Generated when the user lifts the mouse when hovering over a control when there is a drag and drop operation pending.

Use this event to implement custom drop behavior.

Example

Event Data Fields

NameDescription
SourceSource of the event. LabVIEW UI refers to any built-in user interface event.

0LabVIEW UI
TypeType of event that occurred, such as Mouse Down, Value Change, Timeout, and so on.
TimeValue of the millisecond timer when the event occurred.
TimeValue of the millisecond timer when the event occurred.
CoordsCoordinates of the location of the mouse click at the time the event occurs. Coordinates are relative to the drop target's owning pane origin, excluding clusters.
ButtonValue that corresponds to which mouse button the user clicked. Left mouse button is 1, right mouse button is 2. Operating systems might assign higher numbers if you have a mouse with more than two buttons. For filter events, you can modify the data returned by this event data field.
ModsCluster of Booleans that contain platform-independent modifiers. LabVIEW returns all platform-dependent modifiers in the PlatMods event data field. For key events, this event returns a Boolean indicating if the event occurred on the numeric keypad. For mouse events, this event returns a Boolean indicating if the event was a double-click. For both events, a Boolean is returned if the platform-independent menu key, such as <Ctrl> on Windows or <Command> on macOS, was pressed when the event occurred. For filter events, you can modify the data returned by this event data field.
PlatModsCluster of Booleans that contain platform-dependent modifiers. Specifies if platform-dependent keys, such as <Ctrl>, <Shift>, <Alt>, <Command>, and <Option> were held down when the event was triggered. For filter events, you can modify the data returned by this event data field. A key can be both a Mod and PlatMod. For example, <Ctrl> is the platform-independent menu key on Windows, but you also can use it in platform-dependent programming.
Available Data NamesArray of unique names of data types available during this drag and drop operation. Use this array to determine if a data type is available that the drop target can accept
Accepted?Reports to the drag source the action that the drop target would take if the drop occurred at this moment. TRUE, if the target would accept the drop, FALSE otherwise.

Example

Refer to the Drag and Drop - Initiating a Custom Drag VI in the labview\examples\Structures\Event Structure directory for an example of using the Drop event.

 Open example  Find related examples