RichEditDocumentServerExtensions.LoadDocumentTemplateAsync(RichEditDocumentServer, Byte[], DocumentFormat, CancellationToken) Method

Asynchronously loads a document template in the specified format from a byte array.

Namespace: DevExpress.XtraRichEdit

Assembly: DevExpress.Docs.v24.1.dll

NuGet Package: DevExpress.Document.Processor

Declaration

C#

public static Task<bool> LoadDocumentTemplateAsync(
    this RichEditDocumentServer self,
    byte[] buffer,
    DocumentFormat documentFormat,
    CancellationToken cancellationToken
)

VB.NET

<ExtensionAttribute>
Public Shared Function LoadDocumentTemplateAsync(
    self As RichEditDocumentServer,
    buffer As Byte(),
    documentFormat As DocumentFormat,
    cancellationToken As CancellationToken
) As Task(Of Boolean)

Parameters

Name	Type	Description
self	RichEditDocumentServer	The current RichEditDocumentServer instance.
buffer	Byte[]	A byte array that contains document data.
documentFormat	DocumentFormat	An enumeration member that specifies the format of the loaded document.
cancellationToken	CancellationToken	A cancellation token that indicates whether to cancel the operation.

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.

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).