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

Document.LoadDocument(String) Method

Loads a document from the specified file. The file format is determined by its content.

Namespace: DevExpress.XtraRichEdit.API.Native

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

Declaration

bool LoadDocument(
    string fileName
)
Function LoadDocument(
    fileName As String
) As Boolean

Parameters

Name Type Description
fileName String

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

Returns

Type Description
Boolean

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

Remarks

The format of the document loaded from a stream is detected automatically by the built-in IFormatDetectorService service implementation. The following formats are detected:

  • DOC, DOCX, RTF, HTM, HTML, MHT, XML, EPUB;
  • ODT - non-encrypted files only;

Plain text cannot be detected automatically. To load a plain text document, use another method override with the document format DocumentFormat.PlainText as a parameter.

If the format detection fails 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 detected 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.

TIP

Use the LoadDocument method overloads with explicit format definition to improve performance.

See Also