Class
EffectToolBase

Definition

Namespace:Telerik.Windows.Media.Imaging.Tools

Assembly:Telerik.Windows.Controls.ImageEditor.dll

Syntax:

cs-api-definition
public abstract class EffectToolBase : ToolBase, ITool

Inheritance: objectToolBaseEffectToolBase

Derived Classes: ContrastToolHueShiftToolSaturationToolSharpenTool

Implements: ITool

Inherited Members ToolBase.GetCommand()ToolBase.GetContext()ToolBase.IsResetSettingsSupportedToolBase.IsDirty

Constructors

EffectToolBase()

Declaration

cs-api-definition
public EffectToolBase()

Properties

AffectsLayout

Gets whether the tool is changing the image size.

Declaration

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

Property Value

bool

Indicates whether a tool affects layout.

Overrides ToolBase.AffectsLayout

Effect

Declaration

cs-api-definition
public abstract Effect Effect { get; }

Property Value

Effect

IsPreviewOverlay

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

Declaration

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

Property Value

bool

Indicates if a tool has a preview overlay.

Overrides ToolBase.IsPreviewOverlay

Methods

AttachPreviewCore(ToolInitInfo)

Declaration

cs-api-definition
protected virtual void AttachPreviewCore(ToolInitInfo previewInitInfo)

Parameters

previewInitInfo

ToolInitInfo

AttachUI(ToolInitInfo)

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

Declaration

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

Parameters

previewInitInfo

ToolInitInfo

The preview init info.

Overrides ToolBase.AttachUI(ToolInitInfo)

DetachPreviewCore()

Declaration

cs-api-definition
protected virtual void DetachPreviewCore()

DetachUI()

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

Declaration

cs-api-definition
public override void DetachUI()

Overrides ToolBase.DetachUI()

GetSettingsUI()

Gets the tool' settings UI.

Declaration

cs-api-definition
public override UIElement GetSettingsUI()

Returns

UIElement

The UI settings.

Overrides ToolBase.GetSettingsUI()

ResetSettings()

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

Declaration

cs-api-definition
public override void ResetSettings()

Overrides ToolBase.ResetSettings()