TextPatternRange.GetText(Int32) Method

public:
 System::String ^ GetText(int maxLength);

public string GetText(int maxLength);

member this.GetText : int -> string

Public Function GetText (maxLength As Integer) As String

Parameters

Returns

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

Exceptions

Examples

 private String TextFromSelection(AutomationElement target, Int32 length)
{
 // Specify the control type we're looking for, in this case 'Document'
 PropertyCondition cond = new PropertyCondition(AutomationElement.ControlTypeProperty, ControlType.Document);

 // target --> The root AutomationElement.
 AutomationElement textProvider = target.FindFirst(TreeScope.Descendants, cond);

 TextPattern textpatternPattern = textProvider.GetCurrentPattern(TextPattern.Pattern) as TextPattern;

 if (textpatternPattern == null)
 {
 Console.WriteLine("Root element does not contain a descendant that supports TextPattern.");
 return null;
 }
 TextPatternRange[] currentSelection = textpatternPattern.GetSelection();

 // GetText(-1) retrieves all characters but can be inefficient
 return currentSelection[0].GetText(length);
}

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

Remarks

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.

See also

• TextPatternRangeEndpoint