GoDiagram Web Reference
GoTool Class Members
Properties  Methods 


The following tables list the members exposed by GoTool.

Public Properties
 NameDescription
Public PropertyCurrentObjectGets or sets this tool's CurrentObject property.  
Public Propertystatic (Shared in Visual Basic)DragSizeGets or sets the dimensions, in pixels, of the rectangle that a drag operation must extend to be considered a drag operation.  
Public PropertyFirstInputGets this view's FirstInput property.  
Public PropertyLastInputGets this view's LastInput property.  
Public PropertySelectionGets this view's Selection property.  
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.  
Public PropertyViewGets the view for which this tool is handling canonicalized input events.  
Top
Public Methods
 NameDescription
Public MethodCanStartThis predicate should be true if this tool can be activated to be the view's current tool.  
Public MethodDoCancelMouseThe view calls this method when the user cancels the gesture with the mouse; all of the event information is provided by the LastInput property.  
Public MethodDoClickAny tool can call this method in order to implement the standard click behavior.  
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.  
Public MethodDoMouseDownThe view calls this method upon a mouse down event; all of the event information is provided by the LastInput property.  
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.  
Public MethodDoMouseMoveThe view calls this method upon a mouse move event; all of the event information is provided by the LastInput property.  
Public MethodDoMouseUpThe view calls this method upon a mouse up event; all of the event information is provided by the LastInput property.  
Public MethodDoMouseWheelThe view calls this method as the mouse wheel rotates; all of the event information is provided by the LastInput property.  
Public MethodDoSelectAny tool can call this method in order to implement the standard selection behavior for a user click.  
Public MethodIsBeyondDragSizeDetermine if the mouse has gone beyond the DragSize distance to be considered a drag instead of a sloppy click.  
Public MethodStartThis method is called when this tool becomes the view's current tool.  
Public MethodStartTransactionStart a transaction on the view.  
Public MethodStopThis method is called when this tool is about to be replaced as the view's current tool.  
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.  
Public MethodStopTransactionStop the current transaction, aborting it if TransactionResult is null.  
Public Methodstatic (Shared in Visual Basic)SubtractPointsOverloaded. This shared method helps do subtraction of PointF values.  
Top
See Also

Reference

GoTool Class
Northwoods.GoWeb Namespace

 

 


© 2013. Northwoods Software Corporation. All Rights Reserved.

Send Feedback