Document.LoadDocument(Stream, DocumentFormat) Method

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

Namespace : DevExpress.XtraRichEdit.API.Native

Assembly : DevExpress.RichEdit.v25.2.Core.dll

NuGet Package : DevExpress.RichEdit.Core

Declaration

• C#
• VB.NET

bool LoadDocument(
    Stream stream,
    DocumentFormat format
)

Function LoadDocument(
    stream As Stream,
    format As DocumentFormat
) As Boolean

Parameters

The stream from which to load a document.

| | format | DocumentFormat |

One of the DocumentFormat enumeration members indicating the document format.

|

Returns

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.

Determine a moment when the document model can be safely modified using the RichEditControl.DocumentLoaded, RichEditDocumentServer.DocumentLoaded or RichEditControl.DocumentLoaded event. Handle the DocumentLayout.DocumentFormatted event to check the loaded document’s layout.

See Also

Document Interface

Document Members

DevExpress.XtraRichEdit.API.Native Namespace