Document.LoadDocument(Stream, DocumentFormat, String) Method

Loads a document from the stream in the specified format. External content for HTML format is retrieved using the specified source (base) URI.

Namespace: DevExpress.XtraRichEdit.API.Native

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

NuGet Packages: DevExpress.RichEdit.Core, DevExpress.Win.Navigation

Declaration

C#

bool LoadDocument(
    Stream stream,
    DocumentFormat format,
    string sourceUri
)

VB.NET

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

Parameters

Name	Type	Description
stream	Stream	The stream from which to load the document.
format	DocumentFormat	One of the DocumentFormat enumeration members, indicating the document format.
sourceUri	String	A string representing the document URI.

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 method can be used to load HTML files with external references.

If the document is in a different format than specified or the passed stream is null, the RichEditControl.InvalidFormatException event fires.

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