RichEditControl.LoadDocument(String) 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 the specified file. The file format is determined by its content.

Namespace: DevExpress.XtraRichEdit

Assembly: DevExpress.XtraRichEdit.v24.1.dll

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

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 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 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.

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.

View Example

Form1.cs

richEditControl1.LoadDocument("Grimm.docx");

Form1.vb

richEditControl1.LoadDocument("Grimm.docx")

Tip

Use LoadDocument method overloads which explicit format definition 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#

winforms-richedit-create-a-master-detail-report/CS/RichEditMasterDetailMailMerge/Form1.cs#L44

//Load main template, master and detail documents to the corresponding RichEditCotnrols:
mainRichEdit.LoadDocument("Templates\\Template.rtf");
masterRichEdit.LoadDocument("Templates\\Master.rtf");

winforms-richedit-use-calculatedocumentvariable-event-to-insert-formatted-content/CS/Form1.cs#L23

richEditControl1.LoadDocument("Documents//Template.rtf");
ShowFieldCodes();

winforms-richedit-master-detail-mail-merge-essentials/CS/Form1.cs#L13

richEditCategoryTemplate.LoadDocument("MasterTemplate.rtf");
richEditProductTemplate.LoadDocument("DetailTemplate.rtf");

winforms-richedit-document-encryption/CS/RichEditControl_Encryption/Form1.cs#L25

    InitializePasswordEdit();
    richEditControl1.LoadDocument("testEncrypted.docx");
}

winforms-richeditcontrol-common-api/CS/RichEditAPISample/CodeExamples/RichEditControlActions.cs#L385

RichEditControl richEdit = e.Item.Tag as RichEditControl;
richEdit.LoadDocument("Documents\\Grimm.docx");
//Set the required export options:

VB.NET

winforms-richedit-create-a-master-detail-report/VB/RichEditMasterDetailMailMerge/Form1.vb#L41

'Load main template, master and detail documents to the corresponding RichEditCotnrols:
mainRichEdit.LoadDocument("Templates\Template.rtf")
masterRichEdit.LoadDocument("Templates\Master.rtf")

winforms-richedit-use-calculatedocumentvariable-event-to-insert-formatted-content/VB/Form1.vb#L16

AddHandler richEditControl1.Document.CalculateDocumentVariable, New CalculateDocumentVariableEventHandler(AddressOf Document_CalculateDocumentVariable)
richEditControl1.LoadDocument("Documents//Template.rtf")
ShowFieldCodes()

winforms-richedit-master-detail-mail-merge-essentials/VB/Form1.vb#L13

InitializeComponent()
richEditCategoryTemplate.LoadDocument("MasterTemplate.rtf")
richEditProductTemplate.LoadDocument("DetailTemplate.rtf")

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

Dim richEdit As RichEditControl = TryCast(e.Item.Tag, RichEditControl)
richEdit.LoadDocument("Documents\Grimm.docx")
'Set the required export options:

rich-text-editor-highlight-syntax/VB/SyntaxHighlightApp/Form1.vb#L23

    richEditControl1.ReplaceService(Of ISyntaxHighlightService)(New MySyntaxHighlightService(richEditControl1))
    richEditControl1.LoadDocument(path)
End Sub