TextPattern.GetSelection Method ()


Retrieves a collection of disjoint text ranges associated with the current text selection or selections.

Namespace:   System.Windows.Automation
Assembly:  UIAutomationClient (in UIAutomationClient.dll)

Public Function GetSelection As TextPatternRange()

Return Value

Type: System.Windows.Automation.Text.TextPatternRange()

A collection of disjoint text ranges.

Exception Condition

The text container does not support text selection.

If no text is selected, GetSelection returns the degenerate text range (empty range) at the position of the system cursor (text insertion point).

If the system cursor (text insertion point) is not present, GetSelection might return null.


Use the SupportedTextSelection property to test if text selection or positioning of the text insertion point is supported by the control.

Private Function CurrentSelection(ByVal target As AutomationElement) As TextPatternRange
    ' Specify the control type we're looking for, in this case 'Document'
    Dim cond As PropertyCondition = New PropertyCondition(AutomationElement.ControlTypeProperty, ControlType.Document)

    ' target --> The root AutomationElement.
    Dim textProvider As AutomationElement = target.FindFirst(TreeScope.Descendants, cond)

    Dim textpatternPattern As TextPattern = CType(textProvider.GetCurrentPattern(TextPattern.Pattern), TextPattern)

    If (textpatternPattern Is Nothing) Then
        Console.WriteLine("Root element does not contain a descendant that supports TextPattern.")
        Return Nothing
    End If
    Dim currentTextSelection As TextPatternRange() = textpatternPattern.GetSelection()
    Return currentTextSelection(0)
End Function

.NET Framework
Available since 3.0
Return to top