SAPUIRoadMap description properties

Object description properties can be used in the object repository description, in programmatic descriptions, in checkpoint and output value steps, and as argument values for the GetTOProperty and GetROProperty methods.

The SAPUIRoadMap test object supports the description properties listed in the table below.

Property Name

Description

abs_x

The object's absolute x-coordinate (left) relative to the screen (in pixels). 0,0 is always the top-left corner of the (primary) monitor.

If you are working with multiple monitors, the coordinate in the secondary monitor is relative to the primary monitor.

For example, given a resolution of 1280 x 1024 in the primary monitor, if the secondary monitor is positioned to the right of the primary monitor, the x-coordinate is 1280 or greater. If the secondary monitor is placed to the left of the primary monitor, the x-coordinate is negative.

abs_y

The object's absolute y-coordinate (top) relative to the screen (in pixels). 0,0 is always the top-left corner of the (primary) monitor.

If you are working with multiple monitors, the coordinate in the secondary monitor is relative to the primary monitor.

For example, given a resolution of 1280x1024 in the primary monitor, if the secondary monitor is positioned below the primary monitor, the y-coordinate is 1024 or greater. If the secondary monitor is placed above the primary monitor, the y-coordinate is negative.

all items

A list of the names of all of the road maps steps and sub steps, separated by semicolons (;).

For example: 1;a;b;2;a;3;4;a;b;c;

all stepsA list of the names of the road map's top-level steps, separated by semicolons (;). For example: 1;2;3;4

class

The value of the class HTML attribute. For example, <INPUT type=text class=myclass>.

height

The object's height (in pixels).

html id

The road map's HTML identifier (the value of the id attribute that defines the road map in the HTML).

html tag

The road map's HTML tag.

index

The ordinal identifier that UFT One assigns to the road map to indicate the order in which the road map appears in the code relative to other road maps with an otherwise identical description. This property cannot be used with GetROProperty. Values begin with 0.

innerhtml

The HTML code contained between the road map's start and end tags.

innertext

The text contained between the road map's start and end tags.

items countThe number of all items in the road map. (Includes hidden steps and sub steps.)

location

The ordinal identifier value that UFT One assigns to the object to indicate where the object appears within the window, frame, or dialog box. Values are assigned from top to bottom, and left to right. This property cannot be used with GetROProperty.

Values begin with 0.

name

The name of the object.

outerhtml

The road map's HTML code and its content.

outertext

The road map's text.

selected itemThe path to the step or sub step that is selected in the road map. For example: 4;b
steps countThe number of top-level step items in the road map. (Includes hidden steps.)

visible

Indicates whether the object is visible.

Possible values:
    True
    False

visual relations

Represents the test object's visual relations identifier.

Use this property in GetTOProperty and SetTOProperty steps to return or apply a VisualRelationsCollection object for a test object. The VisualRelationsCollection object enables you to retrieve or replace the visual relation identifier settings of a test object during a run session.

Syntax:

SetVRIColl = TestObject.GetTOProperty("visual relations")

TestObject.SetTOProperty "visual relations", VRIColl

For details, see VisualRelationsCollection Object in the Utility section of the UFT One Object Model Reference for GUI Testing.

This property is not listed in the Object Spy. It is not retrieved when you use the GetTOProperties method. It cannot be used in the Object Identification dialog box, the description area of the object repository, checkpoint or output value steps, and so on.

width

The object's width (in pixels).

xpath

The path to the object in XPath format.

For example: //TR[@id='QTP']/*/INPUT

x

The object's X (left) coordinate relative to the parent object (in pixels).

y

The object's Y (top) coordinate relative to the parent object (in pixels).

See also: