RichEditControl.LoadDocumentTemplate(Byte[], DocumentFormat) Method

Loads a document template in the specified format from a byte array.

Assembly : DevExpress.Xpf.RichEdit.v25.2.dll

NuGet Package : DevExpress.Wpf.RichEdit

Declaration

C#
VB.NET

csharp

public bool LoadDocumentTemplate(
    byte[] buffer,
    DocumentFormat documentFormat
)

Public Function LoadDocumentTemplate(
    buffer As Byte(),
    documentFormat As DocumentFormat
) As Boolean

Parameters

Name	Type	Description
buffer	Byte[]

A byte array that contains document data.

| | documentFormat | DocumentFormat |

An enumeration member that specifies the format of the loaded document.

Returns

Type	Description
Boolean

true if the document was successfully loaded; otherwise, false.

Remarks

A document template cannot be 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 a document has a different format than the documentFormat parameter specifies, the RichEditControl.InvalidFormatException event fires.