RichEditDocumentServerExtensions.LoadDocumentTemplateAsync(RichEditDocumentServer, Byte[], DocumentFormat) Method
Asynchronously loads a document template in the specified format from a byte array.
Namespace: DevExpress.XtraRichEdit
Assembly: DevExpress.Docs.v24.2.dll
NuGet Package: DevExpress.Document.Processor
#Declaration
public static Task<bool> LoadDocumentTemplateAsync(
this RichEditDocumentServer self,
byte[] buffer,
DocumentFormat documentFormat
)
#Parameters
Name | Type | Description |
---|---|---|
self | Rich |
The current Rich |
buffer | Byte[] | A byte array that contains document data. |
document |
Document |
An enumeration member that specifies the format of the loaded document. |
#Returns
Type | Description |
---|---|
Task<Boolean> | Returns true if the document was loaded successfully; otherwise, false is returned. |
#Remarks
Important
The Rich
A document template cannot be overwritten either in code or in the UI. The information about the original file location and its format is dropped. An attempt to save (i.e., overwrite) the original document invokes the Save As dialog.
If a document has a different format than the documentFormat parameter specifies, the RichEditDocumentServer.InvalidFormatException event fires.
Important
Take into account the following when you call this method:
The events fired by this method call may occur in a different thread than the target operation.
The operation is not thread safe (the document should not be accessed simultaneously by different threads). Wait until the operation is completed before you continue to work with the document (for example, use the
await
operator).