Skip to main content

SubDocument.GetMhtText(DocumentRange) Method

Gets the content of the specified document range in MHT format.

Namespace: DevExpress.XtraRichEdit.API.Native

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

NuGet Packages: DevExpress.RichEdit.Core, DevExpress.Win.Navigation


string GetMhtText(
    DocumentRange range


Name Type Description
range DocumentRange

A DocumentRange object representing the range to convert to MHT.


Type Description

A string containing the content in MHT format.


You can specify export options via the RichEditDocumentExportOptions.Mht property in the RichEditControl.BeforeExport event handler or use another GetMhtText method overload.

If you operate with a selection range, the GetMhtText method should be enclosed within a DocumentRange.BeginUpdateDocument - DocumentRange.EndUpdateDocument method pair. Otherwise, an incorrect document model might be selected, resulting in an exception “Error: specified document position or range belongs to other document or subdocument” being thrown.

To retrieve the section settings, make sure that the range contains the last section’s paragraph. Otherwise, the section settings are reset to the default.

This code snippet illustrates how to export the selected range to the string in MHT format.

View Example

if (this.richEditControl.Document.Selection.Length > 0) {
    DevExpress.XtraRichEdit.API.Native.DocumentRange selection = richEditControl.Document.Selection;
    DevExpress.XtraRichEdit.API.Native.SubDocument doc = selection.BeginUpdateDocument();
    mhtText = doc.GetMhtText(selection);
else {
mhtText = richEditControl.Document.GetMhtText(richEditControl.Document.Range);

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the GetMhtText(DocumentRange) method.


The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

See Also