RichTextBox.Selection Property

Definition

Namespace:

System.Windows.Controls

Assembly:

PresentationFramework.dll

Gets a TextSelection object containing the current selection in the RichTextBox.

public:
 property System::Windows::Documents::TextSelection ^ Selection { System::Windows::Documents::TextSelection ^ get(); };

public System.Windows.Documents.TextSelection Selection { get; }

member this.Selection : System.Windows.Documents.TextSelection

Public ReadOnly Property Selection As TextSelection

Property Value

TextSelection

A TextSelection object containing the current selection in the RichTextBox.

The default returned TextSelection has an IsEmpty property value of true. An empty TextSelection renders as a caret in the text area with no selection.

Examples

The following example illustrates the use of this property.

// Create a simple FlowDocument to serve as the content input for the construtor.
FlowDocument flowDoc = new FlowDocument(new Paragraph(new Run("Simple FlowDocument")));
// After this constructor is called, the new RichTextBox rtb will contain flowDoc.
RichTextBox rtb = new RichTextBox(flowDoc);
// This call will select the entire contents of the RichTextBox.
rtb.SelectAll();
// This call returns the current selection (which happens to be the entire contents
// of the RichTextBox) as a TextSelection object.
TextSelection currentSelection = rtb.Selection;

' Create a simple FlowDocument to serve as the content input for the construtor.
Dim flowDoc As New FlowDocument(New Paragraph(New Run("Simple FlowDocument")))
' After this constructor is called, the new RichTextBox rtb will contain flowDoc.
Dim rtb As New RichTextBox(flowDoc)
' This call will select the entire contents of the RichTextBox.
rtb.SelectAll()
' This call returns the current selection (which happens to be the entire contents
' of the RichTextBox) as a TextSelection object.
Dim currentSelection As TextSelection = rtb.Selection

Remarks

Use the Select method to programmatically select content.