IWindowProvider Interface

Reference

Definition

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

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.

Edit

Exposes methods and properties to support access by a Microsoft UI Automation client to controls that provide fundamental window-based functionality within a traditional graphical user interface (GUI). Implement this interface in order to support the capabilities that an automation client requests with a GetPattern call and PatternInterface.Window.

public interface class IWindowProvider

/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 65536)]
/// [Windows.Foundation.Metadata.Guid(464161597, 14543, 16730, 133, 211, 32, 228, 58, 14, 193, 177)]
struct IWindowProvider

[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 65536)]
[Windows.Foundation.Metadata.Guid(464161597, 14543, 16730, 133, 211, 32, 228, 58, 14, 193, 177)]
public interface IWindowProvider

Public Interface IWindowProvider

Derived: Windows.UI.Xaml.Automation.Peers.AppBarAutomationPeer

Windows.UI.Xaml.Automation.Peers.ComboBoxAutomationPeer

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

For more info on what this pattern is for, see Window Control Pattern.

IWindowProvider 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 WindowPatternIdentifiers if you want to reference the IWindowProvider pattern properties from control code when you fire automation events or call RaisePropertyChangedEvent.

Properties

InteractionState	Gets the interaction state of the window.
IsModal	Gets a value that specifies whether the window is modal.
IsTopmost	Gets a value that specifies whether the window is the topmost element in the z-order of layout.
Maximizable	Gets a value that specifies whether the window can be maximized.
Minimizable	Gets a value that specifies whether the window can be minimized.
VisualState	Gets the visual state of the window.

Methods

Close()	Closes the window.
SetVisualState(WindowVisualState)	Changes the visual state of the window (such as minimizing or maximizing it).
WaitForInputIdle(Int32)	Blocks the calling code for the specified time or until the associated process enters an idle state, whichever completes first.

Applies to

Product	Versions
WinRT	Build 10240, Build 10586, Build 14383, Build 15063, Build 16299, Build 17134, Build 17763, Build 18362, Build 19041, Build 20348, Build 22000, Build 22621, Build 26100

Share via