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.v24.2.Core.dll

NuGet Package: DevExpress.RichEdit.Core

Declaration

C#

bool LoadDocument(
    string fileName
)

VB.NET

Function LoadDocument(
    fileName As String
) As Boolean

Parameters

Name	Type	Description
fileName	String	A string that specifies 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, DOCM, DOTX, DOT, DOTM, DOCX, RTF, HTM, HTML, MHT, XML, FlatOpc, EPUB;
• ODT - non-encrypted files only;

Plain text cannot be detected automatically. To load a plain text document, use another method override with 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 (WinForms), RichEditDocumentServer.DocumentLoaded or RichEditControl.DocumentLoaded (WPF) 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

Define the format explicitly in the LoadDocument method overloads to improve performance.

View Example

BasicActions.cs

wordProcessor.LoadDocument("Documents\\Grimm.docx", DocumentFormat.OpenXml);

BasicActions.vb

wordProcessor.LoadDocument("Documents\Grimm.docx", DocumentFormat.OpenXml)

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the LoadDocument(String) method.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

C#

winforms-richedit-document-api/CS/RichEditAPISample/CodeExamples/VbaMacros.cs#L11

#region #ObtainVbaModuleNames
document.LoadDocument("Documents\\Grimm.docx");
if (document.VbaProject.Modules.Count > 0)

wpf-richedit-document-api/CS/DXRichEditControlAPISample/CodeExamples/NotesActions.cs#L12

#region #InsertFootnotes
document.LoadDocument("Documents//Grimm.docx");

word-document-api-examples/CS/CodeExamples/ListsActions.cs#L18

Document document = wordProcessor.Document;
document.LoadDocument("Documents//List.docx");
document.BeginUpdate();

VB.NET

winforms-richedit-document-api/VB/RichEditAPISample/CodeExamples/Notes.vb#L10

#Region "#InsertFootnotes"
            document.LoadDocument("Documents//Grimm.docx")
            'Insert a footnote at the end of the 6th paragraph:

wpf-richedit-document-api/VB/DXRichEditControlAPISample/CodeExamples/NotesActions.vb#L9

'            #Region "#InsertFootnotes"
            document.LoadDocument("Documents//Grimm.docx")

word-document-api-examples/VB/CodeExamples/ListsActions.vb#L16

Dim document As DevExpress.XtraRichEdit.API.Native.Document = wordProcessor.Document
document.LoadDocument("Documents//List.docx")
document.BeginUpdate()