Skip to main content

SubDocument.GetWordMLText(DocumentRange, WordMLDocumentExporterOptions) Method

Gets the text contained in the specified range in WordML format.

Namespace: DevExpress.XtraRichEdit.API.Native

Assembly: DevExpress.RichEdit.v23.2.Core.dll

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


string GetWordMLText(
    DocumentRange range,
    WordMLDocumentExporterOptions options


Name Type Description
range DocumentRange

A DocumentRange object representing a text range in the document.

options WordMLDocumentExporterOptions

A WordMLDocumentExporterOptions instance providing options for export.


Type Description

A string of text in WordML format.


If you operate with a selection range, the GetWordMLText 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 WordML (XML) 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();
    wordMLText = doc.GetWordMLText(selection);
else {
    wordMLText = richEditControl.Document.GetWordMLText(richEditControl.Document.Range);
See Also