.NET Framework 4.5.2+
.NET Framework 4.5.2+
.NET Standard 2.0+

SubDocument.GetMhtText(DocumentRange) Method

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

Namespace: DevExpress.XtraRichEdit.API.Native

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

Declaration

string GetMhtText(
    DocumentRange range
)
Function GetMhtText(
    range As DocumentRange
) As String

Parameters

Name Type Description
range DocumentRange

A DocumentRange object representing the range to convert to MHT.

Returns

Type Description
String

A string containing the content in MHT format.

Remarks

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.

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);
    selection.EndUpdateDocument(doc);  
}
else {
mhtText = richEditControl.Document.GetMhtText(richEditControl.Document.Range);
}
See Also