IWindowProvider IWindowProvider IWindowProvider Interface

Definition

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 IWindowProvider
public interface IWindowProvider
Public Interface IWindowProvider
Attributes
Windows 10 requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

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 InteractionState InteractionState

Gets the interaction state of the window.

public : WindowInteractionState InteractionState { get; }
public WindowInteractionState InteractionState { get; }
Public ReadOnly Property InteractionState As WindowInteractionState
Value
WindowInteractionState WindowInteractionState WindowInteractionState

The interaction state of the control, as a value of the enumeration.

IsModal IsModal IsModal

Gets a value that specifies whether the window is modal.

public : Platform::Boolean IsModal { get; }
public bool IsModal { get; }
Public ReadOnly Property IsModal As bool
Value
Platform::Boolean bool bool

true if the window is modal; otherwise, false.

IsTopmost IsTopmost IsTopmost

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

public : Platform::Boolean IsTopmost { get; }
public bool IsTopmost { get; }
Public ReadOnly Property IsTopmost As bool
Value
Platform::Boolean bool bool

true if the window is topmost; otherwise, false.

Maximizable Maximizable Maximizable

Gets a value that specifies whether the window can be maximized.

public : Platform::Boolean Maximizable { get; }
public bool Maximizable { get; }
Public ReadOnly Property Maximizable As bool
Value
Platform::Boolean bool bool

true if the window can be maximized; otherwise, false.

Minimizable Minimizable Minimizable

Gets a value that specifies whether the window can be minimized.

public : Platform::Boolean Minimizable { get; }
public bool Minimizable { get; }
Public ReadOnly Property Minimizable As bool
Value
Platform::Boolean bool bool

true if the window can be minimized; otherwise, false.

VisualState VisualState VisualState

Gets the visual state of the window.

public : WindowVisualState VisualState { get; }
public WindowVisualState VisualState { get; }
Public ReadOnly Property VisualState As WindowVisualState
Value
WindowVisualState WindowVisualState WindowVisualState

The visual state of the window, as a value of the enumeration.

Methods

Close() Close() Close()

Closes the window.

public : void Close()
public void Close()
Public Function Close() As void

SetVisualState(WindowVisualState) SetVisualState(WindowVisualState) SetVisualState(WindowVisualState)

Changes the visual state of the window (such as minimizing or maximizing it).

public : void SetVisualState(WindowVisualState state)
public void SetVisualState(WindowVisualState state)
Public Function SetVisualState(state As WindowVisualState) As void
Parameters
state
WindowVisualState WindowVisualState WindowVisualState

The visual state of the window to change to, as a value of the enumeration.

WaitForInputIdle(Int32) WaitForInputIdle(Int32) WaitForInputIdle(Int32)

Blocks the calling code for the specified time or until the associated process enters an idle state, whichever completes first.

public : Platform::Boolean WaitForInputIdle(int milliseconds)
public bool WaitForInputIdle(Int32 milliseconds)
Public Function WaitForInputIdle(milliseconds As Int32) As bool
Parameters
milliseconds
int Int32 Int32

The amount of time, in milliseconds, to wait for the associated process to become idle.

Returns
Platform::Boolean bool bool

true if the window has entered the idle state; false if the timeout occurred.

See Also