RichEditControl.LoadDocument(String, DocumentFormat) Method

SECURITY NOTE

Downloading documents passed into the LoadDocument method may create security issues. Review the following help topic and learn how to spot, analyze, and prohibit unwanted download requests:

Suppress Control Requests to Download Data from External URLs

Loads a document from a file, specifying the document format.

Namespace: DevExpress.XtraRichEdit

Assembly: DevExpress.XtraRichEdit.v23.2.dll

NuGet Packages: DevExpress.Win.PivotGrid, DevExpress.Win.RichEdit, DevExpress.Win.TreeMap

Declaration

C#

public virtual bool LoadDocument(
    string fileName,
    DocumentFormat documentFormat
)

VB.NET

Public Overridable Function LoadDocument(
    fileName As String,
    documentFormat As DocumentFormat
) As Boolean

Parameters

Name	Type	Description
fileName	String	A string specifying the file to load (including the full path).
documentFormat	DocumentFormat	One of the DocumentFormat enumeration members, indicating the document format.

Returns

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

Remarks

If the document is in a different format than specified 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 specified format.

Determine a moment when the document model can be safely modified using the RichEditControl.DocumentLoaded event. Handle the DocumentLayout.DocumentFormatted event to check the loaded document’s layout.

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the LoadDocument(String, DocumentFormat) 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-richeditcontrol-common-api/CS/RichEditAPISample/CodeExamples/RichEditControlActions.cs#L99

RichEditControl richEdit = e.Item.Tag as RichEditControl;
richEdit.LoadDocument("Documents\\MultiPageDocument.docx", DevExpress.XtraRichEdit.DocumentFormat.OpenXml);
richEdit.Document.CaretPosition = richEdit.Document.Range.End;

how-to-save-a-document-in-the-richedit-control/CS/SaveDocument/Form1.cs#L33

{
    richEditControl1.LoadDocument("TextWithImages.rtf", DocumentFormat.Rtf);
}

mail-merge-in-a-richeditcontrol/CS/MailMerge/Form1.cs#L17

ribbonControl1.SelectedPage = mailingsRibbonPage1;
richEditControl1.LoadDocument("invitation.rtf", DocumentFormat.Rtf);

winforms-richedit-save-text-from-a-range-in-different-formats/CS/GetTextMethodsExample/Form1.cs#L16

    InitializeComponent();
    richEditControl.LoadDocument("sample_document.docx", DevExpress.XtraRichEdit.DocumentFormat.OpenXml);
}

VB.NET

winforms-richeditcontrol-common-api/VB/RichEditAPISample/CodeExamples/RichEditControlActions.vb#L104

Dim richEdit As RichEditControl = TryCast(e.Item.Tag, RichEditControl)
richEdit.LoadDocument("Documents\MultiPageDocument.docx", DevExpress.XtraRichEdit.DocumentFormat.OpenXml)
richEdit.Document.CaretPosition = richEdit.Document.Range.End

how-to-save-a-document-in-the-richedit-control/VB/SaveDocument/Form1.vb#L26

Private Sub Form1_Load(ByVal sender As Object, ByVal e As EventArgs) Handles MyBase.Load
    richEditControl1.LoadDocument("TextWithImages.rtf", DocumentFormat.Rtf)
End Sub

mail-merge-in-a-richeditcontrol/VB/MailMerge/Form1.vb#L15

ribbonControl1.SelectedPage = mailingsRibbonPage1
richEditControl1.LoadDocument("invitation.rtf", DocumentFormat.Rtf)

winforms-richedit-save-text-from-a-range-in-different-formats/VB/GetTextMethodsExample/Form1.vb#L15

    InitializeComponent()
    richEditControl.LoadDocument("sample_document.docx", DevExpress.XtraRichEdit.DocumentFormat.OpenXml)
End Sub