Class ConnectionPoint
The port bases class that use to connect end point to node. Collected in EndPointCollection collection in Node class.
Implements
Inherited Members
Namespace: Syncfusion.Windows.Forms.Diagram
Assembly: Syncfusion.Diagram.Base.dll
Syntax
public class ConnectionPoint : AnchoringPrimitive, IServiceReferenceHolder, IServiceReferenceProvider, IPropertyObserver, IPropertyContainer, ICloneable, ISerializable, IDisposable
Constructors
ConnectionPoint()
Initializes a new instance of the ConnectionPoint class.
Declaration
public ConnectionPoint()
ConnectionPoint(ConnectionPoint)
Initializes a new instance of the ConnectionPoint class.
Declaration
public ConnectionPoint(ConnectionPoint src)
Parameters
| Type | Name | Description |
|---|---|---|
| ConnectionPoint | src | The source instance. |
ConnectionPoint(Node, GraphicsPath)
Initializes a new instance of the ConnectionPoint class.
Declaration
public ConnectionPoint(Node container, GraphicsPath gpPortShape)
Parameters
| Type | Name | Description |
|---|---|---|
| Node | container | The node container. |
| System.Drawing.Drawing2D.GraphicsPath | gpPortShape | The port path shape. |
ConnectionPoint(SerializationInfo, StreamingContext)
Initializes a new instance of the ConnectionPoint class.
Declaration
public ConnectionPoint(SerializationInfo info, StreamingContext context)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Runtime.Serialization.SerializationInfo | info | The serialization info. |
| System.Runtime.Serialization.StreamingContext | context | The serialization context. |
Properties
AllowConnectOnDrag
Declaration
public bool AllowConnectOnDrag { get; set; }
Property Value
| Type |
|---|
| System.Boolean |
ConnectionPointSize
Size of the current ConnectionPoint. Calculated from port path shape.
Declaration
public ConnectionPointSize ConnectionPointSize { get; set; }
Property Value
| Type | Description |
|---|---|
| ConnectionPointSize | The size of the connection point. |
ConnectionPointType
Gets or sets the ConnectionPointType type of the connection point. Determine if port can connect to HeadEndPoint or TailEndPoint or both.
Declaration
public ConnectionPointType ConnectionPointType { get; set; }
Property Value
| Type | Description |
|---|---|
| ConnectionPointType | The type of the connection point. |
Connections
Gets the collection of connected EndPoint's.
Declaration
public EndPointCollection Connections { get; }
Property Value
| Type | Description |
|---|---|
| EndPointCollection | The EndPoint collection. |
ConnectionsLimit
Gets or sets the connections limit. Determine max connections count.
Declaration
public int ConnectionsLimit { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Int32 | The connections limit. |
FillStyle
Properties used to fill the interior.
Declaration
public FillStyle FillStyle { get; }
Property Value
| Type | Description |
|---|---|
| FillStyle | The fill style. |
Remarks
The fill style is used to create brushes for painting interior
FillStyleFullName
Gets or sets the unique connection point full name.
Declaration
public string FullName { get; }
Property Value
| Type | Description |
|---|---|
| System.String | The unique port full name. |
GraphicsPath
Gets or sets the graphics path. Return cloned graphics path instance.
Declaration
public GraphicsPath GraphicsPath { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Drawing.Drawing2D.GraphicsPath | The graphics path. |
HitTestPadding
Gets or sets the ConnectionPoint hit test padding.
Declaration
public float HitTestPadding { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Single | The connectionpoint hit test padding. |
LineStyle
Line drawing properties for this connection point.
Declaration
public LineStyle LineStyle { get; }
Property Value
| Type | Description |
|---|---|
| LineStyle | The line style. |
Remarks
The line style determines the configuration of the pen used to render lines. LineStyle
Name
Gets or sets the unique connection point name.
Declaration
public string Name { get; set; }
Property Value
| Type | Description |
|---|---|
| System.String | The unique port name. |
Size
Gets or sets the connection point size.
Declaration
public int Size { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Int32 | The size of the port. |
Tag
User-defined data associated with the object.
Declaration
public object Tag { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Object | The System.Object. |
Visible
Declaration
public bool Visible { get; set; }
Property Value
| Type |
|---|
| System.Boolean |
VisualType
VisualType contains PortVisualType for current ConnectionPoint.
Declaration
public PortVisualType VisualType { get; set; }
Property Value
| Type | Description |
|---|---|
| PortVisualType | The type of the visual shape. |
Methods
CanConnect(EndPoint)
Determines whether this instance can connect the specified end point.
Declaration
public bool CanConnect(EndPoint endPoint)
Parameters
| Type | Name | Description |
|---|---|---|
| EndPoint | endPoint | The end point. |
Returns
| Type | Description |
|---|---|
| System.Boolean |
|
CheckType(EndPoint)
Declaration
public bool CheckType(EndPoint endPoint)
Parameters
| Type | Name | Description |
|---|---|---|
| EndPoint | endPoint |
Returns
| Type |
|---|
| System.Boolean |
Clone()
Creates a new object that is a copy of the current instance.
Declaration
public override object Clone()
Returns
| Type | Description |
|---|---|
| System.Object | A new object that is a copy of this instance. |
Overrides
Connect(EndPoint)
Connect the specified end point.
Declaration
public void Connect(EndPoint endPoint)
Parameters
| Type | Name | Description |
|---|---|---|
| EndPoint | endPoint | The end point. |
Disconnect(EndPoint)
Disconnect from the specified end point.
Declaration
public void Disconnect(EndPoint endPoint)
Parameters
| Type | Name | Description |
|---|---|---|
| EndPoint | endPoint | The end point. |
DisconnectAll()
Disconnects from all connected endpoints.
Declaration
public void DisconnectAll()
Dispose()
Declaration
public override void Dispose()
Overrides
GetObjectData(SerializationInfo, StreamingContext)
Gets the object data to serialize instance.
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 serialization context. |
Overrides
GetPropertyContainerName()
Gets the name of the property container.
Declaration
protected override string GetPropertyContainerName()
Returns
| Type |
|---|
| System.String |
Overrides
PositionChange(Single, Single)
Calling when primitive position is changed.
Declaration
protected override void PositionChange(float fOffsetX, float fOffsetY)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Single | fOffsetX | The offset by X axis. |
| System.Single | fOffsetY | The offset by Y axis. |
Overrides
Render(Graphics)
Renders the primitive object to specified graphics.
Declaration
protected override void Render(Graphics gfx)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Drawing.Graphics | gfx | Graphics to draw on. |
Overrides
TryConnect(EndPoint)
Tries the connect to specified end point.
Declaration
public bool TryConnect(EndPoint endPoint)
Parameters
| Type | Name | Description |
|---|---|---|
| EndPoint | endPoint | The end point. |
Returns
| Type | Description |
|---|---|
| System.Boolean |
|
UpdateServiceReferences(IServiceReferenceProvider)
Updates the service references from service provider.
Declaration
public override void UpdateServiceReferences(IServiceReferenceProvider provider)
Parameters
| Type | Name | Description |
|---|---|---|
| IServiceReferenceProvider | provider | The service provider. |