IWindowProvider interface

Applies to Windows and Windows Phone

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.

Syntax


public interface IWindowProvider

Attributes

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

Members

The IWindowProvider interface has these types of members:

Methods

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

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

 

Properties

The IWindowProvider interface has these properties.

PropertyAccess typeDescription

InteractionState

Read-onlyGets the interaction state of the window.

IsModal

Read-onlyGets a value that specifies whether the window is modal.

IsTopmost

Read-onlyGets a value that specifies whether the window is the topmost element in the z-order of layout.

Maximizable

Read-onlyGets a value that specifies whether the window can be maximized.

Minimizable

Read-onlyGets a value that specifies whether the window can be minimized.

VisualState

Read-onlyGets the visual state of the window.

 

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

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

WindowPatternIdentifiers
IWindowProvider (COM interface)
Custom automation peers
Window Control Pattern

 

 

Show:
© 2014 Microsoft