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

DrawToolBase

Class

Represents an abstraction of a tool which is responsible for drawing a geometries over an image.

Definition

Namespace:Telerik.Windows.Media.Imaging.Tools

Assembly:Telerik.Windows.Controls.ImageEditor.dll

Syntax:

public abstract class DrawToolBase : ToolBase, ITool

Inheritance: objectToolBaseDrawToolBase

Derived Classes: DrawToolShapeTool

Implements: ITool

Inherited Members ToolBase.GetSettingsUI()ToolBase.IsDirty

Constructors

DrawToolBase()

Initializes a new instance of the DrawToolBase class.

public DrawToolBase()

Properties

AffectsLayout

bool

Gets whether the tool is changing the image size.

public override bool AffectsLayout { get; }

Property Value:

Indicates whether a tool affects layout.

Overrides: ToolBase.AffectsLayout

IsPreviewOverlay

bool

Gets whether the tool has a preview overlay on the main image.

public override bool IsPreviewOverlay { get; }

Property Value:

Indicates if a tool has a preview overlay.

Overrides: ToolBase.IsPreviewOverlay

IsResetSettingsSupported

bool

Specifies whether the settings of a tool can be reset. The common implementation of a tool returns true.

public override bool IsResetSettingsSupported { get; }

Property Value:

Indicates whether the settings can be reseted.

Overrides: ToolBase.IsResetSettingsSupported

Methods

AttachUI(ToolInitInfo)

Attaches the UI. The method is invoked on tool's execution.

public override void AttachUI(ToolInitInfo previewInitInfo)

Parameters:previewInitInfoToolInitInfo

The preview init info.

Overrides: ToolBase.AttachUI(ToolInitInfo)

DetachUI()

Detaches the UI. The method is invoked when the tool execution is canceled.

public override void DetachUI()

Overrides: ToolBase.DetachUI()

Draw(Point)

Draws a geometry.

protected virtual void Draw(Point currentPoint)

Parameters:currentPointPoint

The current point related to the image.

EndDraw(Point)

Ends the drawing of a geometry.

protected virtual void EndDraw(Point currentPoint)

Parameters:currentPointPoint

The current point related to the image.

GetCommand()

Gets the tool's associated command.

public override IImageCommand GetCommand()

Returns:

IImageCommand

The command.

Overrides: ToolBase.GetCommand()

GetContext()

Gets the tool's command context.

public override object GetContext()

Returns:

object

The command context.

Overrides: ToolBase.GetContext()

ResetSettings()

Resets the tool' settings if the tool's IsResetSettingsSupported property is true.

public override void ResetSettings()

Overrides: ToolBase.ResetSettings()

SetPathProperties(Path)

Sets properties to the path which contains the geometry which shall be drawn.

protected virtual void SetPathProperties(Path path)

Parameters:pathPath

The path.

StartDraw(Point)

Starts the drawing of a geometry.

protected virtual void StartDraw(Point currentPoint)

Parameters:currentPointPoint

The current point related to the image.