GoDiagram Web Reference
GoPort Class Members
Fields  Properties  Methods 


The following tables list the members exposed by GoPort.

Public Constructors
 NameDescription
Public ConstructorGoPort ConstructorThe constructor produces a port whose appearance is a filled black ellipse, that is both a valid source and destination for linking, that assumes that source links come in from the left and that destination links depart out to the right, and that is not selectable or resizable by the user.  
Top
Public Fields
 NameDescription
Public FieldChangedAddedLinkThis is a GoObject.Changed subhint.  
Public FieldChangedClearsLinksWhenRemovedThis is a GoObject.Changed subhint.  
Public FieldChangedEndSegmentLengthThis is a GoObject.Changed subhint.  
Public FieldChangedFromSpotThis is a GoObject.Changed subhint.  
Public FieldChangedObjectThis is a GoObject.Changed subhint.  
Public FieldChangedPartIDThis is a GoObject.Changed subhint.  
Public FieldChangedPortUserFlagsThis is a GoObject.Changed subhint.  
Public FieldChangedPortUserObjectThis is a GoObject.Changed subhint.  
Public FieldChangedRemovedLinkThis is a GoObject.Changed subhint.  
Public FieldChangedStyleThis is a GoObject.Changed subhint.  
Public FieldChangedToSpotThis is a GoObject.Changed subhint.  
Public FieldChangedValidDuplicateLinksThis is a GoObject.Changed subhint.  
Public FieldChangedValidFromThis is a GoObject.Changed subhint.  
Public FieldChangedValidSelfNodeThis is a GoObject.Changed subhint.  
Public FieldChangedValidSingleLinkThis is a GoObject.Changed subhint.  
Public FieldChangedValidToThis is a GoObject.Changed subhint.  
Top
Public Properties
 NameDescription
Public PropertyAutoRescalesGets or sets whether this object automatically rescales its appearance when its size changes. (Inherited from Northwoods.GoWeb.GoObject)
Public PropertyBottomGets or sets this object's bottom coordinate. (Inherited from Northwoods.GoWeb.GoObject)
Public PropertyBoundsWhenever the size and/or position is changed, we clear out any cached data. (Inherited from Northwoods.GoWeb.GoShape)
Public PropertyBrushGets or sets the brush used to fill the outline of this shape. (Inherited from Northwoods.GoWeb.GoShape)
Public PropertyBrushColorGets or sets the main or background color of the brush. (Inherited from Northwoods.GoWeb.GoShape)
Public PropertyBrushFocusScalesGets or sets the size of the focus area for path gradients, as normalized fractions of the size of the shape. (Inherited from Northwoods.GoWeb.GoShape)
Public PropertyBrushForeColorGets or sets the foreground color of a brush. (Inherited from Northwoods.GoWeb.GoShape)
Public PropertyBrushMidColorGets or sets the middle color of a gradient brush. (Inherited from Northwoods.GoWeb.GoShape)
Public PropertyBrushMidFractionGets or sets the fractional distance between the end colors at which the middle color is drawn. (Inherited from Northwoods.GoWeb.GoShape)
Public PropertyBrushPointGets or sets the end point for linear gradients or the focus point for path gradients, as normalized fractions of the size of the shape. (Inherited from Northwoods.GoWeb.GoShape)
Public PropertyBrushStartPointGets or sets the start point for linear gradients, as normalized fractions of the size of the shape. (Inherited from Northwoods.GoWeb.GoShape)
Public PropertyBrushStyleGets or sets the kind of brush used by this shape. (Inherited from Northwoods.GoWeb.GoShape)
Public PropertyClearsLinksWhenRemovedGets or sets whether this port calls ClearLinks when it is removed from a GoLayer (i.e., from a document, normally).  
Public PropertyCopyableGets or sets whether the user can copy this object. (Inherited from Northwoods.GoWeb.GoObject)
Public PropertyDeletableGets or sets whether the user can delete this object. (Inherited from Northwoods.GoWeb.GoObject)
Public PropertyDestinationLinksGets an enumerator over all of the links going out of this port.  
Public PropertyDestinationLinksCountGets the number of links going out of this port.  
Public PropertyDocumentGets the document that this object belongs to, or null if this is not in a layer or if this is in a view layer. (Inherited from Northwoods.GoWeb.GoObject)
Public PropertyDraggingObjectGets the object that will be dragged instead of this selected object. (Inherited from Northwoods.GoWeb.GoObject)
Public PropertyDragsNodeGets or sets whether this object, when selected and a child of a group, and when dragged, drags the parent node instead. (Inherited from Northwoods.GoWeb.GoObject)
Public PropertyEditableGets or sets whether the user can edit this object. (Inherited from Northwoods.GoWeb.GoObject)
Public PropertyEndSegmentLengthGets or sets the length of the link segment closest to this port.  
Public PropertyFromSpotGets or sets the GoObject spot at which to connect links coming out from this port.  
Public PropertyGoObjectReturns itself as a GoObject.  
Public PropertyHeightGets or sets this object's height. (Inherited from Northwoods.GoWeb.GoObject)
Public PropertyIsValidDuplicateLinksGets or sets whether a valid link can be made between two ports already connected by a link in the same direction.  
Public PropertyIsValidFromGets or sets whether this port can be a valid value for some link's IGoLink.FromPort.  
Public PropertyIsValidSelfNodeGets or sets whether a valid link can be made between two ports belonging to the same node.  
Public PropertyIsValidSingleLinkGets or sets whether CanLinkFrom and CanLinkTo return false when there is already a link connected at this port.  
Public PropertyIsValidToGets or sets whether this port can be a valid value for some link's IGoLink.ToPort.  
Public PropertyLayerGets the layer to which this object belongs. (Inherited from Northwoods.GoWeb.GoObject)
Public PropertyLeftGets or sets this object's left coordinate, the X position. (Inherited from Northwoods.GoWeb.GoObject)
Public PropertyLinksGets an enumerator over all of the links connected at this port.  
Public PropertyLinksCountGets the total number of links connected at this port.  
Public Propertystatic (Shared in Visual Basic)LinksRedirectedToSubGraphPortGets or sets whether links connected to ports that are inside collapsed GoSubGraphs appear to be connected to the subgraph's GoSubGraph.Port.  
Public PropertyLocationGets or sets this object's natural position. (Inherited from Northwoods.GoWeb.GoObject)
Public PropertyMovableGets or sets whether the user can move this object. (Inherited from Northwoods.GoWeb.GoObject)
Public PropertyNodeGets the node that this port is part of.  
Public PropertyObserversGets an enumerator over the list of observer objects of this object. (Inherited from Northwoods.GoWeb.GoObject)
Public PropertyParentGets the parent group for this object. (Inherited from Northwoods.GoWeb.GoObject)
Public PropertyPartIDGets or sets the unique ID of this part within its document.  
Public PropertyPenGets or sets the pen used to draw the outline of this shape. (Inherited from Northwoods.GoWeb.GoShape)
Public PropertyPenColorGets or sets the color of the pen. (Inherited from Northwoods.GoWeb.GoShape)
Public PropertyPenWidthGets or sets the width of the pen. (Inherited from Northwoods.GoWeb.GoShape)
Public PropertyPortObjectGets or sets the GoObject that may stand in for this port.  
Public PropertyPrintableGets or sets whether the view can print this object. (Inherited from Northwoods.GoWeb.GoObject)
Public PropertyReshapableGets or sets whether the user can reshape this object. (Inherited from Northwoods.GoWeb.GoObject)
Public PropertyResizableGets or sets whether the user can resize this object. (Inherited from Northwoods.GoWeb.GoObject)
Public PropertyResizesRealtimeGets or sets whether this object continuously changes its size during a user resizing operation. [In Web Forms there is no continuous visual feedback of a resize.] (Inherited from Northwoods.GoWeb.GoObject)
Public PropertyRightGets or sets this object's right coordinate. (Inherited from Northwoods.GoWeb.GoObject)
Public PropertySelectableGets or sets whether the user can select this object. (Inherited from Northwoods.GoWeb.GoObject)
Public PropertySelectionObjectGets the object that gets selection handles when this object is selected. (Inherited from Northwoods.GoWeb.GoObject)
Public PropertyShadowedGets or sets whether this object is painted with a drop shadow. (Inherited from Northwoods.GoWeb.GoObject)
Public PropertySourceLinksGets an enumerator over all of the links coming into this port.  
Public PropertySourceLinksCountGets the number of links coming into this port.  
Public PropertyStyleGets or sets the appearance style for this port.  
Public PropertyTopGets or sets this object's top coordinate, the Y position. (Inherited from Northwoods.GoWeb.GoObject)
Public PropertyToSpotGets or sets the GoObject spot at which to connect links going into this port.  
Public PropertyUserFlagsGets or sets an integer value associated with this port.  
Public PropertyUserObjectGets or sets an object associated with this port.  
Public PropertyViewGets the view that this object belongs to, or null if this is not in a layer or if this is in a document layer. (Inherited from Northwoods.GoWeb.GoObject)
Public PropertyVisibleGets or sets whether the user can see this object. (Inherited from Northwoods.GoWeb.GoObject)
Public PropertyWidthGets or sets this object's width. (Inherited from Northwoods.GoWeb.GoObject)
Top
Public Methods
 NameDescription
Public MethodAddDestinationLinkAdd a link to this port's collection of connected links, making sure the link's FromPort is this port so that the link is a connection to another destination port.  
Public MethodAddObserverRegister an object as an observer of changes to this object. (Inherited from Northwoods.GoWeb.GoObject)
Public MethodAddSelectionHandlesAdd selection handles for this object for the given selection collection. (Inherited from Northwoods.GoWeb.GoObject)
Public MethodAddSourceLinkAdd a link to this port's collection of connected links, making sure the link's ToPort is this port so that the link is a connection from another source port.  
Public MethodCanCopyCalled to see if the user can copy this object. (Inherited from Northwoods.GoWeb.GoObject)
Public MethodCanDeleteCalled to see if the user can delete this object. (Inherited from Northwoods.GoWeb.GoObject)
Public MethodCanEditCalled to see if the user can edit this object. (Inherited from Northwoods.GoWeb.GoObject)
Public MethodCanLinkFromThis predicate should be true if, by itself, there is no known reason why one couldn't create a valid link from this port to some port.  
Public MethodCanLinkToThis predicate should be true if, by itself, there is no known reason why one couldn't create a valid link from some port to this one.  
Public MethodCanMoveCalled to see if the user can move this object. (Inherited from Northwoods.GoWeb.GoObject)
Public MethodCanPrintCalled to see if the view can print this object. (Inherited from Northwoods.GoWeb.GoObject)
Public MethodCanReshapeCalled to see if the user can reshape this object. (Inherited from Northwoods.GoWeb.GoObject)
Public MethodCanResizeCalled to see if the user can resize this object. (Inherited from Northwoods.GoWeb.GoObject)
Public MethodCanSelectCalled to see if the user can select this object. (Inherited from Northwoods.GoWeb.GoObject)
Public MethodCanViewCalled to see if the user can see this object. (Inherited from Northwoods.GoWeb.GoObject)
Public MethodChangedNotify this object's document or view that some part of this object's state has been changed, via the GoDocument.Changed event and using the GoChangedEventArgs event args class. (Inherited from Northwoods.GoWeb.GoObject)
Public MethodChangeValueOverridden. Performs changes for undo and redo.  
Public MethodChangingNotify this object's document or view that some part of this object's state is about to be changed. (Inherited from Northwoods.GoWeb.GoObject)
Public MethodClearLinksRemove all links connected to this port.  
Public MethodComputeMoveCalculate a new location for this object. (Inherited from Northwoods.GoWeb.GoObject)
Public MethodComputeResizeCalculate a new bounding rectangle for this object. (Inherited from Northwoods.GoWeb.GoObject)
Public MethodContainedByRectangleConsider the Pen width when determining if this shape is inside a rectangle. (Inherited from Northwoods.GoWeb.GoShape)
Public MethodContainsLinkDetermine if a link is connected at this port.  
Public MethodContainsPointConsider the Pen width when determining if a point is in this shape. (Inherited from Northwoods.GoWeb.GoShape)
Public MethodCopyThis convenience method just makes a copy of the object itself, using a generic GoCopyDictionary. (Inherited from Northwoods.GoWeb.GoObject)
Public MethodCopyLinksArrayReturns a newly allocated array containing references to all of the links connected to this port.  
Public MethodCopyNewValueForRedoPreserve any mutable state needed to perform an IGoUndoableEdit.Redo. (Inherited from Northwoods.GoWeb.GoObject)
Public MethodCopyObjectOverridden. Copying a port does not immediately cause its links to be copied.  
Public MethodCopyObjectDelayedOverridden. Make sure any unshared PortObject is copied.  
Public MethodCopyOldValueForUndoPreserve any mutable state needed to perform an IGoUndoableEdit.Undo. (Inherited from Northwoods.GoWeb.GoObject)
Public MethodCreateBoundingHandleCreate a bounding handle for this object. (Inherited from Northwoods.GoWeb.GoObject)
Public MethodCreateEditorCreate a GoControl that implements an editor for this object in the given view. (Inherited from Northwoods.GoWeb.GoObject)
Public MethodCreateResizeHandleCreate a resize handle for this object, given a handle ID. (Inherited from Northwoods.GoWeb.GoObject)
Public MethodDoBeginEditStart editing this object in the given view. (Inherited from Northwoods.GoWeb.GoObject)
Public MethodDoEndEditStop editing this object in the given view. (Inherited from Northwoods.GoWeb.GoObject)
Public MethodDoMoveCalled when a user moves this object. (Inherited from Northwoods.GoWeb.GoObject)
Public MethodDoResizeCalled when a user resizes this object. (Inherited from Northwoods.GoWeb.GoObject)
Public MethodExpandPaintBoundsOverridden. If the Style is GoPortStyle.Object, we need to consider the PortObject's paint bounds.  
Public MethodFillDoubleEdgeOverloaded. Set the GoShape.Brush to be a vertical linear gradient starting with the start color, with most of the center being Color.White, and ending with the starting color. (Inherited from Northwoods.GoWeb.GoShape)
Public MethodFillEllipseGradientOverloaded. Set the GoShape.Brush to be a gradient occupying this shape's Bounds, with the color color along the four edges of the rectangle, surrounding a very light version of that color. (Inherited from Northwoods.GoWeb.GoShape)
Public MethodFillHalfGradientOverloaded. Set the GoShape.Brush to be a vertical linear gradient starting with a very light version of the color color, and having the last half of the gradient be the solid color color. (Inherited from Northwoods.GoWeb.GoShape)
Public MethodFillMiddleGradientOverloaded. Set the GoShape.Brush to be a vertical linear gradient starting with a very light version of the color color, having the middle with a color lighter than color, and ending with the starting color. (Inherited from Northwoods.GoWeb.GoShape)
Public MethodFillRectangleGradientOverloaded. Set the GoShape.Brush to be a gradient occupying this shape's Bounds, with the color color along the four edges of the rectangle, surrounding a very light version of that color. (Inherited from Northwoods.GoWeb.GoShape)
Public MethodFillShadedGradientOverloaded. Set the GoShape.Brush to be a vertical linear gradient starting with a very light version of the color color, having the middle with a color lighter than color, and ending with a darker color than the color. (Inherited from Northwoods.GoWeb.GoShape)
Public MethodFillShapeFringeOverloaded. Set the GoShape.Brush to be a path shaped gradient starting with the start color, with most of the center being Color.White. (Inherited from Northwoods.GoWeb.GoShape)
Public MethodFillShapeGradientOverloaded. Set the GoShape.Brush to be a path shaped gradient with the color color surrounding a very light version of that color. (Inherited from Northwoods.GoWeb.GoShape)
Public MethodFillShapeHighlightOverloaded. Set the GoShape.Brush to be a path shaped gradient that is mostly the start color, with a white "highlight". (Inherited from Northwoods.GoWeb.GoShape)
Public MethodFillSimpleGradientOverloaded. Set the GoShape.Brush to be a simple vertical linear gradient using the given color. (Inherited from Northwoods.GoWeb.GoShape)
Public MethodFillSingleEdgeOverloaded. Set the GoShape.Brush to be a vertical linear gradient starting with the start color, with most of the center being Color.White. (Inherited from Northwoods.GoWeb.GoShape)
Public Methodstatic (Shared in Visual Basic)FindParentNodeReturn the node that immediately contains an object, or return the object itself if it is an IGoNode.  
Public Methodstatic (Shared in Visual Basic)FindTopNodeReturn the most inclusive node containing an object.  
Public MethodGetContextMenuCalled to get a GoContextMenu to display for this object. (Inherited from Northwoods.GoWeb.GoObject)
Public MethodGetCursorNameOverridden. Change the cursor to a "hand" cursor if the user can draw a new link at this port.  
Public MethodGetFromEndSegmentLengthReturn the length of the link's first segment, at its IGoLink.FromPort.  
Public MethodGetFromLinkDirDetermine the direction that a link will go when coming out of this port.  
Public MethodGetFromLinkPointDetermines the actual point at which a link coming out from this port should originate.  
Public MethodGetLinkDirDetermine the direction in which the link should go from the link point.  
Public MethodGetLinkPointFromPointDetermine the actual point at which a link connected to this port should terminate when the spot is GoObject.NoSpot.  
Public MethodGetNearestIntersectionPointOverridden. If there is a PortObject and the Style is not GoPortStyle.GoPortStyle.Object, return the closest intersection point of the given line with that object.  
Public MethodGetPartInfoReturn a GoPartInfo that describes this object and that can be transmitted to the client (user agent) as JavaScript data structures that can be used by code running on the client. (Inherited from Northwoods.GoWeb.GoObject)
Public MethodGetRectangleSpotLocationGet the position of a spot in a rectangle. (Inherited from Northwoods.GoWeb.GoObject)
Public MethodGetShadowBrushGet a Brush for painting a drop shadow in the given view. (Inherited from Northwoods.GoWeb.GoObject)
Public MethodGetShadowOffsetGets the size of a drop shadow for this object in the given view. (Inherited from Northwoods.GoWeb.GoObject)
Public MethodGetShadowPenGet a Pen for painting a drop shadow in the given view. (Inherited from Northwoods.GoWeb.GoObject)
Public MethodGetSpotLocationGet the position of a spot on this object. (Inherited from Northwoods.GoWeb.GoObject)
Public MethodGetToEndSegmentLengthReturn the length of the link's last segment, at its IGoLink.ToPort.  
Public MethodGetToLinkDirDetermine the direction that a link will go when going into this port.  
Public MethodGetToLinkPointDetermine the actual point at which a link connected to this port should terminate.  
Public MethodGetToolTipCalled to get a String to display as a tooltip for this object. (Inherited from Northwoods.GoWeb.GoObject)
Public MethodInvalidateViewsCause all views to repaint this object when they get a chance. (Inherited from Northwoods.GoWeb.GoObject)
Public MethodIsChildOfDetermines if this object is a child, perhaps indirectly, of the given object. (Inherited from Northwoods.GoWeb.GoObject)
Public Methodstatic (Shared in Visual Basic)IsInSameNodeOverloaded. This static method determines if both arguments belong to the same IGoNode.  
Public Methodstatic (Shared in Visual Basic)IsLinkedOverloaded. This static method determines if there is a link going from one port to another.  
Public MethodIsValidLinkTrue if it is valid to create a link from this port to toPort.  
Public MethodLinksOnPortChangedTell any connected links about any change to this port  
Public MethodMakePathOverridden. Produce a GraphicsPath representing this shape.  
Public MethodOnContextClickCalled when the user context clicks on this object. (Inherited from Northwoods.GoWeb.GoObject)
Public MethodOnDoubleClickCalled when the user double clicks on this object. (Inherited from Northwoods.GoWeb.GoObject)
Public MethodOnEnterLeaveCalled when the document object immediately under the mouse changes after a drag. (Inherited from Northwoods.GoWeb.GoObject)
Public MethodOnGotSelectionCalled when this object becomes selected. (Inherited from Northwoods.GoWeb.GoObject)
Public MethodOnHoverCalled when the user hovers over this object. (Inherited from Northwoods.GoWeb.GoObject)
Public MethodOnLinkChangedWhen a link connected to this port is changed, this method is called.  
Public MethodOnLostSelectionCalled when this object becomes unselected. (Inherited from Northwoods.GoWeb.GoObject)
Public MethodOnMouseOverCalled when the user moves the mouse over this object when not dragging or resizing. (Inherited from Northwoods.GoWeb.GoObject)
Public MethodOnSelectionDroppedCalled after the user has dropped the selection on this object. (Inherited from Northwoods.GoWeb.GoObject)
Public MethodOnSelectionDropRejectCalled during a user's drag of the view's Selection when the mouse is over this object, to give this object a chance to veto a drop. (Inherited from Northwoods.GoWeb.GoObject)
Public MethodOnSingleClickCalled when the user single clicks on this object. (Inherited from Northwoods.GoWeb.GoObject)
Public MethodPaintOverridden. Draw a port as either a simple shape using a Pen and Brush, as an arbitrary object, or not at all.  
Public MethodPaintGreekBecause ports are normally small objects, we heed the GoView.PaintNothingScale and GoView.PaintGreekScale properties.  
Public MethodPickReturn an object at a point, perhaps only a selectable one. (Inherited from Northwoods.GoWeb.GoObject)
Public MethodRemoveThis convenience method just removes this object from its container, if there is any. (Inherited from Northwoods.GoWeb.GoObject)
Public MethodRemoveLinkRemove a link from this port's collection of connected links.  
Public MethodRemoveObserverMake sure an object is not an observer of changes to this object. (Inherited from Northwoods.GoWeb.GoObject)
Public MethodRemoveSelectionHandlesRemove all selection handles for this object for the given selection collection. (Inherited from Northwoods.GoWeb.GoObject)
Public MethodSetRectangleSpotLocationModify a rectangle such that its new spot location is at a given point. (Inherited from Northwoods.GoWeb.GoObject)
Public MethodSetSizeKeepingLocationSets a new size for this object while maintaining the same location. (Inherited from Northwoods.GoWeb.GoObject)
Public MethodSetSpotLocationOverloaded. Move this object so this object's given spot is at the given location. (Inherited from Northwoods.GoWeb.GoObject)
Public MethodSpotOppositeGet the spot that is on the opposite side of a given spot. (Inherited from Northwoods.GoWeb.GoObject)
Top
Protected Methods
 NameDescription
Protected MethodComputeBoundsRecalculates the actual bounding rectangle for this object when it might be invalid. (Inherited from Northwoods.GoWeb.GoObject)
Protected MethodGetPathGets a cached GraphicsPath produced by a call to GoShape.MakePath. (Inherited from Northwoods.GoWeb.GoShape)
Protected MethodOnBoundsChangedOverridden. When a port is moved, we update any links connected to this port by calling LinksOnPortChanged.  
Protected MethodOnLayerChangedOverridden. When a port is removed from a layer, we remove all of the links connected to the port.  
Protected MethodOnObservedChangedCalled when an observed object has been changed. (Inherited from Northwoods.GoWeb.GoObject)
Protected MethodOnParentChangedCalled when this object's parent is changed. (Inherited from Northwoods.GoWeb.GoObject)
Protected MethodResetPathClear any cached GraphicsPath. (Inherited from Northwoods.GoWeb.GoShape)
Top
See Also

Reference

GoPort Class
Northwoods.GoWeb Namespace

 

 


© 2013. Northwoods Software Corporation. All Rights Reserved.

Send Feedback