GoDiagram Web Reference
GoToolDragging Class Members
Properties  Methods 


The following tables list the members exposed by GoToolDragging.

Public Constructors
 NameDescription
Public ConstructorGoToolDragging ConstructorThe standard tool constructor.  
Top
Public Properties
 NameDescription
Public PropertyCopiesEffectiveSelectionGets or sets whether for a copying operation the GoView.SelectionEffectiveSelection is copied.  
Public PropertyCurrentObjectGets or sets this tool's CurrentObject property. (Inherited from Northwoods.GoWeb.GoTool)
Public PropertyDragSelectionGets or sets the alternative selection collection, holding an image of the view's selection.  
Public PropertyDragSelectionOriginalObjectGets or sets what had been the GoTool.CurrentObject before the drag selection substituted its own.  
Public PropertyEffectiveSelectionGets the cached result of a call to ComputeEffectiveSelection.  
Public PropertyEffectiveSelectionIncludesLinksGets or sets whether ComputeEffectiveSelection should include links that have both ports in (or part of) the selection being dragged.  
Public PropertyFirstInputGets this view's FirstInput property. (Inherited from Northwoods.GoWeb.GoTool)
Public PropertyHidesSelectionHandlesGets or sets whether selection handles should be removed as the drag starts.  
Public PropertyLastInputGets this view's LastInput property. (Inherited from Northwoods.GoWeb.GoTool)
Public PropertyMoveOffsetGets or sets the offset of the mouse point within the current object.  
Public PropertySelectionGets this view's Selection property. (Inherited from Northwoods.GoWeb.GoTool)
Public PropertySelectsWhenStartsControl whether Start may modify the view's selection.  
Public PropertyTransactionResultGets or sets whether to abort the current transaction if this tool is stopped; if set to a string, the string specifies the name of the transaction that will be finished when the tool stops. (Inherited from Northwoods.GoWeb.GoTool)
Public PropertyViewGets the view for which this tool is handling canonicalized input events. (Inherited from Northwoods.GoWeb.GoTool)
Top
Public Methods
 NameDescription
Public MethodCanStartOverridden. The dragging tool is applicable when the user can move or copy one or more objects.  
Public MethodClearDragSelectionStop using the DragSelection.  
Public MethodComputeEffectiveSelectionProduce a new GoSelection that is the real set of objects to be moved by GoView.MoveSelection or copied by GoView.CopySelection.  
Public MethodCreateDragSelectionCreate a new selection object containing an image of all of the real selected objects.  
Public MethodDoCancelMouseOverridden. Cancelling a drag involves moving the selection back to the original position before aborting the transaction.  
Public MethodDoClickAny tool can call this method in order to implement the standard click behavior. (Inherited from Northwoods.GoWeb.GoTool)
Public MethodDoDraggingPerform the drag, for both moving and copying, including the final move or copy on a mouse up event.  
Public MethodDoKeyDownThe view calls this method when the user presses a key on the keyboard; all of the event information is provided by the LastInput property. (Inherited from Northwoods.GoWeb.GoTool)
Public MethodDoMouseDownThe view calls this method upon a mouse down event; all of the event information is provided by the LastInput property. (Inherited from Northwoods.GoWeb.GoTool)
Public MethodDoMouseHoverThe view calls this method after the mouse rests for a while at a point; all of the event information is provided by the LastInput property. (Inherited from Northwoods.GoWeb.GoTool)
Public MethodDoMouseMoveOverridden. Mouse drags just call DoDragging and DoMouseOver.  
Public MethodDoMouseOverCall GoView method GoView.DoObjectEnterLeave.  
Public MethodDoMouseUpOverridden. The release of the mouse makes a final call to DoDragging before finishing the transaction.  
Public MethodDoMouseWheelThe view calls this method as the mouse wheel rotates; all of the event information is provided by the LastInput property. (Inherited from Northwoods.GoWeb.GoTool)
Public MethodDoSelectAny tool can call this method in order to implement the standard selection behavior for a user click. (Inherited from Northwoods.GoWeb.GoTool)
Public MethodIsBeyondDragSizeDetermine if the mouse has gone beyond the DragSize distance to be considered a drag instead of a sloppy click. (Inherited from Northwoods.GoWeb.GoTool)
Public MethodMakeDragSelectionStart using a DragSelection, creating it if needed, and moving the originally selected objects back to their original position.  
Public MethodMayBeCopyingThis predicate is true when the view allows objects to be copied and inserted, and some object in the Selection is copyable.  
Public MethodMayBeMovingThis predicate is true when the view allows objects to be moved, and some object in the Selection is movable.  
Public MethodMustBeCopyingThis predicate is true when the user is trying to force a copy by holding down the Control modifier.  
Public MethodMustBeMovingThis predicate is true when the user is trying to force a move by holding down the Shift modifier.  
Public MethodStartOverridden. Start a drag-and-drop operation within the view.  
Public MethodStartTransactionStart a transaction on the view. (Inherited from Northwoods.GoWeb.GoTool)
Public MethodStopOverridden. Clean up after any drag.  
Public MethodStopToolThis method just causes the view's current tool to be stopped and to start the view's default tool instead as the current tool. (Inherited from Northwoods.GoWeb.GoTool)
Public MethodStopTransactionStop the current transaction, aborting it if TransactionResult is null. (Inherited from Northwoods.GoWeb.GoTool)
Top
See Also

Reference

GoToolDragging Class
Northwoods.GoWeb Namespace

 

 


© 2013. Northwoods Software Corporation. All Rights Reserved.

Send Feedback