Class ImageEditor
Inherited Members
Namespace: Syncfusion.EJ2.ImageEditor
Assembly: Syncfusion.EJ2.dll
Syntax
public class ImageEditor : EJTagHelper
Constructors
ImageEditor()
Declaration
public ImageEditor()
Properties
AllowUndoRedo
Specifies a boolean value whether enable undo/redo operations in the image editor.
Declaration
[HtmlAttributeName("allowUndoRedo")]
public bool AllowUndoRedo { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean | The default value is true |
BeforeSave
Event callback that is raised before an image is saved.
Declaration
[HtmlAttributeName("beforeSave")]
public string BeforeSave { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
Click
Event callback that is raised while clicking on an image in the Image Editor.
Declaration
[HtmlAttributeName("click")]
public string Click { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
Created
Event callback that is raised after rendering the Image Editor component.
Declaration
[HtmlAttributeName("created")]
public string Created { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
Cropping
Event callback that is raised while cropping an image.
Declaration
[HtmlAttributeName("cropping")]
public string Cropping { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
CssClass
Defines one or more CSS classes that can be used to customize the appearance of an Image Editor component.
Declaration
[HtmlAttributeName("cssClass")]
public string CssClass { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is "" |
Destroyed
Event callback that is raised once the component is destroyed with its elements and bound events.
Declaration
[HtmlAttributeName("destroyed")]
public string Destroyed { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
Disabled
Defines whether an Image Editor component is enabled or disabled.
Declaration
[HtmlAttributeName("disabled")]
public bool Disabled { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean | The default value is false |
FileOpened
Event callback that is raised once an image is opened in an Image Editor.
Declaration
[HtmlAttributeName("fileOpened")]
public string FileOpened { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
FinetuneSettings
Specifies the finetune settings option which can be used to perform color adjustments in the image editor control.
Declaration
[HtmlAttributeName("finetuneSettings")]
public ImageEditorFinetuneSettings FinetuneSettings { get; set; }
Property Value
Type | Description |
---|---|
ImageEditorFinetuneSettings | The default value is null |
FinetuneValueChanging
Event callback that is raised when applying fine tune to an image.
Declaration
[HtmlAttributeName("finetuneValueChanging")]
public string FinetuneValueChanging { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
Flipping
Event callback that is raised while flipping an image.
Declaration
[HtmlAttributeName("flipping")]
public string Flipping { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
Height
Specifies the height of the Image Editor.
Declaration
[HtmlAttributeName("height")]
public string Height { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is "100%" |
HtmlAttributes
Allows additional HTML attributes such as title, name, etc., and accepts n number of attributes in a key-value pair format.
Declaration
[HtmlAttributeName("htmlAttributes")]
public object HtmlAttributes { get; set; }
Property Value
Type | Description |
---|---|
System.Object |
ImageFiltering
Event callback that is raised when applying filter to an image.
Declaration
[HtmlAttributeName("imageFiltering")]
public string ImageFiltering { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
Locale
Overrides the global culture and localization value for this component. Default global culture is 'en-US'.
Declaration
[HtmlAttributeName("locale")]
public string Locale { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is "" |
Panning
Event callback that is raised while panning an image.
Declaration
[HtmlAttributeName("panning")]
public string Panning { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
QuickAccessToolbarOpening
Event callback that is triggered when the quick access toolbar is opening.
Declaration
[HtmlAttributeName("quickAccessToolbarOpening")]
public string QuickAccessToolbarOpening { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
Rotating
Event callback that is raised while rotating an image.
Declaration
[HtmlAttributeName("rotating")]
public string Rotating { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
Saved
Event callback that is raised once an image is saved.
Declaration
[HtmlAttributeName("saved")]
public string Saved { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
ShapeChanging
Event callback that is raised while changing shapes in an Image Editor.
Declaration
[HtmlAttributeName("shapeChanging")]
public string ShapeChanging { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
Theme
Specifies the theme of the Image Editor. The appearance of the shape selection in Image Editor is determined by this property.
Declaration
[HtmlAttributeName("theme")]
public Theme Theme { get; set; }
Property Value
Type | Description |
---|---|
Theme | The default value is Theme.Bootstrap5 |
Toolbar
Specifies the toolbar items to perform UI interactions. It accepts both string[] and ItemModel[] to configure its toolbar items. The default value is null. If the property is not defined in the control, the default toolbar will be rendered with preconfigured toolbar commands. If the property is defined as empty collection, the toolbar will not be rendered. The preconfigured toolbar commands are
- Crop: helps to crop an image as ellipse, square, various ratio aspects, custom selection with resize, drag and drop.
- Annotate: help to insert a shape on image that supports rectangle, ellipse, line, arrow, text and freehand drawing with resize, drag and drop, and customize its appearance.
- Transform: helps to rotate and flip an image.
- Finetunes: helps to perform adjustments on an image.
- Filters: helps to perform predefined color filters.
- ZoomIn: performs zoom-in an image.
- ZoomOut: performs zoom-out an image.
- Save: save the modified image.
- Open: open an image to perform editing.
- Reset: reset the modification and restore the original image.
Declaration
[HtmlAttributeName("toolbar")]
public object Toolbar { get; set; }
Property Value
Type | Description |
---|---|
System.Object | The default value is null |
ToolbarCreated
Event callback that is raised once the toolbar is created.
Declaration
[HtmlAttributeName("toolbarCreated")]
public string ToolbarCreated { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
ToolbarItemClicked
Event callback that is raised once the toolbar item is clicked.
Declaration
[HtmlAttributeName("toolbarItemClicked")]
public string ToolbarItemClicked { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
ToolbarTemplate
Specifies a custom template for the toolbar of an image editor control. A string that specifies a custom template for the toolbar of the image editor. If this property is defined, the 'toolbar' property will not have any effect.
Declaration
[HtmlAttributeName("toolbarTemplate")]
public string ToolbarTemplate { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
ToolbarUpdating
Event callback that is raised while updating/refreshing the toolbar
Declaration
[HtmlAttributeName("toolbarUpdating")]
public string ToolbarUpdating { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
Width
Specifies the width of an Image Editor.
Declaration
[HtmlAttributeName("width")]
public string Width { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is "100%" |
Zooming
Event callback that is raised while zooming an image.
Declaration
[HtmlAttributeName("zooming")]
public string Zooming { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
ZoomSettings
Specifies the zoom settings to perform zooming action. A 'ZoomSettingsModel' value that specifies the the zoom related options which are enabled in image editor control. The default value is null.
Declaration
[HtmlAttributeName("zoomSettings")]
public ImageEditorZoomSettings ZoomSettings { get; set; }
Property Value
Type | Description |
---|---|
ImageEditorZoomSettings | The default value is null |