ScrollPattern.SetScrollPercent(Double, Double) Método

Definição

Namespace:

System.Windows.Automation

Assembly:

UIAutomationClient.dll

Define a posição de rolagem horizontal e/ou vertical como um percentual da área total de conteúdo dentro de 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)

Parâmetros

horizontalPercent

Double

O percentual da área de conteúdo horizontal total. ONoScroll deverá ser passado se o controle não puder ser rolado nessa direção.

verticalPercent

Double

O percentual da área de conteúdo vertical total. ONoScroll deverá ser passado se o controle não puder ser rolado nessa direção.

Exceções

ArgumentException

Um valor que não pode ser convertido em um duplo é passado.

ArgumentOutOfRangeException

Um valor maior que 100 ou menor que 0 é passado (exceto -1, que é equivalente a NoScroll). Os valores HorizontalScrollPercent e VerticalScrollPercent são normalizados para 0% ou 100%.

InvalidOperationException

É feita uma tentativa de rolar em uma direção sem suporte.

Exemplos

No exemplo a seguir, um ScrollPattern padrão de controle é obtido de um AutomationElement e, em seguida, é usado para rolar a região visível até a posição "home" superior esquerda da área de conteúdo.

///--------------------------------------------------------------------
/// <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

Comentários

Esse método só é útil quando a área de conteúdo do controle é maior que a região visível.

Passar o valor NoScroll indica que não há rolagem na direção especificada.