Class RichTextEditor

Inheritance
System.Object
EJTagHelper
RichTextEditor
Inherited Members
Namespace: Syncfusion.EJ2.RichTextEditor
Assembly: Syncfusion.EJ2.dll
Syntax
public class RichTextEditor : EJTagHelper

Constructors

RichTextEditor()

Declaration
public RichTextEditor()

Properties

ActionBegin

Triggers before command execution using toolbar items or executeCommand method. If you cancel this event, the command cannot be executed. Set the cancel argument to true to cancel the command execution.

Declaration
public string ActionBegin { get; set; }
Property Value
Type Description
System.String

The default value is null

ActionComplete

Triggers after command execution using toolbar items or executeCommand method.

Declaration
public string ActionComplete { get; set; }
Property Value
Type Description
System.String

The default value is null

AfterImageDelete

Event triggers when the selected image is cleared from the Rich Text Editor Content.

Declaration
public string AfterImageDelete { get; set; }
Property Value
Type Description
System.String

The default value is null

AfterMediaDelete

Event triggers when the selected media is cleared from the Rich Text Editor Content.

Declaration
public string AfterMediaDelete { get; set; }
Property Value
Type Description
System.String

The default value is null

AfterPasteCleanup

Triggers after cleanup the copied content.

Declaration
public string AfterPasteCleanup { get; set; }
Property Value
Type Description
System.String

The default value is null

AutoSaveOnIdle

Enables or disables the auto-save option which performs the save action while in the idle state after typed content. If enabled, the Rich Text Editor will save the content on idle state with saveInterval property's value. The change event will be triggered if the content has changed from the last saved state.

Declaration
public bool AutoSaveOnIdle { get; set; }
Property Value
Type Description
System.Boolean

The default value is false

BackgroundColor

Predefine the color palette that can be rendered for background color (text highlighted color) toolbar command.

Declaration
public RichTextEditorBackgroundColor BackgroundColor { get; set; }
Property Value
Type Description
RichTextEditorBackgroundColor

The default value is null

BeforeDialogClose

Event triggers when the dialog is being closed. If you cancel this event, the dialog remains opened. Set the cancel argument to true to prevent closing a dialog.

Declaration
public string BeforeDialogClose { get; set; }
Property Value
Type Description
System.String

The default value is null

BeforeDialogOpen

Event triggers when the dialog is being opened. If you cancel this event, the dialog remains closed. Set the cancel argument to true to cancel the open of a dialog.

Declaration
public string BeforeDialogOpen { get; set; }
Property Value
Type Description
System.String

The default value is null

BeforeFileUpload

Event triggers before the media audio/video upload process.

Declaration
public string BeforeFileUpload { get; set; }
Property Value
Type Description
System.String

The default value is null

BeforeImageDrop

Triggers before drop the image.

Declaration
public string BeforeImageDrop { get; set; }
Property Value
Type Description
System.String

The default value is null

BeforeImageUpload

Event triggers before the image upload process.

Declaration
public string BeforeImageUpload { get; set; }
Property Value
Type Description
System.String

The default value is null

BeforePasteCleanup

Triggers before cleanup the copied content.

Declaration
public string BeforePasteCleanup { get; set; }
Property Value
Type Description
System.String

The default value is null

BeforeQuickToolbarOpen

Event triggers when the quick toolbar is being opened.

Declaration
public string BeforeQuickToolbarOpen { get; set; }
Property Value
Type Description
System.String

The default value is null

BeforeSanitizeHtml

Event triggers before sanitize the value. It's only applicable to editorMode as HTML.

Declaration
public string BeforeSanitizeHtml { get; set; }
Property Value
Type Description
System.String

The default value is null

Blur

Triggers when Rich Text Editor is focused out.

Declaration
public string Blur { get; set; }
Property Value
Type Description
System.String

The default value is null

BulletFormatList

Predefine the advanced list types that populate in the bulletFormatList dropdown list from the toolbar.

Declaration
public RichTextEditorBulletFormatList BulletFormatList { get; set; }
Property Value
Type Description
RichTextEditorBulletFormatList

The default value is null

Change

Triggers only when Rich Text Editor is blurred and changes are done to the content.

Declaration
public string Change { get; set; }
Property Value
Type Description
System.String

The default value is null

ContentTemplate

To get or set value for ContentTemplate.

Declaration
public MvcTemplate<object> ContentTemplate { get; set; }
Property Value
Type Description
MvcTemplate<System.Object>

Created

Triggers when the Rich Text Editor is rendered.

Declaration
public string Created { get; set; }
Property Value
Type Description
System.String

The default value is null

CssClass

Specifies the CSS class name appended with the root element of the RichTextEditor. One or more custom CSS classes can be added to a RichTextEditor.

Declaration
public string CssClass { get; set; }
Property Value
Type Description
System.String

The default value is null

Destroyed

Triggers when the Rich Text Editor is destroyed.

Declaration
public string Destroyed { get; set; }
Property Value
Type Description
System.String

The default value is null

DialogClose

Event triggers after the dialog has been closed.

Declaration
public string DialogClose { get; set; }
Property Value
Type Description
System.String

The default value is null

DialogOpen

Event triggers when a dialog is opened.

Declaration
public string DialogOpen { get; set; }
Property Value
Type Description
System.String

The default value is null

EditorMode

Specifies the editing mode of the RichTextEditor.

Declaration
public EditorMode EditorMode { get; set; }
Property Value
Type Description
EditorMode

The default value is EditorMode.HTML

EmojiPickerSettings

Specifies the emoji picker options in Rich Text Editor with the following properties. iconsSet – Specify an array of items representing emoji icons. showSearchBox - Enables or disables the search box in an emoji picker.

Declaration
public RichTextEditorEmojiSettings EmojiPickerSettings { get; set; }
Property Value
Type Description
RichTextEditorEmojiSettings

The default value is null

EnableAutoUrl

Enable enableAutoUrl to accept the given URL (relative or absolute) without validating the URL for hyperlinks, otherwise the given URL will automatically convert to absolute path URL by prefixing https:// for hyperlinks.

Declaration
public bool EnableAutoUrl { get; set; }
Property Value
Type Description
System.Boolean

The default value is false

Enabled

Specifies a value that indicates whether the component is enabled or not.

Declaration
public bool Enabled { get; set; }
Property Value
Type Description
System.Boolean

The default value is true

EnableHtmlEncode

specifies the value whether the source code is displayed with encoded format.

Declaration
public bool EnableHtmlEncode { get; set; }
Property Value
Type Description
System.Boolean

The default value is false

EnableHtmlSanitizer

Defines whether to allow the cross-scripting site or not.

Declaration
public bool EnableHtmlSanitizer { get; set; }
Property Value
Type Description
System.Boolean

The default value is true

EnablePersistence

Enables or disables the persisting component's state between page reloads. If enabled, the value of Rich Text Editor is persisted

Declaration
public bool EnablePersistence { get; set; }
Property Value
Type Description
System.Boolean

The default value is false

EnableResize

Enables or disables the resizing option in the editor. If enabled, the Rich Text Editor can be resized by dragging the resize icon in the bottom right corner.

Declaration
public bool EnableResize { get; set; }
Property Value
Type Description
System.Boolean

The default value is false

EnableRtl

Enable or disable rendering component in right to left direction.

Declaration
public bool EnableRtl { get; set; }
Property Value
Type Description
System.Boolean

The default value is false

EnableTabKey

Allows the tab key action in the Rich Text Editor content.

Declaration
public bool EnableTabKey { get; set; }
Property Value
Type Description
System.Boolean

The default value is false

EnableXhtml

Specifies a value that indicates whether the xhtml is enabled or not.

Declaration
public bool EnableXhtml { get; set; }
Property Value
Type Description
System.Boolean

The default value is false

EnterKey

Specifies tag to be inserted when enter key is pressed.

Declaration
public EnterKey EnterKey { get; set; }
Property Value
Type Description
EnterKey

The default value is EnterKey.P

FileManagerSettings

Specifies the image manager options in Rich Text Editor component and control with the following properties. enable - set boolean value to enable or disable the image manager. ajaxSettings - Specifies the AJAX settings of the image manager. contextMenuSettings - Specifies the context menu settings of the image manager. navigationPaneSettings - Specifies the navigation pane settings of the image manager. toolbarSettings - Specifies the group of items aligned horizontally in the toolbar. uploadSettings - Specifies the upload settings for the image manager.

Declaration
public RichTextEditorFileManagerSettings FileManagerSettings { get; set; }
Property Value
Type Description
RichTextEditorFileManagerSettings

The default value is null

FileRemoving

Event triggers when the selected media is cleared from the insert audio/video dialog.

Declaration
public string FileRemoving { get; set; }
Property Value
Type Description
System.String

The default value is null

FileSelected

Event triggers when the media is selected or dragged into the insert media audio/video dialog.

Declaration
public string FileSelected { get; set; }
Property Value
Type Description
System.String

The default value is null

FileUploadFailed

Event triggers when there is an error in the media upload.

Declaration
public string FileUploadFailed { get; set; }
Property Value
Type Description
System.String

The default value is null

FileUploading

Event triggers when the selected media begins to upload in the insert media audio/video dialog.

Declaration
public string FileUploading { get; set; }
Property Value
Type Description
System.String

The default value is null

FileUploadSuccess

Event triggers when the media is successfully uploaded to the server side.

Declaration
public string FileUploadSuccess { get; set; }
Property Value
Type Description
System.String

The default value is null

FloatingToolbarOffset

Preserves the toolbar at the top of the Rich Text Editor on scrolling and specifies the offset of the floating toolbar from documents top position

Declaration
public double FloatingToolbarOffset { get; set; }
Property Value
Type Description
System.Double

The default value is 0

Focus

Triggers when Rich Text Editor is focused in

Declaration
public string Focus { get; set; }
Property Value
Type Description
System.String

The default value is null

FontColor

Predefine the color palette that can be rendered for font color toolbar command .

Declaration
public RichTextEditorFontColor FontColor { get; set; }
Property Value
Type Description
RichTextEditorFontColor

The default value is null

FontFamily

Predefine the font families that populate in font family dropdown list from the toolbar.

Declaration
public RichTextEditorFontFamily FontFamily { get; set; }
Property Value
Type Description
RichTextEditorFontFamily

The default value is null

FontSize

Predefine the font sizes that populate in font size dropdown list from the toolbar.

Declaration
public RichTextEditorFontSize FontSize { get; set; }
Property Value
Type Description
RichTextEditorFontSize

The default value is null

For

Declaration
public override ModelExpression For { get; set; }
Property Value
Type Description
Microsoft.AspNetCore.Mvc.ViewFeatures.ModelExpression
Overrides

Format

Predefine the collection of paragraph styles along with quote and code style that populate in format dropdown from the toolbar.

Declaration
public RichTextEditorFormat Format { get; set; }
Property Value
Type Description
RichTextEditorFormat

The default value is null

FormatPainterSettings

Specifies the format painter options in Rich Text Editor with the following properties. allowedFormats - Sets the tag name selectors for elements from which the formats can be copied. deniedFormats - Sets the selectors for elements from which formats cannot be copied.

Declaration
public RichTextEditorFormatPainterSettings FormatPainterSettings { get; set; }
Property Value
Type Description
RichTextEditorFormatPainterSettings

The default value is null

Formatter

Customize keyCode to change the key value.

Declaration
public RichTextEditorFormatter Formatter { get; set; }
Property Value
Type Description
RichTextEditorFormatter

The default value is null

Height

Specifies the height of the Rich Text Editor component.

Declaration
public string Height { get; set; }
Property Value
Type Description
System.String

The default value is "auto"

HtmlAttributes

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

Declaration
public object HtmlAttributes { get; set; }
Property Value
Type Description
System.Object

The default value is null

IframeSettings

Specifies the items to be rendered in an iframe mode, and it has the following properties. enable - Set Boolean value to enable, the editors content is placed in an iframe and isolated from the rest of the page. attributes - Custom style to be used inside the iframe to display content. This style is added to the iframe body. resources - we can add both styles and scripts to the iframe.

  1. styles[] - An array of CSS style files to inject inside the iframe to display content
  2. scripts[] - An array of JS script files to inject inside the iframe
Declaration
public RichTextEditorIFrameSettings IframeSettings { get; set; }
Property Value
Type Description
RichTextEditorIFrameSettings

The default value is null

ImageRemoving

Event triggers when the selected image is cleared from the insert image dialog.

Declaration
public string ImageRemoving { get; set; }
Property Value
Type Description
System.String

The default value is null

ImageSelected

Event triggers when the image is selected or dragged into the insert image dialog.

Declaration
public string ImageSelected { get; set; }
Property Value
Type Description
System.String

The default value is null

ImageUploadFailed

Event triggers when there is an error in the image upload.

Declaration
public string ImageUploadFailed { get; set; }
Property Value
Type Description
System.String

The default value is null

ImageUploading

Event triggers when the selected image begins to upload in the insert image dialog.

Declaration
public string ImageUploading { get; set; }
Property Value
Type Description
System.String

The default value is null

ImageUploadSuccess

Event triggers when the image is successfully uploaded to the server side.

Declaration
public string ImageUploadSuccess { get; set; }
Property Value
Type Description
System.String

The default value is null

InlineMode

Enable or disable the inline edit mode. enable - set boolean value to enable or disable the inline edit mode. onSelection - If its set to true, upon selecting the text, the toolbar is opened in inline. If its set to false, upon clicking to the target element, the toolbar is opened.

Declaration
public RichTextEditorInlineMode InlineMode { get; set; }
Property Value
Type Description
RichTextEditorInlineMode

The default value is null

InsertAudioSettings

Specifies the audio insert options in Rich Text Editor component and control with the following properties. allowedTypes - Specifies the extensions of the audio types allowed to insert on bowering and passing the extensions with comma separators. For example, pass allowedTypes as .jpg and .png. layoutOption - Sets the default display for an audio when it is inserted in to the RichTextEditor. Possible options are: 'Inline' and 'Break'. saveFormat - Specifies the format to store the audio in the Rich Text Editor (Base64 or Blob).

If you want to insert a lot of tiny audios in the editor and don't want a specific physical location for saving audios, you can opt to save format as Base64. saveUrl - Specifies the service URL of save action that will receive the uploaded files and save them in the server. path - Specifies the path of the location to store the audios and refer it to display the audios.

Declaration
public RichTextEditorAudioSettings InsertAudioSettings { get; set; }
Property Value
Type Description
RichTextEditorAudioSettings

The default value is null

InsertImageSettings

Specifies the image insert options in Rich Text Editor component and control with the following properties. allowedTypes - Specifies the extensions of the image types allowed to insert on bowering and passing the extensions with comma separators. For example, pass allowedTypes as .jpg and .png. display - Sets the default display for an image when it is inserted in to the RichTextEditor. Possible options are: 'inline' and 'block'. width - Sets the default width of the image when it is inserted in the RichTextEditor. saveFormat - Specifies the format to store the image in the Rich Text Editor (Base64 or Blob).

If you want to insert a lot of tiny images in the editor and don't want a specific physical location for saving images, you can opt to save format as Base64. height - Sets the default height of the image when it is inserted in the RichTextEditor. saveUrl - Specifies the service URL of save action that will receive the uploaded files and save them in the server. path - Specifies the path of the location to store the images and refer it to display the images.

Declaration
public RichTextEditorImageSettings InsertImageSettings { get; set; }
Property Value
Type Description
RichTextEditorImageSettings

The default value is null

InsertVideoSettings

Specifies the video insert options in Rich Text Editor component and control with the following properties. allowedTypes - Specifies the extensions of the video types allowed to insert on bowering and passing the extensions with comma separators. For example, pass allowedTypes as .jpg and .png. layoutOption - Sets the default display for an video when it is inserted in to the RichTextEditor. Possible options are: 'Inline' and 'Break'. width - Sets the default width of the video when it is inserted in the RichTextEditor. saveFormat - Specifies the format to store the video in the Rich Text Editor (Base64 or Blob).

If you want to insert a lot of tiny videos in the editor and don't want a specific physical location for saving videos, you can opt to save format as Base64. height - Sets the default height of the video when it is inserted in the RichTextEditor. saveUrl - Specifies the service URL of save action that will receive the uploaded files and save them in the server. path - Specifies the path of the location to store the videos and refer it to display the videos.

Declaration
public RichTextEditorVideoSettings InsertVideoSettings { get; set; }
Property Value
Type Description
RichTextEditorVideoSettings

The default value is null

KeyConfig

Customizes the key actions in RichTextEditor. For example, when using German keyboard, the key actions can be customized using these shortcuts.

Declaration
public object KeyConfig { get; set; }
Property Value
Type Description
System.Object

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 ""

MaxLength

Specifies the maximum number of characters allowed in the Rich Text Editor component.

Declaration
public double MaxLength { get; set; }
Property Value
Type Description
System.Double

The default value is -1

NumberFormatList

Predefine the advanced list types that populate in the numberFormatList dropdown list from the toolbar.

Declaration
public RichTextEditorNumberFormatList NumberFormatList { get; set; }
Property Value
Type Description
RichTextEditorNumberFormatList

The default value is null

PasteCleanupSettings

Specifies the pasting options in Rich Text Editor component and control with the following properties. prompt - Set boolean value to enable or disable the prompt when pasting. deniedAttrs - Specifies the attributes to restrict when pasting in RTE. allowedStyleProps - Specifies the allowed style properties when pasting in RTE. deniedTags - Specifies the tags to restrict when pasting in RTE. keepFormat - Set boolean value to keep or remove the from when pasting. plainText - Set boolean value to paste as plain text or not.

Declaration
public RichTextEditorPasteCleanupSettings PasteCleanupSettings { get; set; }
Property Value
Type Description
RichTextEditorPasteCleanupSettings

The default value is null

Placeholder

Specifies the placeholder for the RichTextEditor’s content used when the Rich Text Editor body is empty.

Declaration
public string Placeholder { get; set; }
Property Value
Type Description
System.String

The default value is null

QuickToolbarClose

Event triggers after the quick toolbar has been closed.

Declaration
public string QuickToolbarClose { get; set; }
Property Value
Type Description
System.String

The default value is null

QuickToolbarOpen

Event triggers when a quick toolbar is opened.

Declaration
public string QuickToolbarOpen { get; set; }
Property Value
Type Description
System.String

The default value is null

QuickToolbarSettings

Specifies the items to be rendered in quick toolbar based on the target element. It has following fields: enable - set boolean value to show or hide the quick toolbar actionOnScroll - it has two possible options

  1. hide: The quickToolbar is closed when the parent element is scrolled.
  2. none: The quickToolbar cannot be closed even the parent element is scrolled. link - Specifies the items to be rendered in quick toolbar based on link element such as Open, Edit, and UnLink. image - Specifies the items to be rendered in quick toolbar based on image element such as 'Replace', 'Align', 'Caption', 'Remove', 'InsertLink', 'Display', 'AltText', 'Dimension'. text - Specifies the items to be rendered in quick toolbar based on text element such as 'Cut', 'Copy', 'Paste'.
Declaration
public RichTextEditorQuickToolbarSettings QuickToolbarSettings { get; set; }
Property Value
Type Description
RichTextEditorQuickToolbarSettings

The default value is null

Readonly

The user interactions on the component are disabled, when set to true.

Declaration
public bool Readonly { get; set; }
Property Value
Type Description
System.Boolean

The default value is false

ResizeStart

Triggers only when start resize the image.

Declaration
public string ResizeStart { get; set; }
Property Value
Type Description
System.String

The default value is null

ResizeStop

Triggers only when stop resize the image.

Declaration
public string ResizeStop { get; set; }
Property Value
Type Description
System.String

The default value is null

Resizing

Triggers only when resizing the image.

Declaration
public string Resizing { get; set; }
Property Value
Type Description
System.String

The default value is null

SaveInterval

Specifies the saveInterval in milliseconds for autosave the value. The change event will be triggered if the content was changed from the last saved interval.

Declaration
public double SaveInterval { get; set; }
Property Value
Type Description
System.Double

The default value is 10000

ShiftEnterKey

Specifies tags to be inserted when shift+enter key is pressed.

Declaration
public ShiftEnterKey ShiftEnterKey { get; set; }
Property Value
Type Description
ShiftEnterKey

The default value is ShiftEnterKey.BR

ShowCharCount

Sets Boolean value to enable or disable the display of the character counter.

Declaration
public bool ShowCharCount { get; set; }
Property Value
Type Description
System.Boolean

The default value is false

ShowTooltip

Specify the value whether tooltip will be displayed for the Rich Text Editor toolbar.

Declaration
public bool ShowTooltip { get; set; }
Property Value
Type Description
System.Boolean

The default value is true

TableSettings

Specifies the table insert options in Rich Text Editor component and control with the following properties. styles - Class name should be appended by default in table element. It helps to design the table in specific CSS styles always when inserting in editor. width - Sets the default width of the table when it is inserted in the RichTextEditor. minWidth - Sets the default minWidth of the table when it is inserted in the RichTextEditor. maxWidth - Sets the default maxWidth of the table when it is inserted in the RichTextEditor. resize - To enable resize the table.

Declaration
public RichTextEditorTableSettings TableSettings { get; set; }
Property Value
Type Description
RichTextEditorTableSettings

The default value is null

ToolbarClick

Triggers when Rich Text Editor Toolbar items is clicked.

Declaration
public string ToolbarClick { get; set; }
Property Value
Type Description
System.String

The default value is null

ToolbarSettings

Specifies the group of items aligned horizontally in the toolbar as well as defined the toolbar rendering type. By default, toolbar is float at the top of the RichTextEditor. When you scroll down, the toolbar will scroll along with the page on Rich Text Editor with the specified offset value. enable: set boolean value to show or hide the toolbar. enableFloating: Set Boolean value to enable or disable the floating toolbar. Preserves the toolbar at top of the Rich Text Editor on scrolling. type: it has two possible options

  1. Expand: Hide the overflowing toolbar items in the next row. Click the expand arrow to view overflowing toolbar items
  2. MultiRow: The toolbar overflowing items wrapped in the next row. items: Specifies the array of items aligned horizontally in the toolbar.

| and - can insert a vertical and horizontal separator lines in the toolbar. itemConfigs: Modify the default toolbar item configuration like icon class.

Declaration
public RichTextEditorToolbarSettings ToolbarSettings { get; set; }
Property Value
Type Description
RichTextEditorToolbarSettings

The default value is null

ToolbarStatusUpdate

This event is deprecated and no longer works. Use updatedToolbarStatus event to get the undo and redo status.

Declaration
public string ToolbarStatusUpdate { get; set; }
Property Value
Type Description
System.String

The default value is null

UndoRedoSteps

Specifies the count of undo history which is stored in undoRedoManager.

Declaration
public double UndoRedoSteps { get; set; }
Property Value
Type Description
System.Double

The default value is 30

UndoRedoTimer

Specifies the interval value in milliseconds that store actions in undoRedoManager. The minimum value is 300 milliseconds.

Declaration
public double UndoRedoTimer { get; set; }
Property Value
Type Description
System.Double

The default value is 300

UpdatedToolbarStatus

Triggers when the toolbar items status is updated.

Declaration
public string UpdatedToolbarStatus { get; set; }
Property Value
Type Description
System.String

The default value is null

Value

Specifies the value displayed in the RichTextEditor's content area and it should be string. The content of Rich Text Editor can be loaded with dynamic data such as database, AJAX content, and more.

Declaration
public string Value { get; set; }
Property Value
Type Description
System.String

The default value is null

ValueTemplate

Accepts the template design and assigns it as RichTextEditor’s content. The built-in template engine which provides options to compile template string into a executable function. For EX: We have expression evolution as like ES6 expression string literals

Declaration
public string ValueTemplate { get; set; }
Property Value
Type Description
System.String

The default value is null

Width

Specifies the width of the RichTextEditor.

Declaration
public string Width { get; set; }
Property Value
Type Description
System.String

The default value is "100%"