RichEditControl.LoadDocumentTemplate(Stream) Method

Loads a document template from the stream.

Assembly : DevExpress.XtraRichEdit.v25.2.dll

NuGet Package : DevExpress.Win.RichEdit

Declaration

C#
VB.NET

csharp

public virtual bool LoadDocumentTemplate(
    Stream stream
)

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 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 that enables the end-user to specify a different file name and format.

The code sample below loads a document template from a stream.

C#
VB.NET

csharp

using(Stream stream = GetResourceStream("MyApplication.Document1.rtf"))
{
    stream.Seek(0, SeekOrigin.Begin);
    richEditControl.LoadDocumentTemplate(stream);
    stream.Close();
}

Using stream As Stream = GetResourceStream("MyApplication.Document1.rtf")
    stream.Seek(0, SeekOrigin.Begin)
    richEditControl.LoadDocumentTemplate(stream)
    stream.Close()
End Using

Tip

Use LoadDocumentTemplate method overloads which explicit format definition to improve performance.