RichEditControl.LoadDocument(Stream, DocumentFormat) Method

Loads a document from a stream, specifying the document format.

Namespace: DevExpress.Xpf.RichEdit

Assembly: DevExpress.Xpf.RichEdit.v24.1.dll

NuGet Package: DevExpress.Wpf.RichEdit

Declaration

C#

public virtual bool LoadDocument(
    Stream stream,
    DocumentFormat documentFormat
)

VB.NET

Public Overridable Function LoadDocument(
    stream As Stream,
    documentFormat As DocumentFormat
) As Boolean

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.

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.

If the document is in a different format than specified 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 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.