ListBox Members (Access)

GitHub-Mark-64px

Contribute to this content

Use GitHub to suggest and submit changes. See our guidelines for contributing to VBA documentation.

This object corresponds to a list box control. The list box control displays a list of values or alternatives.

Events

Name

Description

AfterUpdate

The AfterUpdate event occurs after changed data in a control or record is updated.

BeforeUpdate

The BeforeUpdate event occurs before changed data in a control or record is updated.

Click

The Click event occurs when the user presses and then releases a mouse button over an object.

DblClick

The DblClick event occurs when the user presses and releases the left mouse button twice over an object within the double-click time limit of the system.

Enter

The Enter event occurs before a control actually receives the focus from a control on the same form or report.

Exit

The Exit event occurs just before a control loses the focus to another control on the same form or report.

GotFocus

The GotFocus event occurs when the specified object receives the focus.

KeyDown

The KeyDown event occurs when the user presses a key while a form or control has the focus. This event also occurs if you send a keystroke to a form or control by using the SendKeys action in a macro or the SendKeys statement in Visual Basic.

KeyPress

The KeyPress event occurs when the user presses and releases a key or key combination that corresponds to an ANSI code while a form or control has the focus. This event also occurs if you send an ANSI keystroke to a form or control by using the SendKeys action in a macro or the SendKeys statement in Visual Basic.

KeyUp

The KeyUp event occurs when the user releases a key while a form or control has the focus. This event also occurs if you send a keystroke to a form or control by using the SendKeys action in a macro or the SendKeys statement in Visual Basic.

LostFocus

The LostFocus event occurs when the specified object loses the focus.

MouseDown

The MouseDown event occurs when the user presses a mouse button.

MouseMove

The MouseMove event occurs when the user moves the mouse.

MouseUp

The MouseUp event occurs when the user releases a mouse button.

Methods

Name

Description

AddItem

Adds a new item to the list of values displayed by the specified list box control.

Move

Moves the specified object to the coordinates specified by the argument values.

RemoveItem

Removes an item from the list of values displayed by the specified list box control.

Requery

The Requery method updates the data underlying a specified control that's on the active form by requerying the source of data for the control.

SetFocus

The SetFocus method moves the focus to the specified form, the specified control on the active form, or the specified field on the active datasheet.

SizeToFit

You can use the SizeToFit method to size a control so it fits the text or image that it contains.

Undo

You can use the Undo method to reset a control or form when its value has been changed.

Properties

Name

Description

AddColon

Specifies whether a colon follows the text in labels for new controls. Read/write Boolean.

AfterUpdate

Returns or sets which macro, event procedure, or user-defined function runs when the AfterUpdate event occurs. Read/write String.

AllowValueListEdits

Gets or sets whether the Edit List Items command is available when the user right-clicks a list box. Read/write Boolean.

Application

You can use the Application property to access the active Microsoft Access Application object and its related properties. Read-only Application object.

AutoLabel

Specifies whether labels are automatically created and attached to new controls. Read/write Boolean.

BackColor

Gets or sets the interior color of the specified object. Read/write Long.

BackShade

Gets or sets the shade applied to the theme color in the BackColor property of the specified object. Read/write Single.

BackThemeColorIndex

Gets or sets a value that represents a color in the applied color theme associated with the BackColor property of the specified object. Read/write Long.

BackTint

Gets or sets the tint that is applied to the theme color in the BackColor property of the specified object. Read/write Single.

BeforeUpdate

Returns or sets which macro, event procedure, or user-defined function runs when the BeforeUpdate event occurs. Read/write String.

BorderColor

You can use the BorderColor property to specify the color of a control's border. Read/write Long.

BorderShade

Gets or sets the shade that is applied to the theme color in the BorderColor property of the specified object. Read/write Single.

BorderStyle

Specifies how a control's border appears.Read/write Byte.

BorderThemeColorIndex

Gets or sets a value that represents a color in the applied color theme associated with the BorderColor property of the specified object. Read/write Long.

BorderTint

Gets or sets the tint that is applied to the theme color in the BorderColor property of the specified object. Read/write Single.

BorderWidth

You can use the BorderWidth property to specify the width of a control's border. Read/write Byte.

BottomPadding

Gets or sets the amount of space (in inches) between the list box and its bottom gridline. Read/write Integer.

BoundColumn

When you make a selection from a list box, the BoundColumn property tells Microsoft Access which column's values to use as the value of the control. If the control is bound to a field, the value in the column specified by the BoundColumn property is stored in the field named in the ControlSource property. Read/write Long.

Column

You can use the Column property to refer to a specific column, or column and row combination, in a multiple-column combo box or list box. Read-only Variant.

ColumnCount

You can use the ColumnCount property to specify the number of columns displayed in a list box or in the list box portion of a combo box, or sent to OLE objects in a chart control or unbound object frame . Read/write Integer.

ColumnHeads

You can use the ColumnHeads property to display a single row of column headings for list boxes, combo boxes, and OLE objects that accept column headings. You can also use this property to create a label for each entry in a chart control . What is actually displayed as the first-row column heading depends on the object's RowSourceType property setting. Read/write Boolean.

ColumnHidden

You can use the ColumnHidden property to show or hide a specified column in Datasheet view. Read/write Boolean.

ColumnOrder

You can use the ColumnOrder property to specify the order of the columns in Datasheet view. Read/write Integer.

ColumnWidth

You can use the ColumnWidth property to specify the width of a column in Datasheet view. Read/write Integer.

ColumnWidths

You can use the ColumnWidths property to specify the width of each column in a multiple-column list box. Read/write String.

Controls

Returns the Controls collection of a form, subform, report or section. Read-only Controls.

ControlSource

You can use the ControlSource property to specify what data appears in a control. You can display and edit data bound to a field in a table, query, or SQL statement. You can also display the result of an expression. Read/write String.

ControlTipText

You can use the ControlTipText property to specify the text that appears in a ScreenTip when you hold the mouse pointer over a control. Read/write String.

ControlType

You can use the ControlType property in Visual Basic to determine the type of a control on a form or report. Read/write Byte.

DefaultValue

Specifies a value that is automatically entered in a field when a new record is created. For example, in an Addresses table you can set the default value for the City field to New York. When users add a record to the table, they can either accept this value or enter the name of a different city. Read/write String.

DisplayWhen

You can use the DisplayWhen property to specify which of a form's controls you want displayed on screen and in print. Read/write Byte.

Enabled

You can use the Enabled property to set or return the status of the conditional format in the FormatCondition object. Read/write Boolean.

EventProcPrefix

Gets or sets the prefix portion of an event procedure name. Read/write String.

FontBold

You can use the FontBold property to specify whether a font appears in a bold style in the following situations:

FontItalic

You can use the FontItalic property to specify whether text is italic in the following situations:

FontName

You can use the FontName property to specify the font for text in the following situations:

FontSize

You can use the FontSize property to specify the point size for text in the following situations:

FontUnderline

You can use the FontUnderline property to specify whether text is underlined in the following situations:

FontWeight

You can use the DatasheetFontWeight property to specify the line width of the font used to display and print characters for field names and data in Datasheet view. Read/write Integer.

ForeColor

You can use the ForeColor property to specify the color for text in a control. Read/write Long.

ForeShade

Gets or sets the shade that is applied to the theme color in the ForeColor property of the specified object. Read/write Single.

ForeThemeColorIndex

Gets or sets a value that represents a color in the applied color theme associated with the ForeColor property of the specified object. Read/write Long.

ForeTint

Gets or sets the tint that is applied to the theme color in the ForeColor property of the specified object. Read/write Single.

GridlineColor

Gets or sets the color of the gridline for the specified list box. Read/write Long.

GridlineShade

Gets or sets the shade applied to the theme color in the GridlineColor property of the specified object. Read/write Single.

GridlineStyleBottom

Gets or sets the bottom gridline style of the specified list box. Read/write Byte.

GridlineStyleLeft

Gets or sets the width of the bottom gridline for the specified list box. Read/write Byte.

GridlineStyleRight

Gets or sets the right gridline style of the specified list box. Read/write Byte.

GridlineStyleTop

Gets or sets the top gridline style of the specified list box. Read/write Byte.

GridlineThemeColorIndex

Gets or sets the theme color index that represents a color in the applied color theme associated with the GridlineColor property of the specified object. Read/write Long.

GridlineTint

Gets or sets the tint applied to the theme color in the GridlineColor property of the specified object. Read/write Single.

GridlineWidthBottom

Gets or sets the width of the bottom gridline for the specified list box. Read/write Byte.

GridlineWidthLeft

Gets or sets the width of the left gridline for the specified list box. Read/write Byte.

GridlineWidthRight

Gets or sets the width of the right gridline for the specified list box. Read/write Byte.

GridlineWidthTop

Gets or sets the width of the top gridline for the specified list box. Read/write Byte.

Height

Gets or sets the height of the specified object in twips. Read/write Integer.

HelpContextId

The HelpContextID property specifies the context ID of a topic in the custom Help file specified by the HelpFile property setting. Read/write Long.

HideDuplicates

You can use the HideDuplicates property to hide a control on a report when its value is the same as in the preceding record. Read/write Boolean.

HorizontalAnchor

Gets or sets an AcHorizontalAnchor constant that indicates how the list box is anchored horizontally within its layout. Read/write.

Hyperlink

You can use the Hyperlink property to return a reference to a Hyperlink object. You can use the Hyperlink property to access the properties and methods of a control's hyperlink. Read-only.

IMEHold

Language-specific information You can use the IMEHold/Hold KanjiConversionMode property to show whether the Kanji Conversion Mode is maintained when the control loses the focus. Read/write Boolean.

IMEMode

IMESentenceMode

InheritValueList

Gets or sets whether a list box's value list is inherited from its field. Read/write Boolean.

InSelection

You can use the InSelection property to determine or specify whether a control on a form in Design view is selected. Read/write Boolean.

IsVisible

You can use the IsVisible property in to determine whether a control on a report is visible. Read/write Boolean.

ItemData

The ItemData property returns the data in the bound column for the specified row in a list box. Read-only Variant.

ItemsSelected

You can use the ItemsSelected property to return a read-only reference to the hidden ItemsSelected collection. This hidden collection can be used to access data in the selected rows of a multiselect list box control.

LabelAlign

The property specifies the text alignment within attached labels on new controls. Read/write Byte.

LabelX

The LabelX property (along with the LabelY property) specifies the placement of the label for a new control. Read/write Integer.

LabelY

The LabelY property (along with the LabelX property) specifies the placement of the label for a new control. Read/write Integer.

Layout

Returns the type of layout for the specified list box. Read-only AcLayoutType.

LayoutID

Returns the unique identifier for the layout that contains the specified list box. Read-only Long.

Left

You can use the Left property to specify an object's location on a form or report. Read/write Integer.

LeftPadding

Gets or sets the amount of space (in inches) between the list box and its left gridline. Read/write Integer.

ListCount

You can use the ListCount property to determine the number of rows in a list box. Read/write Long.

ListIndex

You can use the ListIndex property to determine which item is selected in a list box. Read/write Long.

ListItemsEditForm

Gets or sets the name of the form that is displayed when the user clicks Edit List Items. Read/write String.

Locked

The Locked property specifies whether you can edit data in a control in Form view. Read/write Boolean.

MultiSelect

You can use the MultiSelect property to specify whether a user can make multiple selections in a list box on a form and how the multiple selections can be made. Read/write Byte.

Name

You can use the Name property to specify or determine the string expression that identifies the name of an object. Read/write String.

NumeralShapes

OldBorderStyle

You can use this property to set or returns the unedited value of the BorderStyle property for a form or control. This property is useful if you need to revert to an unedited or preferred border style. Read/write Byte.

OldValue

You can use the OldValue property to determine the unedited value of a bound control. Read-only Variant.

OnClick

Sets or returns the value of the On Click box in the Properties window. Read/write String.

OnDblClick

Sets or returns the value of the On Dbl Click box in the Properties window. Read/write String.

OnEnter

Sets or returns the value of the On Enter box in the Properties window of specified object. Read/write String. .

OnExit

Sets or returns the value of the On Exit box in the Properties window of specified object. Read/write String. .

OnGotFocus

Sets or returns the value of the On Got Focus box in the Properties window of the specified object. Read/write String.

OnKeyDown

Sets or returns the value of the On Key Down box in the Properties window. Read/write String.

OnKeyPress

Sets or returns the value of the On Key Press box in the Properties window. Read/write String.

OnKeyUp

Sets or returns the value of the On Key Up box in the Properties window. Read/write String.

OnLostFocus

Sets or returns the value of the On Lost Focus box in the Properties window of the specified object. Read/write String.

OnMouseDown

Sets or returns the value of the On Mouse Down box in the Properties window. Read/write String.

OnMouseMove

Sets or returns the value of the On Mouse Move box in the Properties window. Read/write String.

OnMouseUp

Sets or returns the value of the On Mouse Up box in the Properties window. Read/write String.

Parent

Returns the parent object for the specified object. Read-only.

Properties

Returns a reference to a control's Properties collection object. Read-only.

ReadingOrder

You can use the ReadingOrder property to specify or determine the reading order of words in text. Read/write Byte.

Recordset

Returns or sets the ADO Recordset or DAO Recordset object representing the record source for the specified object. Read/write Object.

RightPadding

Gets or sets the amount of space (in inches) between the list box and its right gridline. Read/write Integer.

RowSource

You can use the RowSource property (along with the RowSourceType property) to tell Microsoft Access how to provide data tothe specified object. Read/write String.

RowSourceType

You can use the RowSourceType property (along with the RowSource property) to tell Microsoft Access how to provide data tothe specified object. Read/write String.

ScrollBarAlign

You can use the ScrollBarAlign to specify or determine the alignment of a vertical scroll bar. Read/write Byte.

Section

You can identify these controls by the section of a form or report where the control appears. Read/write Integer.

Selected

You can use the Selected property in Visual Basic to determine if an item in a list box is selected. Read/write Long.

ShortcutMenuBar

You can use the ShortcutMenuBar property to specify the shortcut menu that will appear when you right-click on the specified object. Read/write String.

ShowOnlyRowSourceValues

Gets or sets whether the list box can display values that aren't specified by the RowSource property. Read/write Boolean.

SmartTags

Returns a SmartTags collection that represents the collection of smart tags that have been added to a control. .

SpecialEffect

You can use the SpecialEffect property to specify whether special formatting will apply to the specified object. Read/write Byte.

StatusBarText

You can use the StatusBarText property to specify the text that is displayed in the status bar when a control is selected. Read/write String.

TabIndex

You can use the TabIndex property to specify a control's place in the tab order on a form or report. Read/write Integer.

TabStop

You can use the TabStop property to specify whether you can use the TAB key to move the focus to a control. Read/write Boolean.

Tag

Stores extra information about a form, report, section, or control needed by a Microsoft Access application. Read/write String.

ThemeFontIndex

Gets or sets the font index that represents a font in the applied theme associated with the FontName property of the specified object. Read/write Long.

Top

You can use the Top property to specify an object's location on a form or report. Read/write Integer. .

TopPadding

Gets or sets the amount of space (in inches) between the list box and its top gridline. Read/write Integer.

ValidationRule

You can use the ValidationRule property to specify requirements for data entered into a record, field, or control. When data is entered that violates the ValidationRule setting, you can use the ValidationText property to specify the message to be displayed to the user. Read/write String.

ValidationText

Use the ValidationText property to specify a message to be displayed to the user when data is entered that violates a ValidationRule setting for a record, field, or control. Read/write String.

Value

Determines or specifies which value or option in the list box is selected. Read/write Variant.

VerticalAnchor

Gets or sets an AcVerticalAnchor constant that indicates how the specified list box is anchored vertically within its layout. Read/write.

Visible

Returns or sets whether the object is visible. Read/write Boolean.

Width

Gets or sets the width of the specified object in twips. Read/write Integer.