RichEditDocumentServerExtensions.LoadDocumentTemplateAsync(RichEditDocumentServer, String, DocumentFormat) Method

Asynchronously loads a document template from the file in the specified document format.

Namespace: DevExpress.XtraRichEdit

Assembly: DevExpress.Docs.v24.1.dll

NuGet Package: DevExpress.Document.Processor

Declaration

C#

public static Task<bool> LoadDocumentTemplateAsync(
    this RichEditDocumentServer self,
    string fileName,
    DocumentFormat documentFormat
)

VB.NET

<ExtensionAttribute>
Public Shared Function LoadDocumentTemplateAsync(
    self As RichEditDocumentServer,
    fileName As String,
    documentFormat As DocumentFormat
) As Task(Of Boolean)

Parameters

Name	Type	Description
self	RichEditDocumentServer	The current RichEditDocumentServer instance.
fileName	String	The file to load (including the full path).
documentFormat	DocumentFormat	The DevExpress.XtraRichEdit.DocumentFormat enumeration value that indicates the document format.

Returns

Type	Description
Task<Boolean>	A Task<TResult> object that returns true if the document is successfully loaded; otherwise, false.

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.

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.

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