I​Dock​Provider I​Dock​Provider I​Dock​Provider Interface

Definition

Exposes methods and properties to support access by a Microsoft UI Automation client to controls that expose their dock properties in a docking container. Implement this interface in order to support the capabilities that an automation client requests with a GetPattern call and PatternInterface.Dock.

public interface IDockProviderpublic interface IDockProviderPublic Interface IDockProvider
Attributes
Windows 10 requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

Remarks

A docking container is a control that allows you to arrange child elements horizontally and vertically, relative to each other. For more info on what this pattern is for, see Dock Control Pattern.

IDockProvider isn't implemented by any existing Windows Runtime automation peers. The interface exists so that custom control authors can support the automation pattern in a custom control, and implement their automation support using the same Windows Runtime managed or C++ API as they use to define control logic or other automation support.

Use DockPatternIdentifiers if you want to reference the IDockProvider pattern properties from control code when you fire automation events or call RaisePropertyChangedEvent.

Properties

DockPosition DockPosition DockPosition

Gets the current DockPosition of the control in a docking container.

public DockPosition DockPosition { get; }public DockPosition DockPosition { get; }Public ReadOnly Property DockPosition As DockPosition
Value
DockPosition DockPosition DockPosition

The DockPosition of the control, relative to the boundaries of the docking container and to other elements in the container.

Attributes

Methods

SetDockPosition(DockPosition) SetDockPosition(DockPosition) SetDockPosition(DockPosition)

Docks the control in a docking container.

public void SetDockPosition(DockPosition dockPosition)public void SetDockPosition(DockPosition dockPosition)Public Function SetDockPosition(dockPosition As DockPosition) As void
Parameters
dockPosition
DockPosition DockPosition DockPosition

The dock position, relative to the boundaries of the docking container and to other elements in the container.

Attributes

See Also