Documentation

Class DrawToolBase

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

Inheritance
System.Object
ToolBase
DrawToolBase
DrawTool
ShapeTool
Inherited Members
Namespace: Telerik.Windows.Media.Imaging.Tools
Assembly: Telerik.Windows.Controls.ImageEditor.dll

Syntax

public abstract class DrawToolBase : ToolBase, ITool

Constructors

DrawToolBase()

Initializes a new instance of the DrawToolBase class.

Declaration
public DrawToolBase()

Properties

AffectsLayout

Gets whether the tool is changing the image size.

Declaration
public override bool AffectsLayout { get; }
Property Value
System.Boolean

Indicates whether a tool affects layout.
Overrides

IsPreviewOverlay

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

Declaration
public override bool IsPreviewOverlay { get; }
Property Value
System.Boolean

Indicates if a tool has a preview overlay.
Overrides

IsResetSettingsSupported

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

Declaration
public override bool IsResetSettingsSupported { get; }
Property Value
System.Boolean

Indicates whether the settings can be reseted.
Overrides

Methods

AttachUI(ToolInitInfo)

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

Declaration
public override void AttachUI(ToolInitInfo previewInitInfo)
Parameters
ToolInitInfo previewInitInfo

The preview init info.
Overrides

DetachUI()

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

Declaration
public override void DetachUI()
Overrides

Draw(Point)

Draws a geometry.

Declaration
protected virtual void Draw(Point currentPoint)
Parameters
System.Windows.Point currentPoint

The current point related to the image.

EndDraw(Point)

Ends the drawing of a geometry.

Declaration
protected virtual void EndDraw(Point currentPoint)
Parameters
System.Windows.Point currentPoint

The current point related to the image.

GetCommand()

Gets the tool's associated command.

Declaration
public override IImageCommand GetCommand()
Returns
IImageCommand

The command.
Overrides

GetContext()

Gets the tool's command context.

Declaration
public override object GetContext()
Returns
System.Object

The command context.
Overrides

ResetSettings()

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

Declaration
public override void ResetSettings()
Overrides

SetPathProperties(Path)

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

Declaration
protected virtual void SetPathProperties(Path path)
Parameters
System.Windows.Shapes.Path path

The path.

StartDraw(Point)

Starts the drawing of a geometry.

Declaration
protected virtual void StartDraw(Point currentPoint)
Parameters
System.Windows.Point currentPoint

The current point related to the image.

Extension Methods