DxRichEdit Members

A Rich Text Editor component.

Constructors

Name Description
DxRichEdit() Initializes a new instance of the DxRichEdit class.

Properties

Name Description
ActiveRibbonTabIndex Specifies the active ribbon tab’s index.
AutoSaveTimeout Specifies the timeout for the auto-save feature.
CssClass Specifies the name of the component’s CSS class. Inherited from DxComponentBase.
DocumentAPI Provides access to the document’s common and the main sub-document‘s functionalities.
DocumentContent Specifies an open document’s content.
DocumentFormat Specifies the format in which the DocumentContent property stores content of an open document.
Id For internal use only. Inherited from DxComponentBase.
Modified Specifies whether the open document has unsaved changes.
ReadOnly Specifies whether users can edit a document.
RibbonVisible Specifies whether the ribbon is visible.
Selection Provides access to the Rich Text Editor’s selection.
ViewType Specifies a document view layout type.

Methods

Name Description
Equals(Object) Determines whether the specified object is equal to the current object. Inherited from Object.
Equals(Object, Object) static Determines whether the specified object instances are considered equal. Inherited from Object.
ExportDocumentAsync(DocumentFormat) Exports the document to a byte array in a specified format.
ExportDocumentAsync(Stream, DocumentFormat) Exports the document to a stream in a specified format.
ExportDocumentAsync(String, DocumentFormat) Exports the document to a file in a specified format.
FocusAsync() Sets input focus to the Rich Text Editor.
GetHashCode() Serves as the default hash function. Inherited from Object.
GetType() Gets the Type of the current instance. Inherited from Object.
LoadDocumentAsync(IBrowserFile) Loads a document from a file.
LoadDocumentAsync(Byte[], DocumentFormat) Loads a document in the specified format from a byte array.
LoadDocumentAsync(Stream) Loads a document from a stream.
LoadDocumentAsync(Stream, DocumentFormat) Loads a document in the specified format from a stream.
LoadDocumentAsync(String) Loads a document from the file.
LoadDocumentAsync(String, DocumentFormat) Loads a document in the specified format from a file.
MemberwiseClone() protected Creates a shallow copy of the current Object. Inherited from Object.
NewDocumentAsync() Creates and opens a new document.
ReferenceEquals(Object, Object) static Determines whether the specified Object instances are the same instance. Inherited from Object.
SaveDocumentAsync() Raises the DocumentContentChanged event.
ToString() Returns a string that represents the current object. Inherited from Object.

Events

Name Description
ActiveRibbonTabIndexChanged Fires after the active ribbon tab is changed.
CalculateDocumentVariable Fires when a DOCVARIABLE field is updated and allows you to specify the field result.
DocumentContentChanged Allows you to save document content changes.
DocumentContentChanging Allows you to edit document before saving.
DocumentLoaded Fires after a document is loaded.
GotFocus Fires after the Rich Text Editor receives focus.
LostFocus Fires after the Rich Text Editor loses focus.
ModifiedChanged Allows you to track unsaved document changes.
ReadOnlyChanged Fires after the ReadOnly property value changes.
RibbonVisibleChanged Fires after the ribbon visibility is changed.
SelectionChanged Fires after the selection is changed.
ViewTypeChanged Fires after the document view type is changed.
See Also