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

The list of all items in the control (separated by a new line character).

appearance

Indicates whether an object is painted at run-time with 3-D effects.

Possible values:

0: Paints controls and forms without visual effects.

1: (Default) Paints controls with three-dimensional effects.

attached text

The static text that is attached to a control.

checkboxes

Indicates whether the control has check boxes.

Possible values:                     
    True
    False (Default)

checked

The list of indexes of the object's checked items, if applicable.

Class Name

The object's class.

enabled

Indicates whether the object is enabled.

Possible values:                     
    True
    False

focused

Indicates whether the object has the focus.

Possible values:                     
    True
    False

FullRowSelect

Indicates whether the entire row is selected.

Possible values:                     
    True
    False (Default)

HasHScroll

Indicates whether the object has a horizontal scroll bar.

HasVScroll

Indicates whether the object has a vertical scroll bar.

HideSelection

Indicates whether selected text appears highlighted when the control loses the focus.

Possible values:                     
    True (Default)
    False

HotTracking

Indicates whether mouse-sensitive highlighting is enabled.

Possible values:                     
    True
    False

HScrollPageSize

The horizontal page size. The scroll bar uses this value to determine the approximate size of the scroll box. If the object does not have a scroll bar, the GetROProperty method returns an empty value for this property.

HScrollPosition

The position of the horizontal scroll box. If the object does not have a scroll bar, the GetROProperty method returns an empty value for this property.

hWnd

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

Indentation

The width of the object's indentation.

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.

items count

The number of items contained in the object.

LabelEdit

Possible values:

0 (tvwAutomatic): Automatic. The BeforeLabelEdit event is generated when the user clicks the label of a selected node.

1 (tvwManual): Manual. The BeforeLabelEdit event is generated only when the StartLabelEdit method is invoked.

left

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

LeftScrollbar

Indicates whether the vertical scroll bar is positioned on the left of the object.

LineStyle

The style of lines displayed between nodes in the TreeView object.

Possible values:

0 (tvwTreeLines):Tree lines. Displays lines between node siblings and their parent node.

1 (tvwRootLines): Root Lines. In addition to displaying lines between node siblings and their parent node, also displays lines between the root nodes.

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.

MaxHScrollPos

The maximum horizontal scrolling position. If the object does not have a scroll bar, the GetROProperty method returns an empty value for this property.

MaxVScrollPos

The maximum vertical scrolling position. If the object does not have a scroll bar, the GetROProperty method returns an empty value for this property.

MinHScrollPos

The minimum horizontal scrolling position. If the object does not have a scroll bar, the GetROProperty method returns an empty value for this property.

MinVScrollPos

The minimum vertical scrolling position. If the object does not have a scroll bar, the GetROProperty method returns an empty value for this property.

name

The object's name.

NativeClass

The object's window class name.

PathSeparator

The delimiter character used for the returned path.

RegExpWndClass

The permanent part of the MFC window class.

RegExpWndTitle

The constant part of the window title.

RightAligned

Indicates whether the object has generic "right-aligned" properties.

RightToLeftLayout

Indicates whether the object's horizontal origin is on the right edge.

RightToLeftReading

Indicates whether the object's text is displayed using right-to-left reading-order properties.

scroll

Specifies whether scroll bars are displayed.

Possible values:                     
    True
    False (Default)

selection

The list of items that are selected in the control (separated by ;).

SingleSel

Indicates whether the item is expanded when selected.

Possible values:                     
    True
    False (Default)

sorted

Indicates whether the root level items are sorted alphabetically.

Possible values:                     
    True
    False

style

Indicates the type of graphics (images, text, plus/minus, and lines) and text displayed for each node in a tree view.

Possible values:

0: Text only.
1: Image and text.
2: Plus/minus and text.
3: Plus/minus, image, and text.
4: Lines and text.
5: Lines, image, and text.
6: Lines, plus/minus, and text.
7: (Default) Lines, plus/minus, image, and text.

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.

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.

VScrollPageSize

The vertical page size. The scroll bar uses this value to determine the approximate size of the scroll box. If the object does not have a scroll bar, the GetROProperty method returns an empty value for this property.

VScrollPosition

The position of the vertical scroll box. If the object does not have a scroll bar, the GetROProperty method returns an empty value for this property.

width

The object's width (in pixels).

window id

The object's window identifier.

WindowExtendedStyle

The extended window style of the object.

WindowStyle

The window style of the object.

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: