ScrollPattern.SetScrollPercent(Double, Double) Metoda

Definice

Obor názvů:

System.Windows.Automation

Sestavení:

UIAutomationClient.dll

Nastaví vodorovnou nebo svislou pozici posouvání jako procento celkové oblasti obsahu v rámci objektu 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

Procento celkové vodorovné oblasti obsahu NoScroll pokud ovládací prvek nelze posouvat tímto směrem, měl by být předán.

verticalPercent

Double

Procento celkové svislé oblasti obsahu NoScroll pokud ovládací prvek nelze posouvat tímto směrem, měl by být předán.

Výjimky

ArgumentException

Předá se hodnota, kterou nelze převést na dvojitou hodnotu.

ArgumentOutOfRangeException

Předá se hodnota větší než 100 nebo menší než 0 (s výjimkou -1, což odpovídá hodnotě NoScroll). Hodnoty HorizontalScrollPercent a VerticalScrollPercent se normalizují na 0 % nebo 100 %.

InvalidOperationException

Dojde k pokusu o posouvání v nepodporovaném směru.

Příklady

V následujícím příkladu ScrollPattern se řídicí vzor získá z objektu AutomationElement a pak se použije k posunutí zobrazitelné oblasti do levé horní pozice "domů" oblasti obsahu.

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

Poznámky

Tato metoda je užitečná pouze v případě, že je oblast obsahu ovládacího prvku větší než viditelná oblast.

Předání hodnoty NoScroll znamená, že v zadaném směru nedochází k posouvání.