ScrollPattern.VerticalViewSizeProperty 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 VerticalViewSize property.

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

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

 staticval mutable VerticalViewSizeProperty : System.Windows.Automation.AutomationProperty

Public Shared ReadOnly VerticalViewSizeProperty As AutomationProperty

Field Value

AutomationProperty

Examples

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

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

    double[] viewSizes = new double[2];

    viewSizes[0] =
        (double)targetControl.GetCurrentPropertyValue(
        ScrollPattern.HorizontalViewSizeProperty);

    viewSizes[1] =
         (double)targetControl.GetCurrentPropertyValue(
         ScrollPattern.VerticalViewSizeProperty);

    return viewSizes;
}

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

    Dim viewSizes(1) As Double

    viewSizes(0) = System.Convert.ToDouble( _
    targetControl.GetCurrentPropertyValue( _
    ScrollPattern.HorizontalViewSizeProperty))

    viewSizes(1) = System.Convert.ToDouble( _
    targetControl.GetCurrentPropertyValue( _
    ScrollPattern.VerticalViewSizeProperty))

    Return viewSizes

End Function 'GetViewSizes

Remarks

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

Applies to

Jaa