Class ImageEditor
Inheritance
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
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
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
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
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
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
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
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
public bool Disabled { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean | The default value is false |
EditComplete
Event callback that is triggered after the completion of an editing action in the image editor.
Declaration
public string EditComplete { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
FileOpened
Event callback that is raised once an image is opened in an Image Editor.
Declaration
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
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
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
public string Flipping { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
FontFamily
Predefine the font families that populate in font family dropdown list from the toolbar.
Declaration
public ImageEditorFontFamily FontFamily { get; set; }
Property Value
Type | Description |
---|---|
ImageEditorFontFamily | The default value is null |
FrameChange
Event callback that is raised while applying frames on an image.
Declaration
public string FrameChange { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
Height
Specifies the height of the Image Editor.
Declaration
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
public object HtmlAttributes { get; set; }
Property Value
Type |
---|
System.Object |
ImageFiltering
Event callback that is raised when applying filter to an image.
Declaration
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
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
public string Panning { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
QuickAccessToolbarItemClick
Event callback that is raised once the quick access toolbar item is clicked.
Declaration
public string QuickAccessToolbarItemClick { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
QuickAccessToolbarOpen
Event callback that is raised when opening the quick access toolbar.
Declaration
public string QuickAccessToolbarOpen { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
QuickAccessToolbarTemplate
Specifies a template for the quick access toolbar. Use this property to customize the quick access toolbar.
Declaration
public string QuickAccessToolbarTemplate { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
Resizing
Event callback that is raised while resizing an image.
Declaration
public string Resizing { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
Rotating
Event callback that is raised while rotating an image.
Declaration
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
public string Saved { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
SelectionChanging
Event callback that is raised while changing selection in an Image Editor.
Declaration
public string SelectionChanging { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
SelectionSettings
Declaration
public ImageEditorSelectionSettings SelectionSettings { get; set; }
Property Value
Type |
---|
ImageEditorSelectionSettings |
ShapeChange
Event callback that is raised after shape changing action is performed in an image editor.
Declaration
public string ShapeChange { 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
public string ShapeChanging { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
ShowQuickAccessToolbar
Specifies whether to show/hide the quick access toolbar.
Declaration
public bool ShowQuickAccessToolbar { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean | The default value is true |
Theme
Specifies the theme of the Image Editor. The appearance of the shape selection in Image Editor is determined by this property.
Declaration
public Theme Theme { get; set; }
Property Value
Type | Description |
---|---|
Theme | The default value is Theme.Bootstrap5 |
Toolbar
Declaration
public object Toolbar { get; set; }
Property Value
Type |
---|
System.Object |
ToolbarCreated
Event callback that is raised once the toolbar is created.
Declaration
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
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
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
public string ToolbarUpdating { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
UploadSettings
Represents the settings for configuring image uploads.
Declaration
public ImageEditorUploadSettings UploadSettings { get; set; }
Property Value
Type | Description |
---|---|
ImageEditorUploadSettings | The default value is null |
Width
Specifies the width of an Image Editor.
Declaration
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
public string Zooming { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
ZoomSettings
Declaration
public ImageEditorZoomSettings ZoomSettings { get; set; }
Property Value
Type |
---|
ImageEditorZoomSettings |