RichEditDocumentServer.LoadDocumentTemplate(String) Method

Loads a document template from the specified file.

Namespace: DevExpress.XtraRichEdit

Assembly: DevExpress.RichEdit.v25.1.Core.dll

NuGet Package: DevExpress.RichEdit.Core

Declaration

C#

public virtual bool LoadDocumentTemplate(
    string fileName
)

VB.NET

Public Overridable Function LoadDocumentTemplate(
    fileName As String
) As Boolean

Parameters

Name	Type	Description
fileName	String	A string specifying the file to load (including the full path).

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.

The format of the document loaded from a stream is detected automatically by the built-in IFormatDetectorService service implementation. If the format detection fails or the passed string value is null, an RichEditDocumentServer.InvalidFormatException fires.

Tip

Use the LoadDocumentTemplate method overloads with explicit format definition to improve performance.

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the LoadDocumentTemplate(String) 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#

snap-report-api-examples/CS/SnapServerExamples/CodeExamples/DataShapingActions.cs#L16

#region #InsertData
server.LoadDocumentTemplate("Template.snx");
SnapList list = server.Document.FindListByName("Data Source 11");

VB.NET

snap-report-api-examples/VB/SnapServerExamples/CodeExamples/DataShapingActions.vb#L15

#Region "#InsertData"
            server.LoadDocumentTemplate("Template.snx")
            Dim list As DevExpress.Snap.Core.API.SnapList = server.Document.FindListByName("Data Source 11")