Class LineRouter

A line router provides line routing services for a diagram. model.

Inheritance
System.Object
LineRouter
AStarLineRouter
Implements
System.Runtime.Serialization.ISerializable
Namespace: Syncfusion.Windows.Forms.Diagram
Assembly: Syncfusion.Diagram.Base.dll
Syntax
public abstract class LineRouter : Component, ISerializable

Constructors

LineRouter()

Initializes a new instance of the LineRouter class.

Declaration
public LineRouter()

LineRouter(Model)

Initializes a new instance of the LineRouter class.

Declaration
public LineRouter(Model model)
Parameters
Type Name Description
Model model

Model to attach line router to

LineRouter(SerializationInfo, StreamingContext)

Initializes a new instance of the LineRouter class.

Declaration
protected LineRouter(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_bInAction

Indicates whether line routing engine is updating routes right now.

Declaration
protected bool m_bInAction
Field Value
Type Description
System.Boolean

Properties

DistanceToObstacles

Gets or sets distance to obstacles.

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

Model

Gets or sets model the line router is attached to. Increased when Model.BeginUpdate() is called and decreased when Model.EndUpdate() is called.

Declaration
public Model Model { get; set; }
Property Value
Type Description
Model

RoutingMode

Gets or sets routing mode.

Declaration
public RoutingMode RoutingMode { get; set; }
Property Value
Type Description
RoutingMode

UpdateRequests

Gets or sets the update requests.

Declaration
protected int UpdateRequests { get; set; }
Property Value
Type Description
System.Int32

The update requests.

Methods

Dispose(Boolean)

Declaration
protected override void Dispose(bool disposing)
Parameters
Type Name Description
System.Boolean disposing

GetObjectData(SerializationInfo, StreamingContext)

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

Declaration
public virtual 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.
Exceptions
Type Condition
System.Security.SecurityException

The caller does not have the required permission.

RouteAllModelConnectors()

Reroutes all model connectors.

Declaration
public void RouteAllModelConnectors()

RouteConnector(ConnectorBase)

Route given connection.

Declaration
public void RouteConnector(ConnectorBase connector)
Parameters
Type Name Description
ConnectorBase connector

Connection to route.

RouteConnectors(ICollection)

Route given collection of nodes

Declaration
public void RouteConnectors(ICollection connectors)
Parameters
Type Name Description
System.Collections.ICollection connectors

Collections to route

SetNewModel(Model)

Set new model to the instance.

Declaration
protected virtual void SetNewModel(Model newValue)
Parameters
Type Name Description
Model newValue

The new model.

Subscribe(Model)

Subscribe to events of the model

Declaration
protected void Subscribe(Model model)
Parameters
Type Name Description
Model model

Model to subscribe to.

Unsubscribe(Model)

Unsubscribe from all events when node could change it location or size.

Declaration
protected void Unsubscribe(Model model)
Parameters
Type Name Description
Model model

Model to unsubscribe from.

Implements

System.Runtime.Serialization.ISerializable

Extension Methods