RichEditDocumentServerExtensions.LoadDocumentTemplateAsync(RichEditDocumentServer, Byte[]) Method
Asynchronously loads a document template from a byte array.
Namespace: DevExpress.XtraRichEdit
Assembly: DevExpress.Docs.v24.1.dll
NuGet Package: DevExpress.Document.Processor
Declaration
public static Task<bool> LoadDocumentTemplateAsync(
this RichEditDocumentServer self,
byte[] buffer
)Parameters
| Name | Type | Description |
|---|---|---|
| self | RichEditDocumentServer | The current RichEditDocumentServer instance. |
| buffer | Byte[] | A byte array that contains document data. |
Returns
| Type | Description |
|---|---|
| Task<Boolean> | Returns true if the document was loaded successfully; otherwise, false is returned. |
Remarks
Important
The RichEditDocumentServerExtensions class is defined in the DevExpress.Docs.v24.1.dll assembly. Add this assembly to your project to use the RichEditDocumentServerExtensions members. You need a license for the DevExpress Office File API Subscription or DevExpress Universal Subscription to use this library in production code.
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.
The RichEditDocumentServer uses the built-in IFormatDetectorService service implementation to detect the loaded document’s format. If format detection fails, 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
awaitoperator).