Share via

IUIAutomationTextPattern::GetVisibleRanges Method

  • Article

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

Syntax

HRESULT GetVisibleRanges(      
    IUIAutomationTextRangeArray **ranges
);

Parameters

  • ranges
    [out, retval] The address of a variable that receives a pointer to the IUIAutomationTextRangeArray interface for either a collection of visible text ranges within the container, or an empty array.

Return Value

Returns S_OK if successful, or an error value otherwise.

Remarks

Disjoint text ranges can occur when any content of a text container is obscured by an overlapping window or other object, or when a text container with a multicolumn 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.