RichEditControl.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.XtraRichEdit.v20.1.dll

Declaration

public virtual bool LoadDocument(
    string fileName,
    DocumentFormat documentFormat,
    string sourceUri
)
Public Overridable Function LoadDocument(
    fileName As String,
    documentFormat As DocumentFormat,
    sourceUri As String
) As Boolean

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 is null, the RichEditControl.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 = richEdit.LoadDocument("test.htm", DocumentFormat.Html, "test_files");
TIP

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

See Also