RichEditDocumentServer.LoadDocumentTemplate(String, DocumentFormat) Method

SECURITY-RELATED CONSIDERATIONS

Using file paths sourced from untrusted input may expose unauthorized files or allow unintended file access. Always validate and normalize all external paths to prevent path manipulation.

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

Namespace : DevExpress.XtraRichEdit

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

NuGet Package : DevExpress.RichEdit.Core

csharp

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.

The source stream can be non-seekable. In this case, the stream is buffered automatically. After loading the document, the stream remains open.

If the document is in a different format than specified or the passed string value is null , the RichEditDocumentServer.InvalidFormatException event fires.