Class LineBaseTool

The Line Base tool is used to implement the actions to create a graphical representation object of line shape in Diagram control.

Inheritance
System.Object
Tool
UITool
LineBaseTool
BezierTool
DirectedLineConnectorTool
LineConnectorTool
LineTool
OrgLineConnectorTool
OrthogonalConnectorTool
OrthogonalLineTool
Implements
System.IDisposable
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: Syncfusion.Windows.Forms.Diagram
Assembly: Syncfusion.Diagram.Windows.dll
Syntax
public abstract class LineBaseTool : UITool, IDisposable

Constructors

LineBaseTool(DiagramController, String)

Initializes a new instance of the LineBaseTool class.

Declaration
public LineBaseTool(DiagramController controller, string name)
Parameters
Type Name Description
DiagramController controller

The controller.
System.String name

The name.

Properties

HeadDecorator

Gets or sets Head Decorator applied to created node.

Declaration
public HeadDecorator HeadDecorator { get; set; }
Property Value
Type
HeadDecorator

HeadPossibleConnection

Gets or sets the head possible connection.

Declaration
protected ConnectionPoint HeadPossibleConnection { get; set; }
Property Value
Type Description
ConnectionPoint

The head possible connection.

RenderringHelper

Gets the rendering helper.

Declaration
protected Node RenderringHelper { get; }
Property Value
Type Description
Node

The rendering helper.

TailDecorator

Gets or sets Tail Decorator applied to created node.

Declaration
public TailDecorator TailDecorator { get; set; }
Property Value
Type
TailDecorator

TailPossibleConnection

Gets or sets the tail possible connection.

Declaration
protected ConnectionPoint TailPossibleConnection { get; set; }
Property Value
Type Description
ConnectionPoint

The tail possible connection.

Methods

CheckConnectionPossibility(PointF, out Boolean, Boolean)

Checks for connection possibility.

Declaration
protected ConnectionPoint CheckConnectionPossibility(PointF ptTest, out bool canConnectWithPort, bool endPoint)
Parameters
Type Name Description
System.Drawing.PointF ptTest

The point.
System.Boolean canConnectWithPort

true, if the port can accept connection
System.Boolean endPoint
Returns
Type Description
ConnectionPoint

The connection point

CreateNode(PointF, PointF)

Creates the line shape node.

Declaration
protected abstract Node CreateNode(PointF ptStart, PointF ptEnd)
Parameters
Type Name Description
System.Drawing.PointF ptStart

The start point.
System.Drawing.PointF ptEnd

The end point.
Returns
Type Description
Node

The node.

Dispose()

Declaration
public override void Dispose()
Overrides

Draw(Graphics)

Draws the line shape to specified graphics.

Declaration
public override void Draw(Graphics gfx)
Parameters
Type Name Description
System.Drawing.Graphics gfx

Graphics to draw on.
Overrides

ProcessMouseDown(MouseEventArgs)

Processes the mouse down event.

Declaration
public override Tool ProcessMouseDown(MouseEventArgs evtArgs)
Parameters
Type Name Description
System.Windows.Forms.MouseEventArgs evtArgs

The System.Windows.Forms.MouseEventArgs instance containing the event data.
Returns
Type Description
Tool

The tool.
Overrides

ProcessMouseMove(MouseEventArgs)

Processes the mouse move event.

Declaration
public override Tool ProcessMouseMove(MouseEventArgs evtArgs)
Parameters
Type Name Description
System.Windows.Forms.MouseEventArgs evtArgs

The System.Windows.Forms.MouseEventArgs instance containing the event data.
Returns
Type Description
Tool

The tool.
Overrides

ProcessMouseUp(MouseEventArgs)

Processes the mouse up event.

Declaration
public override Tool ProcessMouseUp(MouseEventArgs evtArgs)
Parameters
Type Name Description
System.Windows.Forms.MouseEventArgs evtArgs

The System.Windows.Forms.MouseEventArgs instance containing the event data.
Returns
Type Description
Tool

The tool.
Overrides

SetDecorator(LineBase)

Sets the decorator for given line node.

Declaration
protected void SetDecorator(LineBase line)
Parameters
Type Name Description
LineBase line

The line.

Implements

System.IDisposable