ASPxClientHtmlEditor Members

Represents a client-side equivalent of the ASPxHtmlEditor control.

Properties

Name Description
name Gets the unique, hierarchically-qualified identifier for the control. Inherited from ASPxClientControlBase.

Methods

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 ASPxClientHtmlEditor type.
CreateChangeMediaElementCommandArguments(element) Creates a parameter for ASPxHtmlEditor's client-side commands related to changing media elements.
CustomDialogComplete(status, data) static Programmatically closes a custom dialog, supplying it with specific parameters.
ExecuteCommand(commandName, parameter, addToUndoHistory) Executes the specified command.
Focus Sets input focus to the ASPxHtmlEditor's edit region.
GetActiveTabName Returns the name of the active HTML editor tab.
GetClientVisible Obsolete. Returns a value specifying whether a control is displayed. Inherited from ASPxClientControlBase.
GetContextMenu Returns a collection of client context menu objects.
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.
GetDialogPopupControl Provides access to the client ASPxPopupControl object that is a Html Editor's dialog.
GetEnabled Returns a value indicating whether an editor is enabled.
GetErrorText Gets the error text to be displayed within the editor's error frame if the editor's validation fails.
GetHeight Returns the control's height. Inherited from ASPxClientControl.
GetHtml Gets the HTML markup that represents the editor's content.
GetIsValid Gets a value that indicates whether the editor's value passes validation.
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.
GetRibbon Provides access to an object implementing the HtmlEditor's ribbon UI.
GetSelection Returns the selection in the ASPxHtmlEditor.
GetToolbarByName(name) Returns a toolbar specified by its name.
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.
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(parameter, onCallback) Sends a callback to the server and generates the server-side ASPxHtmlEditor.CustomDataCallback event passing it the specified argument.
ReconnectToExternalRibbon Reconnect the control to an external ribbon.
ReplacePlaceholders(html, placeholders) Replaces placeholders with the specified values.
RestoreSelection Restores the selection within the ASPxHtmlEditor.
SaveToUndoHistory Adds the current editor state to the undo/redo history.
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.
SetClientVisible(visible) Obsolete. Specifies whether a control is displayed. Inherited from ASPxClientControlBase.
SetEnabled(value) Specifies whether an editor is enabled.
SetErrorText(errorText) Sets the error text to be displayed within the editor's error frame if the editor's validation fails.
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.
SetIsValid(isValid) Sets a value that specifies whether the editor's value passes validation.
SetRibbonContextTabCategoryVisible(categoryName, active) Specifies the visibility of a ribbon context tab category specified by its name.
SetToolbarComboBoxValue(commandName, value) Sets the value of the combo box within the HtmlEditor on the client side.
SetToolbarDropDownItemPickerValue(commandName, value) Sets the value of the dropdown item picker in the HtmlEditor on the client side.
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.

Events

Name Description
ActiveTabChanged Fires on the client side after the active tab has been changed within a control.
ActiveTabChanging Fires on the client side before the active tab is changed within a control.
BeforePaste Occurs before an HTML code is pasted to editor content, and allows you to modify it.
BeginCallback Occurs when a callback for server-side processing is initiated.
CallbackError Fires on the client if any server error occurs during server-side processing of a callback sent by the ASPxClientHtmlEditor.
CommandExecuted Occurs after a default or custom command has been executed on the client side.
CommandExecuting Occurs before a default or custom command has been executed and allows you to cancel the action.
ContextMenuShowing Occurs on the client side before a context menu is shown.
CustomCommand Enables you to implement a custom command's logic.
CustomDataCallback Fires after a callback, sent by the ASPxClientHtmlEditor.PerformDataCallback method, has been processed within the ASPxHtmlEditor.CustomDataCallback event handler.
CustomDialogClosed Occurs on the client side after a custom dialog is closed.
CustomDialogClosing Fires on the client side before a custom dialog is closed.
CustomDialogOpened Occurs on the client side after a custom dialog is opened.
DialogClosed Occurs on the client side after a dialog is closed.
DialogClosing Fires on the client side before a dialog is going to be closed.
DialogInitialized Occurs on the client side after a dialog has been initialized.
EndCallback Occurs on the client side after a callback's server-side processing has been completed.
GotFocus Fires on the client side when the editor's Design View Area receives input focus.
HtmlChanged Occurs on the client side when the content of the editor changes.
Init Occurs on the client side after the control has been initialized. Inherited from ASPxClientControlBase.
LostFocus Fires on the client side when the editor's Design View Area loses input focus.
SelectionChanged Occurs on the client when a selection is changed within the ASPxHtmlEditor.
SpellingChecked Occurs on the client side after the editor content is spell checked.
Validation Allows you to specify whether the value entered into the ASPxHtmlEditor is valid.
See Also