Open topic with navigation

# ListBox

## WinForms. ListBox

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

## attachedText(attachedTextopt) → {string|Description}

The object's attached text.

##### Parameters:

Name | Type | Attributes | Description
--- | --- | --- | ---
`attachedText` | string | <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

## fullNamePath(fullNamePathopt) → {string|Description}

The full hierarchy of swfname with all parent objects.

##### Parameters:

Name | Type | Attributes | Description
--- | --- | --- | ---
`fullNamePath` | string | <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 object's full type name.

##### Parameters:

Name | Type | Attributes | Description
--- | --- | --- | ---
`fullType` | string | <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(isChildWindowopt) → {boolean|Description}

Indicates whether the object is a child window.

##### Parameters:

Name | Type | Attributes | Description
--- | --- | --- | ---
`isChildWindow` | boolean | <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(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

## isOwnedWindow(isOwnedWindowopt) → {boolean|Description}

Indicates whether the object is an owned window.

##### Parameters:

Name | Type | Attributes | Description
--- | --- | --- | ---
`isOwnedWindow` | boolean | <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(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

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

## nativeClass(nativeClassopt) → {string|Description}

The object's native class.

##### Parameters:

Name | Type | Attributes | Description
--- | --- | --- | ---
`nativeClass` | string | <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}

The object's name.

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

## objectProperties(objectPropertiesopt) → {Dictionary|Description}

The concrete test object properties including custom properties.

##### Parameters:

Name | Type | Attributes | Description
--- | --- | --- | ---
`objectProperties` | Dictionary | <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

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

## windowClassRegExp(windowClassRegExpopt) → {string|Description}

The permanent part of the MFC window class.

##### Parameters:

Name | Type | Attributes | Description
--- | --- | --- | ---
`windowClassRegExp` | string | <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(windowExtendedStyleopt) → {WindowExtendedStyles|Description}

The extended window style of the object. The possible value is in the enum WindowExtendedStyles

##### Parameters:

Name | Type | Attributes | Description
--- | --- | --- | ---
`windowExtendedStyle` | WindowExtendedStyles | <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(windowIdopt) → {number|Description}

The object's window ID.

##### Parameters:

Name | Type | Attributes | Description
--- | --- | --- | ---
`windowId` | number | <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(windowStyleopt) → {WindowStyles|Description}

The window style of the object. The possible value is in the enum WindowStyles

##### Parameters:

Name | Type | Attributes | Description
--- | --- | --- | ---
`windowStyle` | WindowStyles | <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(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