Class
PencilTool

Activated when pen drawing action is going to be executed.

Definition

Namespace:Telerik.Windows.Diagrams.Core

Assembly:Telerik.Windows.Diagrams.Core.dll

Syntax:

cs-api-definition
public class PencilTool : DrawingToolBase, ITool, IMouseListener, IKeyboardListener

Inheritance: objectToolBasePrimaryMouseToolBaseDrawingToolBasePencilTool

Implements: IKeyboardListenerIMouseListenerITool

Inherited Members DrawingToolBase.KeyDown(KeyArgs)DrawingToolBase.CompleteTool()DrawingToolBase.CreateShape()DrawingToolBase.OnDeactivated()DrawingToolBase.ControllerServiceDrawingToolBase.DrawingServiceDrawingToolBase.UndoRedoServiceDrawingToolBase.AddShapeCommandPrimaryMouseToolBase.Initialize(IGraphServiceLocator)PrimaryMouseToolBase.KeyUp(KeyArgs)PrimaryMouseToolBase.MouseDoubleClick(PointerArgs)PrimaryMouseToolBase.SelectionServicePrimaryMouseToolBase.HitTestServicePrimaryMouseToolBase.ServiceLocatorPrimaryMouseToolBase.HitItemPrimaryMouseToolBase.ActiveConnectorToolBase.DeactivateTool()ToolBase.ActivateTool()ToolBase.OnActivated()ToolBase.RestoreCursor()ToolBase.ToolServiceToolBase.GraphToolBase.IsEnabledToolBase.IsActiveToolBase.NameToolBase.InitialPointToolBase.Cursor

Constructors

PencilTool()

Initializes a new instance of the PencilTool class.

Declaration

cs-api-definition
public PencilTool()

Fields

ToolName

The name of the pencil tool.

Declaration

cs-api-definition
public const string ToolName = "PencilTool"

Field Value

string

Properties

OmissionStep

Gets or sets the drawing omission step. This property defines the number of mouse or touch events that are skipped after a successful draw. You can increase the omission step for better performance on tablets.

Declaration

cs-api-definition
public int OmissionStep { get; set; }

Property Value

int

The drawing omission step.

Methods

MouseDown(PointerArgs)

Handles the mouse-down event.

Declaration

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

Parameters

e

PointerArgs

The PointerArgs instance containing the event data.

Returns

bool

Overrides DrawingToolBase.MouseDown(PointerArgs)

MouseMove(PointerArgs)

Handles the mouse-move event.

Declaration

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

Parameters

e

PointerArgs

The PointerArgs instance containing the event data.

Returns

bool

Overrides PrimaryMouseToolBase.MouseMove(PointerArgs)

MouseUp(PointerArgs)

Handles the mouse-up event.

Declaration

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

Parameters

e

PointerArgs

The PointerArgs instance containing the event data.

Returns

bool

Overrides PrimaryMouseToolBase.MouseUp(PointerArgs)

UndoToolAction()

Undoes what this tool has performed.

Declaration

cs-api-definition
public override void UndoToolAction()

Overrides DrawingToolBase.UndoToolAction()