new ListBox(propsopt) → {ListBox}
The description of a ListBox test object.
Parameters:
Name | Type | Attributes | Description |
---|
props | Object |
<optional>
| Initializes a ListBox test object using the supplied property bag. |
Returns:
the description object that was initialized.
-
Type
- ListBox
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:
Name | Type | Attributes | Description |
---|
location | Point |
<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
isEnabled(isEnabledopt) → {boolean|Description}
Indicates whether the object is enable.
Parameters:
Name | Type | Attributes | Description |
---|
isEnabled | boolean |
<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:
Name | Type | Attributes | Description |
---|
isFocused | boolean |
<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
isRightAligned(isRightAlignedopt) → {boolean|Description}
Indicates whether the object is right aligned.
Parameters:
Name | Type | Attributes | Description |
---|
isRightAligned | boolean |
<optional>
| When provided, this method acts as a setter and sets the isRightAligned value. |
Returns:
If no parameter is provided, the method acts as a getter and returns the current stored isRightAligned value;
otherwise it returns 'this' for use with the builder pattern.
-
Type
- boolean
|
Description
isRightToLeftLayout(isRightToLeftLayoutopt) → {boolean|Description}
Indicates whether the object is Right to Left layout.
Parameters:
Name | Type | Attributes | Description |
---|
isRightToLeftLayout | boolean |
<optional>
| When provided, this method acts as a setter and sets the isRightToLeftLayout value. |
Returns:
If no parameter is provided, the method acts as a getter and returns the current stored isRightToLeftLayout value;
otherwise it returns 'this' for use with the builder pattern.
-
Type
- boolean
|
Description
isRightToLeftReading(isRightToLeftReadingopt) → {boolean|Description}
Indicates whether the object is Right to Left reading.
Parameters:
Name | Type | Attributes | Description |
---|
isRightToLeftReading | boolean |
<optional>
| When provided, this method acts as a setter and sets the isRightToLeftReading value. |
Returns:
If no parameter is provided, the method acts as a getter and returns the current stored isRightToLeftReading 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:
Name | Type | Attributes | Description |
---|
isVisible | boolean |
<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:
Name | Type | Attributes | Description |
---|
items | Array.<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(itemsCountopt) → {number|Description}
The number of items in the list box.
Parameters:
Name | Type | Attributes | Description |
---|
itemsCount | number |
<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(locationopt) → {Point|Description}
The object's coordinates relative to the parent's location in pixels.
Parameters:
Name | Type | Attributes | Description |
---|
location | Point |
<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
objectName(objectNameopt) → {string|Description}
The object's name as set by the developer.
Parameters:
Name | Type | Attributes | Description |
---|
objectName | string |
<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
selectedItems(selectedItemopt) → {Array.<string>|Description}
An array of all selected items in the list.
Parameters:
Name | Type | Attributes | Description |
---|
selectedItem | Array.<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(sizeopt) → {Size|Description}
The object's size in pixels.
Parameters:
Name | Type | Attributes | Description |
---|
size | Size |
<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:
Name | Type | Attributes | Description |
---|
text | string |
<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:
Name | Type | Attributes | Description |
---|
windowClassRegExp | string |
<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