RichEditDocumentServer.LoadDocument(String) Method

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

Namespace: DevExpress.XtraRichEdit

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

NuGet Packages: DevExpress.RichEdit.Core, DevExpress.Win.Navigation

Declaration

C#

public virtual bool LoadDocument(
    string fileName
)

VB.NET

Public Overridable 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 RichEditDocumentServer.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.

To determine the moment when the document model can be safely modified, use the RichEditDocumentServer.DocumentLoaded event. Handle the DocumentLayout.DocumentFormatted event to check the loaded document layout.

Tip

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

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#

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

#region #CreateContentControls
wordProcessor.LoadDocument("Documents\\Simple Form.docx");
Document document = wordProcessor.Document;

word-document-api-create-master-detail-report/CS/MasterDetailExample/MergeProcessor.cs#L32

// Load main template
mainRichEdit.LoadDocument("main.rtf");

word-document-api-print-documents/CS/WindowsFormsApp1/XtraForm1.cs#L29

{
    server.LoadDocument("Grimm.docx");
    foreach (Section _section in server.Document.Sections)

word-document-api-open-and-save-encrypted-files/CS/word-processing-encryption/Program.cs#L25

server.Options.Import.EncryptionPassword = "test";
server.LoadDocument("Documents//testEncrypted.docx");

word-document-api-use-multiple-data-sources-for-mail-merge/CS/MailMergeSample/Default.aspx.cs#L37

if (templateName == "preview1") {
    documentServer.LoadDocument(Page.MapPath("~/App_Data/InvoicesDetail.rtf"));

VB.NET

word-document-api-examples/VB/CodeExamples/NotesActions.vb#L24

' Load a document from a file.
wordProcessor.LoadDocument("Documents//Grimm.docx")
' Access a document.

word-document-api-create-master-detail-report/VB/MasterDetailExample/MergeProcessor.vb#L35

' Load main template
mainRichEdit.LoadDocument("main.rtf")
' Create project's data source

word-document-api-print-documents/VB/WindowsFormsApp1/XtraForm1.vb#L16

Using server As DevExpress.XtraRichEdit.RichEditDocumentServer = New DevExpress.XtraRichEdit.RichEditDocumentServer()
    server.LoadDocument("Grimm.docx")
    For Each _section As Section In server.Document.Sections

word-document-api-open-and-save-encrypted-files/VB/word-processing-encryption/Program.vb#L18

server.Options.Import.EncryptionPassword = "test"
server.LoadDocument("Documents//testEncrypted.docx")
Dim encryptionOptions As EncryptionSettings = New EncryptionSettings()

word-document-api-use-multiple-data-sources-for-mail-merge/VB/MailMergeSample/Default.aspx.vb#L34

If Equals(templateName, "preview1") Then
    documentServer.LoadDocument(Page.MapPath("~/App_Data/InvoicesDetail.rtf"))
    Dim invoices As List(Of Invoice) = New List(Of Invoice)(10)