FlexList Object

Note: Following the retirement of the Adobe Flash Player, UFT One no longer supports the Flex Add-in out of the box.

If you require the Flex Add-in, contact OpenText Support.

Description

A Flex list control.

Operations

The sections below list the built-in methods and properties that you can use as operations for the FlexList object.

Note: You can also view a list and descriptions of the FlexList description properties, for use in object repository descriptions, programmatic descriptions, checkpoint and output value steps, and as argument values for the GetTOProperty and GetROProperty methods.

Methods

Common Method CaptureBitmapSaves a screen capture of the object as a .png or .bmp image using the specified file name.
Common Method CheckChecks whether the actual value of an item matches the expected value.
Common Method CheckPropertyChecks whether the actual value of the specified object property matches the specified expected value within the specified timeout.
Common Method ChildObjectsReturns the collection of child objects contained within the object.
Common Method GetAllROProperties

Returns the collection of properties and current values from the object in the application.

Method ClickClicks an object.
DblClickDouble clicks an object.
Method DeselectDeselects an item in the list.
Method ExtendSelectThis method is applicable only to lists that allow multiple selection.
Method GetItemChildObjectsReturns the collection of child objects contained within the specified list item.
Common Method GetROPropertyReturns the current value of the description property from the object in the application.
Common Method GetTOPropertiesReturns the collection of properties and values used to identify the object.
Common Method GetTOPropertyReturns the value of the specified description property from the test object description.
Common Method HighlightHighlights the object in the application.
Common Method OutputRetrieves the current value of an item and stores it in a specified location.
Common Method RefreshObjectInstructs UFT One to re-identify the object in the application the next time a step refers to this object.
Method SelectSelects an item from the list.
Method SelectRangeThis method is applicable only to lists that allow multiple selection.
Common Method SetTOPropertySets the value of the specified description property in the test object description.
Common Method ToStringReturns a string that represents the test object.
Common Method WaitPropertyWaits until the specified object property achieves the specified value or exceeds the specified timeout before continuing to the next step.

Properties

Common Property ExistChecks whether the object currently exists in the open application.

Back to top

 

Click Method

Description

Clicks an object.

Syntax

object.Click ([X], [Y], [BUTTON])

Arguments

ParameterDescription
X Optional. An integer value.

The x-coordinate of the click. Note that the specified coordinates are relative to the upper left corner of the object. The default value is the center of the object.


Default value = -9999
Y Optional. An integer value.

The y-coordinate of the click. Note that the specified coordinates are relative to the upper left corner of the object. The default value is the center of the object.


Default value = -9999
BUTTON Optional. A predefined constant or number.

The mouse button used to click the object.


Default value = micLeftBtn

Return Type

None.

Example

Back to top

DblClick Method

Description

Double clicks an object.

Syntax

object.Click ([X], [Y], [BUTTON])

Arguments

ParameterDescription
X Optional. An integer value.

The x-coordinate of the click. Note that the specified coordinates are relative to the upper left corner of the object. The default value is the center of the object.


Default value = -9999
Y Optional. An integer value.

The y-coordinate of the click. Note that the specified coordinates are relative to the upper left corner of the object. The default value is the center of the object.


Default value = -9999
BUTTON Optional. A predefined constant or number.

The mouse button used to click the object.


Default value = micLeftBtn

Return Type

None.

Example

Back to top

 

Deselect Method

Description

Deselects an item in the list.

Syntax

object.Deselect (item)

Arguments

ParameterDescription
item Required. A Variant.
The item to deselect from the list. The item value (with quotes) or numeric index (without quotes) can denote the item. Index values begin with 0.

Return Type

None.

IMPORTANT

  • This method is applicable only to lists that allow multiple selection in addition to no selection or single-item selection. 
  • When recording operations on list items, UFT One records the item label value for the Item argument if the label has a value and that value is unique in the list.  Otherwise UFT One records the item index.

Example

Back to top

 

ExtendSelect Method

Description

This method is applicable only to lists that allow multiple selection.

Syntax

object.ExtendSelect (item)

Arguments

ParameterDescription
item Required. A Variant.
The additional item to select from the list. The item value (with quotes) or numeric index (without quotes) can denote the item. Index values begin with 0.

Return Type

None.

IMPORTANT

When recording operations on list items, UFT One records the item label value for the Item argument if the label has a value and that value is unique in the list.  Otherwise UFT One records the item index.

Example

Back to top

 

GetItemChildObjects Method

Description

Returns the collection of child objects contained within the specified list item.

Syntax

object.GetItemChildObjects (item, [Description])

Arguments

ParameterDescription
item Required. A long integer value.
The index of the list item containing the child objects to return. Index values begin with 0.
Description Optional. An Object.

The Properties (collection) object containing the description of the child objects you want to retrieve.

Tip: You can retrieve a Properties collection using the GetTOProperties method or you can build a Properties collection object using the Description object. For more information on the Description object, refer to the Utility Objects section of the UFT One Object Model Reference.

Return Type

An Object.

A collection of test objects. The collection can be empty, or contain one or more objects, depending on the number of relevant child objects found.

IMPORTANT

  • Use this method to access objects that are embedded inside of Flex list items, such as check boxes, radio buttons, and toggle buttons.
  • You may want to call the Select method to activate the cell before accessing its content, as this sometimes changes the embedded objects.
  • The GetItemChildObjects method returns an item's child objects only if the item is visible. To make sure the item is visible before calling this method, use the Select method.
  • The GetItemChildObjects method may not return a child object for plain text contained in a list item. To retrieve  this type of data, use the GetROProperty method and retrieve the selection or all_items properties.

Example

Back to top

 

Select Method

Description

Selects an item from the list.

Syntax

object.Select (item)

Arguments

ParameterDescription
item Required. A Variant.
The item to select from the list. The item value (with quotes) or numeric index (without quotes) can denote the item. Index values begin with 0.

Return Type

None.

IMPORTANT

When recording operations on list items, UFT One records the item label value for the Item argument if the label has a value and that value is unique in the list.  Otherwise UFT One records the item index.

Example

Back to top

 

SelectRange Method

Description

This method is applicable only to lists that allow multiple selection.

Syntax

object.SelectRange (item, [itemTo])

Arguments

ParameterDescription
item Required. A Variant.

The first item in the range.

  • If the itemTo argument is not specified, then the item argument is one end of the range and the currently selected item (or the same item if there is no selected item) is the other end of the range.
  • If the itemTo argument is specified, then the item argument is the first item in the range. The item value (with quotes) or numeric index (without quotes) can denote the item.

Index values begin with 0.

itemTo Optional. A Variant.

The last item in the range. The item value (with quotes) or numeric index (without quotes) can denote the item. Index values begin with 0.

Return Type

None.

IMPORTANT

When recording operations on list items, UFT One records the item label value for the Item argument if the label has a value and that value is unique in the list.  Otherwise UFT One records the item index.

Example

Back to top

 

See also: