Class ImageEditorEvents

Specifies the events available in the SfImageEditor component.

Inheritance

System.Object

ImageEditorEvents

Namespace: Syncfusion.Blazor.ImageEditor

Assembly: Syncfusion.Blazor.dll

Syntax

public class ImageEditorEvents : OwningComponentBase

Constructors

ImageEditorEvents()

Declaration

public ImageEditorEvents()

Properties

Clicked

Gets or sets an event callback that is raised while clicking the canvas element.

Declaration

public EventCallback<ImageEditorClickEventArgs> Clicked { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<ImageEditorClickEventArgs>	An event callback function.

Created

Gets or sets an event callback that is raised when the component is rendered.

Declaration

public EventCallback<EventArgs> Created { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<System.EventArgs>	An event callback function.

Cropped

Gets or sets an event callback that is raised after cropping action is performed in the SfImageEditor.

Declaration

public EventCallback<CroppedEventArgs> Cropped { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<CroppedEventArgs>	An event callback function that allows responding to crop actions.

Remarks

This event is triggered after cropping has been performed while clicking the OK button in toolbar. The Cropped event is triggered after cropping action is performed and so we can get the current image here for further usage such as save the image after every action.

Cropping

Gets or sets an event callback that is raised when cropping action performed in the SfImageEditor.

Declaration

public EventCallback<CropEventArgs> Cropping { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<CropEventArgs>	An event callback function.

Remarks

Cropping is a cancelable event. To cancel the cropping action, set the Cancel property as true.

Destroyed

Gets or sets an event callback that is raised when the component is destroyed.

Declaration

public EventCallback<object> Destroyed { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<System.Object>	An event callback function.

FileOpened

Gets or sets an event callback that is raised once the image is opened in the SfImageEditor.

Declaration

public EventCallback<FileOpenEventArgs> FileOpened { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<FileOpenEventArgs>	An event callback function.

Remarks

This event is used to perform actions such as selection, shape insertion while loading the image.

FinetuneValueChanged

Gets or sets an event callback that is raised after fine-tune action is performed in the SfImageEditor.

Declaration

public EventCallback<FinetuneValueChangedEventArgs> FinetuneValueChanged { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<FinetuneValueChangedEventArgs>	An event callback function that allows responding to fine-tune actions.

Remarks

The FinetuneValueChanged event is triggered after finetuning action is performed and so we can get the current image here for further usage such as save the image after every action.

FinetuneValueChanging

Gets or sets an event callback that is raised when finetune the color of the image in the SfImageEditor.

Declaration

public EventCallback<FinetuneEventArgs> FinetuneValueChanging { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<FinetuneEventArgs>	An event callback function.

Remarks

FinetuneValueChanging is a cancelable event. To cancel the finetune action, set the Cancel property as true.

Flipped

Gets or sets an event callback that is raised after flip action is performed in the SfImageEditor.

Declaration

public EventCallback<FlippedEventArgs> Flipped { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<FlippedEventArgs>	An event callback function that allows responding to flip actions.

Remarks

The Flipped event is triggered after flipping action is performed and so we can get the current image here for further usage such as save the image after every action.

Flipping

Gets or sets an event callback that is raised when flipping action performed in the SfImageEditor.

Declaration

public EventCallback<FlipEventArgs> Flipping { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<FlipEventArgs>	An event callback function.

Remarks

Flipping is a cancelable event. To cancel the flipping action, set the Cancel property as true.

FrameChanged

Gets or sets an event callback that is raised after frame related actions were performed in the SfImageEditor.

Declaration

public EventCallback<FrameChangedEventArgs> FrameChanged { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<FrameChangedEventArgs>	An event callback function that allows responding to frame related actions.

Remarks

The FrameChanged event is triggered after zooming action is performed and so we can get the current image here for further usage such as save the image after every action.

FrameChanging

Gets or sets an event callback that is raised when a frame change action is performed in the SfImageEditor.

Declaration

public EventCallback<FrameChangeEventArgs> FrameChanging { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<FrameChangeEventArgs>	An event callback function that allows responding to frame change actions.

Remarks

The FrameChanging event is cancelable. To cancel the frame changing action, set the Cancel property to true.

HistoryChanged

Gets or sets an event callback that is raised after undo and redo action is performed in the SfImageEditor.

Declaration

public EventCallback<HistoryChangedEventArgs> HistoryChanged { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<HistoryChangedEventArgs>	An event callback function that allows responding to undo and redo actions.

Remarks

The HistoryChanged event is triggered after every undo and redo action is performed and so we can get the current image here for further usage such as save the image after every action.

ImageFiltered

Gets or sets an event callback that is raised after filter action is performed in the SfImageEditor.

Declaration

public EventCallback<ImageFilteredEventArgs> ImageFiltered { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<ImageFilteredEventArgs>	An event callback function that allows responding to filter actions.

Remarks

The ImageFiltered event is triggered after filtering action is performed and so we can get the current image here for further usage such as save the image after every action.

ImageFiltering

Gets or sets an event callback that is raised when applying filters to the image in the SfImageEditor.

Declaration

public EventCallback<ImageFilterEventArgs> ImageFiltering { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<ImageFilterEventArgs>	An event callback function.

Remarks

ImageFiltering is a cancelable event. To cancel the filtering action, set the Cancel property as true.

ImageResized

Gets or sets an event callback that is raised after resize action is performed in the SfImageEditor.

Declaration

public EventCallback<ImageResizedEventArgs> ImageResized { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<ImageResizedEventArgs>	An event callback function that allows responding to resize actions.

Remarks

The ImageResized event is triggered after resizing action is performed and so we can get the current image here for further usage such as save the image after every action.

ImageResizing

Gets or sets a callback event that is raised when a resizing action is performed in the SfImageEditor.

Declaration

public EventCallback<ImageResizeEventArgs> ImageResizing { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<ImageResizeEventArgs>	An event callback function that allows responding to the resizing action.

Remarks

The ImageResizing event is cancelable. To cancel the resizing action,
set the Cancel property to true.

OnPanEnd

Gets or sets an event callback that is raised when the panning action is completed in the SfImageEditor.

Declaration

public EventCallback<PanEventArgs> OnPanEnd { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<PanEventArgs>	An event callback function.

Remarks

OnPanEnd is a cancelable event. To cancel the panning action, set the Cancel property as true.

OnPanStart

Gets or sets an event callback that is raised when the panning action is started in the SfImageEditor.

Declaration

public EventCallback<PanEventArgs> OnPanStart { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<PanEventArgs>	An event callback function.

Remarks

OnPanStart is a cancelable event. To cancel the panning action, set the Cancel property as true.

OnSelectionResizeEnd

Gets or sets an event callback that is raised when the selection resizing is completed in the SfImageEditor.

Declaration

public EventCallback<SelectionChangeEventArgs> OnSelectionResizeEnd { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<SelectionChangeEventArgs>	An event callback function.

Remarks

see cref="OnSelectionResizeEnd"/> is a cancelable event. To cancel the shape resizing action, set the Cancel property as true.

OnSelectionResizeStart

Gets or sets an event callback that is raised when the selection resizing is started in the SfImageEditor.

Declaration

public EventCallback<SelectionChangeEventArgs> OnSelectionResizeStart { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<SelectionChangeEventArgs>	An event callback function.

Remarks

see cref="OnSelectionResizeStart"/> is a cancelable event. To cancel the shape resizing action, set the Cancel property as true.

OnShapeDragEnd

Gets or sets an event callback that is raised when the shape dragging is completed in the SfImageEditor.

Declaration

public EventCallback<ShapeChangeEventArgs> OnShapeDragEnd { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<ShapeChangeEventArgs>	An event callback function.

Remarks

OnShapeDragEnd is a cancelable event. To cancel the shape dragging action, set the Cancel property as true.

OnShapeDragStart

Gets or sets an event callback that is raised when the shape dragging is started in the SfImageEditor.

Declaration

public EventCallback<ShapeChangeEventArgs> OnShapeDragStart { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<ShapeChangeEventArgs>	An event callback function.

Remarks

OnShapeDragStart is a cancelable event. To cancel the shape dragging action, set the Cancel property as true.

OnShapeResizeEnd

Gets or sets an event callback that is raised when the shape resizing is completed in the SfImageEditor.

Declaration

public EventCallback<ShapeChangeEventArgs> OnShapeResizeEnd { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<ShapeChangeEventArgs>	An event callback function.

Remarks

OnShapeResizeEnd is a cancelable event. To cancel the shape resizing action, set the Cancel property as true.

OnShapeResizeStart

Gets or sets an event callback that is raised when the shape resizing is started in the SfImageEditor.

Declaration

public EventCallback<ShapeChangeEventArgs> OnShapeResizeStart { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<ShapeChangeEventArgs>	An event callback function.

Remarks

see cref="OnShapeResizeStart"/> is a cancelable event. To cancel the shape resizing action, set the Cancel property as true.

QuickAccessToolbarClicked

Gets or sets an event callback that is raised once the quick-access toolbar item is clicked in the SfImageEditor.

Declaration

public EventCallback<ClickEventArgs> QuickAccessToolbarClicked { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<ClickEventArgs>	An event callback function.

Remarks

This event is used to perform actions such as cloning, deleting the shapes while clicking the quick-access toolbar items.

QuickAccessToolbarOpening

Gets or sets an event callback that is raised when opening the quick-access toolbar in the SfImageEditor.

Declaration

public EventCallback<QuickAccessToolbarEventArgs> QuickAccessToolbarOpening { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<QuickAccessToolbarEventArgs>	An event callback function.

Remarks

QuickAccessToolbarOpening is a cancelable event. To cancel the toolbar opening action, set the Cancel property as true.

Rotated

Gets or sets an event callback that is raised after the rotate and straightening action is performed in the SfImageEditor.

Declaration

public EventCallback<RotatedEventArgs> Rotated { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<RotatedEventArgs>	An event callback function that allows responding to rotate actions.

Remarks

The Rotated event is triggered after rotating action and straightening action is performed and so we can get the current image here for further usage such as save the image after every action.

Rotating

Gets or sets an event callback that is raised when rotating and straightening action performed in the SfImageEditor.

Declaration

public EventCallback<RotateEventArgs> Rotating { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<RotateEventArgs>	An event callback function.

Remarks

Rotating is a cancelable event. To cancel the rotating and straightening action, set the Cancel property as /// For straightening, this event is triggered once the slider movement has been completed. true.

Saving

Gets or sets an event callback that is raised when saving action performed in the SfImageEditor.

Declaration

public EventCallback<SaveEventArgs> Saving { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<SaveEventArgs>	An event callback function.

Remarks

Saving is a cancelable event. To cancel the saving action, set the Cancel property as true.

ShapeChanged

Gets or sets an event callback that is raised after shape related actions were performed in the SfImageEditor.

Declaration

public EventCallback<ShapeChangedEventArgs> ShapeChanged { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<ShapeChangedEventArgs>	An event callback function that allows responding to shape related actions.

Remarks

The ShapeChanged event is triggered after performing an action which includes changing the stroke color, fill color, and stroke width etc., for all the annotations and after the shape is applied to the canvas while clicking the OK button in toolbar. So that we can get the current image here for further usage such as save the image after every action.

ShapeChanging

Gets or sets an event callback that is raised when changing shapes in the SfImageEditor.

Declaration

public EventCallback<ShapeChangeEventArgs> ShapeChanging { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<ShapeChangeEventArgs>	An event callback function.

Remarks

ShapeChanging is a cancelable event. To cancel the shape changing action, set the Cancel property as true. This event is triggered while changing stroke color, fill Color, and stroke width property for rectangle. This event is triggered while changing radius, stroke color, fill Color, and stroke width property for ellipse. This event is triggered while changing stroke color, and stroke width property for line. This event is triggered while changing stroke color, and stroke width property for path. This event is triggered while changing stroke color, start, end, and stroke width property for arrow. This event is triggered while changing text, font size, font style, color property for text. This event is triggered while changing stroke width, stroke color property for freehand draw.

ToolbarCreated

Gets or sets an event callback that is raised once the toolbar has been created in the SfImageEditor.

Declaration

public EventCallback<object> ToolbarCreated { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<System.Object>	An event callback function.

Remarks

This event is used to perform customization to the custom toolbar items.

ToolbarItemClicked

Gets or sets an event callback that is raised once the toolbar item is clicked in the SfImageEditor.

Declaration

public EventCallback<ClickEventArgs> ToolbarItemClicked { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<ClickEventArgs>	An event callback function.

Remarks

This event is used to perform actions such as selection, shape insertion while clicking the custom toolbar items.

ToolbarUpdating

Gets or sets an event callback that is raised when updating/refreshing the toolbar in the SfImageEditor.

Declaration

public EventCallback<ToolbarEventArgs> ToolbarUpdating { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<ToolbarEventArgs>	An event callback function.

Remarks

ToolbarUpdating is a cancelable event. To cancel the toolbar updating action, set the Cancel property as true.

Zoomed

Gets or sets an event callback that is raised after zoom action is performed in the SfImageEditor.

Declaration

public EventCallback<ZoomedEventArgs> Zoomed { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<ZoomedEventArgs>	An event callback function that allows responding to zoom actions.

Remarks

The Zoomed event is triggered after zooming action is performed and so we can get the current image here for further usage such as save the image after every action.

Zooming

Gets or sets an event callback that is raised when zooming in or out action performed in the SfImageEditor.

Declaration

public EventCallback<ZoomEventArgs> Zooming { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<ZoomEventArgs>	An event callback function.

Remarks

Zooming is a cancelable event. To cancel the zooming action, set the Cancel property as true.

Examples

The below example explains about zooming event.

 
    <SfImageEditor>
        <ImageEditorEvents Zooming="zooming"/>
    </SfImageEditor>
    @code {
        private zooming(ZoomEventArgs args){
            args.Cancel = false; //Set as true to prevent zooming.
        }
    }