WinForms

Upgrade Guide User Guide Demos Support Forums Download
  • Upgrade Guide
  • User Guide
  • Demos
  • Support
  • Forums
  • Download
Class ConnectorBase - WindowsForms API Reference | Syncfusion

    Show / Hide Table of Contents

    Class ConnectorBase

    Template connector class that contains Head and Tail EndPoints, CompassHeadings, Segments and Bridges.

    Inheritance
    System.Object
    Node
    PathNode
    LineBase
    ConnectorBase
    LineConnector
    OrgLineConnector
    OrthogonalConnector
    Implements
    IUnitIndependent
    IDispatchNodeEvents
    System.Runtime.Serialization.ISerializable
    INode
    System.ICloneable
    IServiceReferenceHolder
    IServiceReferenceProvider
    IPropertyObserver
    IPropertyContainer
    System.IServiceProvider
    IGraphNode
    System.Runtime.Serialization.IDeserializationCallback
    System.IDisposable
    IEndPointContainer
    IGraphEdge
    Inherited Members
    LineBase.ShowResizeHandles()
    LineBase.Render(Graphics)
    LineBase.DrawDecorators(Graphics)
    LineBase.UpdateHelperRegion()
    LineBase.DrawDecoratorsShadow(Graphics)
    LineBase.GetDecoratorTransfrom(PointF, PointF, Single)
    LineBase.GetTailDecoratorTransformations()
    LineBase.GetHeadDecoratorTransformations()
    LineBase.InitBoundsInfo(RectangleF)
    LineBase.SynchronizeEndPoint(EndPoint, SizeF)
    LineBase.HeadDecorator
    LineBase.TailDecorator
    PathNode.m_bCanChangePath
    PathNode.m_bIsVertexEditable
    PathNode.m_maxPoints
    PathNode.m_minPoints
    PathNode.m_gpPath
    PathNode.RenderContiguousData(Graphics)
    PathNode.OnMouseEnter(EventArgs)
    PathNode.OnMouseLeave(EventArgs)
    PathNode.IsControlPointValid(ControlPoint)
    PathNode.HandleMove(IHandle, SizeF)
    PathNode.TransformControlPoints(Matrix)
    PathNode.UpdateSegmentsRegion()
    PathNode.UpdatePathNodeData()
    PathNode.GetPathPoints(Matrix)
    PathNode.CreateGraphicsPath(PointF[])
    PathNode.UpdateBoundsInfo(RectangleF)
    PathNode.PreparePathPointsForInsert(Int32, PointF)
    PathNode.GetAdjacentPathPoint(PointF, Boolean, Boolean, PointF)
    PathNode.CanMoveHandle(IHandle)
    PathNode.GetControlPoints()
    PathNode.DrawControlPoints(Graphics)
    PathNode.DrawControlPoint(Graphics, ControlPoint, SizeF, Pen, Brush)
    PathNode.GetControlPointAt(PointF)
    PathNode.GetControlPointAt(Int32)
    PathNode.GetControlPointByID(Int32)
    PathNode.TryCombine(GraphicsPath, Boolean)
    PathNode.CanCombine(GraphicsPath)
    PathNode.GetPoints(Boolean)
    PathNode.GetPoints()
    PathNode.SetPoints(PointF[], Boolean)
    PathNode.SetPoints(PointF[])
    PathNode.GetPoint(Int32)
    PathNode.GetPoint(Int32, Boolean)
    PathNode.SetPoint(Int32, PointF, Boolean)
    PathNode.SetPoint(Int32, PointF)
    PathNode.AddPoint(PointF, Boolean)
    PathNode.AddPoint(PointF)
    PathNode.InsertPoint(Int32, PointF, Boolean)
    PathNode.RemovePoint(Int32)
    PathNode.GetLineSegmentAtPoint(PointF)
    PathNode.GetLineSegmentPoints(Int32)
    PathNode.MoveLineSegment(Int32, SizeF)
    PathNode.ValidateOffset(Int32, SizeF)
    PathNode.UpdateControlPoints(PointF[], Int32)
    PathNode.UpdateNonLineBoundsInfo(RectangleF)
    PathNode.GetNewBounds(PointF[])
    PathNode.GetNewPathBounds(PointF[])
    PathNode.UpdatePathLocation(GraphicsPath, RectangleF)
    PathNode.IsPathVertexEditable(GraphicsPath)
    PathNode.RecordVertexChanged(VertexChangeType, Int32, PointF)
    PathNode.OnVertexChanging(VertexChangeType, Int32, PointF)
    PathNode.OnVertexChanged(VertexChangeType, Int32, PointF)
    PathNode.CanChangePoints(PointF[])
    PathNode.Labels
    PathNode.LogicalGraphicsPath
    PathNode.PointCount
    PathNode.LineSegmentCount
    PathNode.MinPoints
    PathNode.MaxPoints
    PathNode.CanChangePath
    PathNode.IsVertexEditable
    PathNode.PathPoints
    PathNode.PathPointsRelative
    PathNode.ControlPoints
    Node.m_rgnCache
    Node.m_fRotationAngle
    Node.m_mgrHistory
    Node.m_eventSink
    Node.m_mgrLink
    Node.m_mgrBridge
    Node.m_bLockUpdate
    Node.m_rectRefresh
    Node.m_bPortUpdating
    Node.ISerializable.GetObjectData(SerializationInfo, StreamingContext)
    Node.Clone()
    Node.UpdateServiceReferences(IServiceReferenceProvider)
    Node.ProvideServiceReference(RuntimeTypeHandle)
    Node.GetPropertyContainerByName(String)
    Node.OnPropertyChanging(String, String, Object)
    Node.OnPropertyChanged(String, String)
    Node.Draw(Graphics)
    Node.Draw(Graphics, Boolean)
    Node.PrepareGraphics(Graphics)
    Node.ContainsPoint(PointF)
    Node.Translate(Single, Single, MeasureUnits)
    Node.Translate(Single, Single)
    Node.Rotate(Single)
    Node.Scale(Single, Single)
    Node.AppendFlipTransforms(Matrix)
    Node.AppendLocalFlipTransforms(Matrix)
    Node.GetTransformations()
    Node.GetLocalTransformations()
    Node.GetParentTransformation(Boolean)
    Node.AppendFlipTransforms(Matrix, PointF, Boolean, Boolean)
    Node.GetTransformations(PointF, SizeF, Single)
    Node.OnMeasurementUnitsChanging(MeasureUnits)
    Node.QuiteBoundarySet(Boolean)
    Node.SafeHistoryPause()
    Node.SafeHistoryResume()
    Node.UpdateBoundingRectangle()
    Node.GetNodeBounds(Boolean, Boolean)
    Node.GetRectBounds(Boolean, Boolean)
    Node.GetPathBounds()
    Node.UpdateRefreshRect()
    Node.UpdateRefreshRect(RectangleF, Matrix)
    Node.GetScaleTransformation()
    Node.ConvertToNodeCoordinates(PointF)
    Node.ConvertToModelCoordinates(PointF)
    Node.Move(Single, Single)
    Node.SetPinOffset(SizeF, SizeF)
    Node.SetSize(SizeF, SizeF)
    Node.LogicalUnitChange(GraphicsUnit)
    Node.CanWiden(GraphicsPath)
    Node.OnMouseClick(EventArgs)
    Node.OnMouseDoubleClick(EventArgs)
    Node.SetPinPoint(PointF, MeasureUnits)
    Node.EventSink_PropertyChanging(PropertyChangingEventArgs)
    Node.CreateBoundsInfo()
    Node.CreateBoundsInfo(PointF, SizeF, SizeF)
    Node.CreateBoundsInfo(BoundsInfo)
    Node.CreateBoundsInfo(BoundsInfo, PageScale)
    Node.UpdatePortPositions(SizeF, SizeF)
    Node.UpdateContainerBounds()
    Node.CanUpdateConnections(EndPoint)
    Node.IsClosedPath(GraphicsPath)
    Node.GetBoundsRect(Node)
    Node.UpdateGraphicsPath(SizeF, SizeF)
    Node.GetUpperLeftPoint(MeasureUnits)
    Node.RecordPropertyChanged(String)
    Node.CheckConstrainingRegion(PointF)
    Node.CheckConstrainingRegion(RectangleF)
    Node.GetService(Type)
    Node.IUnitIndependent.GetPinPoint(MeasureUnits)
    Node.IUnitIndependent.GetSize(MeasureUnits)
    Node.IUnitIndependent.GetPinPointOffset(MeasureUnits)
    Node.IUnitIndependent.GetBoundingRectangle(MeasureUnits, Boolean)
    Node.IUnitIndependent.SetPinPoint(PointF, MeasureUnits)
    Node.IUnitIndependent.SetSize(SizeF, MeasureUnits)
    Node.IUnitIndependent.SetPinPointOffset(SizeF, MeasureUnits)
    Node.IDispatchNodeEvents.Click(EventArgs)
    Node.IDispatchNodeEvents.DoubleClick(EventArgs)
    Node.IDispatchNodeEvents.MouseEnter(EventArgs)
    Node.IDispatchNodeEvents.MouseLeave(EventArgs)
    Node.IDeserializationCallback.OnDeserialization(Object)
    Node.AllowLabelDrag
    Node.TreatAsObstacle
    Node.PrintPorts
    Node.DrawPorts
    Node.Ports
    Node.ZOrder
    Node.EnableCentralPort
    Node.CentralPort
    Node.Tag
    Node.ExcludeFromLayout
    Node.IsExpanded
    Node.Name
    Node.FullName
    Node.Container
    Node.Parent
    Node.Root
    Node.Visible
    Node.Layers
    Node.LineHitTestPadding
    Node.MeasurementUnit
    Node.InheritContainerMeasureUnits
    Node.GraphicsPath
    Node.HistoryManager
    Node.EventSink
    Node.PropertyBag
    Node.ToolTipText
    Node.RefreshRect
    Node.BoundingRect
    Node.BoundsInfo
    Node.BoundingRectangle
    Node.Size
    Node.PinPointOffset
    Node.PinPoint
    Node.NodeScale
    Node.ShadowStyle
    Node.LineStyle
    Node.EditStyle
    Node.FullContainerName
    Node.INode.Root
    Node.Edges
    Node.EdgesEntering
    Node.EdgesLeaving
    System.Object.ToString()
    System.Object.Equals(System.Object)
    System.Object.Equals(System.Object, System.Object)
    System.Object.ReferenceEquals(System.Object, System.Object)
    System.Object.GetHashCode()
    System.Object.GetType()
    System.Object.MemberwiseClone()
    Namespace: Syncfusion.Windows.Forms.Diagram
    Assembly: Syncfusion.Diagram.Base.dll
    Syntax
    public abstract class ConnectorBase : LineBase, IUnitIndependent, IDispatchNodeEvents, ISerializable, INode, ICloneable, IServiceReferenceHolder, IServiceReferenceProvider, IPropertyObserver, IPropertyContainer, IServiceProvider, IGraphNode, IDeserializationCallback, IDisposable, IEndPointContainer, IGraphEdge

    Constructors

    ConnectorBase(ConnectorBase)

    Initializes a new instance of the ConnectorBase class.

    Declaration
    public ConnectorBase(ConnectorBase src)
    Parameters
    Type Name Description
    ConnectorBase src

    The source connector.

    ConnectorBase(PointF, PointF)

    Initializes a new instance of the ConnectorBase class.

    Declaration
    public ConnectorBase(PointF ptStart, PointF ptEnd)
    Parameters
    Type Name Description
    System.Drawing.PointF ptStart

    The tail end point location.

    System.Drawing.PointF ptEnd

    The head end point location.

    ConnectorBase(PointF, PointF, MeasureUnits)

    Initializes a new instance of the ConnectorBase class.

    Declaration
    public ConnectorBase(PointF ptStart, PointF ptEnd, MeasureUnits measureUnits)
    Parameters
    Type Name Description
    System.Drawing.PointF ptStart

    The tail end point location.

    System.Drawing.PointF ptEnd

    The head end point location.

    MeasureUnits measureUnits

    Specifies points measure units.

    ConnectorBase(SerializationInfo, StreamingContext)

    Initializes a new instance of the ConnectorBase class.

    Declaration
    protected ConnectorBase(SerializationInfo info, StreamingContext context)
    Parameters
    Type Name Description
    System.Runtime.Serialization.SerializationInfo info

    The serialization info.

    System.Runtime.Serialization.StreamingContext context

    The streaming context.

    Fields

    m_bLineBridgingEnabled

    Flag used to enable line bridging.

    Declaration
    protected bool m_bLineBridgingEnabled
    Field Value
    Type Description
    System.Boolean

    m_bLockHandleMove

    Flag what use for lock handle moving while EditStyle.AllowRotate = false;

    Declaration
    protected bool m_bLockHandleMove
    Field Value
    Type Description
    System.Boolean

    m_fLineBridgeSize

    Line bridge size.

    Declaration
    protected float m_fLineBridgeSize
    Field Value
    Type Description
    System.Single

    m_lineSegments

    Collection of segments with bridges.

    Declaration
    protected ArrayList m_lineSegments
    Field Value
    Type Description
    System.Collections.ArrayList

    Properties

    BridgeStyle

    Gets or sets bridge style.

    Declaration
    public BridgeStyle BridgeStyle { get; set; }
    Property Value
    Type Description
    BridgeStyle

    ConnectorState

    Gets or sets the state of the connector.

    Declaration
    public ConnectorState ConnectorState { get; set; }
    Property Value
    Type Description
    ConnectorState

    The state of the connector.

    EdgeWeight

    Gets weight value associated with the edge.

    Declaration
    public int EdgeWeight { get; }
    Property Value
    Type Description
    System.Int32

    EnableRoundedCorner

    Gets or sets the edge type of the connector.

    Declaration
    public bool EnableRoundedCorner { get; set; }
    Property Value
    Type Description
    System.Boolean

    The edge of the connector.

    FlipX

    Gets or sets a value indicating whether flip X is enable.

    Declaration
    public override bool FlipX { get; set; }
    Property Value
    Type Description
    System.Boolean

    true if node vertical flipped; otherwise, false.

    Overrides
    Node.FlipX

    FlipY

    Gets or sets a value indicating whether flip Y is enable.

    Declaration
    public override bool FlipY { get; set; }
    Property Value
    Type Description
    System.Boolean

    true if node horizontal flipped; otherwise, false.

    Overrides
    Node.FlipY

    FromNode

    Gets node connected to the tail of the edge.

    Declaration
    public IGraphNode FromNode { get; }
    Property Value
    Type Description
    IGraphNode

    HeadEndPoint

    Gets the head end point.

    Declaration
    public EndPoint HeadEndPoint { get; }
    Property Value
    Type Description
    EndPoint

    The head end point.

    HeadingDistance

    Gets or sets the distance from heading to obstacle node.

    Declaration
    public float HeadingDistance { get; set; }
    Property Value
    Type Description
    System.Single

    The heading distance.

    HeadingHead

    Gets or sets the heading head.

    Declaration
    public CompassHeading HeadingHead { get; set; }
    Property Value
    Type Description
    CompassHeading

    The heading head.

    HeadingTail

    Gets or sets the heading tail.

    Declaration
    public CompassHeading HeadingTail { get; set; }
    Property Value
    Type Description
    CompassHeading

    The heading tail.

    LineBridgingEnabled

    Gets or sets a value indicating whether line bridging is enabled for this connector only.

    Declaration
    public bool LineBridgingEnabled { get; set; }
    Property Value
    Type Description
    System.Boolean
    Remarks

    Used by BridgeManager to check if current segment can contains bridges.

    LineRoutingEnabled

    Gets or sets a value indicating whether that line routing is enabled.

    Declaration
    public bool LineRoutingEnabled { get; set; }
    Property Value
    Type Description
    System.Boolean

    LineSegments

    Gets the collection of ConnectorLineSegment items.

    Declaration
    public ArrayList LineSegments { get; }
    Property Value
    Type Description
    System.Collections.ArrayList

    The collection of ConnectorLineSegment items.

    RotationAngle

    Gets or sets the rotation angle.

    Declaration
    public override float RotationAngle { get; set; }
    Property Value
    Type Description
    System.Single

    The rotation angle in range [ -180; 180 ].

    Overrides
    Node.RotationAngle
    Remarks

    Rotation angle saved in rotation range [ -180; 180 ] But on set this property new rotation angle must be in range [ 0; 360 ]

    TailEndPoint

    Gets the tail end point.

    Declaration
    public EndPoint TailEndPoint { get; }
    Property Value
    Type Description
    EndPoint

    The tail end point.

    ToNode

    Gets node connected to the head of the edge.

    Declaration
    public IGraphNode ToNode { get; }
    Property Value
    Type Description
    IGraphNode

    Methods

    AccumulateRefreshRect(ref RectangleF)

    Accumulates the refresh rect.

    Declaration
    protected override void AccumulateRefreshRect(ref RectangleF rcRefresh)
    Parameters
    Type Name Description
    System.Drawing.RectangleF rcRefresh

    The refresh rectangle.

    Overrides
    LineBase.AccumulateRefreshRect(ref RectangleF)

    BeforeMoveSegment(ref PointF[])

    Helper method used to perform additional actions before updating path node data. Used by Connectors to merge control points.

    Declaration
    protected override void BeforeMoveSegment(ref PointF[] ptsNew)
    Parameters
    Type Name Description
    System.Drawing.PointF[] ptsNew

    The new path points.

    Overrides
    PathNode.BeforeMoveSegment(ref PointF[])

    CanDrawControlPoints()

    Determines whether this node can draw control points.

    Declaration
    public override bool CanDrawControlPoints()
    Returns
    Type Description
    System.Boolean

    true if this node can draw control points; otherwise, false.

    Overrides
    PathNode.CanDrawControlPoints()

    CanEditControlPoint()

    Determines whether this node can edit control points.

    Declaration
    public override bool CanEditControlPoint()
    Returns
    Type Description
    System.Boolean

    true if this node can edit control points; otherwise, false.

    Overrides
    PathNode.CanEditControlPoint()

    CanEditSegment()

    Determines whether this node can edit segments.

    Declaration
    public override bool CanEditSegment()
    Returns
    Type Description
    System.Boolean

    true if this node can edit segments; otherwise, false.

    Overrides
    PathNode.CanEditSegment()

    CanEditVertexPoint()

    Determines whether this node can edit vertex points.

    Declaration
    public override bool CanEditVertexPoint()
    Returns
    Type Description
    System.Boolean

    true if this node can edit vertex point; otherwise, false.

    Overrides
    PathNode.CanEditVertexPoint()

    CanMoveHandle(IHandle, PointF)

    Determines whether this node allow move it handle.

    Declaration
    public override bool CanMoveHandle(IHandle handle, PointF ptNewLocation)
    Parameters
    Type Name Description
    IHandle handle

    The handle to move.

    System.Drawing.PointF ptNewLocation

    The new endpoint location to check.

    Returns
    Type Description
    System.Boolean

    true if this node allow move it handle; otherwise, false.

    Overrides
    PathNode.CanMoveHandle(IHandle, PointF)

    ChangeFlipX(Boolean)

    Called after change the flipX value.

    Declaration
    protected override void ChangeFlipX(bool value)
    Parameters
    Type Name Description
    System.Boolean value

    New flipX value.

    Overrides
    Node.ChangeFlipX(Boolean)

    ChangeFlipY(Boolean)

    Called after change the flipY value.

    Declaration
    protected override void ChangeFlipY(bool value)
    Parameters
    Type Name Description
    System.Boolean value

    New flipY value.

    Overrides
    Node.ChangeFlipY(Boolean)

    ChangeRotationBy(Single)

    Called after change the rotation by give angle.

    Declaration
    protected override void ChangeRotationBy(float fRotationChange)
    Parameters
    Type Name Description
    System.Single fRotationChange

    The rotation angle offset.

    Overrides
    Node.ChangeRotationBy(Single)

    CheckLineSegmentIntersect(PointF, PointF, PointF, PointF, out PointF)

    Checks the line segment intersect.

    Declaration
    protected bool CheckLineSegmentIntersect(PointF ptStart1, PointF ptEnd1, PointF ptStart2, PointF ptEnd2, out PointF ptIntersect)
    Parameters
    Type Name Description
    System.Drawing.PointF ptStart1

    The first start point.

    System.Drawing.PointF ptEnd1

    The first end point.

    System.Drawing.PointF ptStart2

    The second start point.

    System.Drawing.PointF ptEnd2

    The pt second end point.

    System.Drawing.PointF ptIntersect

    The intersection point.

    Returns
    Type Description
    System.Boolean

    true, if line segment intersect.

    CheckNewPinPoint(PointF, MeasureUnits)

    Checks the new pin point.

    Declaration
    protected override bool CheckNewPinPoint(PointF ptPinPoint, MeasureUnits unit)
    Parameters
    Type Name Description
    System.Drawing.PointF ptPinPoint

    The pin point.

    MeasureUnits unit

    The unit.

    Returns
    Type Description
    System.Boolean

    true if this value can set; otherwise, false.

    Overrides
    Node.CheckNewPinPoint(PointF, MeasureUnits)

    ContainsHandle(IHandle)

    Determines whether the node contains specific handle.

    Declaration
    public override bool ContainsHandle(IHandle handle)
    Parameters
    Type Name Description
    IHandle handle

    The handle.

    Returns
    Type Description
    System.Boolean

    true if the handle contains specific handle; otherwise, false.

    Overrides
    PathNode.ContainsHandle(IHandle)

    CreateLogicalGraphicsPath(PointF[])

    Creates node's path with given array of points.

    Declaration
    protected override GraphicsPath CreateLogicalGraphicsPath(PointF[] pts)
    Parameters
    Type Name Description
    System.Drawing.PointF[] pts

    Points to create path from.

    Returns
    Type Description
    System.Drawing.Drawing2D.GraphicsPath

    Created GraphicsPath, otherwise null.

    Overrides
    PathNode.CreateLogicalGraphicsPath(PointF[])

    Dispose()

    Declaration
    public override void Dispose()
    Overrides
    LineBase.Dispose()

    DoHandleMoveRelated(IHandle, SizeF)

    Perfoms additional changes on handle move.

    Declaration
    protected override void DoHandleMoveRelated(IHandle handleMoved, SizeF szOffset)
    Parameters
    Type Name Description
    IHandle handleMoved

    The moved handle .

    System.Drawing.SizeF szOffset

    The move offset.

    Overrides
    PathNode.DoHandleMoveRelated(IHandle, SizeF)

    DoMoveRelatedActions(Single, Single)

    Performs additional changes on pin position changed.

    Declaration
    protected override void DoMoveRelatedActions(float fX, float fY)
    Parameters
    Type Name Description
    System.Single fX

    The pin offset by x axis.

    System.Single fY

    The pin offset by y axis.

    Overrides
    Node.DoMoveRelatedActions(Single, Single)

    DoPinOffsetRelatedActions(SizeF, SizeF)

    Performs additional changes on pin offset value changed.

    Declaration
    protected override void DoPinOffsetRelatedActions(SizeF szOldPinOffset, SizeF szNewPinOffset)
    Parameters
    Type Name Description
    System.Drawing.SizeF szOldPinOffset

    The old pin offset value.

    System.Drawing.SizeF szNewPinOffset

    The new pin offset value.

    Overrides
    Node.DoPinOffsetRelatedActions(SizeF, SizeF)

    DoSizeRelatedActions(SizeF, SizeF)

    Used to update child nodes sizes.

    Declaration
    protected override void DoSizeRelatedActions(SizeF szOldSize, SizeF szNewSize)
    Parameters
    Type Name Description
    System.Drawing.SizeF szOldSize

    The old size.

    System.Drawing.SizeF szNewSize

    The new size.

    Overrides
    PathNode.DoSizeRelatedActions(SizeF, SizeF)

    DrawPath(Graphics)

    Draws line in graphics.

    Declaration
    protected override void DrawPath(Graphics gfx)
    Parameters
    Type Name Description
    System.Drawing.Graphics gfx

    The graphics.

    Overrides
    LineBase.DrawPath(Graphics)

    DrawSegment(Graphics, ConnectorLineSegment)

    Draws the line segment to specified graphics.

    Declaration
    protected void DrawSegment(Graphics gfx, ConnectorLineSegment segment)
    Parameters
    Type Name Description
    System.Drawing.Graphics gfx

    Graphics to on.

    ConnectorLineSegment segment

    The segment.

    EventSink_PropertyChanged(PropertyChangedEventArgs)

    Raise when node property is changed.

    Declaration
    protected override void EventSink_PropertyChanged(PropertyChangedEventArgs evtArgs)
    Parameters
    Type Name Description
    PropertyChangedEventArgs evtArgs

    The PropertyChangedEventArgs instance containing the event data.

    Overrides
    Node.EventSink_PropertyChanged(PropertyChangedEventArgs)

    FinishSetPoints()

    Finishes the set points operation.

    Declaration
    protected override void FinishSetPoints()
    Overrides
    PathNode.FinishSetPoints()

    GetAllConnectors(ICompositeNode)

    Gets all connectors in composite nodes in deep.

    Declaration
    protected NodeCollection GetAllConnectors(ICompositeNode composite)
    Parameters
    Type Name Description
    ICompositeNode composite

    The composite node.

    Returns
    Type Description
    NodeCollection

    The NodeCollection.

    GetAllPorts(ICompositeNode)

    Declaration
    protected ArrayList GetAllPorts(ICompositeNode composite)
    Parameters
    Type Name Description
    ICompositeNode composite
    Returns
    Type Description
    System.Collections.ArrayList

    GetHandleAt(Int32)

    Gets the handle by index of pathPoints.

    Declaration
    protected IHandle GetHandleAt(int nIndex)
    Parameters
    Type Name Description
    System.Int32 nIndex

    Index of handle in points list.

    Returns
    Type Description
    IHandle

    Handle by path points index.

    Exceptions
    Type Condition
    System.ArgumentOutOfRangeException

    If index less that zero or larger that handle count.

    GetLineBridgeSize()

    Gets the length of the line bridge.

    Declaration
    protected float GetLineBridgeSize()
    Returns
    Type Description
    System.Single

    The bridge length.

    GetLineSegmentAt(Int32)

    Gets the line segment by it index.

    Declaration
    public override LineSegment GetLineSegmentAt(int nSegmentIndex)
    Parameters
    Type Name Description
    System.Int32 nSegmentIndex

    Index of the segment.

    Returns
    Type Description
    LineSegment

    Line segment

    Overrides
    LineBase.GetLineSegmentAt(Int32)

    GetObjectData(SerializationInfo, StreamingContext)

    Gets the object data.

    Declaration
    protected override void GetObjectData(SerializationInfo info, StreamingContext context)
    Parameters
    Type Name Description
    System.Runtime.Serialization.SerializationInfo info

    The serialization info.

    System.Runtime.Serialization.StreamingContext context

    The streaming context.

    Overrides
    LineBase.GetObjectData(SerializationInfo, StreamingContext)

    GetPathPoints()

    Retrieves array of points needed to construct node's GraphicsPath.

    Declaration
    protected override PointF[] GetPathPoints()
    Returns
    Type Description
    System.Drawing.PointF[]

    Array of path points

    Overrides
    PathNode.GetPathPoints()

    GetPropertyContainer(String)

    Gets the property container.

    Declaration
    protected override object GetPropertyContainer(string strPropertyContainerName)
    Parameters
    Type Name Description
    System.String strPropertyContainerName

    Name of the STR property container.

    Returns
    Type Description
    System.Object

    The property container object.

    Overrides
    LineBase.GetPropertyContainer(String)

    InsertPoint(Int32, PointF)

    Inserts the point to the PathNode at the specified index.

    Declaration
    public override void InsertPoint(int ptIdx, PointF val)
    Parameters
    Type Name Description
    System.Int32 ptIdx

    The zero-based index ar which ptIdx should be inserted.

    System.Drawing.PointF val

    The point in local coordinates.

    Overrides
    PathNode.InsertPoint(Int32, PointF)

    IntersectSegmentWith(Int32, NodeCollection)

    Updates the connectors intersecting.

    Declaration
    public void IntersectSegmentWith(int segmentIndex, NodeCollection nodes)
    Parameters
    Type Name Description
    System.Int32 segmentIndex

    Index of the segment.

    NodeCollection nodes

    The collection of Node items.

    IsConnected()

    Determines whether this line is connected.

    Declaration
    protected virtual bool IsConnected()
    Returns
    Type Description
    System.Boolean

    true if this line is connected; otherwise, false.

    IsHeadConnected()

    Determines whether HeadEdnPoints is connected

    Declaration
    protected virtual bool IsHeadConnected()
    Returns
    Type Description
    System.Boolean

    true - if HeadEndPoints is connected otherwise - false.

    IsLineBridgingEnabled()

    Determines whether the Model.Bridging is enable.

    Declaration
    protected bool IsLineBridgingEnabled()
    Returns
    Type Description
    System.Boolean

    true if model.bridging is enable; otherwise, false.

    IsNodeEntering(IGraphNode)

    Determines if this edge is entering the given node.

    Declaration
    public bool IsNodeEntering(IGraphNode graphNode)
    Parameters
    Type Name Description
    IGraphNode graphNode

    Node to test.

    Returns
    Type Description
    System.Boolean

    True if edge is entering the given node.

    IsNodeLeaving(IGraphNode)

    Determines if this edge is leaving the given node.

    Declaration
    public bool IsNodeLeaving(IGraphNode graphNode)
    Parameters
    Type Name Description
    IGraphNode graphNode

    Node to test.

    Returns
    Type Description
    System.Boolean

    True if edge is leaving the given node.

    IsTailConnected()

    Determines whether TailEdnPoints is connected

    Declaration
    protected virtual bool IsTailConnected()
    Returns
    Type Description
    System.Boolean

    true - if TailEndPoints is connected otherwise - false.

    LengthenLine(PointF, ref PointF, Single)

    Draws the curve for the line

    Declaration
    public void LengthenLine(PointF startPoint, ref PointF endPoint, float pixelCount)
    Parameters
    Type Name Description
    System.Drawing.PointF startPoint

    start point

    System.Drawing.PointF endPoint

    end point

    System.Single pixelCount

    curve radius

    MergeControlPoints()

    Merges the control points placed in line.

    Declaration
    protected virtual void MergeControlPoints()
    Remarks

    Used with handle moving.

    MergeControlPoints(ref PointF[])

    Merges the control points placed in line.

    Declaration
    protected virtual void MergeControlPoints(ref PointF[] ptsNew)
    Parameters
    Type Name Description
    System.Drawing.PointF[] ptsNew

    The new points.

    Remarks

    Used with line segment move.

    MergeNearBridges(ref Int32, Bridge, ConnectorLineSegment, ref Single, ref Single)

    Merges the near bridges.

    Declaration
    protected void MergeNearBridges(ref int nIndex, Bridge bridge, ConnectorLineSegment lineSegment, ref float fOffsetHelper, ref float fBridgeOffset)
    Parameters
    Type Name Description
    System.Int32 nIndex

    Index of the bridge.

    Bridge bridge

    The bridge.

    ConnectorLineSegment lineSegment

    The line segment.

    System.Single fOffsetHelper

    The bridegSize helper.

    System.Single fBridgeOffset

    The bridge offset.

    MoveEndPoints(SizeF)

    Moves the end points to given offset.

    Declaration
    protected virtual void MoveEndPoints(SizeF szOffset)
    Parameters
    Type Name Description
    System.Drawing.SizeF szOffset

    The move offset.

    MoveSegment(Int32, SizeF)

    Moves the segment to given offset.

    Declaration
    protected override PointF[] MoveSegment(int lineSegmentIndex, SizeF szOffset)
    Parameters
    Type Name Description
    System.Int32 lineSegmentIndex

    Index of the line segment.

    System.Drawing.SizeF szOffset

    The segment move offset.

    Returns
    Type Description
    System.Drawing.PointF[]

    The points to offset.

    Overrides
    PathNode.MoveSegment(Int32, SizeF)

    OnDeserialized()

    Called when node is deserialized.

    Declaration
    protected override void OnDeserialized()
    Overrides
    PathNode.OnDeserialized()

    OnNodeScaleChanged(String)

    Called when node scale factor is changed.

    Declaration
    protected override void OnNodeScaleChanged(string strPropertyName)
    Parameters
    Type Name Description
    System.String strPropertyName

    The property name that change scale factor value.

    Overrides
    PathNode.OnNodeScaleChanged(String)

    OnParentChanged()

    Called when parent changed.

    Declaration
    protected override void OnParentChanged()
    Overrides
    Node.OnParentChanged()

    OnParentChanging()

    Called when parent property changed.

    Declaration
    protected override void OnParentChanging()
    Overrides
    Node.OnParentChanging()

    SetControlPoints(PointF[], Int32)

    Set the control points location.

    Declaration
    protected override void SetControlPoints(PointF[] ptsPath, int nStartIndex)
    Parameters
    Type Name Description
    System.Drawing.PointF[] ptsPath

    The points path.

    System.Int32 nStartIndex

    Index of the beginning control path points.

    Overrides
    PathNode.SetControlPoints(PointF[], Int32)

    SetEndPoints(PointF[])

    Updates EndPoints locations.

    Declaration
    protected void SetEndPoints(PointF[] ptsPath)
    Parameters
    Type Name Description
    System.Drawing.PointF[] ptsPath

    New path points.

    SyncEndPointsWithPort()

    Synchronize head and tail end points with port if need.

    Declaration
    protected virtual void SyncEndPointsWithPort()

    UpdateGraphicsPath(PointF[])

    Updates node's GraphicsPath on given array of points.

    Declaration
    protected override void UpdateGraphicsPath(PointF[] pts)
    Parameters
    Type Name Description
    System.Drawing.PointF[] pts

    The new path points array.

    Overrides
    PathNode.UpdateGraphicsPath(PointF[])

    UpdateReferences(IServiceReferenceProvider)

    Updates the references.

    Declaration
    public override void UpdateReferences(IServiceReferenceProvider provider)
    Parameters
    Type Name Description
    IServiceReferenceProvider provider

    The provider.

    Overrides
    LineBase.UpdateReferences(IServiceReferenceProvider)

    UpdateSegments()

    Updates connector's segments.

    Declaration
    protected virtual void UpdateSegments()
    Remarks

    Update using path points and related handles to create new segments.

    Implements

    IUnitIndependent
    IDispatchNodeEvents
    System.Runtime.Serialization.ISerializable
    INode
    System.ICloneable
    IServiceReferenceHolder
    IServiceReferenceProvider
    IPropertyObserver
    IPropertyContainer
    System.IServiceProvider
    IGraphNode
    System.Runtime.Serialization.IDeserializationCallback
    System.IDisposable
    IEndPointContainer
    IGraphEdge
    Back to top Generated by DocFX
    Copyright © 2001 - 2021 Syncfusion Inc. All Rights Reserved