Class
ToolBase

Represents an abstraction of a tool.

Definition

Namespace:Telerik.Windows.Media.Imaging.Tools

Assembly:Telerik.Windows.Controls.ImageEditor.dll

Syntax:

cs-api-definition
public abstract class ToolBase : ITool

Inheritance: objectToolBase

Derived Classes: BlurToolCanvasResizeToolCropToolDrawTextToolDrawToolBaseEffectToolBasePanToolResizeToolRoundCornersTool

Implements: ITool

Constructors

ToolBase()

Declaration

cs-api-definition
protected ToolBase()

Properties

AffectsLayout

Gets whether the tool is changing the image size.

Declaration

cs-api-definition
public abstract bool AffectsLayout { get; }

Property Value

bool

Indicates whether a tool affects layout.

Implements ITool.AffectsLayout

IsDirty

Gets whether the tool has made any changes on the image.

Declaration

cs-api-definition
public abstract bool IsDirty { get; }

Property Value

bool

Indicates is there any changes.

Implements ITool.IsDirty

IsPreviewOverlay

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

Declaration

cs-api-definition
public abstract bool IsPreviewOverlay { get; }

Property Value

bool

Indicates if a tool has a preview overlay.

Implements ITool.IsPreviewOverlay

IsResetSettingsSupported

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

Declaration

cs-api-definition
public virtual bool IsResetSettingsSupported { get; }

Property Value

bool

Indicates whether the settings can be reseted.

Implements ITool.IsResetSettingsSupported

Methods

AttachUI(ToolInitInfo)

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

Declaration

cs-api-definition
public abstract void AttachUI(ToolInitInfo previewInitInfo)

Parameters

previewInitInfo

ToolInitInfo

The preview init info.

Implements ITool.AttachUI(ToolInitInfo)

DetachUI()

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

Declaration

cs-api-definition
public abstract void DetachUI()

Implements ITool.DetachUI()

GetCommand()

Gets the tool's associated command.

Declaration

cs-api-definition
public abstract IImageCommand GetCommand()

Returns

IImageCommand

The command.

Implements ITool.GetCommand()

GetContext()

Gets the tool's command context.

Declaration

cs-api-definition
public abstract object GetContext()

Returns

object

The command context.

Implements ITool.GetContext()

GetSettingsUI()

Gets the tool' settings UI.

Declaration

cs-api-definition
public abstract UIElement GetSettingsUI()

Returns

UIElement

The UI settings.

Implements ITool.GetSettingsUI()

ResetSettings()

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

Declaration

cs-api-definition
public abstract void ResetSettings()

Implements ITool.ResetSettings()