ListBox object (Outlook Forms Script)
Displays a list of values and lets you select one or more.
Remarks
If the ListBox is bound to a data source, the ListBox stores the selected value in that data source.
The ListBox can either appear as a list or as a group of OptionButton controls or CheckBox controls.
The default property for a ListBox is the Value property.
The default event for a ListBox is the Click event.
You can't drop text into a drop-down ListBox.
ListBox styles
You can choose between two presentation styles for a ListBox. This is expressed by the ListStyle property. Each style provides different ways for users to select items in the list.
If the style is 0, each item is on a separate row; the user selects an item by highlighting one or more rows.
If the style is 1, an OptionButton or CheckBox appears at the beginning of each row. With this style, the user selects an item by clicking the option button or check box. Check boxes appear only when the MultiSelect property is True.
Events
| Name | Description |
|---|---|
| Click | Occurs when the user definitively selects a value for the control that has more than one possible value. |
Methods
| Name | Description |
|---|---|
| AddItem | For a single-column ListBox, the AddItem method adds an item to the list. For a multicolumn ListBox, this method adds a row to the list. |
| Clear | Removes all entries in the list in a ListBox. |
| RemoveItem | Removes a row from the list in a ListBox. |
Properties
| Name | Description |
|---|---|
| BackColor | Returns or sets a Long that specifies the background color of the object. Read/write. |
| BorderColor | Returns or sets a Long that specifies the border color of an object. Read/write. |
| BorderStyle | Returns or sets an Integer that specifies the type of border of the control. Read/write. |
| BoundColumn | Returns or sets a Variant that identifies the source of data in a multicolumn ListBox. Read/write. |
| Column | Returns or sets a Variant that represents a single value, a column of values, or a two-dimensional array to load into a ListBox. Read/write. |
| ColumnCount | Returns or sets a Long that represents the number of columns to display in a list box. Read/write. |
| ColumnHeads | Returns or sets a Boolean that specifies whether a single row of column headings are displayed. Read/write. |
| ColumnWidths | Returns or sets a String that specifies the width of each column in a multicolumn ListBox. Read/write. |
| Enabled | Returns or sets a Boolean that specifies whether a control can receive the focus and respond to user-generated events. Read/write. |
| ForeColor | Returns or sets a Long that specifies the foreground color of an object. Read/write. |
| IMEMode | Returns or sets an Integer that specifies the default run-time mode of the Input Method Editor (IME) for a control. Read/write. |
| IntegralHeight | Returns or sets a Boolean that specifies whether a ListBox displays full lines of text in a list or partial lines. Read/write. |
| List | Returns or sets a Variant that represents the specified entry in a ListBox. Read/write. |
| ListCount | Returns a Long that represents the number of list entries in a control. Read-only. |
| ListIndex | Returns or sets a Variant that represents the currently selected item in a ListBox. Read/write. |
| ListStyle | Returns or sets an Integer that specifies the visual appearance of the list in a ListBox. Read/write. |
| Locked | Returns or sets a Boolean that specifies whether a control can be edited. Read/write. |
| MatchEntry | Returns or sets an Integer that indicates how a ListBox searches its list as the user types. Read/write. |
| MouseIcon | Returns a String that represents the full path name of a custom icon that is to be assigned to the control. Read-only. |
| MousePointer | Returns or sets an Integer that specifies the type of pointer displayed when the user positions the mouse over a particular object. Read/write. |
| MultiSelect | Returns or sets an Integer that indicates whether the object permits multiple selections. Read/write. |
| Selected | Returns or sets a Boolean that indicates the selection state of items in a ListBox. Read/write. |
| SpecialEffect | Returns or sets an Integer that specifies the visual appearance of an object. Read/write. |
| Text | Returns or sets a String that specifies text in a ListBox, changing the selected row in the control. Read/write. |
| TextAlign | Returns or sets an Integer that specifies how text is aligned in a control. Read/write. |
| TextColumn | Returns or sets a Variant that identifies the column in a ListBox to display to the user. Read/write. |
| TopIndex | Returns or sets a Long that represents the index of the list item displayed in the topmost position in the list. Read/write. |
| Value | Returns or sets a Variant that specifies the value in the BoundColumn of the currently selected rows. Read/write. |
Support and feedback
Have questions or feedback about Office VBA or this documentation? Please see Office VBA support and feedback for guidance about the ways you can receive support and provide feedback.