SAPFrame 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 SAPFrame test object supports the description properties listed in the table below.

Property

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.

css

The path to the object in CSS format.

For example: tr.BPTRow input

Note: This property can only be used in the object repository description and in programmatic descriptions. It cannot be used in checkpoints or output values, or as argument values for the GetTOProperty and GetROProperty methods.

height

The object's height (in pixels).

index

The ordinal identifier value that UFT One assigns to the object to indicate the order in which the object appears in the code relative to other objects with an otherwise identical description. This property cannot be used with GetROProperty.

Values begin with 0.

name

The object's name.

Text

The text associated with the object.

Title

The frame's title.

url

The URL of the frame.

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 Objects 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

Note: This property can only be used in the object repository description and in programmatic descriptions. It cannot be used in checkpoints or output values, or as argument values for the GetTOProperty and GetROProperty methods.

See also: