This documentation is archived and is not being maintained.

ScrollPattern.NoScroll Field

Specifies that scrolling should not be performed.

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

public const double NoScroll

This identifier is used by UI Automation client applications. UI Automation providers should use the equivalent field in ScrollPatternIdentifiers.

The value -1 can be substituted for the NoScroll field.

In the following example, a ScrollPattern control pattern is obtained from an AutomationElement and is then used to scroll the viewable region to the top of the content area.

/// <summary>
/// Obtains a ScrollPattern control pattern from an automation 
/// element and attempts to scroll to the top of the
/// viewfinder.
/// </summary>
/// <param name="targetControl">
/// The automation element of interest.
/// </param>
private void ScrollToTop(AutomationElement targetControl)
    if (targetControl == null)
        throw new ArgumentNullException(
            "AutomationElement argument cannot be null.");

    ScrollPattern scrollPattern = GetScrollPattern(targetControl);

        scrollPattern.SetScrollPercent(ScrollPattern.NoScroll, 0);
    catch (InvalidOperationException)
        // Control not able to scroll in the direction requested;
        // when scrollable property of that direction is False
        // TO DO: error handling.
    catch (ArgumentOutOfRangeException)
        // A value greater than 100 or less than 0 is passed in 
        // (except -1 which is equivalent to NoScroll).
        // TO DO: error handling.

.NET Framework

Supported in: 4, 3.5, 3.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.