Document.LoadDocument(String, DocumentFormat, String) Method

SECURITY-RELATED CONSIDERATIONS

Using file paths sourced from untrusted input may expose unauthorized files or allow unintended file access. Always validate and normalize all external paths to prevent path manipulation.

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.API.Native

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

NuGet Package : DevExpress.RichEdit.Core

csharp

bool LoadDocument(
    string fileName,
    DocumentFormat format,
    string sourceUri
)

Function LoadDocument(
    fileName As String,
    format As DocumentFormat,
    sourceUri As String
) As Boolean

Parameters

Name	Type	Description
fileName	String

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

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

If the document is in a different format than specified or the passed string value 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:

C#
VB.NET

csharp

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

Dim result As Boolean = richEdit.Document.LoadDocument("test.htm", DocumentFormat.Html, "test_files")

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.