WindowPattern.WaitForInputIdle(Int32) Method

Reference

Definition

Namespace:: System.Windows.Automation

Assembly:: UIAutomationClient.dll

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.

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

public:
 bool WaitForInputIdle(int milliseconds);

public bool WaitForInputIdle (int milliseconds);

member this.WaitForInputIdle : int -> bool

Public Function WaitForInputIdle (milliseconds As Integer) As Boolean

Parameters

milliseconds: Int32

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

Returns

Boolean

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

Exceptions

ArgumentOutOfRangeException

The parameter passed in is not a valid number.

Examples

In the following example, a WindowPattern control 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;
}

'''------------------------------------------------------------------------
''' <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 Function GetWindowPattern(ByVal targetControl As AutomationElement) As WindowPattern
    Dim windowPattern As WindowPattern = Nothing

    Try
        windowPattern = DirectCast( _
        targetControl.GetCurrentPattern(windowPattern.Pattern), _
        WindowPattern)
    Catch
        ' object doesn't support the WindowPattern control pattern
        Return Nothing
    End Try
    ' Make sure the element is usable.
    If False = windowPattern.WaitForInputIdle(10000) Then
        ' Object not responding in a timely manner
        Return Nothing
    End If
    Return windowPattern
End Function 'GetWindowPattern

Remarks

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.

Applies to

Jaa