Interface for a class RichTextEditor
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.
Triggers after command execution using toolbar items or executeCommand method.
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.
Event triggers when the quick toolbar is being opened.
Event triggers before sanitize the value. It’s only applicable to editorMode as
Triggers when RichTextEditor is focused out.
Triggers only when RichTextEditor is blurred and changes are done to the content.
Triggers when the RichTextEditor is rendered.
Triggers when the RichTextEditor is destroyed.
Event triggers after the dialog has been closed.
Event triggers when a dialog is opened.
Triggers when RichTextEditor is focused in
Event triggers when the selected image is cleared from the insert image dialog.
Event triggers when the image is selected or dragged into the insert image dialog.
Event triggers when there is an error in the image upload.
Event triggers when the image is successfully uploaded to the server side.
Event triggers when the selected image begins to upload in the insert image dialog.
Event triggers after the quick toolbar has been closed.
Event triggers when a quick toolbar is opened.
Triggers only when start resize the image.
Triggers only when stop resize the image.
Triggers only when resizing the image.
Triggers when RichTextEditor Toolbar items is clicked.
Triggers when the undo and redo status is updated.
Predefine the color palette that can be rendered for background color (text highlighted color) toolbar command.
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.
Specifies the editing mode of the RichTextEditor.
HTML - Render RichTextEditor as HTML editor using <IFRAME> element or content editable <div> element
or <textarea> element.
Markdown - Render RichTextEditor as markdown editor using <textarea>.
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.
specifies the value whether the source code is displayed with encoded format.
Enables or disables the persisting component’s state between page reloads. If enabled, the value of RichTextEditor is persisted
Enables or disables the resizing option in the editor. If enabled, the RichTextEditor can be resized by dragging the resize icon in the bottom right corner.
Enable or disable rendering component in right to left direction.
Allows the tab key action in the RichTextEditor content.
Specifies a value that indicates whether the component is enabled or not.
Preserves the toolbar at the top of the RichTextEditor on scrolling and specifies the offset of the floating toolbar from documents top position
Predefine the color palette that can be rendered for font color toolbar command .
Predefine the font families that populate in font family dropdown list from the toolbar.
Predefine the font sizes that populate in font size dropdown list from the toolbar.
Predefine the collection of paragraph styles along with quote and code style that populate in format dropdown from the toolbar.
Customize keyCode to change the key value.
Specifies the height of the RichTextEditor component.
Allows additional HTML attributes such as title, name, etc., and It will be accepts n number of attributes in a key-value pair format.
Specifies the items to be rendered in an iframe mode, and it has the following properties.
resources - we can add both styles and scripts to the iframe.
Enable or disable the inline edit mode.
Specifies the image insert options in RichTextEditor component and control with the following properties.
Customizes the key actions in RichTextEditor. For example, when using German keyboard, the key actions can be customized using these shortcuts.
Overrides the global culture and localization value for this component. Default global culture is ‘en-US’.
Specifies the maximum number of characters allowed in the RichTextEditor component.
Specifies the pasting options in RichTextEditor component and control with the following properties.
Specifies the placeholder for the RichTextEditor’s content used when the RichTextEditor body is empty.
Specifies the items to be rendered in quick toolbar based on the target element.
actionOnScroll - it has two possible options
The user interactions on the component are disabled, when set to true.
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.
Sets Boolean value to enable or disable the display of the character counter.
Specifies the table insert options in RichTextEditor component and control with the following properties.
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 RichTextEditor with the specified offset value.
type: it has two possible options
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.
By default, The toolbar is rendered with scrollable in mobile devices and does not support the toolbar type.
Specifies the count of undo history which is stored in undoRedoManager.
Specifies the interval value in milliseconds that store actions in undoRedoManager. The minimum value is 300 milliseconds.
Specifies the value displayed in the RichTextEditor’s content area and it should be string. The content of RichTextEditor can be loaded with dynamic data such as database, AJAX content, and more.
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
Specifies the width of the RichTextEditor.