TextPattern::GetVisibleRanges Method ()


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

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.

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

array<TextPatternRange^>^ GetVisibleRanges()

Return Value

Type: array<System.Windows.Automation.Text::TextPatternRange^>^

The collection of visible text ranges within the container or an empty array. Null is never returned.

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.

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

.NET Framework
Available since 3.0
Return to top