RichEditControl.LoadDocument(Stream) Method
Loads a document from the stream.
Namespace: DevExpress.Xpf.RichEdit
Assembly: DevExpress.Xpf.RichEdit.v20.2.dll
NuGet Packages: DevExpress.WindowsDesktop.Wpf.RichEdit, DevExpress.Wpf.RichEdit
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, DOCX, RTF, HTM, HTML, MHT, XML, EPUB;
- ODT - non-encrypted files only.
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.
Determine a moment when the document model can be safely modified using the RichEditControl.DocumentLoaded event. Call the LoadDocument method in the Form.Loaded event handler to work with the DocumentLoaded event. Handle the DocumentLayout.DocumentFormatted event to check the loaded document’s layout.
Tip
Use LoadDocument method overloads which explicit format definition to improve performance.