New to Telerik UI for WinForms? Start a free 30-day trial

ToolBase

Class

Base class for Diagram tools.

Definition

Namespace:Telerik.Windows.Diagrams.Core

Assembly:Telerik.WinControls.RadDiagram.dll

Syntax:

public abstract class ToolBase : ITool

Inheritance: objectToolBase

Derived Classes: ConnectionManipulationToolDraggingToolManipulationToolPrimaryMouseToolBaseRectangleSelectionTool

Implements: ITool

Constructors

ToolBase(string)

Initializes a new instance of the ToolBase class.

protected ToolBase(string name = "")

Parameters:namestring

The name.

Properties

Cursor

Gets or sets the cursor.

protected Cursor Cursor { get; set; }

Property Value:

The cursor.

Graph

IGraphInternal

Gets or sets the graph view (aka surface).

public IGraphInternal Graph { get; }

Property Value:

The surface.

Implements: ITool.Graph

InitialPoint

Point?

Gets the initial point of the interaction.

protected Point? InitialPoint { get; set; }

Property Value:

The initial point on the surface.

IsActive

bool

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

public bool IsActive { get; }

Property Value:

True if this instance is active; otherwise, false.

Implements: ITool.IsActive

IsEnabled

bool

Gets or sets the IsEnabled.

public bool IsEnabled { get; set; }

Implements: ITool.IsEnabled

Name

string

Gets or sets the layer.

public string Name { get; set; }

Implements: ITool.Name

ToolService

IToolService

Gets or sets the tool service (see ToolService).

public IToolService ToolService { get; set; }

Property Value:

The tool service.

Implements: ITool.ToolService

Methods

ActivateTool()

Activates the tool.

public bool ActivateTool()

Returns:

bool

Implements: ITool.ActivateTool()

DeactivateTool()

Deactivates the tool.

public bool DeactivateTool()

Returns:

bool

Implements: ITool.DeactivateTool()

Initialize(IGraphServiceLocator)

Initializes this tool.

public virtual void Initialize(IGraphServiceLocator serviceLocator)

Parameters:serviceLocatorIGraphServiceLocator

The locator or controller.

Implements: ITool.Initialize(IGraphServiceLocator)

OnActivated()

Called when tool is IsActive is changed to true.

protected virtual void OnActivated()

OnDeactivated()

Called when tool is IsActive is changed to false.

protected virtual void OnDeactivated()

RestoreCursor()

Restores the cursor.

protected void RestoreCursor()