How to: Load a Document

• Jul 09, 2021
• 4 minutes to read

The RichEditDocumentServer.LoadDocument method allows you to load a document from a file, stream, byte array, or string. Handle related events to determine the moment when the document can be modified.

The format of the loaded document 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.

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

Load a Document from a File

View Example

BasicActions.cs

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

BasicActions.vb

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

Load a Document from a Stream

C#

using System.IO;
using DevExpress.XtraRichEdit;
using DevExpress.XtraRichEdit.API.Native;
using System.Reflection;
// ...
//
// Load document from a stream
using(Stream stream = GetResourceStream("MyApplication.Document1.rtf"))
{
    stream.Seek(0, SeekOrigin.Begin);
    wordProcessor.LoadDocument(stream, DocumentFormat.Rtf);
    stream.Close();
}
static Stream GetResourceStream(string resourceName)
{
    return Assembly.GetExecutingAssembly().GetManifestResourceStream(resourceName);
}

VB.NET

Imports System.IO
Imports DevExpress.XtraRichEdit
Imports DevExpress.XtraRichEdit.API.Native
Imports System.Reflection
' ...
' Load document from a stream
Using stream As Stream = GetResourceStream("MyApplication.Document1.rtf")
    stream.Seek(0, SeekOrigin.Begin)
    richEditDocumentServer1.LoadDocument(stream, DocumentFormat.Rtf)
    stream.Close()
End Using

Private Shared Function GetResourceStream(ByVal resourceName As String) As Stream
    Return Assembly.GetExecutingAssembly().GetManifestResourceStream(resourceName)
End Function
' Load document from file
Private Sub btnLoadFile_Click(ByVal sender As Object, ByVal e As EventArgs)  _
        Handles btnLoadFile.Click
    richEditControl1.LoadDocument("Document1.rtf",DocumentFormat.Rtf)
End Sub

Load a Document from a String

The following properties load strings in various formats:

• Document.Text
• Document.RtfText
• Document.OpenXmlBytes
• Document.DocBytes
• Document.OpenDocumentBytes
• Document.DocmBytes
• Document.DotmBytes
• Document.DotxBytes
• Document.DotBytes
• Document.FlatOpcBytes
• Document.FlatOpcMacroEnabledBytes
• Document.FlatOpcTemplateBytes
• Document.FlatOpcMacroEnabledTemplateBytes
• Document.WordMLText
• Document.MhtText
• Document.HtmlText

The code sample below loads an RTF string:

C#

using (RichEditDocumentServer wordProcessor = new RichEditDocumentServer())
{
    string rtfString = @"{\rtf1\ansi\ansicpg1252\deff0\deflang1049
{\fonttbl{\f0\fswiss\fprq2\fcharset0 Arial;}
{\f1\fswiss\fcharset0 Arial;}}
{\colortbl ;\red0\green0\blue255;}
\viewkind4\uc1\pard\cf1\lang1033\b\f0\fs32 Test.\cf0\b0\f1\fs20\par}";
    Document document = wordProcessor.Document;
    document.RtfText = rtfString;
}

VB.NET

Using wordProcessor As New RichEditDocumentServer()
    Dim rtfString As String = "{\rtf1\ansi\ansicpg1252\deff0\deflang1049" & ControlChars.CrLf & _
    "{\fonttbl{\f0\fswiss\fprq2\fcharset0 Arial;}" & ControlChars.CrLf & _
    "{\f1\fswiss\fcharset0 Arial;}}" & ControlChars.CrLf & _
    "{\colortbl ;\red0\green0\blue255;}" & ControlChars.CrLf & _
    "\viewkind4\uc1\pard\cf1\lang1033\b\f0\fs32 Test.\cf0\b0\f1\fs20\par}"
    Dim document As Document = wordProcessor.Document
    document.RtfText = rtfString
End Using

Asynchronous Load

Use the RichEditDocumentServerExtensions.LoadDocumentAsync method to asynchronously load a document from a file, stream, or byte array.

To run asynchronous operations, you need to use the RichEditDocumentServerExtensions class from the DevExpress.Docs.v20.2.dll assembly. Remember to add this assembly to your project. If you use this assembly in production code, a license for the DevExpress Office File API or DevExpress Universal Subscription is required. For pricing information, refer to the following page: DevExpress Subscription Plans.

Important

Take into account the following when you call this method:

• The events fired by this method’s call may occur in a different thread than the target operation.

• The operation is not thread safe (documents should not be accessed simultaneously by different threads). Wait until the operation is completed before working with the document, i.e., use the await operator.

The code sample below merges two asynchronously loaded documents and asynchronously exports the result:

C#

private async void MergeDocuments()
{
  using (RichEditDocumentServer wordProcessor = new RichEditDocumentServer())
  using (RichEditDocumentServer wordProcessor2 = new RichEditDocumentServer())
  {
      await Task.WhenAll(new Task[]
      {
          wordProcessor.LoadDocumentAsync("Document1.docx"),
          wordProcessor2.LoadDocumentAsync("Document2.docx")
      });
      wordProcessor.AppendDocumentContent(wordProcessor2.Document.Range);
      await wordProcessor.SaveDocumentAsync("merged.docx", DocumentFormat.OpenXml);
  }
}

VB.NET

Private Async Sub MergeDocuments()
    Using wordProcessor As RichEditDocumentServer = New RichEditDocumentServer()

        Using wordProcessor2 As RichEditDocumentServer = New RichEditDocumentServer()
            Await Task.WhenAll(New Task() {wordProcessor.LoadDocumentAsync("Document1.docx"), wordProcessor2.LoadDocumentAsync("Document2.docx")})
            wordProcessor.AppendDocumentContent(wordProcessor2.Document.Range)
            Await wordProcessor.SaveDocumentAsync("merged.docx", DocumentFormat.OpenXml)
        End Using
    End Using
End Sub

Related Events

The table below lists events related to the document load:

Event	Description
RichEditDocumentServer.BeforeImport	Occurs before a document is loaded (imported from an external source).
RichEditDocumentServer.InitializeDocument	Occurs before a document is loaded. Handle this event to set initial document settings.
RichEditDocumentServer.DocumentLoaded	Occurs after a document is loaded.
DocumentLayout.DocumentFormatted	Fires after the document layout is calculated.
RichEditDocumentServer.InvalidFormatException	Fires when the supplied data could not be recognized as data in the assumed format for import.
RichEditDocumentServer.UnhandledException	This event is raised when an exception unhandled by the RichEditDocumentServer occurs.