RichEditControl.LoadDocumentTemplate(String) Method

Loads a document template from the specified file so it cannot be overwritten automatically.

Namespace: DevExpress.Xpf.RichEdit

Assembly: DevExpress.Xpf.RichEdit.v24.1.dll

NuGet Package: DevExpress.Wpf.RichEdit

Declaration

C#

public virtual bool LoadDocumentTemplate(
    string fileName
)

VB.NET

Public Overridable Function LoadDocumentTemplate(
    fileName As String
) As Boolean

Parameters

Name	Type	Description
fileName	String	A string specifying the file to load (including the full path).

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.

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.

Tip

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