Class ToolBase

Represents an abstraction of a tool.

Inheritance
System.Object
ToolBase
BlurTool
CanvasResizeTool
CropTool
DrawTextTool
DrawToolBase
EffectToolBase
PanTool
ResizeTool
RoundCornersTool
Inherited Members
System.Object.ToString()
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: Telerik.Windows.Media.Imaging.Tools
Assembly: Telerik.Windows.Controls.ImageEditor.dll

Syntax

public abstract class ToolBase : ITool

Constructors

ToolBase()

Declaration
protected ToolBase()

Properties

AffectsLayout

Gets whether the tool is changing the image size.

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

Indicates whether a tool affects layout.
Implements

IsDirty

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

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

Indicates is there any changes.
Implements

IsPreviewOverlay

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

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

Indicates if a tool has a preview overlay.
Implements

IsResetSettingsSupported

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

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

Indicates whether the settings can be reseted.
Implements

Methods

AttachUI(ToolInitInfo)

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

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

The preview init info.
Implements

DetachUI()

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

Declaration
public abstract void DetachUI()
Implements

GetCommand()

Gets the tool's associated command.

Declaration
public abstract IImageCommand GetCommand()
Returns
IImageCommand

The command.
Implements

GetContext()

Gets the tool's command context.

Declaration
public abstract object GetContext()
Returns
System.Object

The command context.
Implements

GetSettingsUI()

Gets the tool' settings UI.

Declaration
public abstract UIElement GetSettingsUI()
Returns
System.Windows.UIElement

The UI settings.
Implements

ResetSettings()

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

Declaration
public abstract void ResetSettings()
Implements

Extension Methods