HtmlEditorBuilder Methods
An HtmlEditor control.| Name | Description |
|---|---|
| AccessKey(JS) | Specifies the shortcut key that sets focus on the UI component. Mirrors the client-side accessKey option. |
| AccessKey(String) | Specifies the shortcut key that sets focus on the UI component. Mirrors the client-side accessKey option. |
| ActiveStateEnabled(JS) | Specifies whether the UI component changes its visual state as a result of user interaction. Mirrors the client-side activeStateEnabled option. |
| ActiveStateEnabled(Boolean) | Specifies whether the UI component changes its visual state as a result of user interaction. Mirrors the client-side activeStateEnabled option. |
| AllowSoftLineBreak(JS) | |
| AllowSoftLineBreak(Boolean) | |
| Content(RazorBlock) | Specifies content for an HtmlEditor control. |
| Content(String) | Specifies content for a HtmlEditor control. |
| CustomizeModules(RazorBlock) | Allows you to customize the DevExtreme Quill and 3rd-party modules. Mirrors the client-side customizeModules option. |
| CustomizeModules(String) | Allows you to customize the DevExtreme Quill and 3rd-party modules. Mirrors the client-side customizeModules option. |
| Disabled(JS) | Specifies whether the UI component responds to user interaction. Mirrors the client-side disabled option. |
| Disabled(Boolean) | Specifies whether the UI component responds to user interaction. Mirrors the client-side disabled option. |
| ElementAttr(JS) | Mirrors the client-side elementAttr option, specifies attributes for the control’s root HTML element. |
| ElementAttr(Dictionary<String, Object>) | Mirrors the client-side elementAttr option, specifies attributes for the control’s root HTML element. |
| ElementAttr(Object) | Mirrors the client-side elementAttr option, specifies attributes for the control’s root HTML element. |
| ElementAttr(String, Object) | Mirrors the client-side elementAttr option, specifies attributes for the control’s root HTML element. |
| Equals(Object, Object) static | Determines whether the specified object instances are considered equal. Inherited from Object. |
| Equals(Object) | Determines whether the specified object is equal to the current object. Inherited from Object. |
| FocusStateEnabled(JS) | Mirrors the client-side focusStateEnabled option. |
| FocusStateEnabled(Boolean) | Mirrors the client-side focusStateEnabled option. |
| GetHashCode() | Serves as the default hash function. Inherited from Object. |
| GetType() | Gets the Type of the current instance. Inherited from Object. |
| Height(JS) | Specifies the UI component's height. Mirrors the client-side height option. |
| Height(Double) | Specifies the UI component's height. Mirrors the client-side height option. |
| Height(String) | Specifies the UI component's height. Mirrors the client-side height option. |
| Hint(JS) | Specifies text for a hint that appears when a user pauses on the UI component. Mirrors the client-side hint option. |
| Hint(String) | Specifies text for a hint that appears when a user pauses on the UI component. Mirrors the client-side hint option. |
| HoverStateEnabled(JS) | Specifies whether the UI component changes its state when a user pauses on it. Mirrors the client-side hoverStateEnabled option. |
| HoverStateEnabled(Boolean) | Specifies whether the UI component changes its state when a user pauses on it. Mirrors the client-side hoverStateEnabled option. |
| ID(JS) |
Specifies the id attribute for the control’s HTML element (used for nested controls within templates).
|
| ID(String) |
Specifies the id attribute for the control’s HTML element.
|
| ImageUpload(Action<HtmlEditorImageUploadBuilder>) | |
| IsDirty(JS) | |
| IsDirty(Boolean) | |
| IsValid(JS) | Specifies or indicates whether the editor's value is valid. Mirrors the client-side isValid option. |
| IsValid(Boolean) | Specifies or indicates whether the editor's value is valid. Mirrors the client-side isValid option. |
| MediaResizing(Action<HtmlEditorMediaResizingBuilder>) | Configures media resizing. Mirrors the client-side mediaResizing object. |
| MemberwiseClone() protected | Creates a shallow copy of the current Object. Inherited from Object. |
| Mentions(Action<CollectionFactory<HtmlEditorMentionBuilder>>) | Provides access to the client-side mentions option that represents a mention object collection. |
| Name(JS) | Mirrors the client-side name option. |
| Name(String) | Mirrors the client-side name option. |
| OnContentReady(RazorBlock) | A function that is executed when the UI component is rendered and each time the component is repainted. Mirrors the client-side onContentReady option. |
| OnContentReady(String) | A function that is executed when the UI component is rendered and each time the component is repainted. Mirrors the client-side onContentReady option. |
| OnDisposing(RazorBlock) | A function that is executed before the UI component is disposed of. Mirrors the client-side onDisposing option. |
| OnDisposing(String) | A function that is executed before the UI component is disposed of. Mirrors the client-side onDisposing option. |
| OnFocusIn(RazorBlock) | A function that is executed when the UI component gets focus. Mirrors the client-side onFocusIn option. |
| OnFocusIn(String) | A function that is executed when the UI component gets focus. Mirrors the client-side onFocusIn option. |
| OnFocusOut(RazorBlock) | A function that is executed when the UI component loses focus. Mirrors the client-side onFocusOut option. |
| OnFocusOut(String) | A function that is executed when the UI component loses focus. Mirrors the client-side onFocusOut option. |
| OnInitialized(RazorBlock) | A function used in JavaScript frameworks to save the UI component instance. Mirrors the client-side onInitialized option. |
| OnInitialized(String) | A function used in JavaScript frameworks to save the UI component instance. Mirrors the client-side onInitialized option. |
| OnOptionChanged(RazorBlock) | A function that is executed after a UI component property is changed. Mirrors the client-side onOptionChanged option. |
| OnOptionChanged(String) | A function that is executed after a UI component property is changed. Mirrors the client-side onOptionChanged option. |
| OnValueChanged(RazorBlock) | A function that is executed after the UI component's value is changed. Mirrors the client-side onValueChanged option. |
| OnValueChanged(String) | A function that is executed after the UI component's value is changed. Mirrors the client-side onValueChanged option. |
| Option(String, Object) | Specifies an option by its name. |
| Placeholder(JS) | Specifies the text displayed when the input field is empty. Mirrors the client-side placeholder option. |
| Placeholder(String) | Specifies the text displayed when the input field is empty. Mirrors the client-side placeholder option. |
| ReadOnly(JS) | Specifies whether the editor is read-only. Mirrors the client-side readOnly option. |
| ReadOnly(Boolean) | Specifies whether the editor is read-only. Mirrors the client-side readOnly option. |
| ReferenceEquals(Object, Object) static | Determines whether the specified Object instances are the same instance. Inherited from Object. |
| Render() | Inherited from WidgetBuilder. |
| RtlEnabled(JS) | Switches the UI component to a right-to-left representation. Mirrors the client-side rtlEnabled option. |
| RtlEnabled(Boolean) | Switches the UI component to a right-to-left representation. Mirrors the client-side rtlEnabled option. |
| StylingMode(EditorStylingMode) | Specifies how the HtmlEditor's toolbar and content field are styled. Mirrors the client-side stylingMode option. |
| TabIndex(JS) | Specifies the number of the element when the Tab key is used for navigating. Mirrors the client-side tabIndex option. |
| TabIndex(Int32) | Specifies the number of the element when the Tab key is used for navigating. Mirrors the client-side tabIndex option. |
| TableContextMenu(Action<HtmlEditorTableContextMenuBuilder>) | |
| TableResizing(Action<HtmlEditorTableResizingBuilder>) | |
| Toolbar(Action<HtmlEditorToolbarBuilder>) | Configures the UI component's toolbar. Mirrors the client-side toolbar object. |
| ToString() | Inherited from WidgetBuilder. |
| ToTemplate() | Renders the control as a template string for use in another control’s template. Inherited from WidgetBuilder. |
| ValidationError(Object) | Information on the broken validation rule. Contains the first item from the validationErrors array. Mirrors the client-side validationError option. |
| ValidationErrors(JS) | An array of the validation rules that failed. Mirrors the client-side validationErrors option. |
| ValidationErrors(IEnumerable) | An array of the validation rules that failed. Mirrors the client-side validationErrors option. |
| ValidationMessageMode(ValidationMessageMode) | Specifies how the message about the validation rules that are not satisfied by this editor's value is displayed. Mirrors the client-side validationMessageMode option. |
| ValidationMessagePosition(Position) | |
| ValidationStatus(ValidationStatus) | Mirrors the client-side validationStatus option. |
| Value(Object) | Mirrors the client-side value option. |
| ValueType(HtmlEditorValueType) | Specifies in which markup language the value is stored. Mirrors the client-side valueType option. |
| Variables(Action<HtmlEditorVariablesBuilder>) | Configures variables, which are placeholders to be replaced with actual values when processing text. Mirrors the client-side variables object. |
| Visible(JS) | Specifies whether the UI component is visible. Mirrors the client-side visible option. |
| Visible(Boolean) | Specifies whether the UI component is visible. Mirrors the client-side visible option. |
| Width(JS) | Specifies the UI component's width. Mirrors the client-side width option. |
| Width(Double) | Specifies the UI component's width. Mirrors the client-side width option. |
| Width(String) | Specifies the UI component's width. Mirrors the client-side width option. |
See Also