GoDigram for .NET Framework and .NET Core
Northwoods.Go Namespace / GoToolLinking Class
Fields Properties Methods


In This Topic
    GoToolLinking Class Members
    In This Topic

    The following tables list the members exposed by GoToolLinking.

    Public Fields
     NameDescription
    Public Fieldstatic (Shared in Visual Basic)This 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)This 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 Property Gets or sets this tool's CurrentObject property. (Inherited from Northwoods.Go.GoTool)
    Public Property Gets or sets the temporary ending port.  
    Public Property Gets this view's FirstInput property. (Inherited from Northwoods.Go.GoTool)
    Public Property Gets or sets whether the user's linking operation started at the "From" port.  
    Public Property Gets or sets whether users must draw their new links starting at the "from" port and going to the "to" port.  
    Public Property Gets this view's LastInput property. (Inherited from Northwoods.Go.GoTool)
    Public Property Gets or sets the link that the user is manipulating for this linking operation.  
    Public Property Gets or sets the port at the end of an existing link that is being reconnected.  
    Public Property Gets or sets the port from which the user is starting or modifying a link.  
    Public Property Gets this view's Selection property. (Inherited from Northwoods.Go.GoTool)
    Public Property Gets or sets the temporary starting port.  
    Public Property Gets 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.Go.GoTool)
    Public Property Gets the hashtable of all known ports that are valid for this particular linking operation.  
    Public Property Gets the view for which this tool is handling canonicalized input events. (Inherited from Northwoods.Go.GoTool)
    Top
    Public Methods
     NameDescription
    Public Method This predicate should be true if this tool can be activated to be the view's current tool. (Inherited from Northwoods.Go.GoTool)
    Public MethodOverridden.  Clean up the link state before stopping this tool.  
    Public MethodThis is called by DoCancelMouse when a relinking was cancelled by the user.  
    Public Method Any tool can call this method in order to implement the standard click behavior. (Inherited from Northwoods.Go.GoTool)
    Public MethodThe 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.Go.GoTool)
    Public MethodThis method is called by DoMouseMove to find the nearest valid port and adjust the temporary link according to where the given point is.  
    Public MethodThe view calls this method upon a mouse down event; all of the event information is provided by the LastInput property. (Inherited from Northwoods.Go.GoTool)
    Public MethodThe 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.Go.GoTool)
    Public MethodOverridden. A mouse move during a linking operation involves calling DoLinking and autoscrolling the view.  
    Public MethodOverridden.  A mouse up event ends the linking operation.  
    Public MethodThe view calls this method as the mouse wheel rotates; all of the event information is provided by the LastInput property. (Inherited from Northwoods.Go.GoTool)
    Public MethodThis is called by DoMouseUp in order to create a new link.  
    Public MethodThis is called by DoMouseUp or DoCancelMouse when no new link was drawn by the user.  
    Public MethodThis is called by DoMouseUp or DoCancelMouse when an existing link was purposely not reconnected by the user to any port.  
    Public MethodThis is called by DoMouseUp in order to reconnect the existing link.  
    Public Method Any tool can call this method in order to implement the standard selection behavior for a user click. (Inherited from Northwoods.Go.GoTool)
    Public MethodDetermine if the mouse has gone beyond the DragSize distance to be considered a drag instead of a sloppy click. (Inherited from Northwoods.Go.GoTool)
    Public Method This predicate is called to decide if it is OK for a user to start drawing a link from a given port.  
    Public Method This predicate is called during the process of finding the nearest port that the user can link to.  
    Public Method This 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 Method Find the valid document port nearest to a given point.  
    Public Method Find a port in the document at the given point.  
    Public MethodReturn a PointF representing the position of the port.  
    Public Method This method is called when this tool becomes the view's current tool. (Inherited from Northwoods.Go.GoTool)
    Public Method Start the process of drawing a new link from a given port.  
    Public Method Start the process of reconnecting an existing link at a given port.  
    Public Method Start a transaction on the view. (Inherited from Northwoods.Go.GoTool)
    Public MethodOverridden.  Cleaning up from any kind of linking operation involves removing any temporary ports or link from the view and stopping the current transaction.  
    Public Method This 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.Go.GoTool)
    Public MethodStop the current transaction, aborting it if TransactionResult is null. (Inherited from Northwoods.Go.GoTool)
    Top
    Protected Methods
     NameDescription
    Protected Method This is responsible for creating a temporary link when the user is drawing a new link.  
    Protected Method This is responsible for creating a temporary port for the linking process.  
    Protected MethodChange the endport's behavior for link routing to be like the given port iport.  
    Top
    See Also