WindowPattern.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
Assembly:  UIAutomationClient (in UIAutomationClient.dll)

public 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

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 may 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.

In the following example, a WindowPatterncontrol pattern is obtained from an AutomationElement and uses WaitForInputIdle to confirm the element is ready for user interaction within a reasonable amount of time.

///--------------------------------------------------------------------
/// <summary>
/// Obtains a WindowPattern control pattern from an automation element.
/// </summary>
/// <param name="targetControl">
/// The automation element of interest.
/// </param>
/// <returns>
/// A WindowPattern object.
/// </returns>
///--------------------------------------------------------------------
private WindowPattern GetWindowPattern(AutomationElement targetControl)
{
    WindowPattern windowPattern = null;

    try
    {
        windowPattern =
            targetControl.GetCurrentPattern(WindowPattern.Pattern)
            as WindowPattern;
    }
    catch (InvalidOperationException)
    {
        // object doesn't support the WindowPattern control pattern
        return null;
    }
    // Make sure the element is usable.
    if (false == windowPattern.WaitForInputIdle(10000))
    {
        // Object not responding in a timely manner
        return null;
    }
    return windowPattern;
}

.NET Framework
Available since 3.0
Return to top
Show: