RichEditControl.LoadDocument(Stream, DocumentFormat, Boolean) Method
Loads a document from a stream, specifying the document format and optionally leaving the stream open.
Namespace: DevExpress.Xpf.RichEdit
Assembly: DevExpress.Xpf.RichEdit.v20.2.dll
NuGet Packages: DevExpress.WindowsDesktop.Wpf.RichEdit, DevExpress.Wpf.RichEdit
Declaration
public virtual bool LoadDocument(
Stream stream,
DocumentFormat documentFormat,
bool leaveOpen
)Parameters
| Name | Type | Description |
|---|---|---|
| stream | Stream | The stream from which to load a document. |
| documentFormat | DocumentFormat | One of the DocumentFormat enumeration members indicating the document format. |
| leaveOpen | Boolean | true to leave the stream opened; otherwise, false. |
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.
If the document is in a different format than specified or the passed string is null, the RichEditControl.InvalidFormatException event fires.
Tip
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.