RichEditDocumentServer.LoadDocument(Stream) Method
Loads a document from the stream.
Namespace: DevExpress.XtraRichEdit
Assembly: DevExpress.RichEdit.v18.2.Core.dll
Declaration
Parameters
| Name | Type | Description |
|---|---|---|
| stream | Stream | A Stream object that is the stream used to load a document. |
Returns
| Type | Description |
|---|---|
| Boolean | true, if the document is successfully loaded; otherwise, false. |
Remarks
The source stream can be non-seekable. In this case, the stream is buffered automatically. After loading the document, the stream remains open.
The format of the document loaded from a stream is detected automatically by the built-in RichEditDocumentServer.InvalidFormatException service implementation. The following formats are detected:
- DOC, DOCX, ODT - non-encrypted files only;
- RTF, HTM, HTML, MHT, XML, EPUB.
Plain text cannot be detected automatically. To load a plain text document, use another method override with the document format DocumentFormat.PlainText as a parameter.
If the format detection fails or the passed stream is null, the RichEditControl.InvalidFormatException event fires.
Tip
Determine a moment when the document model can be safely modified using the RichEditDocumentServer.DocumentLoaded event. Handle the DocumentLayout.DocumentFormatted event to check the loaded document’s layout.