Class OrthogonalConnector
Line connector that contains horizontal and vertical line segments.
Implements
Inherited Members
Namespace: Syncfusion.Windows.Forms.Diagram
Assembly: Syncfusion.Diagram.Base.dll
Syntax
public class OrthogonalConnector : ConnectorBase, IUnitIndependent, IDispatchNodeEvents, ISerializable, INode, ICloneable, IServiceProvider, IServiceReferenceHolder, IServiceReferenceProvider, IPropertyObserver, IPropertyContainer, IGraphNode, IDeserializationCallback, IDisposable, IEndPointContainer, IGraphEdge
Constructors
OrthogonalConnector(OrthogonalConnector)
Initializes a new instance of the OrthogonalConnector class.
Declaration
public OrthogonalConnector(OrthogonalConnector src)
Parameters
| Type | Name | Description |
|---|---|---|
| OrthogonalConnector | src | The connector source. |
OrthogonalConnector(PointF, PointF)
Initializes a new instance of the OrthogonalConnector class.
Declaration
public OrthogonalConnector(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. |
OrthogonalConnector(PointF, PointF, MeasureUnits)
Initializes a new instance of the OrthogonalConnector class.
Declaration
public OrthogonalConnector(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 | The measure units. |
OrthogonalConnector(PointF, PointF, MeasureUnits, Boolean)
Initializes a new instance of the OrthogonalConnector class.
Declaration
public OrthogonalConnector(PointF ptStart, PointF ptEnd, MeasureUnits measureUnits, bool flip)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Drawing.PointF | ptStart | The start point. |
| System.Drawing.PointF | ptEnd | The end point. |
| MeasureUnits | measureUnits | The measure units. |
| System.Boolean | flip | true if path should be flipped; otherwise, false. |
OrthogonalConnector(PointF, PointF, Boolean)
Initializes a new instance of the OrthogonalConnector class.
Declaration
public OrthogonalConnector(PointF ptStart, PointF ptEnd, bool flip)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Drawing.PointF | ptStart | The tail end point location. |
| System.Drawing.PointF | ptEnd | The head end point location. |
| System.Boolean | flip | true if path should be flipped; otherwise, false. |
OrthogonalConnector(PointF, PointF, Boolean, Boolean)
Initializes a new instance of the OrthogonalConnector class.
Declaration
public OrthogonalConnector(PointF ptStart, PointF ptEnd, bool flip, bool roundCorner)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Drawing.PointF | ptStart | The tail end point location. |
| System.Drawing.PointF | ptEnd | The head end point location. |
| System.Boolean | flip | true if path should be flipped; otherwise, false. |
| System.Boolean | roundCorner | true if corner should be rounded; otherwise, false. |
OrthogonalConnector(SerializationInfo, StreamingContext)
Initializes a new instance of the OrthogonalConnector class.
Declaration
protected OrthogonalConnector(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 |
MoveConnectedSegments
Gets or sets a value indicating whether connected segments are movable.
Declaration
public bool MoveConnectedSegments { get; set; }
Property Value
| Type |
|---|
| System.Boolean |
RotationAngle
orthogonal connector is not rotatable.
Declaration
public override float RotationAngle { get; set; }
Property Value
| Type |
|---|
| System.Single |
Overrides
Methods
CanChangePoints(PointF[])
Determines whether this points can locate in current model.
Declaration
protected override bool CanChangePoints(PointF[] pts)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Drawing.PointF[] | pts | The points. |
Returns
| Type | Description |
|---|---|
| System.Boolean |
|
Overrides
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
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 |
|
Overrides
Clone()
Clones this instance.
Declaration
public override object Clone()
Returns
| Type | Description |
|---|---|
| System.Object | A new object that is a copy of this instance. |
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.
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
EventSink_PropertyChanged(PropertyChangedEventArgs)
Raise when node property changed.
Declaration
protected override void EventSink_PropertyChanged(PropertyChangedEventArgs evtArgs)
Parameters
| Type | Name | Description |
|---|---|---|
| PropertyChangedEventArgs | evtArgs | The PropertyChangedEventArgs instance containing the event data. |
Overrides
FilterControlPoints(ref PointF[])
Filters the control points.
Declaration
protected void FilterControlPoints(ref PointF[] ptsPath)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Drawing.PointF[] | ptsPath | The path points. |
FinishSetPoints()
Finishes the set points operation.
Declaration
protected override void FinishSetPoints()
Overrides
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
InitializeOrthogonalLine(PointF[])
Initializes the orthogonal.
Declaration
protected void InitializeOrthogonalLine(PointF[] pts)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Drawing.PointF[] | pts | The array of points. |
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()
PreparePathPointsForInsert(Int32, PointF)
Prepares new path points
Declaration
protected override PointF[] PreparePathPointsForInsert(int ptIdx, PointF val)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | ptIdx | The point index. |
| System.Drawing.PointF | val | The point. |
Returns
| Type | Description |
|---|---|
| System.Drawing.PointF[] | The new path points. |
Overrides
Remarks
You should override this method if custom login needed (e.g. - if you are inserting point into orthogonal line -> two points must be inserted!)
SyncEndPointsWithPort()
Synchronize head and tail end points with port if need.
Declaration
protected override void SyncEndPointsWithPort()
Overrides
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 bounds rectangle. |
Overrides
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
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. |