Object Model Reference for GUI Testing > Visual Basic > VbListView Object > VbListView description properties

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

For a list of the object's native properties and methods see:

http://msdn.microsoft.com/library/default.asp?url=/library/en-us/cmctl198/html/vbobjListView

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.

Note: 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.

Note: 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).

AllowColumnReorder

Indicates whether the user can reorder columns using the mouse.

Possible values:                     
    True
    False (Default)

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.

arrange

Indicates how the icons in the ListView control's Icon or SmallIcon view are arranged.

Possible values:

0 (lvwNone): Items are randomly arranged.
1 (lvwAutoLeft):Items are aligned automatically along the left side of the control.
2 (lvwAutoTop): Items are aligned automatically along the top of the control.

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

ForeColor

The color of the object's text.

FullRowSelect

Indicates whether the entire row is selected.

Possible values:                     
    True
    False (Default)

GridLines

Indicates whether gridlines are displayed.

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.

HideColumnHeaders

Indicates whether column headers are hidden.

Possible values:                     
    True
    False (Default)

HotTracking

Indicates whether mouse-sensitive highlighting is enabled.

Possible values:                     
    True
    False (Default)

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.

index

The ordinal identifier that UFT 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

Indicates how the user edits the object's labels.

Possible values:

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

1 (lvwManual): 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.

location

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

MultiSelect

Indicates whether the user can select multiple objects or items.

Possible values:                     
    True
    False (Default)

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.

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.

selection

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

sorted

Indicates whether items in a collection are sorted.

Possible values:

True: Items are sorted according to the SortOrder property.
False

SortKey

Indicates how the objects in a ListView control are sorted.

Possible values:

0: Sorted using the object's Text property.
1 to n: Sorted using the specified sub-item collection index.

SortOrder

Indicates whether objects in a ListView control are sorted in ascending or descending order.

Possible values:

0 (lvwAscending): Ascending order.
1 (lvwDescending): Descending order.

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

view

The appearance of the objects in the ListView.

Possible values:

0 (lvwIcon):

Icon. Each ListItem object is represented by a full-sized (standard) icon and a text label.

1 (lvwSmallIcon):

SmallIcon. Each ListItem object is represented by a small icon and a text label that appears to the right of the icon. The items appear horizontally.

2 (lvwList):

List. Each ListItem object is represented by a small icon and a text label that appears to the right of the icon. The ListItem objects are arranged vertically, each on its own line with information arranged in columns.

3 (lvwReport):

Report. Each ListItem object is displayed with its small icon and text labels. Additional information about each ListItem object may be provided in a subitem. The icons, text labels, and information appear in columns with the leftmost column containing the small icon, followed by the text label. Additional columns display the text for each of the item's subitems.

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 HPE UFT Object Model Reference for GUI Testing.

Note: 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: