RichEditDocumentServer.LoadDocument(String, DocumentFormat) Method
Loads a document from a file, specifying the document format.
Namespace: DevExpress.XtraRichEdit
Assembly: DevExpress.RichEdit.v24.2.Core.dll
NuGet Package: DevExpress.RichEdit.Core
#Declaration
public virtual bool LoadDocument(
string fileName,
DocumentFormat documentFormat
)
#Parameters
Name | Type | Description |
---|---|---|
file |
String | A string specifying the file to load (including the full path). |
document |
Document |
One of the Document |
#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 RichEditDocumentServer.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.
Tip
Determine a moment when the document model can be safely modified using the Rich
#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.