MVCxClientHtmlEditor Methods

A client-side counterpart of the HtmlEditor extension.
Name Description
AdjustControl Modifies the control’s size against the control’s container. Inherited from ASPxClientControl.
AdjustControls static Modifies the controls size within the specified container. Inherited from ASPxClientControl.
Cast(obj) static Converts the specified object to the MVCxClientHtmlEditor type.
CreateChangeMediaElementCommandArguments(element) Creates a parameter for ASPxHtmlEditor‘s client-side commands related to changing media elements. Inherited from ASPxClientHtmlEditor.
CustomDialogComplete(status, data) static Programmatically closes a custom dialog, supplying it with specific parameters. Inherited from ASPxClientHtmlEditor.
ExecuteCommand(commandName, parameter, addToUndoHistory) Executes the specified command. Inherited from ASPxClientHtmlEditor.
Focus Sets input focus to the ASPxHtmlEditor‘s edit region. Inherited from ASPxClientHtmlEditor.
GetActiveTabName Returns the name of the active HTML editor tab. Inherited from ASPxClientHtmlEditor.
GetClientVisible Obsolete. Returns a value specifying whether a control is displayed. Inherited from ASPxClientControlBase.
GetContextMenu Returns a collection of client context menu objects. Inherited from ASPxClientHtmlEditor.
GetControlCollection static Returns a collection of client web control objects. Inherited from ASPxClientControl.
GetDesignViewDocument Returns the document object generated by an iframe element within a design view area. Inherited from ASPxClientHtmlEditor.
GetDialogPopupControl Provides access to the client ASPxPopupControl object that is a Html Editor’s dialog. Inherited from ASPxClientHtmlEditor.
GetEnabled Returns a value indicating whether an editor is enabled. Inherited from ASPxClientHtmlEditor.
GetErrorText Gets the error text to be displayed within the editor’s error frame if the editor’s validation fails. Inherited from ASPxClientHtmlEditor.
GetHeight Returns the control’s height. Inherited from ASPxClientControl.
GetHtml Gets the HTML markup that represents the editor’s content. Inherited from ASPxClientHtmlEditor.
GetIsValid Gets a value that indicates whether the editor’s value passes validation. Inherited from ASPxClientHtmlEditor.
GetMainElement Returns an HTML element that is the root of the control’s hierarchy. Inherited from ASPxClientControlBase.
GetParentControl Returns a client instance of the control that is the parent for a specified control. Inherited from ASPxClientControlBase.
GetPreviewDocument Returns the document object generated by an iframe element within a preview area. Inherited from ASPxClientHtmlEditor.
GetRibbon Provides access to an object implementing the HtmlEditor’s ribbon UI. Inherited from ASPxClientHtmlEditor.
GetSelection Returns the selection in the ASPxHtmlEditor. Inherited from ASPxClientHtmlEditor.
GetToolbarByName(name) Returns a toolbar specified by its name. Inherited from ASPxClientHtmlEditor.
GetVisible Returns a value specifying whether a control is displayed. Inherited from ASPxClientControlBase.
GetWidth Returns the control’s width. Inherited from ASPxClientControl.
HighlightText(text, searchContainer) static Highlights the text with the specified text color and background color. Inherited from ASPxClientHtmlEditor.
InCallback Returns a value that determines whether a callback request sent by a web control is being currently processed on the server side. Inherited from ASPxClientControlBase.
PerformDataCallback(data) Sends a callback with a parameter to process the passed information on the server, in an Action specified via the HtmlEditor’s HtmlEditorSettings.CustomDataActionRouteValues property, and then return the processing result to the ASPxClientHtmlEditor.CustomDataCallback event on the client. This method does not update the HtmlEditor.
ReconnectToExternalRibbon Reconnect the control to an external ribbon. Inherited from ASPxClientHtmlEditor.
ReplacePlaceholders(html, placeholders) Replaces placeholders with the specified values. Inherited from ASPxClientHtmlEditor.
RestoreSelection Restores the selection within the ASPxHtmlEditor. Inherited from ASPxClientHtmlEditor.
SaveToUndoHistory Adds the current editor state to the undo/redo history. Inherited from ASPxClientHtmlEditor.
SendMessageToAssistiveTechnology(message) Specifies the text that Assistive Technologies (screen readers or braille display, for example) will provide to a user. Inherited from ASPxClientControlBase.
SetActiveTabByName(name) Set an active tab specified by its name. Inherited from ASPxClientHtmlEditor.
SetClientVisible(visible) Obsolete. Specifies whether a control is displayed. Inherited from ASPxClientControlBase.
SetEnabled(value) Specifies whether an editor is enabled. Inherited from ASPxClientHtmlEditor.
SetErrorText(errorText) Sets the error text to be displayed within the editor’s error frame if the editor’s validation fails. Inherited from ASPxClientHtmlEditor.
SetHeight(height)

Specifies the control’s height. Note that this method is not in effect for some controls.

Inherited from ASPxClientControl.
SetHtml(html) Sets the HTML markup that represents the editor’s content. Inherited from ASPxClientHtmlEditor.
SetIsValid(isValid) Sets a value that specifies whether the editor’s value passes validation. Inherited from ASPxClientHtmlEditor.
SetRibbonContextTabCategoryVisible(categoryName, active) Specifies the visibility of a ribbon context tab category specified by its name. Inherited from ASPxClientHtmlEditor.
SetToolbarComboBoxValue(commandName, value) Sets the value of the combo box within the HtmlEditor on the client side. Inherited from ASPxClientHtmlEditor.
SetToolbarDropDownItemPickerValue(commandName, value) Sets the value of the dropdown item picker in the HtmlEditor on the client side. Inherited from ASPxClientHtmlEditor.
SetVisible(visible) Specifies whether a control is displayed. Inherited from ASPxClientControlBase.
SetWidth(width) Specifies the control’s width in pixels. Inherited from ASPxClientControl.
Validate Performs validation of the editor’s content. Inherited from ASPxClientHtmlEditor.
See Also