Back to Devexpress

ASPxClientRichEdit Members

aspnet-js-aspxclientrichedit-dot-underscore-members.md

latest10.5 KB
Original Source

ASPxClientRichEdit Members

A client-side equivalent of the ASPxRichEdit control.

Properties

NameDescription
commandsProvides access to the RichEdit’s client-side commands.
documentProvides access to document structural elements.
documentFormatSpecifies the format in which the editor prepares the document for saving or export.
documentNameSpecifies the name of the current document.
documentSaveFormatSpecifies the format in which the editor prepares the document for saving.
fileNameSpecifies the name of the saved/downloaded file.
layoutProvides access to a document’s layout functionality.
loadingPanelProvides access to settings related to a loading panel functionality.
nameGets the unique, hierarchically-qualified identifier for the control. Inherited from ASPxClientControlBase.
requestSettingsAllows you to access request settings.
scrollProvides access to a document’s scroll functionality.
selectionProvides access to the client methods that change the selection.
unitConverterGets a unit converter.

Methods

NameDescription
AdjustControlModifies the control’s size against the control’s container. Inherited from ASPxClientControl.
AdjustControls staticModifies the controls size within the specified container. Inherited from ASPxClientControl.
Cast(obj) staticConverts the specified object to the ASPxClientRichEdit type.
DownloadPdfDownloads the current document as a PDF file.
ExportToPdfExports the current document to PDF and invokes the PdfExported event.
FocusSets input focus to the RichEdit.
GetClientVisibleObsolete. Returns a value specifying whether a control is displayed. Inherited from ASPxClientControlBase.
GetControlCollection staticReturns a collection of client web control objects. Inherited from ASPxClientControl.
GetHeightReturns the control’s height. Inherited from ASPxClientControl.
GetMainElementReturns an HTML element that is the root of the control’s hierarchy. Inherited from ASPxClientControlBase.
GetParentControlReturns a client instance of the control that is the parent for a specified control. Inherited from ASPxClientControlBase.
GetRibbonProvides access to an object implementing the RichEdit’s ribbon UI.
GetVisibleReturns a value specifying whether a control is displayed. Inherited from ASPxClientControlBase.
GetWidthReturns the control’s width. Inherited from ASPxClientControl.
HasUnsavedChangesIndicates whether any unsaved changes are contained in the current document.
InCallbackReturns a value that determines whether a callback request sent by a web control is being currently processed on the server side. Inherited from ASPxClientControlBase.
PerformCallback(parameter)Sends a callback to the server and generates the server-side ASPxRichEdit.Callback event, passing it the specified argument.
ReconnectToExternalRibbonReconnects the RichEdit to an external ribbon.
SendMessageToAssistiveTechnology(message)Specifies the text that Assistive Technologies (screen readers or braille display, for example) will provide to a user. Inherited from ASPxClientControlBase.
SetClientVisible(visible)Obsolete. Specifies whether a control is displayed. Inherited from ASPxClientControlBase.
SetFullscreenMode(fullscreen)Enables you to switch the full-screen mode of the Rich Text Editor.
SetHeight(height)

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

Inherited from ASPxClientControl. | | SetVisible(visible) | Specifies whether a control is displayed. Inherited from ASPxClientControlBase. | | SetWidth(width) | Specifies the control’s width in pixels. Inherited from ASPxClientControl. |

Events

NameDescription
ActiveSubDocumentChangedOccurs when the active sub-document is substituted with another sub-document.
AutoCorrectFires when text is typed in the control.
BeforeSendOccurs before a web request is sent to the server.
BeginCallbackOccurs when a callback for server-side processing is initiated.
BeginSynchronizationFires after a client change has been made to the document and the client-server synchronization starts to apply the change on the server.
CallbackErrorFires on the client if any server error occurs during server-side processing of a callback sent by the RichEdit.
CharacterPropertiesChangedOccurs when the characters’ formatting is changed.
ContentInsertedOccurs when content is inserted into the document.
ContentRemovedOccurs when content is removed from the document.
CustomCommandExecutedOccurs after a custom command has been executed on the client side.
DocumentChangedFires if any change is made to the RichEdit’s document on the client.
DocumentFormattedOccurs on the client side when a document layout is formatted.
DocumentLoadedOccurs on the client side when a document model is loaded into the control.
EndCallbackOccurs on the client side after a callback’s server-side processing has been completed.
EndSynchronizationFires after a document change has been applied to the server and server and client document models have been synchronized.
FloatingObjectMovedFires after a floating object has been moved and allows you to change the object’s new position.
GotFocusOccurs when the control receives focus.
HyperlinkClickOccurs when a hyperlink is activated within the document.
InitOccurs on the client side after the control has been initialized. Inherited from ASPxClientControlBase.
KeyDownOccurs when a key is pressed while the ASPxRichEdit‘s document has focus.
KeyUpOccurs when a key is released while the ASPxRichEdit‘s document has focus.
LostFocusOccurs when the control loses focus.
ParagraphPropertiesChangedOccurs when a paragraph’s formatting is changed.
PointerDownOccurs when a pointer becomes active.
PointerUpOccurs when a pointer stops being active.
PopupMenuShowingOccurs when a pop-up menu is about to be shown.
SelectionChangedOccurs when the selection is changed within the document.

See Also

ASPxClientRichEdit Class