Returning a Value from a List Box in Visual Basic

MORE INFORMATION

Microsoft provides programming examples for illustration only, without warranty either expressed or implied. This includes, but is not limited to, the implied warranties of merchantability or fitness for a particular purpose. This article assumes that you are familiar with the programming language that is being demonstrated and with the tools that are used to create and to debug procedures. Microsoft support engineers can help explain the functionality of a particular procedure, but they will not modify these examples to provide added functionality or construct procedures to meet your specific requirements. The List property returns all the values in the list box as an array of strings. The ListIndex property returns an integer indicating the position of the selected item within the List array. By combining these two properties, you can retrieve the selected text value. The following code example demonstrates how to retrieve the selected text value from a list box on a dialog sheet.

Visual Basic Code Example

   Sub GetSelectedListText()

      ' Display the dialog box.
      DialogSheets(1).Show

      ' Set a variable named "SelectedText" to the selected
      ' value in the list box.
      With DialogSheets(1).ListBoxes(1)
         SelectedText = .List(.ListIndex)
      End With

      ' Display the selected value in a message box.
      MsgBox SelectedText

   End Sub
				

Note: Instead of the using the ListIndex property of List, you could use the Value property of List. The Value property for a listbox will return a number from 1 to the number of items in the list.