Class ImageEditorBuilder

Inheritance

System.Object

ControlBuilder

ImageEditorBuilder

Inherited Members

ControlBuilder.Context

Namespace: Syncfusion.EJ2.ImageEditor

Assembly: Syncfusion.EJ2.dll

Syntax

public class ImageEditorBuilder : ControlBuilder

Constructors

ImageEditorBuilder()

Declaration

public ImageEditorBuilder()

ImageEditorBuilder(ImageEditor)

Declaration

public ImageEditorBuilder(ImageEditor model)

Parameters

Type	Name	Description
ImageEditor	model

Fields

model

Declaration

public ImageEditor model

Field Value

Type	Description
ImageEditor

Properties

HtmlAttr

Declaration

public IDictionary<string, object> HtmlAttr { get; set; }

Property Value

Type	Description
System.Collections.Generic.IDictionary<System.String, System.Object>

ID

Declaration

public string ID { get; set; }

Property Value

Type	Description
System.String

Output

Declaration

public override TextWriter Output { get; set; }

Property Value

Type	Description
System.IO.TextWriter

Overrides

ControlBuilder.Output

Methods

AllowUndoRedo(Boolean)

Specifies a boolean value whether enable undo/redo operations in the image editor.

Declaration

public ImageEditorBuilder AllowUndoRedo(bool allowUndoRedo = true)

Parameters

Type	Name	Description
System.Boolean	allowUndoRedo

Returns

Type	Description
ImageEditorBuilder

BeforeSave(String)

Event callback that is raised before an image is saved.

Declaration

public ImageEditorBuilder BeforeSave(string beforeSave)

Parameters

Type	Name	Description
System.String	beforeSave

Returns

Type	Description
ImageEditorBuilder

Click(String)

Event callback that is raised while clicking on an image in the Image Editor.

Declaration

public ImageEditorBuilder Click(string click)

Parameters

Type	Name	Description
System.String	click

Returns

Type	Description
ImageEditorBuilder

Created(String)

Event callback that is raised after rendering the Image Editor component.

Declaration

public ImageEditorBuilder Created(string created)

Parameters

Type	Name	Description
System.String	created

Returns

Type	Description
ImageEditorBuilder

Cropping(String)

Event callback that is raised while cropping an image.

Declaration

public ImageEditorBuilder Cropping(string cropping)

Parameters

Type	Name	Description
System.String	cropping

Returns

Type	Description
ImageEditorBuilder

CssClass(String)

Defines one or more CSS classes that can be used to customize the appearance of an Image Editor component.

Declaration

public ImageEditorBuilder CssClass(string cssClass)

Parameters

Type	Name	Description
System.String	cssClass

Returns

Type	Description
ImageEditorBuilder

Destroyed(String)

Event callback that is raised once the component is destroyed with its elements and bound events.

Declaration

public ImageEditorBuilder Destroyed(string destroyed)

Parameters

Type	Name	Description
System.String	destroyed

Returns

Type	Description
ImageEditorBuilder

Disabled(Boolean)

Defines whether an Image Editor component is enabled or disabled.

Declaration

public ImageEditorBuilder Disabled(bool disabled = true)

Parameters

Type	Name	Description
System.Boolean	disabled

Returns

Type	Description
ImageEditorBuilder

FileOpened(String)

Event callback that is raised once an image is opened in an Image Editor.

Declaration

public ImageEditorBuilder FileOpened(string fileOpened)

Parameters

Type	Name	Description
System.String	fileOpened

Returns

Type	Description
ImageEditorBuilder

FinetuneSettings(ImageEditorFinetuneSettings)

Specifies the finetune settings option which can be used to perform color adjustments in the image editor control.

Declaration

public ImageEditorBuilder FinetuneSettings(ImageEditorFinetuneSettings finetuneSettings)

Parameters

Type	Name	Description
ImageEditorFinetuneSettings	finetuneSettings

Returns

Type	Description
ImageEditorBuilder

FinetuneSettings(Action<ImageEditorFinetuneSettingsBuilder>)

Declaration

public ImageEditorBuilder FinetuneSettings(Action<ImageEditorFinetuneSettingsBuilder> finetuneSettings)

Parameters

Type	Name	Description
System.Action<ImageEditorFinetuneSettingsBuilder>	finetuneSettings

Returns

Type	Description
ImageEditorBuilder

FinetuneValueChanging(String)

Event callback that is raised when applying fine tune to an image.

Declaration

public ImageEditorBuilder FinetuneValueChanging(string finetuneValueChanging)

Parameters

Type	Name	Description
System.String	finetuneValueChanging

Returns

Type	Description
ImageEditorBuilder

Flipping(String)

Event callback that is raised while flipping an image.

Declaration

public ImageEditorBuilder Flipping(string flipping)

Parameters

Type	Name	Description
System.String	flipping

Returns

Type	Description
ImageEditorBuilder

FrameChange(String)

Event callback that is raised while applying frames on an image.

Declaration

public ImageEditorBuilder FrameChange(string frameChange)

Parameters

Type	Name	Description
System.String	frameChange

Returns

Type	Description
ImageEditorBuilder

Height(String)

Specifies the height of the Image Editor.

Declaration

public ImageEditorBuilder Height(string height)

Parameters

Type	Name	Description
System.String	height

Returns

Type	Description
ImageEditorBuilder

HtmlAttributes(Object)

Allows additional HTML attributes such as title, name, etc., and accepts n number of attributes in a key-value pair format.

Declaration

public ImageEditorBuilder HtmlAttributes(object htmlAttributes)

Parameters

Type	Name	Description
System.Object	htmlAttributes

Returns

Type	Description
ImageEditorBuilder

ImageFiltering(String)

Event callback that is raised when applying filter to an image.

Declaration

public ImageEditorBuilder ImageFiltering(string imageFiltering)

Parameters

Type	Name	Description
System.String	imageFiltering

Returns

Type	Description
ImageEditorBuilder

Locale(String)

Overrides the global culture and localization value for this component. Default global culture is 'en-US'.

Declaration

public ImageEditorBuilder Locale(string locale)

Parameters

Type	Name	Description
System.String	locale

Returns

Type	Description
ImageEditorBuilder

Panning(String)

Event callback that is raised while panning an image.

Declaration

public ImageEditorBuilder Panning(string panning)

Parameters

Type	Name	Description
System.String	panning

Returns

Type	Description
ImageEditorBuilder

QuickAccessToolbarItemClick(String)

Event callback that is raised once the quick access toolbar item is clicked.

Declaration

public ImageEditorBuilder QuickAccessToolbarItemClick(string quickAccessToolbarItemClick)

Parameters

Type	Name	Description
System.String	quickAccessToolbarItemClick

Returns

Type	Description
ImageEditorBuilder

QuickAccessToolbarOpen(String)

Event callback that is raised when opening the quick access toolbar.

Declaration

public ImageEditorBuilder QuickAccessToolbarOpen(string quickAccessToolbarOpen)

Parameters

Type	Name	Description
System.String	quickAccessToolbarOpen

Returns

Type	Description
ImageEditorBuilder

QuickAccessToolbarTemplate(String)

Specifies a template for the quick access toolbar. Use this property to customize the quick access toolbar.

Declaration

public ImageEditorBuilder QuickAccessToolbarTemplate(string quickAccessToolbarTemplate)

Parameters

Type	Name	Description
System.String	quickAccessToolbarTemplate

Returns

Type	Description
ImageEditorBuilder

Render()

Declaration

public HtmlString Render()

Returns

Type	Description
Microsoft.AspNetCore.Html.HtmlString

Resizing(String)

Event callback that is raised while resizing an image.

Declaration

public ImageEditorBuilder Resizing(string resizing)

Parameters

Type	Name	Description
System.String	resizing

Returns

Type	Description
ImageEditorBuilder

Rotating(String)

Event callback that is raised while rotating an image.

Declaration

public ImageEditorBuilder Rotating(string rotating)

Parameters

Type	Name	Description
System.String	rotating

Returns

Type	Description
ImageEditorBuilder

Saved(String)

Event callback that is raised once an image is saved.

Declaration

public ImageEditorBuilder Saved(string saved)

Parameters

Type	Name	Description
System.String	saved

Returns

Type	Description
ImageEditorBuilder

SelectionChanging(String)

Event callback that is raised while changing selection in an Image Editor.

Declaration

public ImageEditorBuilder SelectionChanging(string selectionChanging)

Parameters

Type	Name	Description
System.String	selectionChanging

Returns

Type	Description
ImageEditorBuilder

SelectionSettings(ImageEditorSelectionSettings)

Specifies the selection settings to customize selection. A 'SelectionSettingsModel' value that specifies the the customization related options which are enabled in image editor control. The default value is null.

Declaration

public ImageEditorBuilder SelectionSettings(ImageEditorSelectionSettings selectionSettings)

Parameters

Type	Name	Description
ImageEditorSelectionSettings	selectionSettings

Returns

Type	Description
ImageEditorBuilder

SelectionSettings(Action<ImageEditorSelectionSettingsBuilder>)

Declaration

public ImageEditorBuilder SelectionSettings(Action<ImageEditorSelectionSettingsBuilder> selectionSettings)

Parameters

Type	Name	Description
System.Action<ImageEditorSelectionSettingsBuilder>	selectionSettings

Returns

Type	Description
ImageEditorBuilder

ShapeChanging(String)

Event callback that is raised while changing shapes in an Image Editor.

Declaration

public ImageEditorBuilder ShapeChanging(string shapeChanging)

Parameters

Type	Name	Description
System.String	shapeChanging

Returns

Type	Description
ImageEditorBuilder

ShowQuickAccessToolbar(Boolean)

Specifies whether to show/hide the quick access toolbar.

Declaration

public ImageEditorBuilder ShowQuickAccessToolbar(bool showQuickAccessToolbar = true)

Parameters

Type	Name	Description
System.Boolean	showQuickAccessToolbar

Returns

Type	Description
ImageEditorBuilder

Theme(Theme)

Specifies the theme of the Image Editor. The appearance of the shape selection in Image Editor is determined by this property.

Declaration

public ImageEditorBuilder Theme(Theme theme)

Parameters

Type	Name	Description
Theme	theme

Returns

Type	Description
ImageEditorBuilder

Toolbar(Object)

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, path, text, image 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

public ImageEditorBuilder Toolbar(object toolbar)

Parameters

Type	Name	Description
System.Object	toolbar

Returns

Type	Description
ImageEditorBuilder

ToolbarCreated(String)

Event callback that is raised once the toolbar is created.

Declaration

public ImageEditorBuilder ToolbarCreated(string toolbarCreated)

Parameters

Type	Name	Description
System.String	toolbarCreated

Returns

Type	Description
ImageEditorBuilder

ToolbarItemClicked(String)

Event callback that is raised once the toolbar item is clicked.

Declaration

public ImageEditorBuilder ToolbarItemClicked(string toolbarItemClicked)

Parameters

Type	Name	Description
System.String	toolbarItemClicked

Returns

Type	Description
ImageEditorBuilder

ToolbarTemplate(String)

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 ImageEditorBuilder ToolbarTemplate(string toolbarTemplate)

Parameters

Type	Name	Description
System.String	toolbarTemplate

Returns

Type	Description
ImageEditorBuilder

ToolbarUpdating(String)

Event callback that is raised while updating/refreshing the toolbar

Declaration

public ImageEditorBuilder ToolbarUpdating(string toolbarUpdating)

Parameters

Type	Name	Description
System.String	toolbarUpdating

Returns

Type	Description
ImageEditorBuilder

Width(String)

Specifies the width of an Image Editor.

Declaration

public ImageEditorBuilder Width(string width)

Parameters

Type	Name	Description
System.String	width

Returns

Type	Description
ImageEditorBuilder

Zooming(String)

Event callback that is raised while zooming an image.

Declaration

public ImageEditorBuilder Zooming(string zooming)

Parameters

Type	Name	Description
System.String	zooming

Returns

Type	Description
ImageEditorBuilder

ZoomSettings(ImageEditorZoomSettings)

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

public ImageEditorBuilder ZoomSettings(ImageEditorZoomSettings zoomSettings)

Parameters

Type	Name	Description
ImageEditorZoomSettings	zoomSettings

Returns

Type	Description
ImageEditorBuilder

ZoomSettings(Action<ImageEditorZoomSettingsBuilder>)

Declaration

public ImageEditorBuilder ZoomSettings(Action<ImageEditorZoomSettingsBuilder> zoomSettings)

Parameters

Type	Name	Description
System.Action<ImageEditorZoomSettingsBuilder>	zoomSettings

Returns

Type	Description
ImageEditorBuilder