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

ToolBase

Class

Represents an abstraction of a tool.

Definition

Namespace:Telerik.Windows.Media.Imaging.Tools

Assembly:Telerik.Windows.Controls.ImageEditor.dll

Syntax:

public abstract class ToolBase : ITool

Inheritance: objectToolBase

Derived Classes: BlurToolCanvasResizeToolCropToolDrawTextToolDrawToolBaseEffectToolBasePanToolResizeToolRoundCornersTool...

Implements: ITool

Constructors

ToolBase()

protected ToolBase()

Properties

AffectsLayout

bool

Gets whether the tool is changing the image size.

public abstract bool AffectsLayout { get; }

Property Value:

Indicates whether a tool affects layout.

Implements: ITool.AffectsLayout

IsDirty

bool

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

public abstract bool IsDirty { get; }

Property Value:

Indicates is there any changes.

Implements: ITool.IsDirty

IsPreviewOverlay

bool

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

public abstract bool IsPreviewOverlay { get; }

Property Value:

Indicates if a tool has a preview overlay.

Implements: ITool.IsPreviewOverlay

IsResetSettingsSupported

bool

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

public virtual bool IsResetSettingsSupported { get; }

Property Value:

Indicates whether the settings can be reseted.

Implements: ITool.IsResetSettingsSupported

Methods

AttachUI(ToolInitInfo)

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

public abstract void AttachUI(ToolInitInfo previewInitInfo)

Parameters:previewInitInfoToolInitInfo

The preview init info.

Implements: ITool.AttachUI(ToolInitInfo)

DetachUI()

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

public abstract void DetachUI()

Implements: ITool.DetachUI()

GetCommand()

Gets the tool's associated command.

public abstract IImageCommand GetCommand()

Returns:

IImageCommand

The command.

Implements: ITool.GetCommand()

GetContext()

Gets the tool's command context.

public abstract object GetContext()

Returns:

object

The command context.

Implements: ITool.GetContext()

GetSettingsUI()

Gets the tool' settings UI.

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.

public abstract void ResetSettings()

Implements: ITool.ResetSettings()