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

NuGet Package: DevExpress.Win.RichEdit

Declaration

C#

public virtual bool LoadDocumentTemplate(
    string fileName,
    DocumentFormat documentFormat
)

VB.NET

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.

C#

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

VB.NET

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

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the LoadDocumentTemplate(String, DocumentFormat) method.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

C#

how-to-edit-an-existing-snx-template-in-code-t224149/CS/Snap_API/Form1.cs#L33

snapControl1.DataSource = GetDataSource();
snapControl1.LoadDocumentTemplate("SnapTemplate.snx", SnapDocumentFormat.Snap);

winforms-the-richeditcontrols-common-api-t210437/CS/RichEditAPISample/CodeExamples/RichEditControlActions.cs#L261

    RichEditControl richEdit = e.Item.Tag as RichEditControl;
    richEdit.LoadDocumentTemplate("Documents\\LoremDocumentTest.docx", DevExpress.XtraRichEdit.DocumentFormat.OpenXml);
}

VB.NET

how-to-edit-an-existing-snx-template-in-code-t224149/VB/Snap_API/Form1.vb#L35

snapControl1.DataSource = GetDataSource()
snapControl1.LoadDocumentTemplate("SnapTemplate.snx", SnapDocumentFormat.Snap)

winforms-the-richeditcontrols-common-api-t210437/VB/RichEditAPISample/CodeExamples/RichEditControlActions.vb#L268

    Dim richEdit As RichEditControl = TryCast(e.Item.Tag, RichEditControl)
    richEdit.LoadDocumentTemplate("Documents\LoremDocumentTest.docx", DevExpress.XtraRichEdit.DocumentFormat.OpenXml)
End Sub