Class EndPoint

The bases connector endPoint handle class that implement moving, protection and serialization. Used by ConnectorBase and Line that implemented IEndPointContainer interface.

Inheritance
System.Object
PropertyContainer
EndPoint
HeadEndPoint
TailEndPoint
Implements
System.ICloneable
System.Runtime.Serialization.ISerializable
System.IDisposable
Inherited Members
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 EndPoint : PropertyContainer, IServiceReferenceHolder, IServiceReferenceProvider, IPropertyObserver, IPropertyContainer, ICloneable, ISerializable, IDisposable, IHandle
Remarks

Used as base class for HeadEndPoint and TailEndPoint classes.

Constructors

EndPoint(EndPoint)

Initializes a new instance of the EndPoint class.

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

The source instance.

EndPoint(PathNode, PointF)

Initializes a new instance of the EndPoint class.

Declaration
public EndPoint(PathNode container, PointF ptLocation)
Parameters
Type Name Description
PathNode container

The PathNode container.
System.Drawing.PointF ptLocation

The handle location in parent coordinates.

EndPoint(SerializationInfo, StreamingContext)

Initializes a new instance of the EndPoint class.

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

The info.
System.Runtime.Serialization.StreamingContext context

The context.

Properties

AllowMoveX

Gets or sets a value indicating whether handle can move by X axis.

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

true if handle can move by X axis; otherwise, false.

AllowMoveY

Gets or sets a value indicating whether can move by Y axis.

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

true if handle can move by Y axis; otherwise, false.

Container

Gets or sets the end point container.

Declaration
public PathNode Container { get; set; }
Property Value
Type Description
PathNode

The PathNode container.

ID

Gets the EndPoint ID.

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

The ID.
Remarks

Always return 0.

InUpdate

Gets or sets a value indicating whether the handle is updating

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

true if handle is updating; otherwise, false.

IsMoving

Gets or sets a value indicating whether the handle is moving

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

true if handle is moving; otherwise, false.

Location

Gets or sets the endpoint location in parent coordinates.

Declaration
public PointF Location { get; set; }
Property Value
Type Description
System.Drawing.PointF

The location in parent coordinates.

Port

Gets or sets the port which end point is connected. Return null if end point isn't connected.

Declaration
public ConnectionPoint Port { get; set; }
Property Value
Type Description
ConnectionPoint

The port which end point is connected.

Methods

Dispose()

Declaration
public override void Dispose()
Overrides

GetHeading()

Get the heading to this end point taken from container.

Declaration
public CompassHeading GetHeading()
Returns
Type Description
CompassHeading

Current heading value.

GetObjectData(SerializationInfo, StreamingContext)

Populates a System.Runtime.Serialization.SerializationInfo with the data needed to serialize the target object.

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

The System.Runtime.Serialization.SerializationInfo to populate with data.
System.Runtime.Serialization.StreamingContext context

The destination (see System.Runtime.Serialization.StreamingContext) for this serialization.
Overrides
Exceptions
Type Condition
System.Security.SecurityException

The caller does not have the required permission.

Move(SizeF, MeasureUnits)

Move end point to the specified offset.

Declaration
public void Move(SizeF offset, MeasureUnits offsetUnits)
Parameters
Type Name Description
System.Drawing.SizeF offset

The move offset.
MeasureUnits offsetUnits

The offset units.

OnVertexChanged()

Called when vertex changed.

Declaration
protected void OnVertexChanged()

OnVertexChanging(PointF)

Called when vertex position changing.

Declaration
protected bool OnVertexChanging(PointF newValue)
Parameters
Type Name Description
System.Drawing.PointF newValue

The new position value.
Returns
Type Description
System.Boolean

SetLocation(PointF)

Sets the new location value.

Declaration
protected void SetLocation(PointF value)
Parameters
Type Name Description
System.Drawing.PointF value

The new value.

SyncPositionWithPort()

Synchronizes EndPoint position with connected ConnectionPoint.

Declaration
[Obsolete("This method is obsolete. Please use Model.LinkManager.SynchronizeEndPoint(EndPoint endpoint).")]
public void SyncPositionWithPort()

Implements

System.ICloneable
System.Runtime.Serialization.ISerializable
System.IDisposable