Description

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

Declaration

TestObj.WaitSlObject(Name, Timeout)

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.WaitSlObject(ClassName, Text, Timeout)

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
Text	[in]	Required	String
Timeout	[in]	Required	Integer
Result	Object

TestObj.WaitSlObject(ClassName, Text, Index, Timeout)

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
Text	[in]	Required	String
Index	[in]	Required	Integer
Timeout	[in]	Required	Integer
Result	Object

Applies To

Web and XUL objects and all Silverlight application 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 name of the desired Silverlight object as it is specified in the tested application’s source code (the string that is returned by the SlObjectName property).

ClassName

The object’s class name that is specified by the application’s code. This value is returned by the SlClassName property of the object. You can use wildcards (* and ?) in this parameter.

Text

The text of the object (the object’s caption, in most cases). This value is returned by the SlObjectText property. You can use wildcards (* and ?) in this parameter.

Index

The object’s index among sibling objects of the same type. This value is returned by the SlObjectIndex property.

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 0, the second - 1 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 WaitSlObject method returns an object that provides access to an object located in a Silverlight application. If TestComplete cannot access the specified object (for example, this object does not exist), the method will return an empty stub object. To determine whether WaitSlObject 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 WaitSlObject was not successful.

Remarks

The returned object contains methods, fields 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 or properties having the same name. When 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 NativeSlObject namespace.

The WaitSlObject method is available only if the Silverlight Application Support and Web Testing plugins are installed. Otherwise, the method is absent in the method list of the TestObj object.

To obtain the class name, text and index used by the second or third implementation of the WaitSlObject method, use the SlClassName, SlObjectText and SlObjectIndex properties.

WaitSlObject Method