Class RadImageEditor

Inheritance
System.Object
RadControl
RadImageEditor
Inherited Members
Namespace: Telerik.WinControls.UI
Assembly: Telerik.WinControls.UI.dll

Syntax

[TelerikToolboxCategory("Editors")]
public class RadImageEditor : RadControl, INotifyPropertyChanged, ISupportInitializeNotification, ISupportInitialize, IComponentTreeHandler, ILayoutHandler, IPCHost, IAnalyticsProvider

Constructors

RadImageEditor()

Initializes a new instance of the RadImageEditor class.

Declaration
public RadImageEditor()

Properties

BitmapPath

Gets or sets the path that will be used for save operations.

Declaration
public string BitmapPath { get; set; }
Property Value
System.String

CurrentBitmap

Gets or sets the current bitmap. If you want to open an image for edit use one of the OpenImage methods.

Declaration
public Bitmap CurrentBitmap { get; set; }
Property Value
System.Drawing.Bitmap

DefaultSize

Gets the default size for this RadImageEditor control.

Declaration
protected override Size DefaultSize { get; }
Property Value
System.Drawing.Size

ImageEditorElement

Gets the main element of the editor.

Declaration
public RadImageEditorElement ImageEditorElement { get; }
Property Value
RadImageEditorElement

ZoomFactor

Gets or sets the zoom factor of the editor.

Declaration
public SizeF ZoomFactor { get; set; }
Property Value
System.Drawing.SizeF

Methods

CancelAsync()

Cancels the asynchronous loading operation.

Declaration
public virtual void CancelAsync()

CreateChildItems(RadElement)

Creates the child items for this RadImageEditor control.

Declaration
protected override void CreateChildItems(RadElement parent)
Parameters
RadElement parent

The parent element to add child items to.
Overrides

CreateImageEditorElement()

Creates the main image editor element for this control.

Declaration
protected virtual RadImageEditorElement CreateImageEditorElement()
Returns
RadImageEditorElement

A new RadImageEditorElement instance.

LoadAsync()

Loads an image asynchronously.

Declaration
public virtual void LoadAsync()

LoadAsync(String)

Loads an image asynchronously from the specified URL.

Declaration
public virtual void LoadAsync(string url)
Parameters
System.String url

The URL of the image to load.

OnDragDrop(DragEventArgs)

Raises the DragDrop event and opens the dropped image file.

Declaration
protected override void OnDragDrop(DragEventArgs e)
Parameters
System.Windows.Forms.DragEventArgs e

The event arguments containing the drag and drop data.

OnDragEnter(DragEventArgs)

Raises the DragEnter event and sets the drag effect for file drops.

Declaration
protected override void OnDragEnter(DragEventArgs e)
Parameters
System.Windows.Forms.DragEventArgs e

The event arguments containing the drag and drop data.

OnKeyDown(KeyEventArgs)

Raises the KeyDown event.

Declaration
protected override void OnKeyDown(KeyEventArgs e)
Parameters
System.Windows.Forms.KeyEventArgs e

The System.Windows.Forms.KeyEventArgs instance containing the event data.
Overrides

OnKeyPress(KeyPressEventArgs)

Raises the KeyPress event.

Declaration
protected override void OnKeyPress(KeyPressEventArgs e)
Parameters
System.Windows.Forms.KeyPressEventArgs e

The System.Windows.Forms.KeyPressEventArgs instance containing the event data.
Overrides

OnKeyUp(KeyEventArgs)

Raises the KeyUp event.

Declaration
protected override void OnKeyUp(KeyEventArgs e)
Parameters
System.Windows.Forms.KeyEventArgs e

The System.Windows.Forms.KeyEventArgs instance containing the event data.
Overrides

OnMouseClick(MouseEventArgs)

Raises the System.Windows.Forms.Control.MouseClick event.

Declaration
protected override void OnMouseClick(MouseEventArgs e)
Parameters
System.Windows.Forms.MouseEventArgs e

An System.Windows.Forms.MouseEventArgs that contains the event data.

OnMouseDoubleClick(MouseEventArgs)

Raises the System.Windows.Forms.Control.MouseDoubleClick event.

Declaration
protected override void OnMouseDoubleClick(MouseEventArgs e)
Parameters
System.Windows.Forms.MouseEventArgs e

An System.Windows.Forms.MouseEventArgs that contains the event data.

OnMouseDown(MouseEventArgs)

Raises the MouseDown event.

Declaration
protected override void OnMouseDown(MouseEventArgs e)
Parameters
System.Windows.Forms.MouseEventArgs e

The System.Windows.Forms.MouseEventArgs instance containing the event data.
Overrides

OnMouseEnter(EventArgs)

Raises the MouseEnter event.

Declaration
protected override void OnMouseEnter(EventArgs e)
Parameters
System.EventArgs e

The System.EventArgs instance containing the event data.
Overrides

OnMouseHover(EventArgs)

Raises the MouseHover event.

Declaration
protected override void OnMouseHover(EventArgs e)
Parameters
System.EventArgs e

The System.EventArgs instance containing the event data.
Overrides

OnMouseLeave(EventArgs)

Raises the MouseLeave event.

Declaration
protected override void OnMouseLeave(EventArgs e)
Parameters
System.EventArgs e

The System.EventArgs instance containing the event data.
Overrides

OnMouseMove(MouseEventArgs)

Raises the MouseMove event.

Declaration
protected override void OnMouseMove(MouseEventArgs e)
Parameters
System.Windows.Forms.MouseEventArgs e

The System.Windows.Forms.MouseEventArgs instance containing the event data.
Overrides

OnMouseUp(MouseEventArgs)

Raises the MouseUp event.

Declaration
protected override void OnMouseUp(MouseEventArgs e)
Parameters
System.Windows.Forms.MouseEventArgs e

The System.Windows.Forms.MouseEventArgs instance containing the event data.
Overrides

OnMouseWheel(MouseEventArgs)

Raises the MouseWheel event.

Declaration
protected override void OnMouseWheel(MouseEventArgs e)
Parameters
System.Windows.Forms.MouseEventArgs e

The System.Windows.Forms.MouseEventArgs instance containing the event data.
Overrides

OnSizeChanged(EventArgs)

Raises the SizeChanged event and updates auto zoom if applicable.

Declaration
protected override void OnSizeChanged(EventArgs e)
Parameters
System.EventArgs e

The event arguments.

OnThemeChanged()

Raises the ThemeChanged event and updates command icons.

Declaration
protected override void OnThemeChanged()
Overrides

OpenImage()

Opens an image file for editing using a file dialog.

Declaration
public virtual void OpenImage()

OpenImage(Bitmap)

Opens a bitmap image for editing.

Declaration
public virtual void OpenImage(Bitmap bitmap)
Parameters
System.Drawing.Bitmap bitmap

The bitmap to open.

OpenImage(String)

Opens an image file for editing.

Declaration
public virtual void OpenImage(string fileName)
Parameters
System.String fileName

The name of the file to open.

SaveImage()

Saves the current image to the default path.

Declaration
public virtual void SaveImage()

SaveImage(Stream)

Saves the current image to the specified stream.

Declaration
public virtual void SaveImage(Stream stream)
Parameters
System.IO.Stream stream

The stream to save the image to.

SaveImage(Stream, ImageFormat)

Saves the current image to the specified stream with the specified format.

Declaration
public virtual void SaveImage(Stream stream, ImageFormat imageFormat)
Parameters
System.IO.Stream stream

The stream to save the image to.
System.Drawing.Imaging.ImageFormat imageFormat

The format in which to save the image.

SaveImage(String)

Saves the current image to the specified path.

Declaration
public virtual void SaveImage(string path)
Parameters
System.String path

The path where the image will be saved.

SaveImage(String, ImageFormat)

Saves the current image to the specified path with the specified format.

Declaration
public virtual void SaveImage(string path, ImageFormat imageFormat)
Parameters
System.String path

The path where the image will be saved.
System.Drawing.Imaging.ImageFormat imageFormat

The format in which to save the image.

SaveImageAs()

Saves an image using a file dialog.

Declaration
public virtual void SaveImageAs()

ShowBlurDialog()

Shows the blur filter dialog for applying blur effects.

Declaration
public virtual void ShowBlurDialog()

ShowCanvasResizeDialog()

Shows the canvas resize dialog for changing canvas dimensions and background.

Declaration
public virtual void ShowCanvasResizeDialog()

ShowContrastDialog()

Shows the contrast adjustment dialog for modifying image contrast and brightness.

Declaration
public virtual void ShowContrastDialog()

ShowDrawDialog()

Shows the free drawing dialog for freehand drawing on the image.

Declaration
public virtual void ShowDrawDialog()

ShowDrawShapeDialog()

Shows the shape drawing dialog for adding geometric shapes to the image.

Declaration
public virtual void ShowDrawShapeDialog()

ShowDrawTextDialog()

Shows the text drawing dialog for adding text to the image.

Declaration
public virtual void ShowDrawTextDialog()

ShowHueDialog()

Shows the hue shift dialog for adjusting image hue values.

Declaration
public virtual void ShowHueDialog()

ShowResizeDialog()

Shows the resize dialog for changing image dimensions.

Declaration
public virtual void ShowResizeDialog()

ShowRoundCornersDialog()

Shows the round corners dialog for applying rounded corner effects.

Declaration
public virtual void ShowRoundCornersDialog()

ShowSaturationDialog()

Shows the saturation adjustment dialog for modifying image saturation levels.

Declaration
public virtual void ShowSaturationDialog()

ShowSharpenDialog()

Shows the sharpen filter dialog for applying sharpening effects.

Declaration
public virtual void ShowSharpenDialog()

Events

CurrentImageChanged

Occurs after a specific operation is performed over the image.

Declaration
public event ImageChangedEventHandler CurrentImageChanged
Event Type
ImageChangedEventHandler

ImageLoadAsyncProgressChanged

Occurs when the progress of an async load operation changes.

Declaration
public event ProgressChangedEventHandler ImageLoadAsyncProgressChanged
Event Type
System.ComponentModel.ProgressChangedEventHandler

ImageLoaded

Occurs after an image is loaded in the editor.

Declaration
public event AsyncCompletedEventHandler ImageLoaded
Event Type
System.ComponentModel.AsyncCompletedEventHandler

ImageSaved

Occurs after an image is saved.

Declaration
public event EventHandler ImageSaved
Event Type
System.EventHandler

OperationError

Occurs when an operation results in an error or an exception.

Declaration
public event ErrorEventHandler OperationError
Event Type
System.IO.ErrorEventHandler

Extension Methods