Interface ITool

The base interface for all Diagram tools.

Namespace: Telerik.Windows.Diagrams.Core
Assembly: Telerik.Windows.Diagrams.Core.dll

Syntax

public interface ITool

Properties

Graph

Gets or sets the diagramming surface.

Declaration
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
bool IsActive { get; }
Property Value
System.Boolean

True if this instance is active; otherwise, false.

IsEnabled

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

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

True if enabled; otherwise, false.

Name

Gets the name of the tool.

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

The name.

ToolService

Gets or sets the tool manager (see ToolService).

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

The tool manager.

Methods

ActivateTool()

Activates the tool.

Declaration
bool ActivateTool()
Returns
System.Boolean

DeactivateTool()

Deactivates the tool.

Declaration
bool DeactivateTool()
Returns
System.Boolean

Initialize(IGraphServiceLocator)

Initializes the specified service locator.

Declaration
void Initialize(IGraphServiceLocator serviceLocator)
Parameters
IGraphServiceLocator serviceLocator

The service locator.

Extension Methods