RichEditControl.LoadDocument(String) Method

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

Namespace: DevExpress.Xpf.RichEdit

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

Declaration

public virtual bool LoadDocument(
    string fileName
)
Public Overridable 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 is null, the RichEditControl.InvalidFormatException event fires.

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

Determine a moment when the document model can be safely modified using the RichEditControl.DocumentLoaded event. Call the LoadDocument method in the Form.Loaded event handler to work with the DocumentLoaded event. Handle the DocumentLayout.DocumentFormatted event to check the loaded document's layout.

TIP

Use LoadDocument method overloads which explicit format definition to improve performance.

See Also