Skip to main content

RichEditControl.LoadDocumentTemplate(String, DocumentFormat) Method

Loads a document template from the file in the specified format.

Namespace: DevExpress.Xpf.RichEdit

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

Declaration

public virtual bool LoadDocumentTemplate(
    string fileName,
    DocumentFormat documentFormat
)

Parameters

Name Type Description
fileName String

A string specifying the file to load (including the full path).

documentFormat DocumentFormat

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

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 string is null, the RichEditControl.InvalidFormatException event fires.

Tip

Determine a moment when the document model can be safely modified using the RichEditControl.DocumentLoaded event. Call the LoadDocumentTemplate method in the Form.Loaded event handler to work with the DocumentLoaded event. Handle the DocumentLayout.DocumentFormatted event to check the loaded document’s layout.

See Also