ScrollPattern.HorizontalScrollPercentProperty Field

Reference

Definition

Namespace:: System.Windows.Automation

Assembly:: UIAutomationClient.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Identifies the HorizontalScrollPercent property.

public: static initonly System::Windows::Automation::AutomationProperty ^ HorizontalScrollPercentProperty;

public static readonly System.Windows.Automation.AutomationProperty HorizontalScrollPercentProperty;

 staticval mutable HorizontalScrollPercentProperty : System.Windows.Automation.AutomationProperty

Public Shared ReadOnly HorizontalScrollPercentProperty As AutomationProperty

Field Value

AutomationProperty

Examples

In the following example, a root element is passed to a function that returns the current horizontal and vertical scroll percentages of the viewable region within the content area.

///--------------------------------------------------------------------
/// <summary>
/// Obtains the current scroll positions of the viewable region 
/// within the content area.
/// </summary>
/// <param name="targetControl">
/// The automation element of interest.
/// </param>
/// <returns>
/// The horizontal and vertical scroll percentages.
/// </returns>
///--------------------------------------------------------------------
private double[] GetScrollPercentages(AutomationElement targetControl)
{
    if (targetControl == null)
    {
        throw new ArgumentNullException(
            "AutomationElement argument cannot be null.");
    }

    double[] percentage = new double[2];

    percentage[0] =
        (double)targetControl.GetCurrentPropertyValue(
        ScrollPattern.HorizontalScrollPercentProperty);

    percentage[1] =
         (double)targetControl.GetCurrentPropertyValue(
         ScrollPattern.VerticalScrollPercentProperty);

    return percentage;
}

'''--------------------------------------------------------------------
''' <summary>
''' Obtains the current scroll positions of the viewable region 
''' within the content area.
''' </summary>
''' <param name="targetControl">
''' The automation element of interest.
''' </param>
''' <returns>
''' The horizontal and vertical scroll percentages.
''' </returns>
'''--------------------------------------------------------------------
Private Function GetScrollPercentages( _
ByVal targetControl As AutomationElement) As Double()
    If targetControl Is Nothing Then
        Throw New ArgumentNullException( _
        "AutomationElement argument cannot be null.")
    End If

    Dim percentage(1) As Double

    percentage(0) = System.Convert.ToDouble( _
    targetControl.GetCurrentPropertyValue( _
    ScrollPattern.HorizontalScrollPercentProperty))

    percentage(1) = System.Convert.ToDouble( _
    targetControl.GetCurrentPropertyValue( _
    ScrollPattern.VerticalScrollPercentProperty))

    Return percentage

End Function 'GetScrollPercentages

Remarks

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

Applies to

Dela via