DockPattern.DockPositionProperty 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 DockPosition property.

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

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

 staticval mutable DockPositionProperty : System.Windows.Automation.AutomationProperty

Public Shared ReadOnly DockPositionProperty As AutomationProperty

Field Value

AutomationProperty

Examples

In the following example, a DockPosition value is obtained representing the current dock position for a control that supports DockPattern.

///--------------------------------------------------------------------
/// <summary>
/// Finds all automation elements that satisfy 
/// the specified condition(s).
/// </summary>
/// <param name="targetApp">
/// The automation element from which to start searching.
/// </param>
/// <returns>
/// A collection of automation elements satisfying 
/// the specified condition(s).
/// </returns>
///--------------------------------------------------------------------
private AutomationElementCollection FindAutomationElement(
    AutomationElement targetApp)
{
    if (targetApp == null)
    {
        throw new ArgumentException("Root element cannot be null.");
    }

    PropertyCondition conditionSupportsDock =
        new PropertyCondition(
        AutomationElement.IsDockPatternAvailableProperty, true);

    return targetApp.FindAll(
        TreeScope.Descendants, conditionSupportsDock);
}

'''--------------------------------------------------------------------
''' <summary>
''' Finds all automation elements that satisfy 
''' the specified condition(s).
''' </summary>
''' <param name="targetApp">
''' The automation element from which to start searching.
''' </param>
''' <returns>
''' A collection of automation elements satisfying 
''' the specified condition(s).
''' </returns>
'''--------------------------------------------------------------------
Private Function FindAutomationElement( _
ByVal targetApp As AutomationElement) As AutomationElementCollection
    If targetApp Is Nothing Then
        Throw New ArgumentException("Root element cannot be null.")
    End If

    Dim conditionSupportsDock As New PropertyCondition( _
    AutomationElement.IsDockPatternAvailableProperty, True)

    Return targetApp.FindAll( _
    TreeScope.Descendants, conditionSupportsDock)

End Function 'FindAutomationElement

///--------------------------------------------------------------------
/// <summary>
/// Gets the current DockPosition of a target.
/// </summary>
/// <param name="dockControl">
/// The automation element of interest.
/// </param>
/// <returns>
/// The current dock position.
/// </returns>
///--------------------------------------------------------------------
private DockPosition GetCurrentDockPosition(
    AutomationElement dockControl)
{
    if (dockControl == null)
    {
        throw new ArgumentNullException(
            "AutomationElement parameter must not be null.");
    }

    return (DockPosition)dockControl.GetCurrentPropertyValue(
        DockPattern.DockPositionProperty);
}

'''--------------------------------------------------------------------
''' <summary>
''' Gets the current DockPosition of a target.
''' </summary>
''' <param name="dockControl">
''' The automation element of interest.
''' </param>
''' <returns>
''' The current dock position.
''' </returns>
'''--------------------------------------------------------------------
Private Overloads Function GetCurrentDockPosition( _
ByVal dockControl As AutomationElement) As DockPosition
    If dockControl Is Nothing Then
        Throw New ArgumentNullException( _
        "AutomationElement parameter must not be null.")
    End If

    Return CType(dockControl.GetCurrentPropertyValue( _
    DockPattern.DockPositionProperty), DockPosition)

End Function 'GetCurrentDockPosition

Remarks

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

This property can also be retrieved from the Current or Cached properties.

The default value is None.

Applies to

Jaa