IDockProvider interface

Applies to Windows and Windows Phone

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.

Syntax


public interface IDockProvider

Attributes

[Version(0x06020000)]
[WebHostHidden()]

Members

The IDockProvider interface has these types of members:

Methods

The IDockProvider interface has these methods. It also inherits methods from the Object class.

MethodDescription
SetDockPosition Docks the control in a docking container.

 

Properties

The IDockProvider interface has these properties.

PropertyAccess typeDescription

DockPosition

Read-onlyGets the current DockPosition of the control in a docking container.

 

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++ APIs 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.

Requirements

Minimum supported client

Windows 8

Minimum supported server

Windows Server 2012

Minimum supported phone

Windows Phone 8.1 [Windows Runtime apps only]

Namespace

Windows.UI.Xaml.Automation.Provider
Windows::UI::Xaml::Automation::Provider [C++]

Metadata

Windows.winmd

See also

DockPatternIdentifiers
IDockProvider (COM interface)
Custom automation peers
Dock Control Pattern

 

 

Show:
© 2014 Microsoft. All rights reserved.