RichEditDocumentServerExtensions.LoadDocumentTemplateAsync(RichEditDocumentServer, Stream, DocumentFormat, CancellationToken) Method
Asynchronously loads a document template from the stream in the specified document format.
Namespace: DevExpress.XtraRichEdit
Assembly: DevExpress.Docs.v24.2.dll
NuGet Package: DevExpress.Document.Processor
#Declaration
public static Task<bool> LoadDocumentTemplateAsync(
this RichEditDocumentServer self,
Stream stream,
DocumentFormat documentFormat,
CancellationToken cancellationToken
)
#Parameters
Name | Type | Description |
---|---|---|
self | Rich |
The current Rich |
stream | Stream | A stream used to load a document. |
document |
Document |
The DevExpress. |
cancellation |
Cancellation |
A Cancellation |
#Returns
Type | Description |
---|---|
Task<Boolean> | A Task |
#Remarks
Important
The Rich
The source stream can be non-seekable. In this instance, the stream is buffered automatically. After the document is loaded, the stream remains open.
The document template cannot be automatically overwritten. 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 format of the document loaded from a stream is detected automatically by the built-in DevExpress.XtraRichEdit.Services.IFormatDetectorService service implementation. If the format detection fails or the passed stream is null, 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).