ScrollPattern.ScrollPatternInformation.HorizontallyScrollable Property

 
System_CAPS_noteNote

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

Gets a value that indicates whether the UI Automation element can scroll horizontally.

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

public bool HorizontallyScrollable { get; }

Property Value

Type: System.Boolean

true if the UI Automation element can scroll horizontally; otherwise false. The default value is false.

This property can be dynamic. For example, the content area of the UI Automation element might not be larger than the current viewable area, meaning HorizontallyScrollable is false. However, resizing the UI Automation element or adding child items can increase the bounds of the content area beyond the viewable area, indicating that HorizontallyScrollable is true.

In the following example, a ScrollPatterncontrol pattern is obtained from a UI Automation element and is then used to horizontally scroll the element the requested amount.

///--------------------------------------------------------------------
/// <summary>
/// Obtains a ScrollPattern control pattern from an 
/// automation element.
/// </summary>
/// <param name="targetControl">
/// The automation element of interest.
/// </param>
/// <returns>
/// A ScrollPattern object.
/// </returns>
///--------------------------------------------------------------------
private ScrollPattern GetScrollPattern(
    AutomationElement targetControl)
{
    ScrollPattern scrollPattern = null;

    try
    {
        scrollPattern =
            targetControl.GetCurrentPattern(
            ScrollPattern.Pattern)
            as ScrollPattern;
    }
    // Object doesn't support the ScrollPattern control pattern
    catch (InvalidOperationException)
    {
        return null;
    }

    return scrollPattern;
}
///--------------------------------------------------------------------
/// <summary>
/// Obtains a ScrollPattern control pattern from an automation 
/// element and attempts to horizontally scroll the requested amount.
/// </summary>
/// <param name="targetControl">
/// The automation element of interest.
/// </param>
/// <param name="hScrollAmount">
/// The requested horizontal scroll amount.
/// </param>
///--------------------------------------------------------------------
private void ScrollElementHorizontally(
    AutomationElement targetControl,
    ScrollAmount hScrollAmount)
{
    if (targetControl == null)
    {
        throw new ArgumentNullException(
            "AutomationElement argument cannot be null.");
    }

    ScrollPattern scrollPattern = GetScrollPattern(targetControl);

    if (scrollPattern == null)
    {
        return;
    }

    if (!scrollPattern.Current.HorizontallyScrollable)
    {
        return;
    }

    try
    {
        scrollPattern.ScrollHorizontal(hScrollAmount);
    }
    catch (InvalidOperationException)
    {
        // Control not able to scroll in the direction requested;
        // when scrollable property of that direction is False
        // TO DO: error handling.
    }
    catch (ArgumentException)
    {
        // If a control supports SmallIncrement values exclusively 
        // for horizontal or vertical scrolling but a LargeIncrement 
        // value (NaN if not supported) is passed in.
        // TO DO: error handling.
    }
}

.NET Framework
Available since 3.0
Return to top
Show: