Document.LoadDocument(String, DocumentFormat) Method

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

Namespace: DevExpress.XtraRichEdit.API.Native

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

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

Declaration

C#

bool LoadDocument(
    string fileName,
    DocumentFormat format
)

VB.NET

Function LoadDocument(
    fileName As String,
    format As DocumentFormat
) As Boolean

Parameters

Name	Type	Description
fileName	String	A string specifying the file to load (including the full path).
format	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.

Use the RichEditControl.DocumentLoaded, RichEditDocumentServer.DocumentLoaded or RichEditControl.DocumentLoaded 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.

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-richedit-document-api/CS/RichEditAPISample/CodeExamples/Comments.cs#L10

#region #CreateComment
document.LoadDocument("Documents//Grimm.docx", DevExpress.XtraRichEdit.DocumentFormat.OpenXml);
DocumentRange docRange = document.Paragraphs[2].Range;

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

#region #SelectTextInRange
document.LoadDocument("Documents//Grimm.docx", DocumentFormat.OpenXml);
DocumentPosition myStart = document.CreatePosition(69);

word-document-api-examples/CS/CodeExamples/PageLayoutActions.cs#L17

Document document = wordProcessor.Document;
document.LoadDocument("Documents\\Grimm.docx", DevExpress.XtraRichEdit.DocumentFormat.OpenXml);
document.Unit = DevExpress.Office.DocumentUnit.Inch;

VB.NET

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

#Region "#CreateComment"
            document.LoadDocument("Documents//Grimm.docx", DevExpress.XtraRichEdit.DocumentFormat.OpenXml)
            Dim docRange As DevExpress.XtraRichEdit.API.Native.DocumentRange = document.Paragraphs(CInt((2))).Range

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

'            #Region "#SelectTextInRange"
            document.LoadDocument("Documents//Grimm.docx", DocumentFormat.OpenXml)
            Dim myStart As DocumentPosition = document.CreatePosition(69)

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

Dim document As DevExpress.XtraRichEdit.API.Native.Document = wordProcessor.Document
document.LoadDocument("Documents\Grimm.docx", DevExpress.XtraRichEdit.DocumentFormat.OpenXml)
document.Unit = DevExpress.Office.DocumentUnit.Inch