Adding (All) Options to Combo Boxes or List Boxes in Access 2007

Adding (All) Options to Combo Boxes...

Summary: Learn how to add an (All) entry to the list of items displayed in a list box or combo box in Access 2007.

Applies to: 2007 Microsoft Office System, Microsoft Office Access 2007

Joel Krist, Akona Systems

May 2007

Developers frequently use list boxes and combo boxes in Microsoft Office Access 2007 forms to let users specify selection criteria. Adding an (All) option to the list of items can be helpful in scenarios when users might want to select all the items in the list.

This Office Visual How To illustrates how to add an (All) entry to the list of items displayed in a list box or combo box in Access 2007.

This section describes the two key steps:

Creating the custom function that adds the (All) option to a list or combo box.
Setting the RowSourceType property of the list or combo box to the name of the function.

To create the custom function

In Office Access 2007, select the Database Tools tab on the Office Fluent Ribbon.
In the Macro group, click Visual Basic.
To create a new module, on the Insert menu, click Module.

Next, add the following code for the AddAllToList function to the new module, and then save the module.

Visual Basic

Function AddAllToList(ctl As Control, lngID As Long, _
    lngRow As Long, lngCol As Long, _
    intCode As Integer) As Variant

    Static dbs As Database, rst As Recordset
    Static lngDisplayID As Long
    Static intDisplayCol As Integer
    Static strDisplayText As String
    Dim intSemiColon As Integer

    On Error GoTo Err_AddAllToList
        Select Case intCode
            Case acLBInitialize

                ' See if function is already in use.
                If lngDisplayID <> 0 Then
                    MsgBox "AddAllToList is already in use!"
                    AddAllToList = False
                    Exit Function
                End If

                ' Parse the display column and display text
                ' from the Tag property.
                intDisplayCol = 1
                strDisplayText = "(All)"
                If Not IsNull(ctl.Tag) And (ctl.Tag <> "") Then
                    intSemiColon = InStr(ctl.Tag, ";")
                    If intSemiColon = 0 Then
                        intDisplayCol = Val(ctl.Tag)
                    Else
                        intDisplayCol = _
                        Val(Left(ctl.Tag, intSemiColon - 1))
                        strDisplayText = Mid(ctl.Tag, intSemiColon + 1)
                    End If
                End If

                ' Open the recordset defined in the 
                ' RowSource property.
                Set dbs = CurrentDb
                Set rst = dbs.OpenRecordset(ctl.RowSource, _
                    dbOpenSnapshot)

                ' Record and return the lngID for this 
                ' function.
                lngDisplayID = Timer
                AddAllToList = lngDisplayID

            Case acLBOpen
                AddAllToList = lngDisplayID

            Case acLBGetRowCount

                ' Return number of rows in recordset.
                On Error Resume Next

                rst.MoveLast
                AddAllToList = rst.RecordCount + 1

            Case acLBGetColumnCount

                ' Return number of fields (columns) in recordset.
                AddAllToList = rst.Fields.Count

            Case acLBGetColumnWidth
                AddAllToList = -1

            Case acLBGetValue
                If lngRow = 0 Then
                    If lngCol = 0 Or lngCol = intDisplayCol Then
                        AddAllToList = strDisplayText
                    End If
                Else
                    rst.MoveFirst
                    rst.Move lngRow - 1
                    AddAllToList = rst(lngCol)
                End If
            Case acLBEnd
                lngDisplayID = 0
                rst.Close
        End Select

Bye_AddAllToList:
    Exit Function

Err_AddAllToList:
    MsgBox Err.Description, vbOKOnly + vbCritical, "AddAllToList"
    AddAllToList = False
    Resume Bye_AddAllToList
End Function

The next step is to direct Access to call the new AddAllToList function when it inserts items into the item list of a list or combo box.

To set the RowSourceType property

To open the form that contains the list box or combo box in design view, in the Navigation Pane, right-click the form's name, and then select Design View.
Right-click the list or combo box on the form and select Properties.
In the Properties dialog box, select the Data tab to display the data-related properties.
Locate the RowSourceType property and set its value to AddAllToList.

Save the form and then display it in Form View. The list of items in the list or combo box should now display an (All) item.

Developers use list boxes and combo boxes in Access 2007 forms to let users specify selection criteria. For example, a common scenario is to bind a combo box display list to an Access database table and map the list items to the items in the table rows. In some scenarios, it might be useful to add an (All) option to the list of items so that the user can specify all items in the combo box.

To add an (All) item to the list, you first create a custom function that adds the option to the list box or combo box, and then you set the RowSourceType property to the name of this function.

Adding All Options to Combo Boxes or List Boxes

Watch the Video

Video Length: 00:07:26

File Size: 6.12 MB WMV

Tags

: access2007 (x) combobox (x) listbox (x) office2007 (x) video (x) Add a tag

Community Content

Add new content

Annotations

.Tag and two helpful functions

jstout | Edit |

It's not immediately obvious from the code what role the .Tag plays in this but the code suggests that it either contains the ordinal of the field that is to be displayed in the drop down box and the value that is to be displayed for (All), perhaps to allow customisation by country separated by a semi-colon, e.g., 1;(Alles). It might be better to use the name of the field and alter the field selection code to something like rst.Fields(strFieldName).Value.

The idiom of splitting something up depending on a character position in this way is so common I have defined two functions to help:

Public Function LeftPart(ofString As String, upToFirstOccurrenceOf As String) As String
'
'Give the left hand 'part' ofString, from the leftmost character upToFirstOccurrence (a character or
' string, e.g., LeftPart("HENSHAW, Fred:SO13/05",":") = "HENSHAW, Fred". If there is no occurrence
' of the delimiter character then return the entire string (including the empty string case)
'
LeftPart = Left(ofString, InStr(ofString & upToFirstOccurrenceOf, upToFirstOccurrenceOf) - 1)
End Function

and

Public Function RightPart(ofString As String, fromFirstOccurrenceOf As String) As String
'
'Give the right hand 'part' ofString, from the leftmost character fromFirstOccurrence (a character or
' string, e.g., RightPart("HENSHAW, Fred:SO13/05",":") = "SO13/05". If there is no occurrence
' of the delimiter character then return a null string (including the empty string case)
'
RightPart = Mid(ofString, InStr(ofString & fromFirstOccurrenceOf, fromFirstOccurrenceOf) + Len(fromFirstOccurrenceOf))
End Function

Product Families

Resources

About Microsoft

Popular Places

Popular Searches

Popular Downloads

To create the custom function

To set the RowSourceType property