TextPatternRange.GetText Method (Int32)

 

Returns the plain text of the text range.

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

Public Function GetText (
	maxLength As Integer
) As String

Parameters

maxLength
Type: System.Int32

The maximum length of the string to return. Use -1 if no limit is required.

Return Value

Type: System.String

The plain text of the text range, possibly truncated at the specified maxLength.

Exception Condition
ArgumentOutOfRangeException

If maxLength is less than -1.

GetText respects both hidden and visible text. The UI Automation client can check the IsHiddenAttribute for text visibility.

If maxLength is greater than the length of the text span of the caller, the string returned will be the plain text of the text range.

GetText will not be affected by the order of endpoints in the text flow; it will always return the text between the Start and End endpoints of the text range in the logical text flow order.

Private Function TextFromSelection(ByVal target As AutomationElement, ByVal length As Int32) As String
    ' 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 currentSelection As TextPatternRange() = textpatternPattern.GetSelection()
    ' GetText(-1) retrieves all characters but can be inefficient
    Return currentSelection(0).GetText(length)
End Function

.NET Framework
Available since 3.0
Return to top
Show: