Export (0) Print
Expand All

TextPatternRange.ScrollIntoView Method

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
)
public void ScrollIntoView (
	boolean alignToTop
)
public function ScrollIntoView (
	alignToTop : boolean
)
Not applicable.

Parameters

alignToTop

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 typeCondition

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);
}

Windows 98, Windows Server 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile for Pocket PC, Windows Mobile for Smartphone, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft Windows XP SP2, and Windows Server 2003 SP1.

.NET Framework

Supported in: 3.0

Community Additions

ADD
Show:
© 2014 Microsoft