List

WPF. List

new List(propsopt) → {List}

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

Methods

absoluteLocation(locationopt) → {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(attachedTextopt) → {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

canFocus(canFocusopt) → {boolean|Description}

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

canSelectMultiple(canSelectMultipleopt) → {boolean|Description}

Indicates whether the container allows more than one child element to be selected concurrently.
Parameters:
NameTypeAttributesDescription
canSelectMultipleboolean <optional>
When provided, this method acts as a setter and sets the canSelectMultiple value.
Returns:
If no parameter is provided, the method acts as a getter and returns the current stored canSelectMultiple value; otherwise it returns 'this' for use with the builder pattern.
Type
boolean | Description

fullNamePath(fullNamePathopt) → {string|Description}

The full hierarchy of the object's name 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(fullTypeopt) → {string|Description}

The full type name of this object.
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

helpText(helpTextopt) → {string|Description}

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

isEnabled(isEnabledopt) → {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(isFocusedopt) → {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

isVisible(isVisibleopt) → {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(itemsopt) → {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

location(locationopt) → {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

name(nameopt) → {string|Description}

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

nativeClass(nativeClassopt) → {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(objectNameopt) → {string|Description}

This object's name as set by the developer.
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(objectPropertiesopt) → {object|Description}

The concrete test object properties including custom properties.
Parameters:
NameTypeAttributesDescription
objectPropertiesobject <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
object | Description

parentText(parentTextopt) → {string|Description}

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

selectedItems(selectedItemsopt) → {string|Description}

The list of items that are selected in the List object.
Parameters:
NameTypeAttributesDescription
selectedItemsstring <optional>
When provided, this method acts as a setter and sets the selectedItems.
Returns:
If no parameter is provided, the method acts as a getter and returns the selectedItems; otherwise it returns 'this' for use with the builder pattern.
Type
string | Description

size(sizeopt) → {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(textopt) → {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

windowTitleRegExp(windowClassRegExpopt) → {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