SubDocument.GetWordMLText(DocumentRange, WordMLDocumentExporterOptions) Method
Gets the text contained in the specified range in WordML format.
Namespace: DevExpress.XtraRichEdit.API.Native
Assembly: DevExpress.RichEdit.v24.2.Core.dll
NuGet Package: DevExpress.RichEdit.Core
#Declaration
string GetWordMLText(
DocumentRange range,
WordMLDocumentExporterOptions options
)
#Parameters
Name | Type | Description |
---|---|---|
range | Document |
A Document |
options | Word |
A Word |
#Returns
Type | Description |
---|---|
String | A string of text in Word |
#Remarks
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.
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);
selection.EndUpdateDocument(doc);
}
else {
wordMLText = richEditControl.Document.GetWordMLText(richEditControl.Document.Range);
}