Document.Selection Property

Gets or sets the selected range in the document.

Namespace: DevExpress.XtraRichEdit.API.Native

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

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

Declaration

C#

DocumentRange Selection { get; set; }

VB.NET

Property Selection As DocumentRange

Property Value

Type	Description
DocumentRange	A range that the selected text occupies.

Remarks

Use the Document.Copy, Document.Cut and Document.Paste methods without parameters to work with selection in the document.

The DocumentRange.Start and DocumentRange.End properties allows you to obtain the selection’s start and end positions.

Use the SubDocument.GetText method to obtain the plain text contained in the selection.

When you select individual table cells, the Selection property returns the last selected range. Use the Document.Selections property to obtain a collection of selections in the document. You can use the SelectionCollection to add new selection range or unselect previously selected range.

Example

View Example

Range.cs

using DevExpress.XtraRichEdit;
using DevExpress.XtraRichEdit.API.Native;

static void SelectTextInRange(Document document) {

    document.LoadDocument("Grimm.docx", DocumentFormat.OpenXml);
    DocumentPosition myStart = document.CreatePosition(69);
    DocumentRange myRange = document.CreateRange(myStart, 216);
    document.Selection = myRange;
}

Range.vb

Imports DevExpress.XtraRichEdit
Imports DevExpress.XtraRichEdit.API.Native

Shared Sub SelectTextInRange(ByVal document As Document)

    document.LoadDocument("Grimm.docx", DocumentFormat.OpenXml)
    Dim myStart As DocumentPosition = document.CreatePosition(69)
    Dim myRange As DocumentRange = document.CreateRange(myStart, 216)
    document.Selection = myRange
End Sub

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the Selection property.

Note

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.

C#

winforms-richedit-save-text-from-a-range-in-different-formats/CS/GetTextMethodsExample/Form1.cs#L31

{
    DevExpress.XtraRichEdit.API.Native.DocumentRange selection = richEditControl.Document.Selection;
    DevExpress.XtraRichEdit.API.Native.SubDocument doc = selection.BeginUpdateDocument();

winforms-richedit-document-api/CS/RichEditAPISample/CodeExamples/Range.cs#L15

DocumentRange myRange = document.CreateRange(myStart, 216);
document.Selection = myRange;
#endregion #SelectTextInRange

winforms-richeditcontrol-common-api/CS/RichEditAPISample/CodeExamples/RichEditControlActions.cs#L49

DocumentRange[] buttonWordRanges = richEdit.Document.FindAll("button", SearchOptions.None);
richEdit.Document.Selection = buttonWordRanges[0];
richEdit.ShowReplaceForm();

how-to-customize-copy-and-paste-commands/CS/RichEditCustomCopyPaste/CustomCommands.cs#L25

try {
    string html = Control.Document.GetHtmlText(Control.Document.Selection, new CustomUriProvider(), richEditControl.Options.Export.Html);
    htmlForClipboard = CF_HTMLHelper.GetHtmlClipboardFormat(html);

winforms-richedit-select-a-current-line/CS/Form1.cs#L34

if (text.EndsWith(Environment.NewLine))
    richEditControl1.Document.Selection = range2;
else

VB.NET

winforms-richedit-save-text-from-a-range-in-different-formats/VB/GetTextMethodsExample/Form1.vb#L27

If Me.richEditControl.Document.Selection.Length > 0 Then
    Dim selection As DevExpress.XtraRichEdit.API.Native.DocumentRange = richEditControl.Document.Selection
    Dim doc As DevExpress.XtraRichEdit.API.Native.SubDocument = selection.BeginUpdateDocument()

winforms-richedit-document-api/VB/RichEditAPISample/CodeExamples/Range.vb#L14

            Dim myRange As DevExpress.XtraRichEdit.API.Native.DocumentRange = document.CreateRange(myStart, 216)
            document.Selection = myRange
#End Region  ' #SelectTextInRange

winforms-richeditcontrol-common-api/VB/RichEditAPISample/CodeExamples/RichEditControlActions.vb#L54

Dim buttonWordRanges() As DocumentRange = richEdit.Document.FindAll("button", SearchOptions.None)
richEdit.Document.Selection = buttonWordRanges(0)
richEdit.ShowReplaceForm()

how-to-customize-copy-and-paste-commands/VB/CustomCommands.vb#L27

Try
    Dim html As String = Control.Document.GetHtmlText(Control.Document.Selection, New CustomUriProvider(), richEditControl.Options.Export.Html)
    htmlForClipboard = CF_HTMLHelper.GetHtmlClipboardFormat(html)

winforms-richedit-select-a-current-line/VB/Form1.vb#L30

If text.EndsWith(Environment.NewLine) Then
    richEditControl1.Document.Selection = range2
Else