waitForObjectItem

Object waitForObjectItem(objectOrName, itemOrIndex)

Object waitForObjectItem(objectOrName, itemOrIndex, timeoutMSec)

Waits until the objectOrName object is accessible (i.e., it exists and is visible and enabled), and contains an item that is identified by the itemOrIndex and that is itself accessible.

The given name can also be a native script dictionary (resp. hash) value.

This function is typically used to access items inside containers such as lists, tables, and trees.

The itemOrIndex for a table can be a row/column string like "4/21". In a tree, it can be a period (.)-separated path string such as Mammals.Felines.Cats. In a list where strings may appear multiple times, a specific item can be selected by appending (_) followed by the item's occurrence index, to the non-unique string. For example, "itemtext_3" would retrieve the third item in the list which contains the "itemtext" string.

The return value depends on the Squish edition:

• Java, Qt and Windows: The return value is a reference to the item. (The reference can be used with other Squish functions.)
• Web and other Squish editions: The return value is a reference to the object identified by objectOrName (not the item).

The function raises a (catchable) LookupError exception on failure, i.e., if it times out.

The function waits for the time defined by the testSettings.waitForObjectTimeout property or if the optional timeoutMSec parameter is used, that many milliseconds.

Additional processing can be done on the object items before this function returns, by providing a user-defined callback function. See waitUntilObjectItemReady(item) for details.