IDockProvider Interface

  • Reference

Definition

Namespace:
Windows.UI.Xaml.Automation.Provider
Edit

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 class IDockProvider
/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 65536)]
/// [Windows.Foundation.Metadata.Guid(1220690936, 30897, 17568, 172, 95, 117, 7, 87, 188, 222, 60)]
struct IDockProvider
[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 65536)]
[Windows.Foundation.Metadata.Guid(1220690936, 30897, 17568, 172, 95, 117, 7, 87, 188, 222, 60)]
public interface IDockProvider
Public Interface IDockProvider
Attributes
ContractVersionAttribute GuidAttribute

Windows requirements

Device family
Windows 10 (introduced in 10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced in v1.0)

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

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

Methods

SetDockPosition(DockPosition)

Docks the control in a docking container.

Applies to

See also