TextPatternRange.ScrollIntoView Method (Boolean)

 

Causes the text control to scroll vertically until the text range is visible in the viewport.

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

public void ScrollIntoView(
	bool alignToTop
)

Parameters

alignToTop
Type: System.Boolean

true if the text control should be scrolled so the text range is flush with the top of the viewport; false if it should be flush with the bottom of the viewport.

Exception Condition
InvalidOperationException

If scrolling is not supported by the control.

ScrollIntoView respects both hidden and visible text. The UI Automation client can check the IsHiddenAttribute for text visibility. If the text range is hidden, the text control will scroll only if the hidden text has an anchor in the viewport.

private void ScrollToSelection(AutomationElement target)
{
    // Specify the control type we're looking for, in this case 'Document'
    PropertyCondition cond = new PropertyCondition(AutomationElement.ControlTypeProperty, ControlType.Document);

    // target --> The root AutomationElement.
    AutomationElement textProvider = target.FindFirst(TreeScope.Descendants, cond);

    TextPattern textpatternPattern = textProvider.GetCurrentPattern(TextPattern.Pattern) as TextPattern;

    if (textpatternPattern == null)
    {
        Console.WriteLine("Root element does not contain a descendant that supports TextPattern.");
        return;
    }
    TextPatternRange[] currentSelection = textpatternPattern.GetSelection();

    currentSelection[0].ScrollIntoView(true);
}

.NET Framework
Available since 3.0
Return to top
Show: