Interface
ITool

The base interface for all Diagram tools.

Definition

Namespace:Telerik.Windows.Diagrams.Core

Assembly:Telerik.Windows.Diagrams.Core.dll

Syntax:

cs-api-definition
public interface ITool

Properties

Graph

Gets or sets the diagramming surface.

Declaration

cs-api-definition
IGraphInternal Graph { get; }

Property Value

IGraphInternal

The surface.

IsActive

Gets or sets a value indicating whether this tool is active. If true the tool is actually performing work via the various mouse or keyboard event handlers. If IsEnabled is false the tool can never be active.

Declaration

cs-api-definition
bool IsActive { get; }

Property Value

bool

True if this instance is active; otherwise, false.

IsEnabled

Gets or sets a value indicating whether this ITool is enabled.

Declaration

cs-api-definition
bool IsEnabled { get; set; }

Property Value

bool

True if enabled; otherwise, false.

Name

Gets the name of the tool.

Declaration

cs-api-definition
string Name { get; }

Property Value

string

The name.

ToolService

Gets or sets the tool manager (see ToolService).

Declaration

cs-api-definition
IToolService ToolService { get; set; }

Property Value

IToolService

The tool manager.

Methods

ActivateTool()

Activates the tool.

Declaration

cs-api-definition
bool ActivateTool()

Returns

bool

DeactivateTool()

Deactivates the tool.

Declaration

cs-api-definition
bool DeactivateTool()

Returns

bool

Initialize(IGraphServiceLocator)

Initializes the specified service locator.

Declaration

cs-api-definition
void Initialize(IGraphServiceLocator serviceLocator)

Parameters

serviceLocator

IGraphServiceLocator

The service locator.