VbButton 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 VbButton 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.

BackColor

The background color of an object.

cancel

Indicates whether the button object is the Cancel button on a form.

Possible values:

True: The button object is the Cancel button. The Cancel property gives the user the option of canceling uncommitted changes and returning the form to its previous state.
False: (Default) The button object is not the Cancel button.

caption

The text displayed in or next to the object.

Class Name

The object's class.

default

Indicates whether the button object is the default button on a form.

Possible values:

True: The button object is the default button. The user can choose the button object (invoking its Click event) by pressing ENTER. Any other control with the focus does not receive a keyboard event (KeyDown, KeyPress, or KeyUp) for the ENTER key unless the user has moved the focus to another button object on the same form. In this case, pressing ENTER chooses the command button that has the focus instead of the default command button.
False: (Default) The button object is not the default button.

enabled

Indicates whether the object is enabled.

Possible values:                     
    True
    False

focused

Indicates whether the object has the focus.

Possible values:                     
    True
    False

FontBold

Indicates whether the font style is bold.

Possible values:                     
    True
    False (Default)

FontItalic

Indicates whether the font style is italic.

Possible values:                     
    True
    False (Default)

FontName

The font used to display text in the control.

FontSize

The size (in points) of the font used for text displayed in the control.

FontStrikethru

Indicates whether the font style is strikethrough.

Possible values:                     
    True
    False (Default)

FontUnderline

Indicates whether the font style is underlined.

Possible values:                     
    True
    False (Default)

height

The object's height (in pixels).

hWnd

The handle of the run-time object's window.

index

The ordinal identifier 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.

left

The distance between the internal left edge of an object and the left edge of its container.

location

The ordinal identifier 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 object's name.

NativeClass

The object's window class name.

RegExpWndClass

The permanent part of the MFC window class.

RegExpWndTitle

The constant part of the window title.

style

Indicates the appearance and behavior of the button in a toolbar control.

Possible values:

0 (tbrDefault): (Default) Button.

1 (tbrCheck): Check.

2 (tbrButtonGroup): Button group.

3 (tbrSeparator): Separator.

4 (tbrPlaceholder): Placeholder.

5 (tbrDropDown): MenuButton drop down list.

TabIndex

The tab order of the object within its parent form.

TabStop

Indicates whether a user can use the Tab key to give the focus to the object.

Possible values:                     
    True (Default)
    False

tag

An expression that stores any extra data needed for your program. This property is generally used to identify objects.

TestObjGenType

The object's generic type, for example, text box, list box, or table.

TestObjName

The object's name as it appears in the object repository. This property cannot be used with programmatic descriptions or as a description property for the ChildObjects method.

If the object is not found in the object repository, the TestObjName is defined as follows:

  • If the object is found in the application, UFT One uses the value of the property it normally uses when adding this object to the object repository, surrounded by [ ].

  • If the object is not found in the application, UFT One uses the value of the object's Class Name property, surrounded by [ ].

text

The text associated with the object.

ToolTipText

The text displayed when the mouse pauses over the control.

top

The distance between the internal top edge of an object and the top edge of its container.

value

Indicates whether the object is chosen.

Possible values:                     
    True
    False (Default)

vbname

The object's name as set by the developer.

vbname path

The full hierarchy of vbname with all parent objects.

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 Micro Focus 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).

window id

The object's window identifier.

x

The object's x-coordinate (left) relative to the parent window (in pixels).

y

The object's y-coordinate (top) relative to the parent window (in pixels).

See also: