DockPattern.DockPositionProperty Field

Definition

Namespace:

System.Windows.Automation

Assembly:

UIAutomationClient.dll

Identifies the DockPosition property.

C#

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

Field Value

AutomationProperty

Examples

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

C#

///--------------------------------------------------------------------
/// <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);
}

C#

///--------------------------------------------------------------------
/// <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);
}

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