RichEditDocumentServer.LoadDocument(Stream) Method
Loads a document from the stream.
Namespace: DevExpress.XtraRichEdit
Assembly: DevExpress.RichEdit.v24.1.Core.dll
NuGet Packages: DevExpress.RichEdit.Core, DevExpress.Win.Navigation
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 IFormatDetectorService service implementation. The following formats are detected:
- DOC, DOCM, DOTX, DOT, DOTM, DOCX, RTF, HTM, HTML, MHT, XML, FlatOpc, EPUB;
- ODT - non-encrypted files only;
Plain text cannot be detected automatically. To load a plain text document, use another method override with DocumentFormat.PlainText as a parameter.
If the format detection fails or the passed stream is null, the RichEditControl.InvalidFormatException event fires.
To determine the moment when the document model can be safely modified, use the RichEditDocumentServer.DocumentLoaded event. Handle the DocumentLayout.DocumentFormatted event to check the loaded document layout.
Tip
Define the format explicitly in the LoadDocument method overloads to improve performance.
Related GitHub Examples
The following code snippet (auto-collected from DevExpress Examples) contains a reference to the LoadDocument(Stream) method.
Note
The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.