Export (0) Print
Expand All

ITextRangeProvider.GetText Method

Retrieves the plain text of the range.

Namespace:  System.Windows.Automation.Provider
Assembly:  UIAutomationProvider (in UIAutomationProvider.dll)

string GetText(
	int maxLength
)

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.

ExceptionCondition
ArgumentOutOfRangeException

If maxLength is less than -1.

GetText respects both hidden and visible text.

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.

.NET Framework

Supported in: 4.6, 4.5, 4, 3.5, 3.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1
Show:
© 2015 Microsoft