All docs
V20.2
21.1 (EAP/Beta)
20.2
20.1
The page you are viewing does not exist in version 20.1. This link will take you to the root page.
19.2
The page you are viewing does not exist in version 19.2. This link will take you to the root page.
19.1
The page you are viewing does not exist in version 19.1. This link will take you to the root page.
18.2
The page you are viewing does not exist in version 18.2. This link will take you to the root page.
18.1
The page you are viewing does not exist in version 18.1. This link will take you to the root page.
17.2
The page you are viewing does not exist in version 17.2. This link will take you to the root page.
.NET Framework 4.5.2+
.NET Framework 4.5.2+
.NET Standard 2.0+

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.v20.2.dll

Declaration

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

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.v20.2.dll assembly. Add this assembly to your project to use the RichEditDocumentServerExtensions members. You need an active 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's call may occur in a different thread than the target operation.

  • The operation is not thread safe (documents should not be accessed simultaneously by different threads). Wait until the operation is completed before working with the document, i.e., use the await operator.

See Also