IRichEditDocumentServer.LoadDocumentTemplate(Stream, DocumentFormat) Method

Loads a document template from a stream with specific document format.

Namespace: DevExpress.XtraRichEdit

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

NuGet Packages: DevExpress.RichEdit.Core, DevExpress.Win.Navigation

Declaration

C#

bool LoadDocumentTemplate(
    Stream stream,
    DocumentFormat documentFormat
)

VB.NET

Function LoadDocumentTemplate(
    stream As Stream,
    documentFormat As DocumentFormat
) As Boolean

Parameters

Name	Type	Description
stream	Stream	The stream from which to load a document.
documentFormat	DocumentFormat	One of the DocumentFormat enumeration members, 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 if the passed stream is null, the RichEditControl.InvalidFormatException event fires.