RichEditDocumentServer.LoadDocumentTemplate(Stream) Method

Loads a document template from the stream.

Namespace: DevExpress.XtraRichEdit

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

NuGet Package: DevExpress.RichEdit.Core

Declaration

C#

public virtual bool LoadDocumentTemplate(
    Stream stream
)

VB.NET

Public Overridable Function LoadDocumentTemplate(
    stream As Stream
) As Boolean

Parameters

Name	Type	Description
stream	Stream	A Stream object that is the stream used to load a document.

Returns

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

Remarks

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

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.

If the format detection fails or the passed stream in null, the RichEditDocumentServer.InvalidFormatException event fires.

Tip

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