GoDiagram Win Reference
GoStroke Class Members
Fields  Properties  Methods 


The following tables list the members exposed by GoStroke.

Public Constructors
 NameDescription
Public ConstructorGoStroke ConstructorThe constructor produces a shape whose arrowheads are filled with black and that the user can resize in realtime.  
Top
Public Fields
 NameDescription
Public FieldAddedPointThis is a Changed subhint.  
Public FieldChangedAddPointThis is a synonym for AddedPoint.  
Public FieldChangedAllPointsThis is a Changed subhint.  
Public FieldChangedCurvinessThis is a Changed subhint identifying changes to the value of the Curviness property.  
Public FieldChangedFromArrowFilledThis is a Changed subhint identifying changes to the value of the FromArrowFilled property.  
Public FieldChangedFromArrowHeadThis is a Changed subhint identifying changes to the value of the FromArrow property.  
Public FieldChangedFromArrowLengthThis is a Changed subhint identifying changes to the value of the FromArrowLength property.  
Public FieldChangedFromArrowShaftLengthThis is a Changed subhint identifying changes to the value of the FromArrowShaftLength property.  
Public FieldChangedFromArrowStyleThis is a Changed subhint identifying changes to the value of the FromArrowStyle property.  
Public FieldChangedFromArrowWidthThis is a Changed subhint identifying changes to the value of the FromArrowWidth property.  
Public FieldChangedHighlightThis is a Changed subhint identifying changes to the value of the Highlight property.  
Public FieldChangedHighlightPenThis is a Changed subhint identifying changes to the value of the HighlightPen property.  
Public FieldChangedHighlightWhenSelectedThis is a Changed subhint identifying changes to the value of the HighlightWhenSelected property.  
Public FieldChangedModifiedPointThis is a synonym for ModifiedPoint.  
Public FieldChangedRemovePointThis is a synonym for RemovedPoint.  
Public FieldChangedStyleThis is a Changed subhint identifying changes to the value of the Style property.  
Public FieldChangedToArrowFilledThis is a Changed subhint identifying changes to the value of the ToArrowFilled property.  
Public FieldChangedToArrowHeadThis is a Changed subhint identifying changes to the value of the ToArrow property.  
Public FieldChangedToArrowLengthThis is a Changed subhint identifying changes to the value of the ToArrowLength property.  
Public FieldChangedToArrowShaftLengthThis is a Changed subhint identifying changes to the value of the ToArrowShaftLength property.  
Public FieldChangedToArrowStyleThis is a Changed subhint identifying changes to the value of the ToArrowStyle property.  
Public FieldChangedToArrowWidthThis is a Changed subhint identifying changes to the value of the ToArrowWidth property.  
Public FieldModifiedPointThis is a Changed subhint.  
Public FieldRemovedPointThis is a Changed subhint.  
Top
Public Properties
 NameDescription
Public PropertyAutoRescalesGets or sets whether this object automatically rescales its appearance when its size changes. (Inherited from Northwoods.Go.GoObject)
Public PropertyBottomGets or sets this object's bottom coordinate. (Inherited from Northwoods.Go.GoObject)
Public PropertyBoundsWhenever the size and/or position is changed, we clear out any cached data. (Inherited from Northwoods.Go.GoShape)
Public PropertyBrushGets or sets the brush used to fill the outline of this shape. (Inherited from Northwoods.Go.GoShape)
Public PropertyBrushColorGets or sets the main or background color of the brush. (Inherited from Northwoods.Go.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.Go.GoShape)
Public PropertyBrushForeColorGets or sets the foreground color of a brush. (Inherited from Northwoods.Go.GoShape)
Public PropertyBrushMidColorGets or sets the middle color of a gradient brush. (Inherited from Northwoods.Go.GoShape)
Public PropertyBrushMidFractionGets or sets the fractional distance between the end colors at which the middle color is drawn. (Inherited from Northwoods.Go.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.Go.GoShape)
Public PropertyBrushStartPointGets or sets the start point for linear gradients, as normalized fractions of the size of the shape. (Inherited from Northwoods.Go.GoShape)
Public PropertyBrushStyleGets or sets the kind of brush used by this shape. (Inherited from Northwoods.Go.GoShape)
Public PropertyCopyableGets or sets whether the user can copy this object. (Inherited from Northwoods.Go.GoObject)
Public PropertyCurvinessGets how rounded the corners are for adjacent line segments when the stroke style is RoundedLine.  
Public PropertyDeletableGets or sets whether the user can delete this object. (Inherited from Northwoods.Go.GoObject)
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.Go.GoObject)
Public PropertyDraggingObjectGets the object that will be dragged instead of this selected object. (Inherited from Northwoods.Go.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.Go.GoObject)
Public PropertyEditableGets or sets whether the user can edit this object. (Inherited from Northwoods.Go.GoObject)
Public PropertyFirstPickIndexGets the index of the first point that should get a selection handle.  
Public PropertyFromArrowGets or sets whether an arrow is drawn at the start of this stroke.  
Public PropertyFromArrowAnchorPointGets a point which specifies the direction the arrow is coming from.  
Public PropertyFromArrowEndPointGets the point at the tip of the arrowhead at the start of this stroke.  
Public PropertyFromArrowFilledGets or sets whether the arrowhead at the start of this stroke is filled with the brush.  
Public PropertyFromArrowLengthGets or sets the length of the arrowhead at the start of this stroke.  
Public PropertyFromArrowShaftLengthGets or sets the length of the shaft of the arrowhead at the start of this stroke.  
Public PropertyFromArrowStyleGets or sets the general shape of an arrowhead at the start of this stroke.  
Public PropertyFromArrowWidthGets or sets the maximum width of the arrowhead at the start of this stroke.  
Public PropertyHeightGets or sets this object's height. (Inherited from Northwoods.Go.GoObject)
Public PropertyHighlightGets or sets whether this stroke displays a highlight along its path.  
Public PropertyHighlightPenGets or sets the pen used to draw a highlight for this stroke.  
Public PropertyHighlightPenColorGets or sets the color of the HighlightPen.  
Public PropertyHighlightPenWidthGets or sets the width of the line drawn as the highlight for the stroke.  
Public PropertyHighlightWhenSelectedGets or sets whether the highlight is shown when this stroke becomes selected.  
Public PropertyLastPickIndexGets the index of the last point that should get a selection handle.  
Public PropertyLayerGets the layer to which this object belongs. (Inherited from Northwoods.Go.GoObject)
Public PropertyLeftGets or sets this object's left coordinate, the X position. (Inherited from Northwoods.Go.GoObject)
Public PropertyLocationGets or sets this object's natural position. (Inherited from Northwoods.Go.GoObject)
Public PropertyMovableGets or sets whether the user can move this object. (Inherited from Northwoods.Go.GoObject)
Public PropertyObserversGets an enumerator over the list of observer objects of this object. (Inherited from Northwoods.Go.GoObject)
Public PropertyParentGets the parent group for this object. (Inherited from Northwoods.Go.GoObject)
Public PropertyPenGets or sets the pen used to draw the outline of this shape. (Inherited from Northwoods.Go.GoShape)
Public PropertyPenColorGets or sets the color of the pen. (Inherited from Northwoods.Go.GoShape)
Public PropertyPenWidthGets or sets the width of the pen. (Inherited from Northwoods.Go.GoShape)
Public PropertyPickMarginGets the approximate width of the region across the stroke, in addition to the pen width, that is still considered "inside" the stroke when picking.  
Public PropertyPointsCountGets the number of points in this stroke.  
Public PropertyPrintableGets or sets whether the view can print this object. (Inherited from Northwoods.Go.GoObject)
Public PropertyReshapableGets or sets whether the user can reshape this object. (Inherited from Northwoods.Go.GoObject)
Public PropertyResizableGets or sets whether the user can resize this object. (Inherited from Northwoods.Go.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.Go.GoObject)
Public PropertyRightGets or sets this object's right coordinate. (Inherited from Northwoods.Go.GoObject)
Public PropertySelectableGets or sets whether the user can select this object. (Inherited from Northwoods.Go.GoObject)
Public PropertySelectionObjectGets the object that gets selection handles when this object is selected. (Inherited from Northwoods.Go.GoObject)
Public PropertyShadowedGets or sets whether this object is painted with a drop shadow. (Inherited from Northwoods.Go.GoObject)
Public PropertyStyleGets or sets the kind of curve drawn using this stroke's points.  
Public PropertyToArrowGets or sets whether an arrow is drawn at the end of this stroke.  
Public PropertyToArrowAnchorPointGets a point which specifies the direction the arrow is coming from.  
Public PropertyToArrowEndPointGets the point at the tip of the arrowhead at the end of this stroke.  
Public PropertyToArrowFilledGets or sets whether the arrowhead at the end of this stroke is filled with the brush.  
Public PropertyToArrowLengthGets or sets the length of the arrowhead at the end of this stroke.  
Public PropertyToArrowShaftLengthGets or sets the length of the shaft of the arrowhead at the end of this stroke.  
Public PropertyToArrowStyleGets or sets the general shape of an arrowhead at the end of this stroke.  
Public PropertyToArrowWidthGets or sets the maximum width of the arrowhead at the end of this stroke.  
Public PropertyTopGets or sets this object's top coordinate, the Y position. (Inherited from Northwoods.Go.GoObject)
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.Go.GoObject)
Public PropertyVisibleGets or sets whether the user can see this object. (Inherited from Northwoods.Go.GoObject)
Public PropertyWidthGets or sets this object's width. (Inherited from Northwoods.Go.GoObject)
Top
Public Methods
 NameDescription
Public MethodAddObserverRegister an object as an observer of changes to this object. (Inherited from Northwoods.Go.GoObject)
Public MethodAddPointOverloaded. Add another point to the end of this stroke.  
Public MethodAddSelectionHandlesOverridden. Display the appropriate selected appearance, normally resize selection handles at each point of the stroke.  
Public MethodCalculateArrowheadModify an array of points to hold the four points of a polygon outlining an arrowhead  
Public MethodCanCopyCalled to see if the user can copy this object. (Inherited from Northwoods.Go.GoObject)
Public MethodCanDeleteCalled to see if the user can delete this object. (Inherited from Northwoods.Go.GoObject)
Public MethodCanEditCalled to see if the user can edit this object. (Inherited from Northwoods.Go.GoObject)
Public MethodCanMoveCalled to see if the user can move this object. (Inherited from Northwoods.Go.GoObject)
Public MethodCanPrintCalled to see if the view can print this object. (Inherited from Northwoods.Go.GoObject)
Public MethodCanReshapeCalled to see if the user can reshape this object. (Inherited from Northwoods.Go.GoObject)
Public MethodCanResizeCalled to see if the user can resize this object. (Inherited from Northwoods.Go.GoObject)
Public MethodCanSelectCalled to see if the user can select this object. (Inherited from Northwoods.Go.GoObject)
Public MethodCanViewCalled to see if the user can see this object. (Inherited from Northwoods.Go.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.Go.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.Go.GoObject)
Public MethodClearPointsRemove all of the points for this stroke.  
Public MethodComputeMoveCalculate a new location for this object. (Inherited from Northwoods.Go.GoObject)
Public MethodComputeResizeCalculate a new bounding rectangle for this object. (Inherited from Northwoods.Go.GoObject)
Public MethodContainedByRectangleConsider the Pen width when determining if this shape is inside a rectangle. (Inherited from Northwoods.Go.GoShape)
Public MethodContainsPointOverridden. A point is in a stroke only if it is near one of its segments.  
Public MethodCopyThis convenience method just makes a copy of the object itself, using a generic GoCopyDictionary. (Inherited from Northwoods.Go.GoObject)
Public MethodCopyNewValueForRedoOverridden. Copies state to permit a redo.  
Public MethodCopyObjectOverridden. Make sure the cloned stroke does not share any data references with the original stroke.  
Public MethodCopyObjectDelayedFor objects that require a second pass to complete the copying, this method is called after the first pass of copying all of the objects in CopyFromCollection(IGoCollection). (Inherited from Northwoods.Go.GoObject)
Public MethodCopyOldValueForUndoOverridden. Copies state to permit an undo.  
Public MethodCopyPointsArrayReturns a copy of the array of points in this stroke.  
Public MethodCreateBoundingHandleCreate a bounding handle for this object. (Inherited from Northwoods.Go.GoObject)
Public MethodCreateEditorCreate a GoControl that implements an editor for this object in the given view. (Inherited from Northwoods.Go.GoObject)
Public MethodCreateResizeHandleCreate a resize handle for this object, given a handle ID. (Inherited from Northwoods.Go.GoObject)
Public MethodDoBeginEditStart editing this object in the given view. (Inherited from Northwoods.Go.GoObject)
Public MethodDoEndEditStop editing this object in the given view. (Inherited from Northwoods.Go.GoObject)
Public MethodDoMoveCalled when a user moves this object. (Inherited from Northwoods.Go.GoObject)
Public MethodDoResizeOverridden. When the resize handles are at each point of the stroke, the user's dragging of a resize handle should just change that point in the stroke.  
Public MethodExpandPaintBoundsOverridden. Consider Pen width, miter limit, drop shadow and highlight in computing the paint bounds.  
Public MethodFillDoubleEdgeOverloaded. Set the 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.Go.GoShape)
Public MethodFillEllipseGradientOverloaded. Set the 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.Go.GoShape)
Public MethodFillHalfGradientOverloaded. Set the 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.Go.GoShape)
Public MethodFillMiddleGradientOverloaded. Set the 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.Go.GoShape)
Public MethodFillRectangleGradientOverloaded. Set the 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.Go.GoShape)
Public MethodFillShadedGradientOverloaded. Set the 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.Go.GoShape)
Public MethodFillShapeFringeOverloaded. Set the Brush to be a path shaped gradient starting with the start color, with most of the center being Color.White. (Inherited from Northwoods.Go.GoShape)
Public MethodFillShapeGradientOverloaded. Set the Brush to be a path shaped gradient with the color color surrounding a very light version of that color. (Inherited from Northwoods.Go.GoShape)
Public MethodFillShapeHighlightOverloaded. Set the Brush to be a path shaped gradient that is mostly the start color, with a white "highlight". (Inherited from Northwoods.Go.GoShape)
Public MethodFillSimpleGradientOverloaded. Set the Brush to be a simple vertical linear gradient using the given color. (Inherited from Northwoods.Go.GoShape)
Public MethodFillSingleEdgeOverloaded. Set the Brush to be a vertical linear gradient starting with the start color, with most of the center being Color.White. (Inherited from Northwoods.Go.GoShape)
Public Methodstatic (Shared in Visual Basic)GetAngleReturn the angle of the line going from the origin to a point.  
Public MethodGetArrowheadPointsCountGets the number of points to be used in the polygon representing an arrowhead.  
Public MethodGetContextMenuCalled to get a GoContextMenu to display for this object. (Inherited from Northwoods.Go.GoObject)
Public MethodGetContextMenuStripCalled to get a ContextMenuStrip to display for this object. (Inherited from Northwoods.Go.GoObject)
Public MethodGetCursorNameCalled by OnMouseOver to determine the cursor, if any, to display over this object. (Inherited from Northwoods.Go.GoObject)
Public MethodGetNearestIntersectionPointOverridden. The closest intersection point of a stroke with a line is the closest such point for each of its segments.  
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.Go.GoObject)
Public MethodGetPointGet the point at a particular index.  
Public MethodGetRectangleSpotLocationGet the position of a spot in a rectangle. (Inherited from Northwoods.Go.GoObject)
Public MethodGetSegmentNearPointReturn the index of the first point of a segment of this stroke that is close to a given point.  
Public MethodGetShadowBrushGet a Brush for painting a drop shadow in the given view. (Inherited from Northwoods.Go.GoObject)
Public MethodGetShadowOffsetGets the size of a drop shadow for this object in the given view. (Inherited from Northwoods.Go.GoObject)
Public MethodGetShadowPenGet a Pen for painting a drop shadow in the given view. (Inherited from Northwoods.Go.GoObject)
Public MethodGetSpotLocationGet the position of a spot on this object. (Inherited from Northwoods.Go.GoObject)
Public MethodGetToolTipCalled to get a String to display as a tooltip for this object. (Inherited from Northwoods.Go.GoObject)
Public MethodInsertPointAdd a point at a particular index, thereby increasing the number of points by one.  
Public MethodInvalidateViewsCause all views to repaint this object when they get a chance. (Inherited from Northwoods.Go.GoObject)
Public MethodIsChildOfDetermines if this object is a child, perhaps indirectly, of the given object. (Inherited from Northwoods.Go.GoObject)
Public MethodMakePathOverridden. Returns a GraphicsPath representation of what will be drawn.  
Public Methodstatic (Shared in Visual Basic)NearestIntersectionOnLineFind the intersection point of the finite line segment A-B and the infinite line P-Q that is closest to point P.  
Public Methodstatic (Shared in Visual Basic)NearestPointOnLineReturn a point on a straight line segment that is closest to a given point.  
Public MethodOnContextClickCalled when the user context clicks on this object. (Inherited from Northwoods.Go.GoObject)
Public MethodOnDoubleClickCalled when the user double clicks on this object. (Inherited from Northwoods.Go.GoObject)
Public MethodOnEnterLeaveCalled when the document object immediately under the mouse changes as the mouse moves when no particular tool is running or when the GoToolDragging tool is running. (Inherited from Northwoods.Go.GoObject)
Public MethodOnGotSelectionCalled when this object becomes selected. (Inherited from Northwoods.Go.GoObject)
Public MethodOnHoverCalled when the user hovers over this object. (Inherited from Northwoods.Go.GoObject)
Public MethodOnLostSelectionCalled when this object becomes unselected. (Inherited from Northwoods.Go.GoObject)
Public MethodOnMouseOverCalled when the user moves the mouse over this object when not dragging or resizing. (Inherited from Northwoods.Go.GoObject)
Public MethodOnSelectionDroppedCalled after the user has dropped the selection on this object. (Inherited from Northwoods.Go.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.Go.GoObject)
Public MethodOnSingleClickCalled when the user single clicks on this object. (Inherited from Northwoods.Go.GoObject)
Public MethodPaintOverridden. A stroke is drawn as a sequence of straight line segments or Bezier curves, with optional arrows at the ends.  
Public MethodPickReturn an object at a point, perhaps only a selectable one. (Inherited from Northwoods.Go.GoObject)
Public MethodRemoveThis convenience method just removes this object from its container, if there is any. (Inherited from Northwoods.Go.GoObject)
Public MethodRemoveObserverMake sure an object is not an observer of changes to this object. (Inherited from Northwoods.Go.GoObject)
Public MethodRemovePointRemove the point at a particular index, thereby reducing the number of points by one.  
Public MethodRemoveSelectionHandlesOverridden. Besides removing all selection handles, we also turn off any highlighting if HighlightWhenSelected is true.  
Public MethodSetPointReplace the point at a particular index;  
Public MethodSetPointsReplace all of the points for this stroke.  
Public MethodSetRectangleSpotLocationModify a rectangle such that its new spot location is at a given point. (Inherited from Northwoods.Go.GoObject)
Public MethodSetSizeKeepingLocationSets a new size for this object while maintaining the same location. (Inherited from Northwoods.Go.GoObject)
Public MethodSetSpotLocationOverloaded. Move this object so this object's given spot is at the given location. (Inherited from Northwoods.Go.GoObject)
Public MethodSpotOppositeGet the spot that is on the opposite side of a given spot. (Inherited from Northwoods.Go.GoObject)
Top
Protected Methods
 NameDescription
Protected MethodComputeBoundsOverridden. The bounding rectangle of a stroke is computed as the smallest rectangle that includes all of the stroke's points.  
Protected MethodDrawArrowheadThis method is called by Paint to actually draw an arrowhead.  
Protected MethodGetPathGets a cached GraphicsPath produced by a call to MakePath. (Inherited from Northwoods.Go.GoShape)
Protected MethodOnBoundsChangedOverridden. Changing the bounds of a stroke may change all of the stroke's points.  
Protected MethodOnLayerChangedCalled when this object's layer is changed. (Inherited from Northwoods.Go.GoObject)
Protected MethodOnObservedChangedCalled when an observed object has been changed. (Inherited from Northwoods.Go.GoObject)
Protected MethodOnParentChangedCalled when this object's parent is changed. (Inherited from Northwoods.Go.GoObject)
Protected MethodResetPathClear any cached GraphicsPath. (Inherited from Northwoods.Go.GoShape)
Top
See Also

Reference

GoStroke Class
Northwoods.Go Namespace

 

 


© 2015. Northwoods Software Corporation. All Rights Reserved.

Send Feedback