UITestControl.WaitForControlPropertyEqual Method (String, Object, Int32)

Blocks the current thread until the specified property of this control is equal to the specified value, or until the specified time-out expires.

Namespace:  Microsoft.VisualStudio.TestTools.UITesting
Assembly:  Microsoft.VisualStudio.TestTools.UITesting (in Microsoft.VisualStudio.TestTools.UITesting.dll)

Syntax

'Declaration
Public Function WaitForControlPropertyEqual ( _
    propertyName As String, _
    propertyValue As Object, _
    millisecondsTimeout As Integer _
) As Boolean

public bool WaitForControlPropertyEqual(
    string propertyName,
    Object propertyValue,
    int millisecondsTimeout
)

public:
bool WaitForControlPropertyEqual(
    String^ propertyName, 
    Object^ propertyValue, 
    int millisecondsTimeout
)

member WaitForControlPropertyEqual : 
        propertyName:string * 
        propertyValue:Object * 
        millisecondsTimeout:int -> bool

public function WaitForControlPropertyEqual(
    propertyName : String, 
    propertyValue : Object, 
    millisecondsTimeout : int
) : boolean

Parameters

• propertyName
  Type: String

  The name of the property.

• propertyValue
  Type: Object

  The value to test.

• millisecondsTimeout
  Type: Int32

  The number of milliseconds before time-out.

Return Value

Type: Boolean
true if the specified property equals propertyValue before the time-out; otherwise, false.

Remarks

When the wait operation causes an implicit search for the control or, when the application is busy, the actual wait time could be more than the time-out specified.

.NET Framework Security

• Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see Using Libraries from Partially Trusted Code.

See Also

Reference

UITestControl Class

WaitForControlPropertyEqual Overload

Microsoft.VisualStudio.TestTools.UITesting Namespace