ListView

WinForms. ListView

new ListView(props[opt]) → {ListView}

The description of a ListView test object.
Parameters:
NameTypeAttributesDescription
propsObject <optional>
Initializes a ListView test object using the supplied property bag.
Returns:
the description object that was initialized.
Type
ListView

Methods

absoluteLocation(location[opt]) → {Point|Description}

The object's coordinates relative to the screen in pixels. 0,0 is the top-left corner of the primary monitor.
Parameters:
NameTypeAttributesDescription
locationPoint <optional>
When provided, this method acts as a setter and sets the absoluteLocation value.
Returns:
If no parameter is provided, the method acts as a getter and returns the absoluteLocation value; otherwise it returns 'this' for use with the builder pattern.
Type
Point | Description

attachedText(attachedText[opt]) → {string|Description}

The object's attached text.
Parameters:
NameTypeAttributesDescription
attachedTextstring <optional>
When provided, this method acts as a setter and sets the attachedText value.
Returns:
If no parameter is provided, the method acts as a getter and returns the current stored attachedText value; otherwise it returns 'this' for use with the builder pattern.
Type
string | Description

extendSelect(…items) → {Promise.<void>}

Selects additional items from the multi-selection list.
Parameters:
NameTypeAttributesDescription
itemsListItem | string | number <repeatable>
One or more items to add to the selection. Each item can be either the StdWin.ListViewItem, name of the item you wish to select, or the numeric index of the item in the list.
Returns:
a promise that is fulfilled when the operation is performed.
Type
Promise.<void>

fullNamePath(fullNamePath[opt]) → {string|Description}

The full hierarchy of swfname with all parent objects.
Parameters:
NameTypeAttributesDescription
fullNamePathstring <optional>
When provided, this method acts as a setter and sets the fullNamePath value.
Returns:
If no parameter is provided, the method acts as a getter and returns the current stored fullNamePath value; otherwise it returns 'this' for use with the builder pattern.
Type
string | Description

fullType(fullType[opt]) → {string|Description}

The object's full type name.
Parameters:
NameTypeAttributesDescription
fullTypestring <optional>
When provided, this method acts as a setter and sets the fullType value.
Returns:
If no parameter is provided, the method acts as a getter and returns the current stored fullType value; otherwise it returns 'this' for use with the builder pattern.
Type
string | Description

isChildWindow(isChildWindow[opt]) → {boolean|Description}

Indicates whether the object is a child window.
Parameters:
NameTypeAttributesDescription
isChildWindowboolean <optional>
When provided, this method acts as a setter and sets the isChildWindow value.
Returns:
If no parameter is provided, the method acts as a getter and returns the current stored isChildWindow value; otherwise it returns 'this' for use with the builder pattern.
Type
boolean | Description

isEnabled(isEnabled[opt]) → {boolean|Description}

Indicates whether the object is enable.
Parameters:
NameTypeAttributesDescription
isEnabledboolean <optional>
When provided, this method acts as a setter and sets the isEnabled value.
Returns:
If no parameter is provided, the method acts as a getter and returns the current stored isEnabled value; otherwise it returns 'this' for use with the builder pattern.
Type
boolean | Description

isFocused(isFocused[opt]) → {boolean|Description}

Indicates whether the object is focused.
Parameters:
NameTypeAttributesDescription
isFocusedboolean <optional>
When provided, this method acts as a setter and sets the isFocused value.
Returns:
If no parameter is provided, the method acts as a getter and returns the current stored isFocused value; otherwise it returns 'this' for use with the builder pattern.
Type
boolean | Description

isOwnedWindow(isOwnedWindow[opt]) → {boolean|Description}

Indicates whether the object is an owned window.
Parameters:
NameTypeAttributesDescription
isOwnedWindowboolean <optional>
When provided, this method acts as a setter and sets the isOwnedWindow value.
Returns:
If no parameter is provided, the method acts as a getter and returns the current stored isOwnedWindow value; otherwise it returns 'this' for use with the builder pattern.
Type
boolean | Description

isVisible(isVisible[opt]) → {boolean|Description}

Indicates whether the object is visible.
Parameters:
NameTypeAttributesDescription
isVisibleboolean <optional>
When provided, this method acts as a setter and sets the isVisible value.
Returns:
If no parameter is provided, the method acts as a getter and returns the current stored isVisible value; otherwise it returns 'this' for use with the builder pattern.
Type
boolean | Description

items(items[opt]) → {Array.<string>|Description}

An array of all items in the list.
Parameters:
NameTypeAttributesDescription
itemsArray.<string> <optional>
When provided, this method acts as a setter and sets the items value.
Returns:
If no parameter is provided, the method acts as a getter and returns the current stored items value; otherwise it returns 'this' for use with the builder pattern.
Type
Array.<string> | Description

itemsCount(itemsCount[opt]) → {number|Description}

The number of items in the list box.
Parameters:
NameTypeAttributesDescription
itemsCountnumber <optional>
When provided, this method acts as a setter and sets the itemsCount value.
Returns:
If no parameter is provided, the method acts as a getter and returns the current stored itemsCount value; otherwise it returns 'this' for use with the builder pattern.
Type
number | Description

location(location[opt]) → {Point|Description}

The object's coordinates relative to the parent's location in pixels.
Parameters:
NameTypeAttributesDescription
locationPoint <optional>
When provided, this method acts as a setter and sets the location value.
Returns:
If no parameter is provided, the method acts as a getter and returns the current stored location value; otherwise it returns 'this' for use with the builder pattern.
Type
Point | Description

nativeClass(nativeClass[opt]) → {string|Description}

The object's native class.
Parameters:
NameTypeAttributesDescription
nativeClassstring <optional>
When provided, this method acts as a setter and sets the nativeClass value.
Returns:
If no parameter is provided, the method acts as a getter and returns the current stored nativeClass value; otherwise it returns 'this' for use with the builder pattern.
Type
string | Description

objectName(objectName[opt]) → {string|Description}

The object's name.
Parameters:
NameTypeAttributesDescription
objectNamestring <optional>
When provided, this method acts as a setter and sets the objectName value.
Returns:
If no parameter is provided, the method acts as a getter and returns the current stored objectName value; otherwise it returns 'this' for use with the builder pattern.
Type
string | Description

objectProperties(objectProperties[opt]) → {Dictionary|Description}

The concrete test object properties including custom properties.
Parameters:
NameTypeAttributesDescription
objectPropertiesDictionary <optional>
When provided, this method acts as a setter and sets the objectProperties value.
Returns:
If no parameter is provided, the method acts as a getter and returns the current stored objectProperties value; otherwise it returns 'this' for use with the builder pattern.
Type
Dictionary | Description

selectedItems(selectedItem[opt]) → {Array.<string>|Description}

An array of all selected items in the list.
Parameters:
NameTypeAttributesDescription
selectedItemArray.<string> <optional>
When provided, this method acts as a setter and sets the selectedItems value.
Returns:
If no parameter is provided, the method acts as a getter and returns the current stored selectedItems value; otherwise it returns 'this' for use with the builder pattern.
Type
Array.<string> | Description

size(size[opt]) → {Size|Description}

The object's size in pixels.
Parameters:
NameTypeAttributesDescription
sizeSize <optional>
When provided, this method acts as a setter and sets the size value.
Returns:
If no parameter is provided, the method acts as a getter and returns the current stored size value; otherwise it returns 'this' for use with the builder pattern.
Type
Size | Description

text(text[opt]) → {string|Description}

The text associated with the object.
Parameters:
NameTypeAttributesDescription
textstring <optional>
When provided, this method acts as a setter and sets the text value.
Returns:
If no parameter is provided, the method acts as a getter and returns the current stored text value; otherwise it returns 'this' for use with the builder pattern.
Type
string | Description

windowClassRegExp(windowClassRegExp[opt]) → {string|Description}

The permanent part of the MFC window class.
Parameters:
NameTypeAttributesDescription
windowClassRegExpstring <optional>
When provided, this method acts as a setter and sets the windowClassRegExp value.
Returns:
If no parameter is provided, the method acts as a getter and returns the current stored windowClassRegExp value; otherwise it returns 'this' for use with the builder pattern.
Type
string | Description

windowExtendedStyle(windowExtendedStyle[opt]) → {WindowExtendedStyles|Description}

The extended window style of the object. The possible value is in the enum WindowExtendedStyles
Parameters:
NameTypeAttributesDescription
windowExtendedStyleWindowExtendedStyles <optional>
When provided, this method acts as a setter and sets the windowExtendedStyle value.
Returns:
If no parameter is provided, the method acts as a getter and returns the current stored windowExtendedStyle value; otherwise it returns 'this' for use with the builder pattern.
Type
WindowExtendedStyles | Description

windowId(windowId[opt]) → {number|Description}

The object's window ID.
Parameters:
NameTypeAttributesDescription
windowIdnumber <optional>
When provided, this method acts as a setter and sets the windowId value.
Returns:
If no parameter is provided, the method acts as a getter and returns the current stored windowId value; otherwise it returns 'this' for use with the builder pattern.
Type
number | Description

windowStyle(windowStyle[opt]) → {WindowStyles|Description}

The window style of the object. The possible value is in the enum WindowStyles
Parameters:
NameTypeAttributesDescription
windowStyleWindowStyles <optional>
When provided, this method acts as a setter and sets the windowStyle value.
Returns:
If no parameter is provided, the method acts as a getter and returns the current stored windowStyle value; otherwise it returns 'this' for use with the builder pattern.
Type
WindowStyles | Description

windowTitleRegExp(windowClassRegExp[opt]) → {string|Description}

The constant part of the window title.
Parameters:
NameTypeAttributesDescription
windowClassRegExpstring <optional>
When provided, this method acts as a setter and sets the windowTitleRegExp value.
Returns:
If no parameter is provided, the method acts as a getter and returns the current stored windowTitleRegExp value; otherwise it returns 'this' for use with the builder pattern.
Type
string | Description