Interface
ITool

Represents an abstraction of a tool.

Definition

Namespace:Telerik.Windows.Media.Imaging.Tools

Assembly:Telerik.Windows.Controls.ImageEditor.dll

Syntax:

cs-api-definition
public interface ITool

Properties

AffectsLayout

Gets whether the tool is changing the image size.

Declaration

cs-api-definition
bool AffectsLayout { get; }

Property Value

bool

Indicates whether a tool affects layout.

IsDirty

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

Declaration

cs-api-definition
bool IsDirty { get; }

Property Value

bool

Indicates is there any changes.

IsPreviewOverlay

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

Declaration

cs-api-definition
bool IsPreviewOverlay { get; }

Property Value

bool

Indicates if a tool has a preview overlay.

IsResetSettingsSupported

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

Declaration

cs-api-definition
bool IsResetSettingsSupported { get; }

Property Value

bool

Methods

AttachUI(ToolInitInfo)

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

Declaration

cs-api-definition
void AttachUI(ToolInitInfo previewInitInfo)

Parameters

previewInitInfo

ToolInitInfo

The preview init info.

DetachUI()

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

Declaration

cs-api-definition
void DetachUI()

GetCommand()

Gets the tool's associated command.

Declaration

cs-api-definition
IImageCommand GetCommand()

Returns

IImageCommand

The command.

GetContext()

Gets the tool's command context.

Declaration

cs-api-definition
object GetContext()

Returns

object

The command context.

GetSettingsUI()

Gets the tool' settings UI.

Declaration

cs-api-definition
UIElement GetSettingsUI()

Returns

UIElement

The UI settings.

ResetSettings()

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

Declaration

cs-api-definition
void ResetSettings()