Class ToolBase

Base class for Diagram tools.

Inheritance
System.Object
ToolBase
ConnectionManipulationTool
DraggingTool
ManipulationTool
PrimaryMouseToolBase
RectangleSelectionTool
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: Telerik.Windows.Diagrams.Core
Assembly: Telerik.WinControls.RadDiagram.dll

Syntax

public abstract class ToolBase : ITool

Constructors

ToolBase(String)

Initializes a new instance of the ToolBase class.

Declaration
protected ToolBase(string name = "")
Parameters
System.String name

The name.

Properties

Cursor

Gets or sets the cursor.

Declaration
protected Cursor Cursor { get; set; }
Property Value
System.Windows.Forms.Cursor

The cursor.

Graph

Gets or sets the graph view (aka surface).

Declaration
public IGraphInternal Graph { get; }
Property Value
IGraphInternal

The surface.
Implements

InitialPoint

Gets the initial point of the interaction.

Declaration
protected Point? InitialPoint { get; set; }
Property Value
System.Nullable<Point>

The initial point on the surface.

IsActive

Gets or sets a value indicating whether this tool is active.

Declaration
public bool IsActive { get; }
Property Value
System.Boolean

True if this instance is active; otherwise, false.
Implements

IsEnabled

Gets or sets the IsEnabled.

Declaration
public bool IsEnabled { get; set; }
Property Value
System.Boolean

Implements

Name

Gets or sets the layer.

Declaration
public string Name { get; set; }
Property Value
System.String

Implements

ToolService

Gets or sets the tool service (see ToolService).

Declaration
public IToolService ToolService { get; set; }
Property Value
IToolService

The tool service.
Implements

Methods

ActivateTool()

Activates the tool.

Declaration
public bool ActivateTool()
Returns
System.Boolean

Implements

DeactivateTool()

Deactivates the tool.

Declaration
public bool DeactivateTool()
Returns
System.Boolean

Implements

Initialize(IGraphServiceLocator)

Initializes this tool.

Declaration
public virtual void Initialize(IGraphServiceLocator serviceLocator)
Parameters
IGraphServiceLocator serviceLocator

The locator or controller.
Implements

OnActivated()

Called when tool is IsActive is changed to true.

Declaration
protected virtual void OnActivated()

OnDeactivated()

Called when tool is IsActive is changed to false.

Declaration
protected virtual void OnDeactivated()

RestoreCursor()

Restores the cursor.

Declaration
protected void RestoreCursor()

Extension Methods