ITextProvider.GetVisibleRanges Method

Definition

Namespace:

System.Windows.Automation.Provider

Assembly:

UIAutomationProvider.dll

Retrieves an array of disjoint text ranges from a text container where each text range begins with the first partially visible line through to the end of the last partially visible line.

public:
 cli::array <System::Windows::Automation::Provider::ITextRangeProvider ^> ^ GetVisibleRanges();

public System.Windows.Automation.Provider.ITextRangeProvider[] GetVisibleRanges ();

abstract member GetVisibleRanges : unit -> System.Windows.Automation.Provider.ITextRangeProvider[]

Public Function GetVisibleRanges () As ITextRangeProvider()

Returns

ITextRangeProvider[]

The collection of visible text ranges within the container or an empty array. A null reference (Nothing in Visual Basic) is never returned.

Remarks

UI Automation providers should ensure that they return, at most, the text ranges that are visible within the container.

Disjoint text ranges may occur when any content of a text container is obscured by an overlapping window or other object, or when a text container with a multi-column layout has one or more columns partially scrolled out of view.

If no text is visible, a degenerate (empty) text range is returned. This empty range can be returned if the text container is empty or when all text is scrolled out of view.

See also

• ITextRangeProvider