Document.Selection Property

Gets or sets the selected range in the document.

Namespace: DevExpress.XtraRichEdit.API.Native

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

Declaration

C#

DocumentRange Selection { get; set; }

VB.NET

Property Selection As DocumentRange

Property Value

Type	Description
DocumentRange	A DocumentRange object, representing the DocumentRange.Start and DocumentRange.End positions of the selected text.

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 of the Selection provides you with the positions which characterize the selection’s start and end.

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

Example

Note

A complete sample project is available at https://github.com/DevExpress-Examples/winforms-richedit-document-api-e5219

Range.vb

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

Range.cs

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

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#

how-to-save-the-text-of-a-document-range-in-different-formats-e1604/CS/GetTextMethodsExample/Form1.cs#L29

#region #exportmht
if (this.richEditControl.Document.Selection.Length > 0)
{

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

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

winforms-the-richeditcontrols-common-api-t210437/CS/RichEditAPISample/CodeExamples/RichEditControlActions.cs#L48

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

using-the-search-and-replace-api-functionality-e1677/CS/SearchAndReplaceExample/Form1.cs#L41

if (direction == SearchDirection.Forward) {
    int startPos = Document.Selection.End.ToInt();
    int length = Document.Range.End.ToInt() - startPos;

how-to-customize-copy-and-paste-commands-e3665/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);

VB.NET

how-to-save-the-text-of-a-document-range-in-different-formats-e1604/VB/GetTextMethodsExample/Form1.vb#L26

Try
    If Me.richEditControl.Document.Selection.Length > 0 Then
        Dim selection As DevExpress.XtraRichEdit.API.Native.DocumentRange = richEditControl.Document.Selection

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

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

winforms-the-richeditcontrols-common-api-t210437/VB/RichEditAPISample/CodeExamples/RichEditControlActions.vb#L53

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

how-to-change-formatting-of-text-and-paragraph-e2206/VB/HowToChangeFormatting/Form1.vb#L23

richEditControl1.Document.LoadDocument("SampleText.rtf", DocumentFormat.Rtf)
richEditControl1.Document.Selection = richEditControl1.Document.Paragraphs(1).Range

using-the-search-and-replace-api-functionality-e1677/VB/SearchAndReplaceExample/Form1.vb#L48

If direction = SearchDirection.Forward Then
    Dim startPos As Integer = Document.Selection.End.ToInt()
    Dim length As Integer = Document.Range.End.ToInt() - startPos