Syncfusion.EJ2
Properties  Methods 


RichTextEditor Class Members

The following tables list the members exposed by RichTextEditor.

Public Constructors
 NameDescription
Public Constructor  
Top
Public Properties
 NameDescription
Public Property 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.  
Public Property Triggers after command execution using toolbar items or executeCommand method.  
Public Property Event triggers when the selected image is cleared from the Rich Text Editor Content.  
Public Property 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.  
Public Property Predefine the color palette that can be rendered for background color (text highlighted color) toolbar command.  
Public Property 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.  
Public Property 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.  
Public Property Event triggers when the quick toolbar is being opened.  
Public Property Event triggers before sanitize the value. It's only applicable to editorMode as `HTML`.  
Public Property Triggers when Rich Text Editor is focused out.  
Public Property Triggers only when Rich Text Editor is blurred and changes are done to the content.  
Public Property To get or set value for ContentTemplate.  
Public Property Triggers when the Rich Text Editor is rendered.  
Public Property 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.  
Public Property Triggers when the Rich Text Editor is destroyed.  
Public Property Event triggers after the dialog has been closed.  
Public Property Event triggers when a dialog is opened.  
Public Property Specifies the editing mode of the RichTextEditor.  
Public Property 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.  
Public Property Specifies a value that indicates whether the component is enabled or not.  
Public Property specifies the value whether the source code is displayed with encoded format.  
Public Property Defines whether to allow the cross-scripting site or not.  
Public Property Enables or disables the persisting component's state between page reloads. If enabled, the value of Rich Text Editor is persisted  
Public Property 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.  
Public Property Enable or disable rendering component in right to left direction.  
Public Property Allows the tab key action in the Rich Text Editor content.  
Public Property Specifies a value that indicates whether the xhtml is enabled or not.  
Public Property 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  
Public Property Triggers when Rich Text Editor is focused in  
Public Property Predefine the color palette that can be rendered for font color toolbar command .  
Public Property Predefine the font families that populate in font family dropdown list from the toolbar.  
Public Property Predefine the font sizes that populate in font size dropdown list from the toolbar.  
Public Property Predefine the collection of paragraph styles along with quote and code style that populate in format dropdown from the toolbar.  
Public Property Customize keyCode to change the key value.  
Public Property Specifies the height of the Rich Text Editor component.  
Public Property Allows additional HTML attributes such as title, name, etc., and It will be accepts n number of attributes in a key-value pair format.  
Public Property (Inherited from Syncfusion.EJ2.EJTagHelper)
Public Property 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  
Public Property Event triggers when the selected image is cleared from the insert image dialog.  
Public Property Event triggers when the image is selected or dragged into the insert image dialog.  
Public Property Event triggers when there is an error in the image upload.  
Public Property Event triggers when the selected image begins to upload in the insert image dialog.  
Public Property Event triggers when the image is successfully uploaded to the server side.  
Public Property 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.  
Public Property 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.  
Public Property Customizes the key actions in RichTextEditor. For example, when using German keyboard, the key actions can be customized using these shortcuts.  
Public Property Overrides the global culture and localization value for this component. Default global culture is 'en-US'.  
Public Property Specifies the maximum number of characters allowed in the Rich Text Editor component.  
Public Property 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.  
Public Property Specifies the placeholder for the RichTextEditor’s content used when the Rich Text Editor body is empty.  
Public Property Event triggers after the quick toolbar has been closed.  
Public Property Event triggers when a quick toolbar is opened.  
Public Property 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'.  
Public Property The user interactions on the component are disabled, when set to true.  
Public Property Triggers only when start resize the image.  
Public Property Triggers only when stop resize the image.  
Public Property Triggers only when resizing the image.  
Public Property 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.  
Public Property Sets Boolean value to enable or disable the display of the character counter.  
Public Property 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.  
Public Property Triggers when Rich Text Editor Toolbar items is clicked.  
Public Property 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.  
Public Property Triggers when the undo and redo status is updated.  
Public Property Specifies the count of undo history which is stored in undoRedoManager.  
Public Property Specifies the interval value in milliseconds that store actions in undoRedoManager. The minimum value is 300 milliseconds.  
Public Property 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.  
Public Property 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  
Public Property Specifies the width of the RichTextEditor.  
Top
Protected Properties
 NameDescription
Protected PropertyOverridden.   
Protected Property (Inherited from Syncfusion.EJ2.EJTagHelper)
Protected Property (Inherited from Syncfusion.EJ2.EJTagHelper)
Protected Property (Inherited from Syncfusion.EJ2.EJTagHelper)
Protected PropertyOverridden.   
Protected PropertyOverridden.   
Protected Property (Inherited from Syncfusion.EJ2.EJTagHelper)
Protected PropertyOverridden.   
Top
Public Methods
Protected Methods
 NameDescription
Protected Method (Inherited from Syncfusion.EJ2.EJTagHelper)
Top
Extension Methods
 NameDescription
Public Extension MethodOverloaded.  Iterates the index.
Top
See Also