wpf-devexpress-dot-xpf-dot-richedit-dot-richeditcontrol-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.Xpf.RichEdit
Assembly : DevExpress.Xpf.RichEdit.v25.2.dll
NuGet Package : DevExpress.Wpf.RichEdit
public virtual bool LoadDocument(
string fileName,
DocumentFormat documentFormat
)
Public Overridable Function LoadDocument(
fileName As String,
documentFormat As DocumentFormat
) As Boolean
| 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.
|
| 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 is null , the RichEditControl.InvalidFormatException event fires.
After loading a document, the DXRichEditDocumentSaveOptions.CurrentFileName property is set to the file name and the DXRichEditDocumentSaveOptions.CurrentFormat property is set to the specified format.
Tip
Determine a moment when the document model can be safely modified using the RichEditControl.DocumentLoaded event. Call the LoadDocument method in the Form.Loaded event handler to work with the DocumentLoaded event. Handle the DocumentLayout.DocumentFormatted event to check the loaded document’s layout.
The following code snippet (auto-collected from DevExpress Examples) contains a reference 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.
{
richEditControl1.LoadDocument("sample.docx", DocumentFormat.OpenXml);
}
Private Sub richEditControl1_Loaded(ByVal sender As Object, ByVal e As RoutedEventArgs)
Me.richEditControl1.LoadDocument("sample.docx", DocumentFormat.OpenXml)
End Sub
See Also