Skip to main content

DevExpress v24.2 Update — Your Feedback Matters

Our What's New in v24.2 webpage includes product-specific surveys. Your response to our survey questions will help us measure product satisfaction for features released in this major update and help us refine our plans for our next major release.

Take the survey Not interested

RichEditControl.LoadDocument(String, DocumentFormat) Method

Loads a document from a file, specifying the document format.

Namespace: DevExpress.Xpf.RichEdit

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

NuGet Package: DevExpress.Wpf.RichEdit

#Declaration

public virtual bool LoadDocument(
    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 members, indicating the document format.

#Returns

Type Description
Boolean

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

#Remarks

If the document is in a different format than specified or the passed string is null, the RichEditControl.InvalidFormatException event fires.

After loading a document, the DXRichEditDocumentSaveOptions.CurrentFileName property is set to the file name and the DXRichEditDocumentSaveOptions.CurrentFormat property is set to the specified format.

Tip

Determine a moment when the document model can be safely modified using the RichEditControl.DocumentLoaded event. Call the LoadDocument 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