JavaScript/jQuery HtmlEditor Methods
beginUpdate()
Postpones rendering that can negatively affect performance until the endUpdate() method is called.
The beginUpdate() and endUpdate() methods reduce the number of renders in cases where extra rendering can negatively affect performance.
See Also
defaultOptions(rule)
Name | Type | Description |
---|---|---|
device | | |
Device parameters. |
options |
Options to be applied. |
defaultOptions is a static method that the UI component class supports. The following code demonstrates how to specify default properties for all instances of the HtmlEditor UI component in an application executed on the desktop.
- DevExpress.ui.dxHtmlEditor.defaultOptions({
- device: { deviceType: "desktop" },
- options: {
- // Here go the HtmlEditor properties
- }
- });
You can also set rules for multiple device types:
- const devicesConfig = [
- { deviceType: 'desktop' },
- { deviceType: 'tablet' },
- { deviceType: 'phone' },
- ];
- devicesConfig.forEach(deviceConfig => {
- DevExpress.ui.dxHtmlEditor.defaultOptions({
- device: deviceConfig,
- options: {
- // Here go the HtmlEditor properties
- }
- });
- });
delete(index, length)
endUpdate()
Refreshes the UI component after a call of the beginUpdate() method.
The beginUpdate() and endUpdate() methods reduce the number of renders in cases where extra rendering can negatively affect performance.
See Also
format(formatName, formatValue)
Applies a format to the selected content. Cannot be used with embedded formats.
A format name.
If no content is selected, the format applies to the character typed next.
- const htmlEditorInstance = $("#htmlEditorContainer").dxHtmlEditor("instance");
- // Makes text bold
- htmlEditorInstance.format("bold", true);
- // Inserts a link
- htmlEditorInstance.format("link", {
- href: "https://www.google.com/",
- text: "Google",
- title: "Go to Google"
- });
See Also
formatLine(index, length, formatName, formatValue)
Applies a single block format to all lines in the given range.
The length of the content to be formatted.
Embedded items have a length of 1.
A format name.
- // Aligns the first line to the right
- $("#htmlEditorContainer").dxHtmlEditor("instance").formatLine(0, 1, "align", "right");
See Also
formatLine(index, length, formats)
Applies several block formats to all lines in the given range.
The length of the content to be formatted.
Embedded items have a length of 1.
- // Aligns the first line to the right and turns it into an ordered list's item.
- $("#htmlEditorContainer").dxHtmlEditor("instance").formatLine(0, 1, { "align": "right", "list": "ordered" });
See Also
formatText(index, length, formatName, formatValue)
Applies a single text format to all characters in the given range.
The length of the content to be formatted.
Embedded items have a length of 1.
A format name.
- // Makes the first five characters bold
- $("#htmlEditorContainer").dxHtmlEditor("instance").formatText(0, 5, "bold", true);
See Also
formatText(index, length, formats)
Applies several text formats to all characters in the given range.
The length of the content to be formatted.
Embedded items have a length of 1.
- // Makes the first five characters bold and underlined
- $("#htmlEditorContainer").dxHtmlEditor("instance").formatText(0, 5, { "bold": "true", "underline": "true" });
See Also
get(componentPath)
Gets a format, module, or Parchment.
You can perform the following tasks after getting a format, module, or Parchment:
Modify the format
You can change the markup tag associated with the format and allowed format values, as shown in the code example after this list.Extend the format or module
You can extend HTML Editor's formats and modules, and also the DevExtreme Quill's formats and modules. See the Extend Built-In Formats and Modules topic for the code example.Create a custom format based on the Parchment
Refer to the Parchment documentation for more information.
In the following code, the bold
format is associated with the <b>
tag instead of the default <strong>
tag. After the modification, the format is registered.
- $(function() {
- // ...
- const htmlEditor = $("#htmlEditorContainer").dxHtmlEditor("instance");
- const Bold = htmlEditor.get("formats/bold");
- Bold.tagName = "b";
- htmlEditor.register({ "formats/bold": Bold });
- });
See Also
getFormat(index, length)
getInstance(element)
getInstance is a static method that the UI component class supports. The following code demonstrates how to get the HtmlEditor instance found in an element with the myHtmlEditor
ID:
- // Modular approach
- import HtmlEditor from "devextreme/ui/html_editor";
- ...
- let element = document.getElementById("myHtmlEditor");
- let instance = HtmlEditor.getInstance(element) as HtmlEditor;
- // Non-modular approach
- let element = document.getElementById("myHtmlEditor");
- let instance = DevExpress.ui.dxHtmlEditor.getInstance(element);
See Also
getLength()
Embedded items have a length of 1.
getModule(moduleName)
The name of a registered module.
You can get DevExtreme Quill modules, DevExtreme UI modules, or custom modules.
If you implement the customizeModules function, make sure that it does not disable the modules that you want to get.
getSelection()
The selected content's range. It has the following structure:
- index
A zero-based index at which the selection starts. - length
The selected content's length.
Embedded items have a length of 1.
getText(index, length)
This method skips mentions and variables. To get them, use the QuillJS getContents() method:
- const quill = htmlEditorInstance.getQuillInstance();
- quill.getContents().forEach((contentItem) => {
- if (contentItem.insert.variable) { // is a variable
- // Your configuration goes here
- } else if (contentItem.insert.mention) { // is a mention
- // Your configuration goes here
- } else { // is a plain text
- // Your configuration goes here
- }
- });
insertText(index, text, formats)
Inserts formatted text at the specified position. Used with all formats except embedded.
on(eventName, eventHandler)
Use this method to subscribe to one of the events listed in the Events section.
See Also
on(events)
Use this method to subscribe to several events with one method call. Available events are listed in the Events section.
See Also
register(components)
- $(function() {
- // ...
- const htmlEditor = $("#htmlEditorContainer").dxHtmlEditor("instance");
- htmlEditor.register({ "modules/myModule": moduleObject });
- });
See Also
registerKeyHandler(key, handler)
A handler. Accepts the keydown event as the argument. It is a EventObject or a jQuery.Event when you use jQuery.
The key argument accepts one of the following values:
- "backspace"
- "tab"
- "enter"
- "escape"
- "pageUp"
- "pageDown"
- "end"
- "home"
- "leftArrow"
- "upArrow"
- "rightArrow"
- "downArrow"
- "del"
- "space"
- "F"
- "A"
- "asterisk"
- "minus"
A custom handler for a key cancels the default handler for this key.
See Also
removeFormat(index, length)
repaint()
Renders the component again without reloading data. Use the method to update the component's markup and appearance dynamically.
The repaint()
method re-initializes the component with new settings, resetting its state and history. Note: when you repaint()
a component, the "undo" and "redo" buttons become inactive.
See Also
- reload() in DataSource | List
- refresh() in DataGrid | TreeList