officefileapi-devexpress-dot-xtrarichedit-dot-api-dot-native-dot-document-dot-loaddocument-x28-system-dot-string-devexpress-dot-xtrarichedit-dot-documentformat-x29.md
Using file paths sourced from untrusted input may expose unauthorized files or allow unintended file access. Always validate and normalize all external paths to prevent path manipulation.
Loads a document from a file, specifying the document format.
Namespace : DevExpress.XtraRichEdit.API.Native
Assembly : DevExpress.RichEdit.v25.2.Core.dll
NuGet Package : DevExpress.RichEdit.Core
bool LoadDocument(
string fileName,
DocumentFormat format
)
Function LoadDocument(
fileName As String,
format As DocumentFormat
) As Boolean
| 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.
|
| Type | Description |
|---|---|
| Boolean |
true , if the document is successfully loaded; otherwise, false.
|
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.
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.
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);
winforms-richedit-document-api/VB/RichEditAPISample/CodeExamples/PageLayout.vb#L9
#Region "#LineNumbering"
document.LoadDocument("Documents//Grimm.docx", DevExpress.XtraRichEdit.DocumentFormat.OpenXml)
document.Unit = DevExpress.Office.DocumentUnit.Inch
wpf-richedit-document-api/VB/DXRichEditControlAPISample/CodeExamples/PageLayoutActions.vb#L7
' #Region "#LineNumbering"
document.LoadDocument("Documents//Grimm.docx", DevExpress.XtraRichEdit.DocumentFormat.OpenXml)
document.Unit = DevExpress.Office.DocumentUnit.Inch
See Also