WaitTextObject Method

Applies to TestComplete 14.80, last modified on April 13, 2021

Description

Use this method to pause the script execution until the specified window or control of the tested application becomes available. WaitTextObject returns a program object that provides a scripting interface to the specified window or control. The resulting object contains methods and properties defined in application code as well as methods, properties and actions provided by TestComplete.

Declaration

TestObj.WaitTextObject(NameTimeout)

TestObj A variable, parameter or expression that specifies a reference to one of the objects listed in the Applies To section
Name [in]    Required    String    
Timeout [in]    Required    Integer    
Result Object

TestObj.WaitTextObject(NameIndexTimeout)

TestObj A variable, parameter or expression that specifies a reference to one of the objects listed in the Applies To section
Name [in]    Required    String    
Index [in]    Required    Integer    
Timeout [in]    Required    Integer    
Result Object

Applies To

The method is applied to the following object:

View Mode

To view this method in the Object Browser panel and in other panels and dialogs, activate the Advanced view mode.

Parameters

The method has the following parameters:

Name

The text the desired object contains. Wildcard characters ('*' and '?') can be used in this parameter.

Index

Specifies the index of the needed object in a collection of objects containing the same text. Index is zero-based, that is, it starts from 0.

Timeout

The number of milliseconds to wait until the specified object becomes available. If Timeout is 0, the method returns immediately. If Timeout is -1, the wait time is infinite.

Note that Timeout value is not strict and if the tested application is busy, TestComplete could wait for the object for a longer period of time than it is specified by the parameter. The following can cause this:

A call to any WaitXXXObject method causes the object tree to refresh. To update object data, TestComplete may call some of object’s native methods that are accessible only from the application’s thread. When the thread is busy, TestComplete tries to call those methods during some pre-defined time (one second) thus delaying the refresh. There could be several attempts to get the object’s data which could result in a noticeable difference from the Timeout value.

Result Value

The WaitTextObject method returns an object that provides a scripting interface to an object that is exposed by the Text Recognition plugin. If TestComplete cannot access the specified object (for example, this object does not exist), WaitTextObject will return an empty stub object. To determine whether the method returns a valid object, use the Exists property of the resultant object. If this property returns False, then the returned object is a stub object and the call to WaitTextObject was not successful.

Remarks

The WaitTextObject method is available only if the Text Recognition plugin is installed and enabled in TestComplete. Otherwise, the method is absent in the method list of the Window object.

See Also

TextObject Method
Using Microsoft UI Automation Technology - Overview
Requirements

Highlight search results