Class
PrimaryMouseToolBase

An abstract base tool for mouse tools.

Definition

Namespace:Telerik.Windows.Diagrams.Core

Assembly:Telerik.Windows.Diagrams.Core.dll

Syntax:

cs-api-definition
public abstract class PrimaryMouseToolBase : ToolBase, ITool, IMouseListener, IKeyboardListener

Inheritance: objectToolBasePrimaryMouseToolBase

Derived Classes: ConnectionToolDrawingToolBasePrimaryMouseToolTextTool

Implements: IKeyboardListenerIMouseListenerITool

Inherited Members ToolBase.DeactivateTool()ToolBase.ActivateTool()ToolBase.OnActivated()ToolBase.OnDeactivated()ToolBase.RestoreCursor()ToolBase.ToolServiceToolBase.GraphToolBase.IsEnabledToolBase.IsActiveToolBase.NameToolBase.InitialPointToolBase.Cursor

Constructors

PrimaryMouseToolBase(string)

Initializes a new instance of the PrimaryMouseToolBase class.

Declaration

cs-api-definition
protected PrimaryMouseToolBase(string name)

Parameters

name

string

The name.

Properties

ActiveConnector

Gets or sets the active connector.

Declaration

cs-api-definition
protected IConnector ActiveConnector { get; set; }

Property Value

IConnector

HitItem

Gets the hit item.

Declaration

cs-api-definition
protected IDiagramItem HitItem { get; set; }

Property Value

IDiagramItem

HitTestService

Declaration

cs-api-definition
protected IHitTestService HitTestService { get; }

Property Value

IHitTestService

SelectionService

Declaration

cs-api-definition
protected ISelectionService<IDiagramItem> SelectionService { get; }

Property Value

ISelectionService<IDiagramItem>

ServiceLocator

Declaration

cs-api-definition
protected IGraphServiceLocator ServiceLocator { get; set; }

Property Value

IGraphServiceLocator

Methods

Initialize(IGraphServiceLocator)

Initializes this tool.

Declaration

cs-api-definition
public override void Initialize(IGraphServiceLocator serviceLocator)

Parameters

serviceLocator

IGraphServiceLocator

The locator or controller.

Overrides ToolBase.Initialize(IGraphServiceLocator)

KeyDown(KeyArgs)

Handles the key down event.

Declaration

cs-api-definition
public virtual bool KeyDown(KeyArgs key)

Parameters

key

KeyArgs

Returns

bool

Implements IKeyboardListener.KeyDown(KeyArgs)

KeyUp(KeyArgs)

Handles the key up event.

Declaration

cs-api-definition
public virtual bool KeyUp(KeyArgs key)

Parameters

key

KeyArgs

Returns

bool

Implements IKeyboardListener.KeyUp(KeyArgs)

MouseDoubleClick(PointerArgs)

Handles the mouse double click event.

Declaration

cs-api-definition
public virtual bool MouseDoubleClick(PointerArgs e)

Parameters

e

PointerArgs

The PointerArgs instance containing the event data.

Returns

bool

Implements IMouseListener.MouseDoubleClick(PointerArgs)

MouseDown(PointerArgs)

Handles the mouse-down event.

Declaration

cs-api-definition
public virtual bool MouseDown(PointerArgs e)

Parameters

e

PointerArgs

The PointerArgs instance containing the event data.

Returns

bool

Implements IMouseListener.MouseDown(PointerArgs)

MouseMove(PointerArgs)

Handles the mouse-move event.

Declaration

cs-api-definition
public virtual bool MouseMove(PointerArgs e)

Parameters

e

PointerArgs

The PointerArgs instance containing the event data.

Returns

bool

Implements IMouseListener.MouseMove(PointerArgs)

MouseUp(PointerArgs)

Handles the mouse-up event.

Declaration

cs-api-definition
public virtual bool MouseUp(PointerArgs e)

Parameters

e

PointerArgs

The PointerArgs instance containing the event data.

Returns

bool

Implements IMouseListener.MouseUp(PointerArgs)