Class OrgLineConnector
OrgLine connector is used to create Org chart diagram connector.
Implements
Inherited Members
Namespace: Syncfusion.Windows.Forms.Diagram
Assembly: Syncfusion.Diagram.Base.dll
Syntax
public class OrgLineConnector : ConnectorBase, IUnitIndependent, IDispatchNodeEvents, ISerializable, INode, ICloneable, IServiceReferenceHolder, IServiceReferenceProvider, IPropertyObserver, IPropertyContainer, IServiceProvider, IGraphNode, IDeserializationCallback, IDisposable, IEndPointContainer, IGraphEdgeConstructors
OrgLineConnector(OrgLineConnector)
Initializes a new instance of the OrgLineConnector class.
Declaration
public OrgLineConnector(OrgLineConnector src)Parameters
| Type | Name | Description |
|---|---|---|
| OrgLineConnector | src | The source instance. |
OrgLineConnector(PointF, PointF)
Initializes a new instance of the OrgLineConnector class.
Declaration
public OrgLineConnector(PointF start, PointF end)Parameters
| Type | Name | Description |
|---|---|---|
| System.Drawing.PointF | start | The start. |
| System.Drawing.PointF | end | The end. |
OrgLineConnector(PointF, PointF, MeasureUnits)
Initializes a new instance of the OrgLineConnector class.
Declaration
public OrgLineConnector(PointF start, PointF end, MeasureUnits units)Parameters
| Type | Name | Description |
|---|---|---|
| System.Drawing.PointF | start | The start. |
| System.Drawing.PointF | end | The end. |
| MeasureUnits | units | The units. |
OrgLineConnector(PointF, PointF, Boolean)
Initializes a new instance of the OrgLineConnector class.
Declaration
public OrgLineConnector(PointF ptStart, PointF ptEnd, bool edge)Parameters
| Type | Name | Description |
|---|---|---|
| System.Drawing.PointF | ptStart | The tail end point location. |
| System.Drawing.PointF | ptEnd | The head end point location. |
| System.Boolean | edge | true if the edge should be round; otherwise, false. |
OrgLineConnector(PointF, PointF, Boolean, Single)
Initializes a new instance of the OrgLineConnector class.
Declaration
public OrgLineConnector(PointF ptStart, PointF ptEnd, bool edge, float curveRadius)Parameters
| Type | Name | Description |
|---|---|---|
| System.Drawing.PointF | ptStart | The tail end point location. |
| System.Drawing.PointF | ptEnd | The head end point location. |
| System.Boolean | edge | true if the edge should be round; otherwise, false. |
| System.Single | curveRadius | Radius of the curve. |
OrgLineConnector(SerializationInfo, StreamingContext)
Initializes a new instance of the OrgLineConnector class.
Declaration
protected OrgLineConnector(SerializationInfo info, StreamingContext context)Parameters
| Type | Name | Description |
|---|---|---|
| System.Runtime.Serialization.SerializationInfo | info | The info. |
| System.Runtime.Serialization.StreamingContext | context | The context. |
Properties
CurveRadius
Gets or sets the radius of the curve.
Declaration
public float CurveRadius { get; set; }Property Value
| Type |
|---|
| System.Single |
VerticalDistance
Gets or sets the vertical distance of this connector.
Declaration
public float VerticalDistance { get; set; }Property Value
| Type |
|---|
| System.Single |
Methods
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 |
|
Overrides
Clone()
Clones this OrgLineConnector instance
Declaration
public override object Clone()Returns
| Type | Description |
|---|---|
| System.Object | The cloned object. |
Overrides
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
DoHandleMoveRelated(IHandle, SizeF)
Does the handle move related. It will calculate path points between tail and head endpoint
Declaration
protected override void DoHandleMoveRelated(IHandle handleMoved, SizeF szOffset)Parameters
| Type | Name | Description |
|---|---|---|
| IHandle | handleMoved | The handle moved. |
| System.Drawing.SizeF | szOffset | The size offset. |
Overrides
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
DoPinOffsetRelatedActions(SizeF, SizeF)
Performs pin offset related actions.
Declaration
protected override void DoPinOffsetRelatedActions(SizeF szOldPinOffset, SizeF szNewPinOffset)Parameters
| Type | Name | Description |
|---|---|---|
| System.Drawing.SizeF | szOldPinOffset | Old pin offset |
| System.Drawing.SizeF | szNewPinOffset | New pin offset |
Overrides
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
FilterControlPoints(ref PointF[])
Filters the unwanted control points
Declaration
protected void FilterControlPoints(ref PointF[] ptsPath)Parameters
| Type | Name | Description |
|---|---|---|
| System.Drawing.PointF[] | ptsPath | path points |
FinishSetPoints()
Finishes the set points operation.
Declaration
protected override void FinishSetPoints()Overrides
GetObjectData(SerializationInfo, StreamingContext)
Add the values to the serialization.
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
InitializeOrgLine(PointF, PointF)
Initializes the orthogonal.
Declaration
protected void InitializeOrgLine(PointF ptStart, PointF ptEnd)Parameters
| Type | Name | Description |
|---|---|---|
| System.Drawing.PointF | ptStart | The start point location. |
| System.Drawing.PointF | ptEnd | The end point location. |
IsHeadConnected()
Determines whether HeadEndPoints is connected
Declaration
protected override bool IsHeadConnected()Returns
| Type | Description |
|---|---|
| System.Boolean | true - if HeadEndPoints is connected otherwise - false. |
Overrides
IsTailConnected()
Determines whether TailEndPoints is connected
Declaration
protected override bool IsTailConnected()Returns
| Type | Description |
|---|---|
| System.Boolean | true - if TailEndPoints is connected otherwise - false. |
Overrides
MergeControlPoints()
Merges the control points placed in line.
Declaration
protected override void MergeControlPoints()Overrides
Remarks
Used with handle moving.
MergeControlPoints(ref PointF[])
Merges the control points placed in line.
Declaration
protected override void MergeControlPoints(ref PointF[] ptsNew)Parameters
| Type | Name | Description |
|---|---|---|
| System.Drawing.PointF[] | ptsNew | New points |
Overrides
Remarks
Used with line segment move.
MergeSegements()
Updates the looping segments of the connector
Declaration
[Obsolete("Use MergeSegments")]
public void MergeSegements()MergeSegments()
Updates the looping segments of the connector
Declaration
public void MergeSegments()SyncEndPointsWithPort()
Synchronize head and tail end points with port if need.
Declaration
protected override void SyncEndPointsWithPort()Overrides
UpdateSegments()
Updates connector's segments.
Declaration
protected override void UpdateSegments()Overrides
Exceptions
| Type | Condition |
|---|---|
| System.ArgumentOutOfRangeException | If handles count less that pathPoints count. |
ValidateOffset(Int32, ref SizeF)
Validates the offset.
Declaration
protected override void ValidateOffset(int lineSegmentIndex, ref SizeF szOffset)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | lineSegmentIndex | Index of the line segment. |
| System.Drawing.SizeF | szOffset | The move offset. |