Class RadImageEditor

Provides support for visualization, manipulation and editing of images in different file formats.

Inheritance
System.Object
RadLayout
RadImageEditor
Inherited Members
Namespace: Telerik.Maui.Controls
Assembly: Telerik.Maui.Controls.dll

Syntax

public class RadImageEditor : RadLayout

Constructors

RadImageEditor()

Initializes a new instance of the RadImageEditor class.

Declaration
public RadImageEditor()

Fields

BusyIndicatorTemplateProperty

Identifies the BusyIndicatorTemplate property.

Declaration
public static readonly BindableProperty BusyIndicatorTemplateProperty
Field Value
Microsoft.Maui.Controls.BindableProperty

IsImageLoadedProperty

Identifies the IsImageLoaded property.

Declaration
public static readonly BindableProperty IsImageLoadedProperty
Field Value
Microsoft.Maui.Controls.BindableProperty

MaxZoomLevelProperty

Identifies the MaxZoomLevel property.

Declaration
public static readonly BindableProperty MaxZoomLevelProperty
Field Value
Microsoft.Maui.Controls.BindableProperty

MinZoomLevelProperty

Identifies the MinZoomLevel property.

Declaration
public static readonly BindableProperty MinZoomLevelProperty
Field Value
Microsoft.Maui.Controls.BindableProperty

SourceProperty

Identifies the Source property.

Declaration
public static readonly BindableProperty SourceProperty
Field Value
Microsoft.Maui.Controls.BindableProperty

ZoomLevelProperty

Identifies the ZoomLevel property.

Declaration
public static readonly BindableProperty ZoomLevelProperty
Field Value
Microsoft.Maui.Controls.BindableProperty

Properties

ApplyInteractiveCommand

Gets the command which applies the changes done in interactive command such as CropInteractiveCommand.

Declaration
public ICommand ApplyInteractiveCommand { get; }
Property Value
System.Windows.Input.ICommand

BlurCommand

Gets the command which applies blur to the image. The command accepts a single parameter of type BlurCommandContext, which specifies the radius of the blur filter.

Declaration
public ICommand BlurCommand { get; }
Property Value
System.Windows.Input.ICommand

BlurInteractiveCommand

Gets the command which initiates the blur action of the image. The command accepts a single parameter of type BlurCommandContext, which specifies the radius of the blur filter.

Declaration
public ICommand BlurInteractiveCommand { get; }
Property Value
System.Windows.Input.ICommand

BrightnessCommand

Gets the command which changes the brightness of the image. The command accepts a single parameter of type BrightnessCommandContext, which specifies the strength of the brightness filter.

Declaration
public ICommand BrightnessCommand { get; }
Property Value
System.Windows.Input.ICommand

BrightnessInteractiveCommand

Gets the command which initiates the brightness action of the image. The command accepts a single parameter of type BrightnessCommandContext, which specifies the strength of the brightness filter.

Declaration
public ICommand BrightnessInteractiveCommand { get; }
Property Value
System.Windows.Input.ICommand

BusyIndicatorTemplate

Gets or sets a Microsoft.Maui.Controls.DataTemplate to be used when displaying a busy indicator during long running operations, e.g. when loading an image. When no template is specified, a default busy indicator is shown.

Declaration
public DataTemplate BusyIndicatorTemplate { get; set; }
Property Value
Microsoft.Maui.Controls.DataTemplate

CancelInteractiveCommand

Gets the command which cancels the changes done in interactive command such as CropInteractiveCommand.

Declaration
public ICommand CancelInteractiveCommand { get; }
Property Value
System.Windows.Input.ICommand

ContrastCommand

Gets the command which changes the image contrast. The command accepts a single parameter of type ContrastCommandContext, which specifies the strength of the contrast filter.

Declaration
public ICommand ContrastCommand { get; }
Property Value
System.Windows.Input.ICommand

ContrastInteractiveCommand

Gets the command which initiates the contrast action of the image. The command accepts a single parameter of type ContrastCommandContext, which specifies the strength of the contrast filter.

Declaration
public ICommand ContrastInteractiveCommand { get; }
Property Value
System.Windows.Input.ICommand

CropCommand

Gets the command which crops the image. The command accepts a single parameter of type CropCommandContext, which specifies the Geometry, Bounds and AspectRatio of the crop command.

Declaration
public ICommand CropCommand { get; }
Property Value
System.Windows.Input.ICommand

CropInteractiveCommand

Gets the command which initiates crop action. The command accepts a single parameter of type CropCommandContext, which specifies the Geometry, Bounds and AspectRatio of the crop command.

Declaration
public ICommand CropInteractiveCommand { get; }
Property Value
System.Windows.Input.ICommand

FilterCommand

Gets the command which applies a composite filter to the image. The command accepts a single parameter of type FilterCommandContext, which specifies the values of the different filters.

Declaration
public ICommand FilterCommand { get; }
Property Value
System.Windows.Input.ICommand

FilterInteractiveCommand

Gets the command which initiates the composite filter action of the image. The command accepts a single parameter of type FilterCommandContext, which specifies the values of the different filters.

Declaration
public ICommand FilterInteractiveCommand { get; }
Property Value
System.Windows.Input.ICommand

FlipHorizontalCommand

Gets the command which flips the image horizontally.

Declaration
public ICommand FlipHorizontalCommand { get; }
Property Value
System.Windows.Input.ICommand

FlipVerticalCommand

Gets the command which flips the image vertically.

Declaration
public ICommand FlipVerticalCommand { get; }
Property Value
System.Windows.Input.ICommand

HueCommand

Gets the command which changes the image hue. The command accepts a single parameter of type HueCommandContext, which specifies the strength of the hue filter.

Declaration
public ICommand HueCommand { get; }
Property Value
System.Windows.Input.ICommand

HueInteractiveCommand

Gets the command which initiates the hue action of the image. The command accepts a single parameter of type HueCommandContext, which specifies the strength of the hue filter.

Declaration
public ICommand HueInteractiveCommand { get; }
Property Value
System.Windows.Input.ICommand

IsImageLoaded

Gets a value indicating whether an image is loaded in the editor.

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

MaxZoomLevel

Gets or sets the maximum allowed zoom level of the image in percent.

Declaration
public double MaxZoomLevel { get; set; }
Property Value
System.Double

MinZoomLevel

Gets or sets the minimum allowed zoom level of the image in percent.

Declaration
public double MinZoomLevel { get; set; }
Property Value
System.Double

RedoCommand

Gets the redo command.

Declaration
public ICommand RedoCommand { get; }
Property Value
System.Windows.Input.ICommand

ResetCommand

Gets the reset command.

Declaration
public ICommand ResetCommand { get; }
Property Value
System.Windows.Input.ICommand

ResizeCommand

Gets the command which resizes the image. The command accepts a single parameter of type ResizeCommandContext, which specifies different settings of the resize command.

Declaration
public ICommand ResizeCommand { get; }
Property Value
System.Windows.Input.ICommand

ResizeInteractiveCommand

Gets the command which initiates the resize action of the image. The command accepts a single parameter of type ResizeCommandContext, which specifies different settings of the resize command.

Declaration
public ICommand ResizeInteractiveCommand { get; }
Property Value
System.Windows.Input.ICommand

RotateBackwardCommand

Gets the command which rotates the image backwards.

Declaration
public ICommand RotateBackwardCommand { get; }
Property Value
System.Windows.Input.ICommand

RotateLeftCommand

Gets the command which rotates the image 90 degree to the left.

Declaration
public ICommand RotateLeftCommand { get; }
Property Value
System.Windows.Input.ICommand

RotateRightCommand

Gets the command which rotates the image 90 degree to the right.

Declaration
public ICommand RotateRightCommand { get; }
Property Value
System.Windows.Input.ICommand

SaturationCommand

Gets the command which changes the image saturation. The command accepts a single parameter of type SaturationCommandContext, which specifies the strength of the saturation filter.

Declaration
public ICommand SaturationCommand { get; }
Property Value
System.Windows.Input.ICommand

SaturationInteractiveCommand

Gets the command which initiates the saturation action of the image. The command accepts a single parameter of type SaturationCommandContext, which specifies the strength of the saturation filter.

Declaration
public ICommand SaturationInteractiveCommand { get; }
Property Value
System.Windows.Input.ICommand

SharpenCommand

Gets the command which changes the image sharpness. The command accepts a single parameter of type SharpenCommandContext, which specifies the radius of the sharpen filter.

Declaration
public ICommand SharpenCommand { get; }
Property Value
System.Windows.Input.ICommand

SharpenInteractiveCommand

Gets the command which initiates the sharpen action of the image. The command accepts a single parameter of type SharpenCommandContext, which specifies the radius of the sharpen filter.

Declaration
public ICommand SharpenInteractiveCommand { get; }
Property Value
System.Windows.Input.ICommand

Source

Gets or sets the source of the image to edit.

Declaration
public ImageSource Source { get; set; }
Property Value
Microsoft.Maui.Controls.ImageSource

UndoCommand

Gets the undo command.

Declaration
public ICommand UndoCommand { get; }
Property Value
System.Windows.Input.ICommand

ZoomInCommand

Gets the command which zooms the image in with the default zoom change factor.

Declaration
public ICommand ZoomInCommand { get; }
Property Value
System.Windows.Input.ICommand

ZoomLevel

Gets the current zoom level of the image in percent.

Declaration
public double ZoomLevel { get; }
Property Value
System.Double

ZoomOutCommand

Gets the command which zooms the image out with the default zoom change factor.

Declaration
public ICommand ZoomOutCommand { get; }
Property Value
System.Windows.Input.ICommand

ZoomToFitCommand

Gets the command which zooms the image to fit the available screen space.

Declaration
public ICommand ZoomToFitCommand { get; }
Property Value
System.Windows.Input.ICommand

ZoomToLevelCommand

Gets the command which zooms the image to a specified zoom level in percent. The command accepts a single parameter of type System.Double, which specifies the desired zoom level in percent. The specified zoom level can be coerced according to the MinZoomLevel and MaxZoomLevel.

Declaration
public ICommand ZoomToLevelCommand { get; }
Property Value
System.Windows.Input.ICommand

ZoomToOriginalCommand

Gets the command which zooms the image to its original size.

Declaration
public ICommand ZoomToOriginalCommand { get; }
Property Value
System.Windows.Input.ICommand

Methods

OnSizeAllocated(Double, Double)

Declaration
protected override void OnSizeAllocated(double width, double height)
Parameters
System.Double width

System.Double height

SaveAsync(Stream, ImageFormat, Double)

Saves the currently edited image to the specified stream, encoding it with the given format and quality. The saved image contains all currently applied changes in the editor.

Declaration
public Task SaveAsync(Stream outputStream, ImageFormat imageFormat, double imageQuality)
Parameters
System.IO.Stream outputStream

Specifies the output stream to save the image to.
Microsoft.Maui.Graphics.ImageFormat imageFormat

Specifies the image format to encode the image to. Microsoft.Maui.Graphics.ImageFormat.Tiff is not supported.
System.Double imageQuality

Specifies the quality of the encoded image, when using a lossy compression format: the value of 1 specifies the maximum possible quality, resulting in minimum compression; the value of 0 specifies the minimum possible quality, resulting in maximum compression.
Returns
System.Threading.Tasks.Task

Returns a System.Threading.Tasks.Task to await the asynchronous operation.

SaveAsync(Stream, ImageFormat, Double, Size)

Saves the currently edited image to the specified stream, encoding it with the given format, quality and size. The saved image contains all currently applied changes in the editor.

Declaration
public Task SaveAsync(Stream outputStream, ImageFormat imageFormat, double imageQuality, Size maximumSize)
Parameters
System.IO.Stream outputStream

Specifies the output stream to save the image to.
Microsoft.Maui.Graphics.ImageFormat imageFormat

Specifies the image format to encode the image to. Microsoft.Maui.Graphics.ImageFormat.Tiff is not supported.
System.Double imageQuality

Specifies the quality of the encoded image, when using a lossy compression format: the value of 1 specifies the maximum possible quality, resulting in minimum compression; the value of 0 specifies the minimum possible quality, resulting in maximum compression.
Microsoft.Maui.Graphics.Size maximumSize

Specifies the maximum desired size of the image to save: if the image is larger than the specified size, it is downscaled to fit that size; if the image is smaller than the specified size, it is saved with its original size.
Returns
System.Threading.Tasks.Task

Returns a System.Threading.Tasks.Task to await the asynchronous operation.

SaveAsync(Stream, ImageFormat, Double, Double)

Saves the currently edited image to the specified stream, encoding it with the given format, quality and scale. The saved image contains all currently applied changes in the editor.

Declaration
public Task SaveAsync(Stream outputStream, ImageFormat imageFormat, double imageQuality, double scaleFactor)
Parameters
System.IO.Stream outputStream

Specifies the output stream to save the image to.
Microsoft.Maui.Graphics.ImageFormat imageFormat

Specifies the image format to encode the image to. Microsoft.Maui.Graphics.ImageFormat.Tiff is not supported.
System.Double imageQuality

Specifies the quality of the encoded image, when using a lossy compression format: the value of 1 specifies the maximum possible quality, resulting in minimum compression; the value of 0 specifies the minimum possible quality, resulting in maximum compression.
System.Double scaleFactor

Specifies a scale factor, which can be used to reduce the size of the final image: values below 1 downscale the image before saving, thus reducing the final image size; values above 1 upscale the image before saving, thus increasing the final image size.
Returns
System.Threading.Tasks.Task

Returns a System.Threading.Tasks.Task to await the asynchronous operation.

ZoomIn()

Zooms the currently open image in using the default zoom change factor.

Declaration
public void ZoomIn()

ZoomOut()

Zooms the currently open image out using the default zoom change factor.

Declaration
public void ZoomOut()

ZoomToFit()

Zooms the currently open image to fit the available size.

Declaration
public void ZoomToFit()

ZoomToLevel(Double)

Zooms the currently open image to the specified zoom level in percent. The specified zoom level can be coerced according to the values of the MinZoomLevel and MaxZoomLevel properties.

Declaration
public void ZoomToLevel(double zoomLevel)
Parameters
System.Double zoomLevel

Specifies the zoom level in percent.

ZoomToOriginal()

Zooms the currently open image to its original size.

Declaration
public void ZoomToOriginal()

Events

ImageLoaded

Raised when an image is loaded in the editor.

Declaration
public event EventHandler<ImageLoadedEventArgs> ImageLoaded
Event Type
System.EventHandler<ImageLoadedEventArgs>

Extension Methods