IWindowProvider.WaitForInputIdle Method (Int32)

 
System_CAPS_noteNote

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

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

Namespace:   System.Windows.Automation.Provider
Assembly:  UIAutomationProvider (in UIAutomationProvider.dll)

bool WaitForInputIdle(
	int milliseconds
)

Parameters

milliseconds
Type: System.Int32

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

Return Value

Type: System.Boolean

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

Exception Condition
ArgumentOutOfRangeException

When the parameter passed in is not a valid number.

This method is typically used in conjunction with the handling of a WindowOpenedEvent.

The implementation is dependent on the underlying application framework; therefore this method might return some time after the window is ready for user input. The calling code should not rely on this method to ascertain exactly when the window has become idle.

.NET Framework
Available since 3.0
Silverlight
Available since 2.0
Windows Phone Silverlight
Available since 7.0
Return to top
Show: