IMcGraphOverlayMoveSelectedObjects Method
|
|
The position of the selected graph object(s) is moved
by a given offset.
Namespace:
MediaCy.IQL.Display.Overlays
Assembly:
MediaCy.IQL.Display.Overlays (in MediaCy.IQL.Display.Overlays.dll) Version: 10.0.6912.0
SyntaxSub MoveSelectedObjects (
DeltaX As Single,
DeltaY As Single,
Optional Dragging As Boolean = false,
Optional FromTool As Boolean = false
)
Parameters
- DeltaX
- Type: SystemSingle
The offset by which to move the X coordinate of the position - DeltaY
- Type: SystemSingle
The offset by which to move the Y coordinate of the position - Dragging (Optional)
- Type: SystemBoolean
If given and TRUE, then the move is assumed to be one of a
series of calls during a dragging operation of the selected objects. This
affects what and how events are fired (see Notes). - FromTool (Optional)
- Type: SystemBoolean
If given and TRUE, then the move is assumed to be from a tool. In
this case, during events fired by this method, the NotifyContext
mcgoncFromTool bit will be set.
RemarksIf there are no selected graph objects with the mcgsAllowMove Style bit
set, then this method does nothing.
This method moves all selected McGraphObj instances that have the
mcgsAllowMove Style bit set. To move a specific McGraphObj instance, call
McGraphObj.GetPosition to find the current position and then call
McGraphObj.SetPosition to move it to the desired new position.
The MoveSelectedObjects method is called internally by the
McGraphToolSelect selection tool when the selected object(s) are dragged to a
new position by the user. The events fired during such a move will see a
NotifyContext property that has the mcgoncFromTool bit set.
Before the selected McGraphObj instances are moved, a MoveSelected event with a
AboutToMove argument of 1 is fired. After each McGraphObj is moved, a
MoveObject or DragObject event is fired (depending on the state of the Dragging
argument). And finally, after all selected objects have been moved and if the
call had a Dragging argument of FALSE, then a MoveSelected event with a
AboutToMove argument of 0 is fired.
If the Dragging argument is TRUE, then the MoveSelected event is fired with
AboutToMove set to 1 on only the first call, and no event is then fired until a
call is made with Dragging FALSE. The idea here is to avoid a series of
MoveSelected events during dragging. The caller is responsible for calling one
last time MoveSelectedObjects with Dragging FALSE when dragging is done, so that
the final notifications (both the MoveObject notifications and also the
MoveSelected event with AboutToMove set to zero) can be sent.
See AlsoReference
MoveSelected
MoveObject