SftTabs.OLEDragDrop Event
An object is dropped on the control.
Syntax
| | VB | Private Sub object_OLEDragDrop(Data As DataObject, TargetTab As Integer, Effect As Long, Button As Integer, Shift As Integer, x As Single, y As Single) |
object
A SftTabs object.
Data
A DataObject object containing formats that the source will provide and, in addition, possibly the data for those formats. If no data is contained in the DataObject, it is provided when the control calls the GetData method. The SetData and Clear methods cannot be used here.
TargetTab
The zero-based tab index of the tab where the mouse cursor is located. -1 if the mouse cursor is not over a tab.
Effect
A Long variable set by the target component identifying the action that has been performed (if any), thus allowing the source to take appropriate action if the component was moved (such as the source deleting the data).
| Effect | Value | Description |
|---|
| vbDropEffectNone | 0 | Drop target cannot accept the data. |
| vbDropEffectCopy | 1 | Drop results in a copy of data from the source to the target. The original data is unaltered by the drag operation. |
| vbDropEffectMove | 2 | Drop results in data being moved from the drag source to the drop source. The drag source should remove the data from itself after the move. |
Button
Describes the button(s) that are pressed. The Button argument is a bit field with bits corresponding to the left button, right button and middle button. These bits correspond to the values shown below. Only one of the bits is set, indicating the button that caused the event.
| Button | Value | Description |
|---|
| constSftControlLeftButton | 1 | The left mouse button was pressed. |
| constSftControlRightButton | 2 | The right mouse button was pressed. |
| constSftControlMiddleButton | 4 | The middle mouse button was pressed. |
Shift
Describes the state of the SHIFT, CONTROL and ALT keys. A bit is set if the key is down. The Shift argument is a bit field with bits corresponding to the SHIFT, CONTROL and ALT keys. It indicates the state of these keys. Some, all, or none of the bits can be set, indicating which of the keys are pressed.
| Shift | Value | Description |
|---|
| constSftControlShiftMask | 1 | The SHIFT key is down. |
| constSftControlCtrlMask | 2 | The CONTROL key is down. |
| constSftControlAltMask | 4 | The ALT key is down. |
x
The x coordinate of the mouse cursor. The units used depend on the container (Visual Basic) and the coordinate system used.
y
The y coordinate of the mouse cursor. The units used depend on the container (Visual Basic) and the coordinate system used.
Comments
The OLEDragDrop event occurs when an object is dropped on the control.
The OLEDragDrop event only occurs if the OLEDropMode property is set to OLEDropSftControlManual.
The Tabs.HitTest method can also be used to determine which tab is the drop target in the control.
The source control should always mask values from the Effect parameter to insure compatibility with future implementations of OLE drag & drop. Presently, only three bits in the Effect parameter are used. In future versions other bits may be used. As a precaution against future problems, drag sources and drop targets should mask these values appropriately before performing any comparisons.
For example, a source component should not compare an Effect against, for example, vbDropEffectCopy, such as:
If Effect = vbDropEffectCopy...
Instead, the source component should mask the value or values being sought, as here:
If (Effect And vbDropEffectCopy) = vbDropEffectCopy...
-or-
If (Effect And vbDropEffectCopy)...
This allows for the definition of new drop effects in future versions while preserving compatibility with existing code.
Example
See Reorder Sample
See Also SftTabs Object | Object Hierarchy
On
Off