Interface ITool

Represents an abstraction of a tool.

Namespace: Telerik.Windows.Media.Imaging.Tools
Assembly: Telerik.Windows.Controls.ImageEditor.dll

Syntax

public interface ITool

Properties

AffectsLayout

Gets whether the tool is changing the image size.

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

Indicates whether a tool affects layout.

IsDirty

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

Declaration
bool IsDirty { get; }
Property Value
System.Boolean

Indicates is there any changes.

IsPreviewOverlay

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

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

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
bool IsResetSettingsSupported { get; }
Property Value
System.Boolean

Methods

AttachUI(ToolInitInfo)

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

Declaration
void AttachUI(ToolInitInfo previewInitInfo)
Parameters
ToolInitInfo previewInitInfo

The preview init info.

DetachUI()

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

Declaration
void DetachUI()

GetCommand()

Gets the tool's associated command.

Declaration
IImageCommand GetCommand()
Returns
IImageCommand

The command.

GetContext()

Gets the tool's command context.

Declaration
object GetContext()
Returns
System.Object

The command context.

GetSettingsUI()

Gets the tool' settings UI.

Declaration
UIElement GetSettingsUI()
Returns
System.Windows.UIElement

The UI settings.

ResetSettings()

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

Declaration
void ResetSettings()

Extension Methods