Class Line

Line node that contains endpoints and control points. Can be used as connector.

Inheritance

System.Object

Node

PathNode

LineBase

Line

BezierCurve

MeasureLine

SplineNode

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.AccumulateRefreshRect(RectangleF)

LineBase.DrawDecorators(Graphics)

LineBase.DrawDecoratorsShadow(Graphics)

LineBase.DrawPath(Graphics)

LineBase.GetDecoratorTransfrom(PointF, PointF, Single)

LineBase.GetHeadDecoratorTransformations()

LineBase.GetTailDecoratorTransformations()

LineBase.HeadDecorator

LineBase.InitBoundsInfo(RectangleF)

LineBase.Render(Graphics)

LineBase.ShowResizeHandles()

LineBase.SynchronizeEndPoint(EndPoint, SizeF)

LineBase.TailDecorator

LineBase.UpdateHelperRegion()

Node.AllowLabelDrag

Node.AppendFlipTransforms(Matrix)

Node.AppendFlipTransforms(Matrix, PointF, Boolean, Boolean)

Node.AppendLocalFlipTransforms(Matrix)

Node.BoundingRectangle

Node.BoundsInfo

Node.CanUpdateConnections(EndPoint)

Node.CanWiden(GraphicsPath)

Node.CentralPort

Node.CheckConstrainingRegion(PointF)

Node.CheckConstrainingRegion(RectangleF)

Node.Container

Node.ContainsPoint(PointF)

Node.ConvertToModelCoordinates(PointF)

Node.ConvertToNodeCoordinates(PointF)

Node.CreateBoundsInfo(BoundsInfo)

Node.CreateBoundsInfo(BoundsInfo, PageScale)

Node.CreateBoundsInfo(PointF, SizeF, SizeF)

Node.Draw(Graphics)

Node.Draw(Graphics, Boolean)

Node.DrawPorts

Node.Edges

Node.EdgesEntering

Node.EdgesLeaving

Node.EditStyle

Node.EnableCentralPort

Node.EventSink

Node.EventSink_PropertyChanged(PropertyChangedEventArgs)

Node.EventSink_PropertyChanging(PropertyChangingEventArgs)

Node.ExcludeFromLayout

Node.FullContainerName

Node.FullName

Node.GetBoundsRect(Node)

Node.GetLocalTransformations()

Node.GetNodeBounds(Boolean, Boolean)

Node.GetParentTransformation(Boolean)

Node.GetPathBounds()

Node.GetPropertyContainerByName(String)

Node.GetRectBounds(Boolean, Boolean)

Node.GetScaleTransformation()

Node.GetService(Type)

Node.GetTransformations()

Node.GetTransformations(PointF, SizeF, Single)

Node.GetUpperLeftPoint(MeasureUnits)

Node.GraphicsPath

Node.HistoryManager

Node.IDeserializationCallback.OnDeserialization(Object)

Node.IDispatchNodeEvents.Click(EventArgs)

Node.IDispatchNodeEvents.DoubleClick(EventArgs)

Node.IDispatchNodeEvents.MouseEnter(EventArgs)

Node.IDispatchNodeEvents.MouseLeave(EventArgs)

Node.InheritContainerMeasureUnits

Node.INode.Root

Node.IsClosedPath(GraphicsPath)

Node.ISerializable.GetObjectData(SerializationInfo, StreamingContext)

Node.IsExpanded

Node.IUnitIndependent.GetBoundingRectangle(MeasureUnits, Boolean)

Node.IUnitIndependent.GetPinPoint(MeasureUnits)

Node.IUnitIndependent.GetPinPointOffset(MeasureUnits)

Node.IUnitIndependent.GetSize(MeasureUnits)

Node.IUnitIndependent.SetPinPoint(PointF, MeasureUnits)

Node.IUnitIndependent.SetPinPointOffset(SizeF, MeasureUnits)

Node.IUnitIndependent.SetSize(SizeF, MeasureUnits)

Node.Layers

Node.LineHitTestPadding

Node.LineStyle

Node.LogicalUnitChange(GraphicsUnit)

Node.m_bLockUpdate

Node.m_bPortUpdating

Node.m_eventSink

Node.m_fRotationAngle

Node.m_mgrBridge

Node.m_mgrHistory

Node.m_mgrLink

Node.m_rgnCache

Node.MeasurementUnit

Node.Move(Single, Single)

Node.Name

Node.NodeScale

Node.OnMeasurementUnitsChanging(MeasureUnits)

Node.OnMouseClick(EventArgs)

Node.OnMouseDoubleClick(EventArgs)

Node.OnParentChanged()

Node.OnParentChanging()

Node.OnPropertyChanged(String, String)

Node.OnPropertyChanging(String, String, Object)

Node.Parent

Node.PinPoint

Node.PinPointOffset

Node.Ports

Node.PrepareGraphics(Graphics)

Node.PrintPorts

Node.PropertyBag

Node.ProvideServiceReference(RuntimeTypeHandle)

Node.QuiteBoundarySet(Boolean)

Node.RecordPropertyChanged(String)

Node.RefreshRect

Node.Root

Node.Rotate(Single)

Node.SafeHistoryPause()

Node.SafeHistoryResume()

Node.Scale(Single, Single)

Node.SetPinOffset(SizeF, SizeF)

Node.SetPinPoint(PointF, MeasureUnits)

Node.SetSize(SizeF, SizeF)

Node.ShadowStyle

Node.Size

Node.Tag

Node.ToolTipText

Node.Translate(Single, Single)

Node.Translate(Single, Single, MeasureUnits)

Node.TreatAsObstacle

Node.UpdateBoundingRectangle()

Node.UpdateContainerBounds()

Node.UpdateGraphicsPath(SizeF, SizeF)

Node.UpdatePortPositions(SizeF, SizeF)

Node.UpdateRefreshRect()

Node.UpdateRefreshRect(RectangleF, Matrix)

Node.UpdateServiceReferences(IServiceReferenceProvider)

Node.Visible

Node.ZOrder

PathNode.AddPoint(PointF)

PathNode.AddPoint(PointF, Boolean)

PathNode.BeforeMoveSegment(PointF[])

PathNode.CanChangePath

PathNode.CanChangePoints(PointF[])

PathNode.CanCombine(GraphicsPath)

PathNode.CanMoveHandle(IHandle)

PathNode.CreateGraphicsPath(PointF[])

PathNode.DrawControlPoint(Graphics, ControlPoint, SizeF, Pen, Brush)

PathNode.DrawControlPoints(Graphics)

PathNode.FinishSetPoints()

PathNode.GetAdjacentPathPoint(PointF, Boolean, Boolean, PointF)

PathNode.GetControlPointAt(Int32)

PathNode.GetControlPointAt(PointF)

PathNode.GetControlPointByID(Int32)

PathNode.GetControlPoints()

PathNode.GetLineSegmentAtPoint(PointF)

PathNode.GetLineSegmentPoints(Int32)

PathNode.GetNewBounds(PointF[])

PathNode.GetNewPathBounds(PointF[])

PathNode.GetPathPoints(Matrix)

PathNode.GetPoint(Int32)

PathNode.GetPoint(Int32, Boolean)

PathNode.GetPoints()

PathNode.GetPoints(Boolean)

PathNode.HandleMove(IHandle, SizeF)

PathNode.InsertPoint(Int32, PointF)

PathNode.InsertPoint(Int32, PointF, Boolean)

PathNode.IsControlPointValid(ControlPoint)

PathNode.IsPathVertexEditable(GraphicsPath)

PathNode.IsVertexEditable

PathNode.Labels

PathNode.LineSegmentCount

PathNode.LogicalGraphicsPath

PathNode.m_maxPoints

PathNode.m_minPoints

PathNode.MaxPoints

PathNode.MinPoints

PathNode.MoveLineSegment(Int32, SizeF)

PathNode.MoveSegment(Int32, SizeF)

PathNode.OnDeserialized()

PathNode.OnMouseEnter(EventArgs)

PathNode.OnMouseLeave(EventArgs)

PathNode.OnVertexChanged(VertexChangeType, Int32, PointF)

PathNode.OnVertexChanging(VertexChangeType, Int32, PointF)

PathNode.PathPointsRelative

PathNode.PointCount

PathNode.PreparePathPointsForInsert(Int32, PointF)

PathNode.RecordVertexChanged(VertexChangeType, Int32, PointF)

PathNode.RemovePoint(Int32)

PathNode.RenderContiguousData(Graphics)

PathNode.SetControlPoints(PointF[], Int32)

PathNode.SetPoint(Int32, PointF)

PathNode.SetPoint(Int32, PointF, Boolean)

PathNode.SetPoints(PointF[])

PathNode.SetPoints(PointF[], Boolean)

PathNode.TransformControlPoints(Matrix)

PathNode.TryCombine(GraphicsPath, Boolean)

PathNode.UpdateControlPoints(PointF[], Int32)

PathNode.UpdateNonLineBoundsInfo(RectangleF)

PathNode.UpdatePathLocation(GraphicsPath, RectangleF)

PathNode.UpdatePathNodeData()

PathNode.UpdateSegmentsRegion()

PathNode.ValidateOffset(Int32, SizeF)

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Syncfusion.Windows.Forms.Diagram

Assembly: Syncfusion.Diagram.Base.dll

Syntax

public class Line : LineBase, IUnitIndependent, IDispatchNodeEvents, ISerializable, INode, ICloneable, IServiceReferenceHolder, IServiceReferenceProvider, IPropertyObserver, IPropertyContainer, IServiceProvider, IGraphNode, IDeserializationCallback, IDisposable, IEndPointContainer, IGraphEdge

Constructors

Line()

Initializes a new instance of the Line class.

Declaration

public Line()

Line(Line)

Initializes a new instance of the Line class.

Declaration

public Line(Line src)

Parameters

Type	Name	Description
Line	src	The Line instance.

Line(PointF, PointF)

Initializes a new instance of the Line class.

Declaration

public Line(PointF ptStart, PointF ptEnd)

Parameters

Type	Name	Description
System.Drawing.PointF	ptStart	The start point.
System.Drawing.PointF	ptEnd	The end point.

Line(PointF, PointF, MeasureUnits)

Initializes a new instance of the Line class.

Declaration

public Line(PointF ptStart, PointF ptEnd, MeasureUnits measureUnits)

Parameters

Type	Name	Description
System.Drawing.PointF	ptStart	The start point.
System.Drawing.PointF	ptEnd	The end point.
MeasureUnits	measureUnits	Specifies points measure units.

Line(PointF[])

Initializes a new instance of the Line class.

Declaration

public Line(PointF[] pts)

Parameters

Type	Name	Description
System.Drawing.PointF[]	pts	The array of points.

Line(PointF[], MeasureUnits)

Initializes a new instance of the Line class.

Declaration

public Line(PointF[] pts, MeasureUnits measureUnits)

Parameters

Type	Name	Description
System.Drawing.PointF[]	pts	The array of points.
MeasureUnits	measureUnits	Specifies points measure units.

Line(SerializationInfo, StreamingContext)

Initializes a new instance of the Line class.

Declaration

protected Line(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_endPointHead

Head end point.

Declaration

protected HeadEndPoint m_endPointHead

Field Value

Type
HeadEndPoint

m_endPointTail

Tail end point.

Declaration

protected TailEndPoint m_endPointTail

Field Value

Type
TailEndPoint

m_lineSegments

Collection of segments with bridges.

Declaration

protected ArrayList m_lineSegments

Field Value

Type
System.Collections.ArrayList

Properties

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
System.Int32

FlipX

Gets or sets a value indicating whether [flip X].

Declaration

public override bool FlipX { get; set; }

Property Value

Type	Description
System.Boolean	true if flip X; otherwise, false.

Overrides

Node.FlipX

FlipY

Gets or sets a value indicating whether [flip Y].

Declaration

public override bool FlipY { get; set; }

Property Value

Type	Description
System.Boolean	true if flip Y; otherwise, false.

Overrides

Node.FlipY

FromNode

Gets node connected to the tail of the edge.

Declaration

public IGraphNode FromNode { get; }

Property Value

Type
IGraphNode

HeadEndPoint

Gets the head end point handle.

Declaration

public EndPoint HeadEndPoint { get; }

Property Value

Type	Description
EndPoint	The head end point.

LineSegments

Gets the line segments list.

Declaration

protected ArrayList LineSegments { get; }

Property Value

Type	Description
System.Collections.ArrayList	The line segments.

RotationAngle

Gets or sets the rotation angle.

Declaration

public override float RotationAngle { get; set; }

Property Value

Type	Description
System.Single	The rotation angle.

Overrides

Node.RotationAngle

TailEndPoint

Gets the tail end point handle.

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
IGraphNode

Methods

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 flip x 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 flip y 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)

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)

Clone()

Clones this instance.

Declaration

public override object Clone()

Returns

Type	Description
System.Object	The cloned object

Overrides

Node.Clone()

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)

Called when node is moved.

Declaration

protected override void DoMoveRelatedActions(float fX, float fY)

Parameters

Type	Name	Description
System.Single	fX	The x offset.
System.Single	fY	The y offset.

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)

GetLineSegmentAt(Int32)

Gets the line segment by its index.

Declaration

public override LineSegment GetLineSegmentAt(int nSegmentIndex)

Parameters

Type	Name	Description
System.Int32	nSegmentIndex	Index of the segment.

Returns

Type	Description
LineSegment	The 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[]	The 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	Property container value.

Overrides

LineBase.GetPropertyContainer(String)

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.

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.

MergeControlPoints()

Merges the control points.

Declaration

protected void MergeControlPoints()

MergeControlPoints(ref PointF[])

Merges the control points.

Declaration

protected void MergeControlPoints(ref PointF[] ptsNew)

Parameters

Type	Name	Description
System.Drawing.PointF[]	ptsNew	The points.

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)

SetEndPoints(PointF[])

Updates EndPoints locations.

Declaration

protected void SetEndPoints(PointF[] ptsPath)

Parameters

Type	Name	Description
System.Drawing.PointF[]	ptsPath	New path points.

UpdateBoundsInfo(RectangleF)

Updates the Pin position, pin offset and size from new bounds rectangle.

Declaration

protected override void UpdateBoundsInfo(RectangleF rcBounds)

Parameters

Type	Name	Description
System.Drawing.RectangleF	rcBounds	The updated bounds.

Overrides

PathNode.UpdateBoundsInfo(RectangleF)

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 from PathPoints.

Declaration

protected void UpdateSegments()

UpdateSegments(PointF[])

Updates connector's segments.

Declaration

protected virtual void UpdateSegments(PointF[] ptsPoints)

Parameters

Type	Name	Description
System.Drawing.PointF[]	ptsPoints	The array of points.

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