TextPatternRange.GetText Method (Int32)


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

Returns the plain text of the text range.

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

member GetText : 
        maxLength:int -> string


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

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.

No code example is currently available or this language may not be supported.

.NET Framework
Available since 3.0
Return to top