.NET Framework 4.5.2+
.NET Framework 4.5.2+
.NET Standard 2.0+

RichEditDocumentServer.LoadDocument(String, DocumentFormat, String) Method

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

Namespace: DevExpress.XtraRichEdit

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

Declaration

public virtual bool LoadDocument(
    string filename,
    DocumentFormat documentFormat,
    string sourceUri
)

Parameters

Name Type Description
filename String

A string specifying the file to load (including the full path).

documentFormat 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

If the document is in a different format than specified or the passed string value is null, the RichEditDocumentServer.InvalidFormatException event fires.

The method can be used to load HTML files with external references. To load a file filename.html obtained by saving a document in HTML format from Rich Edit, set the sourceUri to filename_files:

bool result = richEditServer.LoadDocument("test.htm", DocumentFormat.Html, "test_files");

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.

See Also