RichEditDocumentServer.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

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

NuGet Package : DevExpress.RichEdit.Core

Declaration

csharp

public virtual bool LoadDocument(
    Stream stream,
    DocumentFormat documentFormat,
    string sourceUri
)

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

Name	Type	Description
stream	Stream

The stream from which to load the document.

| | documentFormat | DocumentFormat |

One of the DocumentFormat enumeration members, indicating the document format.

| | sourceUri | String |

A string representing the document URI.

Type	Description
Boolean

true , if the document is successfully loaded; otherwise, false.

The source stream can be non-seekable. In this case, the stream is buffered automatically. After loading the document, the stream remains open.

Tip

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 RichEditDocumentServer.InvalidFormatException event fires.

Tip

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