RichEditControl.LoadDocumentTemplate(Stream, DocumentFormat) Method

Loads a document template from a stream, specifying the document format.

Namespace: DevExpress.XtraRichEdit

Assembly: DevExpress.XtraRichEdit.v24.1.dll

NuGet Packages: DevExpress.Win.PivotGrid, DevExpress.Win.RichEdit, DevExpress.Win.TreeMap

Declaration

C#

public virtual bool LoadDocumentTemplate(
    Stream stream,
    DocumentFormat documentFormat
)

VB.NET

Public Overridable 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 the passed stream is null, the RichEditControl.InvalidFormatException event fires.

The code sample below loads a document template from a stream. The IFormatDetectorService.DetectFormat(Stream) method determines the format of the template contained in the stream.

C#

using (Stream stream = System.Reflection.Assembly.GetExecutingAssembly().GetManifestResourceStream("LoadDocumentExample.TextWithImagesODT"))
    {
    DocumentFormat format = richEditControl1.GetService<IFormatDetectorService>().DetectFormat(stream);
    richEditControl1.LoadDocumentTemplate(stream, format);
}

VB.NET

Using stream As Stream = System.Reflection.Assembly.GetExecutingAssembly().GetManifestResourceStream("LoadDocumentExample.TextWithImagesODT")
    Dim format As DocumentFormat = richEditControl1.GetService(Of IFormatDetectorService)().DetectFormat(stream)
    richEditControl1.LoadDocumentTemplate(stream, format)
End Using