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

Document.LoadDocument(String, DocumentFormat) Method

Loads a document from a file, specifying the document format.

Namespace: DevExpress.XtraRichEdit.API.Native

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

Declaration

bool LoadDocument(
    string fileName,
    DocumentFormat format
)
Function LoadDocument(
    fileName As String,
    format As DocumentFormat
) 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.

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.

After loading a document, the DocumentSaveOptions.CurrentFileName property is set to the file name and the DocumentSaveOptions.CurrentFormat property is set to the specified format.

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.

See Also