GoDiagram Web Reference
GoToolLinking Class Members
Fields  Properties  Methods 


The following tables list the members exposed by GoToolLinking.

Public Fields
 NameDescription
Public Fieldstatic (Shared in Visual Basic)InvalidThis value associated with a port in the ValidPortsCache indicates that it is not valid to make a link between OriginalStartPort and that port.  
Public Fieldstatic (Shared in Visual Basic)ValidThis value associated with a port in the ValidPortsCache indicates that it is valid to make a link between OriginalStartPort and that port.  
Top
Public Properties
 NameDescription
Public PropertyCurrentObjectGets or sets this tool's CurrentObject property. (Inherited from Northwoods.GoWeb.GoTool)
Public PropertyEndPortGets or sets the temporary ending port.  
Public PropertyFirstInputGets this view's FirstInput property. (Inherited from Northwoods.GoWeb.GoTool)
Public PropertyForwardsGets or sets whether the user's linking operation started at the "From" port.  
Public PropertyForwardsOnlyGets or sets whether users must draw their new links starting at the "from" port and going to the "to" port.  
Public PropertyLastInputGets this view's LastInput property. (Inherited from Northwoods.GoWeb.GoTool)
Public PropertyLinkGets or sets the link that the user is manipulating for this linking operation.  
Public PropertyOriginalEndPortGets or sets the port at the end of an existing link that is being reconnected.  
Public PropertyOriginalStartPortGets or sets the port from which the user is starting or modifying a link.  
Public PropertySelectionGets this view's Selection property. (Inherited from Northwoods.GoWeb.GoTool)
Public PropertyStartPortGets or sets the temporary starting port.  
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 PropertyValidPortsCacheGets the hashtable of all known ports that are valid for this particular linking operation.  
Public PropertyViewGets the view for which this tool is handling canonicalized input events. (Inherited from Northwoods.GoWeb.GoTool)
Top
Public Methods
 NameDescription
Public MethodCanStartThis predicate should be true if this tool can be activated to be the view's current tool. (Inherited from Northwoods.GoWeb.GoTool)
Public MethodDoCancelMouseOverridden. Clean up the link state before stopping this tool.  
Public MethodDoCancelRelinkThis is called by DoCancelMouse when a relinking was cancelled by the user.  
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 MethodDoLinkingThis method is called by DoMouseMove to find the nearest valid port and adjust the temporary link according to where the given point is.  
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. A mouse move during a linking operation involves calling DoLinking and autoscrolling the view.  
Public MethodDoMouseUpOverridden. A mouse up event ends the linking operation.  
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 MethodDoNewLinkThis is called by DoMouseUp in order to create a new link.  
Public MethodDoNoNewLinkThis is called by DoMouseUp or DoCancelMouse when no new link was drawn by the user.  
Public MethodDoNoRelinkThis is called by DoMouseUp or DoCancelMouse when an existing link was purposely not reconnected by the user to any port.  
Public MethodDoRelinkThis is called by DoMouseUp in order to reconnect the existing link.  
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 MethodIsValidFromPortThis predicate is called to decide if it is OK for a user to start drawing a link from a given port.  
Public MethodIsValidLinkThis predicate is called during the process of finding the nearest port that the user can link to.  
Public MethodIsValidToPortThis predicate is called to decide if it is OK for a user to start drawing a link backwards at a given port that will be the destination for the link.  
Public MethodPickNearestPortFind the valid document port nearest to a given point.  
Public MethodPickPortFind a port in the document at the given point.  
Public MethodPortPointReturn a PointF representing the position of the port.  
Public MethodStartThis method is called when this tool becomes the view's current tool. (Inherited from Northwoods.GoWeb.GoTool)
Public MethodStartNewLinkStart the process of drawing a new link from a given port.  
Public MethodStartRelinkStart the process of reconnecting an existing link at a given port.  
Public MethodStartTransactionStart a transaction on the view. (Inherited from Northwoods.GoWeb.GoTool)
Public MethodStopOverridden. Cleaning up from any kind of linking operation involves removing any temporary ports or link from the view and stopping the current transaction.  
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
Protected Methods
 NameDescription
Protected MethodCreateTemporaryLinkThis is responsible for creating a temporary link when the user is drawing a new link.  
Protected MethodCreateTemporaryPortThis is responsible for creating a temporary port for the linking process.  
Protected MethodImitatePortChange the endport's behavior for link routing to be like the given port iport.  
Top
See Also

Reference

GoToolLinking Class
Northwoods.GoWeb Namespace

 

 


© 2013. Northwoods Software Corporation. All Rights Reserved.

Send Feedback