RichEditControl.LoadDocumentTemplate(String, DocumentFormat) Method

Loads a document template from the file in the specified format.

Namespace: DevExpress.XtraRichEdit

Assembly: DevExpress.XtraRichEdit.v20.1.dll

Declaration

public virtual bool LoadDocumentTemplate(
    string fileName,
    DocumentFormat documentFormat
)
Public Overridable Function LoadDocumentTemplate(
    fileName As String,
    documentFormat As DocumentFormat
) As Boolean

Parameters

Name Type Description
fileName String

A string specifying the file to load (including the full path).

documentFormat DocumentFormat

One of the DocumentFormat enumeration values indicating the document format.

Returns

Type Description
Boolean

true, if the document is successfully loaded; otherwise, false.

Remarks

The document template cannot be automatically 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 that enables the end-user to specify a different file name and format.

The code sample below loads a document template from a file.

richEditControl.LoadDocumentTemplate("Documents\\Template.docx", DocumentFormat.OpenXml);
See Also