RichTextBox.Selection Property

 
System_CAPS_noteNote

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

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

Namespace:   System.Windows.Controls
Assembly:  PresentationFramework (in PresentationFramework.dll)

Public ReadOnly Property Selection As TextSelection

Property Value

Type: System.Windows.Documents.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.

Use the Select method to programmatically select content.

The following example illustrates the use of this property.

' 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

.NET Framework
Available since 3.0
Silverlight
Available since 4.0
Windows Phone Silverlight
Available since 7.1
Return to top
Show: