GoDiagram Web Reference
GoToolRelinking Class Members
Properties  Methods 


The following tables list the members exposed by GoToolRelinking.

Public Constructors
 NameDescription
Public ConstructorGoToolRelinking ConstructorThe standard tool constructor.  
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. (Inherited from Northwoods.GoWeb.GoToolLinking)
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. (Inherited from Northwoods.GoWeb.GoToolLinking)
Public PropertyForwardsOnlyGets or sets whether users must draw their new links starting at the "from" port and going to the "to" port. (Inherited from Northwoods.GoWeb.GoToolLinking)
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. (Inherited from Northwoods.GoWeb.GoToolLinking)
Public PropertyOriginalEndPortGets or sets the port at the end of an existing link that is being reconnected. (Inherited from Northwoods.GoWeb.GoToolLinking)
Public PropertyOriginalStartPortGets or sets the port from which the user is starting or modifying a link. (Inherited from Northwoods.GoWeb.GoToolLinking)
Public PropertySelectionGets this view's Selection property. (Inherited from Northwoods.GoWeb.GoTool)
Public PropertyStartPortGets or sets the temporary starting port. (Inherited from Northwoods.GoWeb.GoToolLinking)
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. (Inherited from Northwoods.GoWeb.GoToolLinking)
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 user can relink if the view allows it and if the handle found at the input event point has an ID that indicates it is relinkable.  
Public MethodDoCancelMouseClean up the link state before stopping this tool. (Inherited from Northwoods.GoWeb.GoToolLinking)
Public MethodDoCancelRelinkThis is called by DoCancelMouse when a relinking was cancelled by the user. (Inherited from Northwoods.GoWeb.GoToolLinking)
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. (Inherited from Northwoods.GoWeb.GoToolLinking)
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 MethodDoMouseMoveA mouse move during a linking operation involves calling DoLinking and autoscrolling the view. (Inherited from Northwoods.GoWeb.GoToolLinking)
Public MethodDoMouseUpA mouse up event ends the linking operation. (Inherited from Northwoods.GoWeb.GoToolLinking)
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. (Inherited from Northwoods.GoWeb.GoToolLinking)
Public MethodDoNoNewLinkThis is called by DoMouseUp or DoCancelMouse when no new link was drawn by the user. (Inherited from Northwoods.GoWeb.GoToolLinking)
Public MethodDoNoRelinkThis is called by DoMouseUp or DoCancelMouse when an existing link was purposely not reconnected by the user to any port. (Inherited from Northwoods.GoWeb.GoToolLinking)
Public MethodDoRelinkThis is called by DoMouseUp in order to reconnect the existing link. (Inherited from Northwoods.GoWeb.GoToolLinking)
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. (Inherited from Northwoods.GoWeb.GoToolLinking)
Public MethodIsValidLinkThis predicate is called during the process of finding the nearest port that the user can link to. (Inherited from Northwoods.GoWeb.GoToolLinking)
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. (Inherited from Northwoods.GoWeb.GoToolLinking)
Public MethodPickNearestPortFind the valid document port nearest to a given point. (Inherited from Northwoods.GoWeb.GoToolLinking)
Public MethodPickPortFind a port in the document at the given point. (Inherited from Northwoods.GoWeb.GoToolLinking)
Public MethodPickRelinkHandleFind a resize handle at the given point.  
Public MethodPortPointReturn a PointF representing the position of the port. (Inherited from Northwoods.GoWeb.GoToolLinking)
Public MethodStartOverridden. Start relinking by by calling GoToolLinking.StartRelink and hiding any selection handles for the link.  
Public MethodStartNewLinkStart the process of drawing a new link from a given port. (Inherited from Northwoods.GoWeb.GoToolLinking)
Public MethodStartRelinkStart the process of reconnecting an existing link at a given port. (Inherited from Northwoods.GoWeb.GoToolLinking)
Public MethodStartTransactionStart a transaction on the view. (Inherited from Northwoods.GoWeb.GoTool)
Public MethodStopOverridden. Restore the selection handles on the link.  
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. (Inherited from Northwoods.GoWeb.GoToolLinking)
Protected MethodCreateTemporaryPortThis is responsible for creating a temporary port for the linking process. (Inherited from Northwoods.GoWeb.GoToolLinking)
Protected MethodImitatePortChange the endport's behavior for link routing to be like the given port iport. (Inherited from Northwoods.GoWeb.GoToolLinking)
Top
See Also

Reference

GoToolRelinking Class
Northwoods.GoWeb Namespace

 

 


© 2013. Northwoods Software Corporation. All Rights Reserved.

Send Feedback