GoDiagram Web Reference
GoToolAction Class Members
Properties  Methods 


The following tables list the members exposed by GoToolAction.

Public Constructors
 NameDescription
Public ConstructorGoToolAction ConstructorThe standard tool constructor.  
Top
Public Properties
 NameDescription
Public PropertyActionObjectGets or sets the IGoActionObject being manipulated.  
Public PropertyAdjustedAutomaticallyTrue when IGoActionObject.IGoActionObject.OnActionAdjusted. is called automatically, due to a Windows Forms Timer.  
Public PropertyCurrentObjectGets or sets this tool's CurrentObject property. (Inherited from Northwoods.GoWeb.GoTool)
Public PropertyFirstInputGets this view's FirstInput property. (Inherited from Northwoods.GoWeb.GoTool)
Public PropertyLastInputGets this view's LastInput property. (Inherited from Northwoods.GoWeb.GoTool)
Public PropertySelectionGets this view's Selection property. (Inherited from Northwoods.GoWeb.GoTool)
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. This tool is appropriate when the last input event is over an object that implements IGoActionObject, or is over a part of an IGoActionObject.  
Public MethodDoCancelMouseOverridden. When this tool is cancelled, call the IGoActionObject.OnActionCancelled method.  
Public MethodDoClickAny tool can call this method in order to implement the standard click behavior. (Inherited from Northwoods.GoWeb.GoTool)
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. Invoke the IGoActionObject.OnActionAdjusted method.  
Public MethodDoMouseUpOverridden. Invoke the IGoActionObject.OnAction method.  
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 MethodPickActionObjectFind an IGoActionObject that the last input event is over.  
Public MethodStartOverridden. Get the IGoActionObject that the mouse is over, and activate it by setting its IGoActionObject.ActionActivated property to true and calling its IGoActionObject.OnActionActivated method.  
Public MethodStartAutoAdjustingOn Windows Forms, start a Timer to repeatedly call IGoActionObject.IGoActionObject.OnActionAdjusted.  
Public MethodStartTransactionStart a transaction on the view. (Inherited from Northwoods.GoWeb.GoTool)
Public MethodStopOverridden. Make sure any IGoActionObject is deactivated and that any automatic adjustments calls are stopped.  
Public MethodStopAutoAdjustingOn Windows Forms, stop any Timer that is automatically calling IGoActionObject.IGoActionObject.OnActionAdjusted.  
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

GoToolAction Class
Northwoods.GoWeb Namespace

 

 


© 2013. Northwoods Software Corporation. All Rights Reserved.

Send Feedback