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

PencilTool

Class

Activated when pen drawing action is going to be executed.

Definition

Namespace:Telerik.Windows.Diagrams.Core

Assembly:Telerik.Windows.Diagrams.Core.dll

Syntax:

public class PencilTool : DrawingToolBase, ITool, IMouseListener, IKeyboardListener

Inheritance: objectToolBasePrimaryMouseToolBaseDrawingToolBasePencilTool

Implements: IKeyboardListenerIMouseListenerITool

Constructors

PencilTool()

Initializes a new instance of the PencilTool class.

public PencilTool()

Fields

ToolName

string

The name of the pencil tool.

public const string ToolName = "PencilTool"

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.

public int OmissionStep { get; set; }

Property Value:

The drawing omission step.

Methods

MouseDown(PointerArgs)

bool

Handles the mouse-down event.

public override bool MouseDown(PointerArgs e)

Parameters:ePointerArgs

The PointerArgs instance containing the event data.

Returns:

bool

Overrides: DrawingToolBase.MouseDown(PointerArgs)

MouseMove(PointerArgs)

bool

Handles the mouse-move event.

public override bool MouseMove(PointerArgs e)

Parameters:ePointerArgs

The PointerArgs instance containing the event data.

Returns:

bool

Overrides: PrimaryMouseToolBase.MouseMove(PointerArgs)

MouseUp(PointerArgs)

bool

Handles the mouse-up event.

public override bool MouseUp(PointerArgs e)

Parameters:ePointerArgs

The PointerArgs instance containing the event data.

Returns:

bool

Overrides: PrimaryMouseToolBase.MouseUp(PointerArgs)

UndoToolAction()

Undoes what this tool has performed.

public override void UndoToolAction()

Overrides: DrawingToolBase.UndoToolAction()