Skip to main content

DevExpress v24.2 Update — Your Feedback Matters

Our What's New in v24.2 webpage includes product-specific surveys. Your response to our survey questions will help us measure product satisfaction for features released in this major update and help us refine our plans for our next major release.

Take the survey Not interested

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

public virtual bool LoadDocumentTemplate(
    Stream stream
)

#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.

See Also