ScrollPattern.SetScrollPercent(Double, Double) Metoda

Definicja

Przestrzeń nazw:

System.Windows.Automation

Zestaw:

UIAutomationClient.dll

Ustawia poziomą i/lub pionową pozycję przewijania jako wartość procentową całkowitego obszaru zawartości w obiekcie AutomationElement.

public:
 void SetScrollPercent(double horizontalPercent, double verticalPercent);

public void SetScrollPercent (double horizontalPercent, double verticalPercent);

member this.SetScrollPercent : double * double -> unit

Public Sub SetScrollPercent (horizontalPercent As Double, verticalPercent As Double)

Parametry

horizontalPercent

Double

Procent całkowitego obszaru zawartości poziomej. NoScroll należy przekazać, jeśli nie można przewinąć kontrolki w tym kierunku.

verticalPercent

Double

Procent całkowitego pionowego obszaru zawartości. NoScroll należy przekazać, jeśli nie można przewinąć kontrolki w tym kierunku.

Wyjątki

ArgumentException

Przekazano wartość, której nie można przekonwertować na wartość podwójną.

ArgumentOutOfRangeException

Przekazano wartość większą niż 100 lub mniejszą niż 0 (z wyjątkiem -1, która jest równoważna NoScroll). Wartości HorizontalScrollPercent i VerticalScrollPercent są znormalizowane do 0% lub 100%.

InvalidOperationException

Podjęto próbę przewinięcia w nieobsługiwanym kierunku.

Przykłady

W poniższym przykładzie ScrollPattern wzorzec kontrolki jest uzyskiwany z elementu AutomationElement , a następnie służy do przewijania widocznego regionu do lewej górnej pozycji "strona główna" obszaru zawartości.

///--------------------------------------------------------------------
/// <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.
''' </summary>
''' <param name="targetControl">
''' The automation element of interest.
''' </param>
''' <returns>
''' A ScrollPattern object.
''' </returns>
'''--------------------------------------------------------------------
Private Function GetScrollPattern( _
ByVal targetControl As AutomationElement) As ScrollPattern
    Dim scrollPattern As ScrollPattern = Nothing

    Try
        scrollPattern = DirectCast( _
        targetControl.GetCurrentPattern(scrollPattern.Pattern), _
        ScrollPattern)
    Catch
        ' Object doesn't support the ScrollPattern control pattern
        Return Nothing
    End Try

    Return scrollPattern

End Function 'GetScrollPattern

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

    ScrollPattern scrollPattern = GetScrollPattern(targetControl);

    if (scrollPattern == null)
    {
        return;
    }

    try
    {
        scrollPattern.SetScrollPercent(0, 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.
    }
}

'''--------------------------------------------------------------------
''' <summary>
''' Obtains a ScrollPattern control pattern from an automation 
''' element and attempts to scroll to the top left 'home' position.
''' </summary>
''' <param name="targetControl">
''' The automation element of interest.
''' </param>
'''--------------------------------------------------------------------
Private Sub ScrollHome(ByVal targetControl As AutomationElement) 
    If targetControl Is Nothing Then
        Throw New ArgumentNullException( _
        "AutomationElement argument cannot be null.")
    End If
    
    Dim scrollPattern As ScrollPattern = _
    GetScrollPattern(targetControl)
    
    If scrollPattern Is Nothing Then
        Return
    End If
    
    Try
        scrollPattern.SetScrollPercent(0, 0)
    Catch exc As InvalidOperationException
        ' Control not able to scroll in the direction requested;
        ' when scrollable property of that direction is False
        ' TO DO: error handling.
    Catch exc As ArgumentOutOfRangeException
        ' A value greater than 100 or less than 0 is passed in 
        ' (except -1 which is equivalent to NoScroll).
        ' TO DO: error handling.
    End Try

End Sub

Uwagi

Ta metoda jest przydatna tylko wtedy, gdy obszar zawartości kontrolki jest większy niż widoczny region.

Przekazanie wartości NoScroll oznacza, że nie ma przewijania w określonym kierunku.