ComboBox

From Xojo Documentation
Jump to: navigation, search

Class (inherits from PopupMenu)

A ComboBox is a combination of a TextField and a PopupMenu. The user can type in the field or click to select an item from a list.

Events
Change DropObject MouseExit
Close GotFocus MouseMove
ConstructContextualMenu KeyDown MouseUp
ContextualMenuAction KeyUp MouseWheel
DragEnter LostFocus Open
DragExit MouseDown TextChanged
DragOver MouseEnter


Properties
Active ReadOnlyProperty.png List ReadOnlyProperty.png SelLength
AutoComplete ListCount ReadOnlyProperty.png SelStart
AutoDeactivate ListIndex TabIndex
Bold LockBottom TabStop
DataField ReadOnlyProperty.png LockLeft Text
DataSource ReadOnlyProperty.png LockRight TextFont
Enabled LockTop TextSize
Handle ReadOnlyProperty.png MouseCursor Top
Height MouseX ReadOnlyProperty.png TrueWindow ReadOnlyProperty.png
HelpTag MouseY ReadOnlyProperty.png Underline
Index ReadOnlyProperty.png Name UseFocusRing
InitialValue ReadOnlyProperty.png PanelIndex Visible
Italic Parent Width
Left Scope ReadOnlyProperty.png Window ReadOnlyProperty.png


Methods
AcceptFileDrop AddSeparator Refresh
AcceptPictureDrop Close RefreshRect
AcceptRawDataDrop DeleteAllRows RemoveRow
AcceptTextDrop DrawInto RowTag
AddRow InsertRow SetFocus
AddRows Invalidate

Notes

The ComboBox height is limited to just a single size on macOS, so any changes to the Height property are ignored.

On macOS, the maximum number of visible rows in the dropdown is 15. You can adjust this number using this declare, passing in the ComboBox's handle for controlHandle:

Declare Sub setNumberOfVisibleItems Lib "AppKit" Selector "setNumberOfVisibleItems:" (controlHandle As Integer, count As Integer)
setNumberOfVisibleItems(MyComboBox.Handle, 30)

Examples

This code in the Open event handler populates a ComboBox and sets the initial value to the current month:

Dim s As String
Dim last As Integer
Dim d As New Date
s = "January,February,March,April,May,June,July," _
+ "August,September,October,November,December"
last = CountFields(s, ",")
For i As Integer = 1 To last
Me.AddRow(NthField(s, ",", i))
Next
Me.ListIndex = d.Month - 1

The value of the ListIndex property contains the index of the selected item, but it does not indicate whether the user has entered text into the ComboBox. Examine the Text property to get the current menu selection or the text entered by the user. For example, the following line in the TextChanged event handler displays either the currently selected menu item or the text typed into the ComboBox.

Label1.Text = Me.Text

This example adds an item to a ComboBox in its Open event handler.

Me.AddRow("October")

This example opens a new window when an item is chosen.

Sub Change()
Dim w As ListEditorWindow
If ComboBox1.Text = "Edit List..." Then
w = New ListEditorWindow
End If
End Sub

The following line changes the selected item in a ComboBox

ComboBox1.ListIndex = 3

See Also

TextField, PopupMenu controls; RectControl class.

Personal tools
Namespaces

Variants
Actions
Main
Content
Starting Out
Dig Deeper
More Help
Toolbox
About