Applies to TestComplete 14.30, last modified on November 21, 2019

Description

Use this method to pause the script execution until the specified window or control of a .NET application (that was created with Microsoft Windows Forms library) becomes available to TestComplete. The method returns a program object that provides a scripting interface to the specified window or control. The resulting object contains methods and properties defined in the application code as well as methods, properties and actions provided by TestComplete.

Declaration

TestObj.WaitWinFormsObject(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.WaitWinFormsObject(ClassNameWndCaptionTimeout)

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

TestObj.WaitWinFormsObject(ClassNameWndCaptionIndexTimeout)

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

Applies To

The method is applied to the following objects:

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 object name as it is specified by the developers in the application’s source code. This is the value of the object’s WinFormsControlName property.

Note that .NET compilers do not include object names in the executable if developers do not assign a value to the object’s Name property in the code. In this case, use the second implementation of the method to address the desired object.

ClassName

The object’s class name as it is specified in the application code. This is the same value as the object’s ClrClassName property. Note, that you should specify a short name rather than the full class name, for instance, Button rather than System.Windows.Forms.Button. You can use wildcards (* and ?) in this parameter.

Note that class names of .NET application objects may be unavailable. For instance, this happens if the application was processed with an obfuscator. In this case, TestComplete replaces the class name with an underscore and an index. To determine the class name used, explore the tested application in the Object Browser.

WndCaption

The caption of the desired window or control. The caption can include wildcards (* and ?).

Index

The object’s index, starting from 1, among other objects that belong to the TestObj object and that have the same window class name (the WndClass property value) and caption.

The Index parameter is used only if an object contains two or more child objects that have the same class name and caption. It is used to distinguish these objects from each other. The first found object has an index of 1, the second -  2 and so on.

If there is only one child object with the specified class name and caption, index should not be specified. To decide whether the index should be used, explore your application in the Object Browser panel and use the naming format that is used by the panel.

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 WaitWinFormsObject method returns an object that provides a scripting interface to an object located in a WinForms .NET application (.NET applications are always “open” to TestComplete). If TestComplete cannot access the specified object (for example, this object does not exist), WaitWinFormsObject will return an empty stub object. To determine whether WaitWinFormsObject 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 WaitWinFormsObject was not successful.

Remarks

If you only use two parameters, TestComplete considers the use of the first implementation of the WaitWinFormsObject method and the first parameter as the object’s name. If you use three or four parameters, TestComplete considers it as using the second or third implementation of the method.

The object returned by the WaitWinFormsObject method contains methods and properties defined in the application code as well as methods, properties and actions provided by TestComplete. The returned object may hold two or more methods and properties having the same name. If you call such a method or property, a naming conflict will occur. To avoid it and to specify which method or property is to be called, use the NativeClrObject namespace.

The WaitWinFormsObject method is available only if the .NET Application Support plugin is installed and enabled in File | Install Extensions. Otherwise, the method is absent in the method list of the TestObj object.

See Also

WinFormsObject Method
Testing .NET Applications
Addressing Objects in .NET Applications
VCLNETObject Method (Window Objects)
VCLNETObject Method (Process Objects)

Highlight search results