Class # ComboBox (deprecated) ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

Warning

This item was deprecated in version 2021r3. Please use `DesktopComboBox` as a replacement.

## Description 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. ## Properties

table-centered_columns_3_and_4

| Name | Type | Read-Only | Shared | |-----------------------------------------------------|--------------------------------------------------------|-----------|--------| | `Active` | `Boolean` | ✓ | | | `AllowAutoComplete` | `Boolean` | | | | `AllowAutoDeactivate` | `Boolean` | | | | `AllowFocusRing` | `Boolean` | | | | `AllowTabStop` | `Boolean` | | | | `Bold` | `Boolean` | | | | `Enabled` | `Boolean` | | | | `FontName` | `String` | | | | `FontSize` | `Single` | | | | `FontUnit` | `FontUnits` | | | | `Handle` | `Integer` | ✓ | | | `Height` | `Integer` | | | | `Index` | `Integer` | ✓ | | | `InitialValue` | `String` | ✓ | | | `Italic` | `Boolean` | | | | `LastAddedRowIndex` | `Integer` | ✓ | | | `LastRowIndex` | `Integer` | ✓ | | | `Left` | `Integer` | | | | `LockBottom` | `Boolean` | | | | `LockLeft` | `Boolean` | | | | `LockRight` | `Boolean` | | | | `LockTop` | `Boolean` | | | | `MouseCursor` | `MouseCursor` | | | | `MouseX` | `Integer` | ✓ | | | `MouseY` | `Integer` | ✓ | | | `Name` | `String` | ✓ | | | `PanelIndex` | `Integer` | | | | `Parent` | `Control` | | | | `RowCount` | `Integer` | ✓ | | | `RowValueAt` | `String` | ✓ | | | `Scope` | `Integer` | ✓ | | | `SelectedRow` | `String` | ✓ | | | `SelectedRowIndex` | `Integer` | | | | `SelectionLength` | `Integer` | | | | `SelectionStart` | `Integer` | | | | `TabIndex` | `Integer` | | | | `Tooltip` | `String` | | | | `Top` | `Integer` | | | | `Transparent` | `Boolean` | | | | `TrueWindow` | `Window` | ✓ | | | `Underline` | `Boolean` | | | | `Visible` | `Boolean` | | | | `Width` | `Integer` | | | | `Window` | `Window` | ✓ | | ## Methods

table-centered_column_4

| Name | Parameters | Returns | Shared | |---------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------|------------------------------------|--------| | `AcceptFileDrop` | FileType As `String` | | | | `AcceptPictureDrop` | | | | | `AcceptRawDataDrop` | Type As `String` | | | | `AcceptTextDrop` | | | | | `AddAllRows` | Items() As `String` | | | | `AddRow` | Item As `String` | | | | `AddRowAt` | RowNumber As `Integer`, Item As `String` | | | | `AddSeparator` | | | | | `Close` | | | | | `DrawInto` | g As `Graphics`, x As `Integer`, y As `Integer` | | | | `Invalidate` | \[EraseBackground As `Boolean`\] | | | | `Refresh` | eraseBackground As `Boolean` | | | | `RemoveAllRows` | | | | | `RemoveRowAt` | Index As `Integer` | | | | `RowTagAt` | index As `Integer` | `Variant` | | | `SelectRowWithTag` | value As `Variant` | | | | `SelectRowWithValue` | value As `String` | | | | `SetFocus` | | | | ## Events

table-centered_column_4

| Name | Parameters | Returns | |-------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------| | `Change` | | | | `Close` | | | | `ConstructContextualMenu` | Base As `MenuItem`, x As `Integer`, y As `Integer` | `Boolean` | | `ContextualMenuAction` | HitItem As `MenuItem` | `Boolean` | | `DragEnter` | obj As `DragItem`, Action As `Integer` | `Boolean` | | `DragExit` | obj As `DragItem`, Action As `Integer` | | | `DragOver` | x As `Integer`, y As `Integer`, obj As `DragItem`, Action As `Integer` | `Boolean` | | `DropObject` | Obj As `DragItem` Action As `Integer` | | | `GotFocus` | | | | `KeyDown` | Key As `String` | `Boolean` | | `KeyUp` | Key As `String` | | | `LostFocus` | | | | `MouseDown` | x As `Integer`, y As `Integer` | `Boolean` | | `MouseEnter` | | | | `MouseExit` | | | | `MouseMove` | X As `Integer`, Y As `Integer` | | | `MouseUp` | x As `Integer`, y As `Integer` | | | `MouseWheel` | X As `Integer`, Y As `Integer`, DeltaX As `Integer`, DeltaY As `Integer` | `Boolean` | | `Open` | | | | `TextChanged` | | | ## Property descriptions

---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

forsearch

ComboBox.Active **Active** As `Boolean` Indicates whether the `RectControl` is active. This property is read-only. Active is `False` when the `RectControl`'s window is not in the foreground. When a `Window` is deactivated, its controls are automatically deactivated unless `AutoDeactivate` is set to `False`.

forsearch

ComboBox.AllowAutoComplete **AllowAutoComplete** As `Boolean` If `True`, enables the autocomplete feature to complete text entries. The default is `False`. ``` xojo Me.AllowAutoComplete = True ```

forsearch

ComboBox.AllowAutoDeactivate **AllowAutoDeactivate** As `Boolean` Determines whether the control should be deactivated (on macOS) when the parent window is deactivated. The default is `True`.

forsearch

ComboBox.AllowFocusRing **AllowFocusRing** As `Boolean` If `True`, the control indicates that it has the focus with a ring around its border; if `False`, the appearance of the control does not change when it has the focus. At present, the focus ring appears only on macOS and Linux. On all platforms, the ComboBox gets a text insertion point when it has the focus. The default is `True`. The following code turns off AllowFocusRing. ``` xojo ComboBox1.AllowFocusRing = False ```

forsearch

ComboBox.AllowTabStop **AllowTabStop** As `Boolean` If `True`, the **RectControl** is in the Tab Order and accepts the focus when the user tabs into it. The default is `True`. If `False`, the user cannot tab into it to give it the focus. However, the **RectControl** can gain the focus by other means, such as the user's clicking on it or by setting the focus in code. This example removes the control from the Tab Order: ``` xojo Me.AllowTabStop = False ```

forsearch

ComboBox.Bold **Bold** As `Boolean` If `True`, applies the bold style to the control's caption and/or its text content if any. Mac apps can only display font styles that are available. You cannot force a font to display in bold or italic if it does not have bold or italic variations available. In this situation, the Bold property will not affect the font.

forsearch

ComboBox.Enabled **Enabled** As `Boolean` Determines if the control should be enabled when the owning window is opened. A disabled control cannot be clicked and cannot receive the focus. This example disables the control. Its caption is grayed out. ``` xojo Me.Enabled = False ```

forsearch

ComboBox.FontName **FontName** As `String` Name of the font used to display the item in the menu. You can enter any font that is installed on the computer or the names of the two metafonts, "System" and "SmallSystem". The System font is the font used by the system software as its default font. Different operating systems use different default fonts. If the system software supports both a large and small System font, you can also specify the "SmallSystem" font as your TextFont. On macOS, "SmallSystem" specifies the OS's smaller system font and may make the control smaller in size as well. On Windows and Linux, "SmallSystem" is the same as "System". This code sets the FontName property. ``` xojo Me.FontName = "Helvetica" ```

forsearch

ComboBox.FontSize **FontSize** As `Single` Point size of the font used to display the menu items. If you enter zero as the FontSize, your app will use the font size that works best for the platform on which it is running. This code sets the font size to 16 points. ``` xojo Me.FontSize = 16 ```

forsearch

ComboBox.FontUnit **FontUnit** As `FontUnits` The units in which FontSize is measured.

forsearch

ComboBox.Handle **Handle** As `Integer` Returns a handle to the control. This property is read-only. For interfacing with Mac APIs using `` Declare`s, RectControl.Handle returns NSViews (except for :doc:`Toolbar ``). On Windows returns the HWND of the control. On Linux it returns a GtkWidget. The following gets a handle to the control. ``` xojo Var i As Integer = Me.Handle ```

forsearch

ComboBox.Height **Height** As `Integer` The height (in points) of the control. This example sets the height of the control to 100: ``` xojo Me.Height = 100 ```

forsearch

ComboBox.Index **Index** As `Integer` If the control is used in a control set, this specifies the control's index in the set. This property is read-only. The *control set* is often used to manage a group of RadioButtons since a single RadioButton in a window doesn't make much sense. Most typically, you create an instance of the RadioButton, assign 0 to its Index property, and then duplicate it. This increments the value of Index for each new instance but retain the original control's name. To determine which RadioButton the user clicked, use the Action event handler of the control set. The parameter *Index* contains the value of Index for the RadioButton that was clicked. The event handler is this: ``` xojo Sub Action(Index As Integer) Label1.Text = "You chose radio button " + index.ToString + "." End Sub ``` To set a RadioButton in a control set, you use its *Index* property to refer to the RadioButton whose value you want to set. For example, the following line selects the second RadioButton from code: ``` xojo RadioButton1(1).Value = True ' 0-based ```

forsearch

ComboBox.InitialValue **InitialValue** As `String` A list of the default items separated by returns. This property is read-only. This property is unreadable at runtime because the list is removed from memory once the control is created. You can set a default value for the control by populating the pop-up with *InitialValue* and setting the default value with *ListIndex*.

forsearch

ComboBox.Italic **Italic** As `Boolean` If `True`, applies the italic style to the control's caption and/or its text content if any. Mac apps can only display font styles that are available. You cannot force a font to display in bold or italic if it does not have bold or italic variations available. In this situation, the Italic property will not affect the font.

forsearch

ComboBox.LastAddedRowIndex **LastAddedRowIndex** As `Integer` The number of the last row added with the AddRow, AddAllRows or AddRowAt method. LastAddedRowIndex is zero-based. If no rows have been added, LastAddedRowIndex will be -1. This property is read-only. This example displays the value of the last row added to the popup menu: ``` xojo Var r As Integer = PopupMenu1.LastAddedRowIndex System.Beep MessageBox("The last value added was: " + PopupMenu1.RowValueAt(r)) ```

forsearch

ComboBox.LastRowIndex **LastRowIndex** As `Integer` The number of the last row of the `PopupMenu`. Because the `PopupMenu` is zero-based, this value will be 1 less than the `PopupMenu`. This property is read-only.

forsearch

ComboBox.Left **Left** As `Integer` The left side of the control in local coordinates (relative to the window). The following example moves the control 100 points from the left side of the window: ``` xojo Me.Left = 150 ```

forsearch

ComboBox.LockBottom **LockBottom** As `Boolean` Determines whether the bottom edge of the control should stay at a set distance from the bottom edge of the parent control, if there is one, or the owning window. This property can be set in the control's Inspector. The following example sets it in code. ``` xojo Me.LockBottom = True ```

forsearch

ComboBox.LockLeft **LockLeft** As `Boolean` Determines whether the left edge of the control should stay at a set distance from the left edge of the parent control, if there is one, or the owning window. Beginning with version 2009r5, LockLeft and Locktop default to `True` when you add a new control to a window. Existing controls will be altered only if LockRight and/or LockBottom are not set. *LockLeft* has no effect unless *LockRight* is `True`. This property can be set in the control's Inspector. The following example sets it in code. ``` xojo Me.LockLeft = True ```

forsearch

ComboBox.LockRight **LockRight** As `Boolean` Determines whether the right edge of the control should stay at a set distance from the right edge of the parent control, if there is one, or the owning window. This property can be set in the control's Inspector. The following example sets it in code. ``` xojo Me.LockRight = True ```

forsearch

ComboBox.LockTop **LockTop** As `Boolean` Determines whether the top edge of the control should stay at a set distance from the top edge of the parent control, if there is one, or the owning window. Beginning with version 2009r5, LockTop and LockLeft default to `True` when you add a control to a window. Existing controls will be altered only if LockRight and/or LockBottom are not set. *LockTop* has no effect unless *LockBottom* is `True`. This property can be set in the control's Inspector. The following example sets it in code. ``` xojo Me.LockTop = True ```

forsearch

ComboBox.MouseCursor **MouseCursor** As `MouseCursor` The cursor to be displayed while the mouse is within the control and both the `DesktopApplication` and `Window` class's MouseCursor properties are `Nil`. If the `DesktopApplication` class's MouseCursor property is not `Nil` or the `Window`'s MouseCursor property is not `Nil`, then any control's MouseCursor property is ignored. You can use a cursor stored in the `Cursors` module. On Macintosh, you can also obtain a `MouseCursor` from a resource file. This line in the Open event of the control sets the default cursor to the finger pointer. ``` xojo Me.MouseCursor = System.Cursors.FingerPointer ```

forsearch

ComboBox.MouseX **MouseX** As `Integer` The X coordinate of the mouse (points). Measured from the top-left corner of the control. This property is read-only. This code is in the MouseDown event of a `TextField` and displays the X-coordinate at the point of the MouseDown event. ``` xojo Me.Value = Str(Me.MouseX) ```

forsearch

ComboBox.MouseY **MouseY** As `Integer` The Y coordinate of the mouse (points). Measured from the top-left corner of the control. This property is read-only. This code is in the MouseDown event of a `TextField` and displays the Y-coordinate at the point of the MouseDown event. ``` xojo Me.Value = Str(Me.MouseY) ```

forsearch

ComboBox.Name **Name** As `String` The name of the control. Set the name of the control in the Inspector. This property is read-only.

forsearch

ComboBox.PanelIndex **PanelIndex** As `Integer` If the control has been placed on a `TabPanel` or `PagePanel` control, this is the panel (page/tab) that the control is on. If the control is not on a panel, it returns -1. The first panel is numbered zero. If the control has been placed on a panel of a `TabPanel` or `PagePanel` control, it returns the panel number. If the control is not on a `PagePanel` or `TabPanel`, it returns -1. If you change the PanelIndex to a nonexistent panel, the control will disappear until you give it a PanelIndex value that corresponds to a panel that exists. If you are looking to change the currently selected panel (page/tab), use `PagePanel`. This code displays the panel index of the control that is on the page. ``` xojo Label3.Value = Str(Me.PanelIndex) ```

forsearch

ComboBox.Parent **Parent** As `Control` Used to get and set the control's parent control or window. Returns `Nil` if the parent is the window. Assign `Nil` to make the control's parent the window, even if it is enclosed by another control. The child control's behavior in the IDE will reflect the parent's state. If the parent control is somehow in another window, an `InvalidParentException` will occur. The following example sets the parent of the control to the window. ``` xojo Me.Parent = Nil ```

forsearch

ComboBox.RowCount **RowCount** As `Integer` The number of rows in the popup menu. This property is read-only. This example displays the number of rows in the popup menu. ``` xojo MsgBox(FruitPopup.RowCount.ToString) ```

forsearch

ComboBox.RowValueAt **RowValueAt** As `String` Used to read the row value based on the index passed. This property is read-only.

forsearch

ComboBox.Scope **Scope** As `Integer` Used to determine whether access to the control is Public (0) or Private (2). The default is Public. This property is read-only. If the Scope of a control is set to Private, it cannot be accessed from outside its parent window.

forsearch

ComboBox.SelectedRow **SelectedRow** As `String` The text of the currently selected row. This property is read-only. This example displays the value of the currently selected item in a `TextField`. ``` xojo TextField1.Text = PopupMenu1.SelectedRow ```

forsearch

ComboBox.SelectedRowIndex **SelectedRowIndex** As `Integer` Used to get or set the selected item number. The first item is numbered zero. A value of -1 means no selection. SelectedRowIndex may be set using the Properties pane to set the default value of PopupMenu control. If you use the InitialValue property to populate the PopupMenu control and set a value of SelectedRowIndex that corresponds to a default item, that item will be displayed in the IDE. The following example changes the selected item to the third item: ``` xojo FruitMenu.SelectedRowIndex = 2 ```

forsearch

ComboBox.SelectionLength **SelectionLength** As `Integer` The number of highlighted characters. A SelectionLength of 0 means an insertion point rather than a selection. A value greater than the number of characters in the ComboBox means that the selection is from SelectionStart to the end of the ComboBox. This code selects the second through the fourth characters. After the code is executed, those characters are highlighted in the ComboBox. ``` xojo ComboBox1.SelectionStart = 1 ComboBox1.SelectionLength = 3 ```

forsearch

ComboBox.SelectionStart **SelectionStart** As `Integer` The position of the insertion point. A value of zero means that the insertion point is before the first character. Use SelectionStart to set the position of the insertion point in the text. Use SelectionStart in conjunction with SelectionLength to select a portion of the text in the ComboBox, beginning with *SelectionStart* and extending for *SelectionLength* characters. This code selects the second through the fourth characters. After the code is executed, those characters are highlighted in the ComboBox. ``` xojo ComboBox1.SelectionStart = 1 ComboBox1.SelectionLength = 3 ```

forsearch

ComboBox.TabIndex **TabIndex** As `Integer` The **RectControl's** position in the Tab Order. It is 0-based. A TabIndex of 0 is the first **RectControl** to get the focus. On the Mac you need Full Keyboard Access turned on in System Preferences (Keyboard-\>Shortcuts) in order to manually set focus to non-text controls. This example sets the control's TabIndex. ``` xojo Me.TabIndex = 2 ```

forsearch

ComboBox.Tooltip **Tooltip** As `String` Text of help message displayed as a Windows or Linux "tooltip" or macOS help tag. The tip/tag is displayed when the user hovers the mouse cursor over the control. This example adds a tooltip to a `BevelButton` that has an icon. ``` xojo Me.CaptionAlignment = 0 ' left Me.CaptionDelta = 10 Me.Tooltip = "Click to bark." Me.Icon = Woof ' added to the project Me.CaptionPosition = 2 ```

forsearch

ComboBox.Top **Top** As `Integer` The top of the control in local coordinates (relative to the window). This example sets the top of the control to 140 points from the top of the window: ``` xojo Me.Top = 140 ```

forsearch

ComboBox.Transparent **Transparent** As `Boolean` Determines whether the control is transparent on Windows. The default is `False`. Has no effect on macOS or Linux. Transparent controls draw more slowly and use more memory in order to cache the background. Unless you absolutely require transparency, leave this set to False. For projects that were created prior to 2018r1, this property defaults to True to emulate previous behavior. Consider changing it to False to improve performance if you do not require transparency.

forsearch

ComboBox.TrueWindow **TrueWindow** As `Window` Returns a reference to the actual enclosing `Window`. This property is read-only. TrueWindow walks up the window hierarchy and finds the actual enclosing window regardless of how deeply nested the `RectControl` or `DesktopContainer` hierarchy is. `Window` also has a TrueWindow property. This example accesses the TrueWindow and displays its Title property in a `TextField`. ``` xojo TextField1.Text = Me.TrueWindow.Title ```

forsearch

ComboBox.Underline **Underline** As `Boolean` If `True`, applies the underline style to the control's caption and/or its text content if any.

forsearch

ComboBox.Visible **Visible** As `Boolean` Determines whether the control is visible when its owning window is opened. The default is `True`: the control is visible. The following code in the DisclosureTriangle Action event handler displays or hides a ListBox on the window: ``` xojo ListBox1.Value = Me.Visible ```

forsearch

ComboBox.Width **Width** As `Integer` The width (in points) of the control. The following example resizes the control: ``` xojo Me.Width = 200 ```

forsearch

ComboBox.Window **Window** As `Window` The control's parent window. This property is read-only. This code gets the parent window's Title property. ``` xojo TextField1.Text = Me.Window.Title ``` ## Method descriptions

forsearch

ComboBox.AcceptFileDrop **AcceptFileDrop**(FileType As `String`) Permits documents of type *FileType* to be dropped on the control. *FileType* must be a file type that you defined in via the `FileType` class or the File Type Sets Editor. This code in the Open event of an `ImageWell` makes it possible for the user to drop either a picture or a file that is a jpeg image. The File Type Sets editor was used to define the “image/jpeg” file type. It is one of the “Common File Types” that is available in the editor. ``` xojo Me.AcceptPictureDrop Me.AcceptFileDrop("image/jpeg") ``` To restrict file drops to just folders (and not files), you can put this code in the `DragEnter` event: ``` xojo If Not obj.FolderItem.IsFolder Then Return True ```

forsearch

ComboBox.AcceptPictureDrop **AcceptPictureDrop** Permits pictures to be dropped on the control. If a control should accept pictures in a drag and drop, then AcceptPictureDrop needs to be called prior to the drop. Typically, it is in the Open event of the control itself. For example, the line: ``` xojo Me.AcceptPictureDrop ``` in the Open event of the control that will receive the dragged pictures is needed. When the picture is dropped, the `DropObject` event is called and this is where you will put your code to handle the drop. Canvas.Open: ``` xojo Me.AcceptPictureDrop ``` Canvas.DropObject: ``` xojo If obj.PictureAvailable Then Me.Backdrop = obj.Picture End If ```

forsearch

ComboBox.AcceptRawDataDrop **AcceptRawDataDrop**(Type As `String`) Permits data (of the Type specified) to be dropped on the control. The following specfies a generic file type defined in the File Type Sets editor. ``` xojo Me.AcceptRawDataDrop("????") ```

forsearch

ComboBox.AcceptTextDrop **AcceptTextDrop** Permits text to be dropped on the control. This line in the Open event of a control that can accept dragged text. ``` xojo Me.AcceptTextDrop ```

forsearch

ComboBox.AddAllRows **AddAllRows**(Items() As `String`) Appends the elements of the array to the items in the pop-up menu. You can add a "-" on macOS (instead of calling `PopupMenu`) to add a separator. Windows and Linux do not support separators within PopupMenus, so this adds a row with the text "-" that can be selectable by the user. The following example adds two items to the menu. It is equivalent to the example for `AddRow` that calls AddRow repeatedly. ``` xojo Me.AddAllRows("Banana", "Orange") ```

forsearch

ComboBox.AddRow **AddRow**(Item As `String`) Appends *Item* in a new row to the end of the list. You can add a "-" on macOS (instead of calling `PopupMenu`) to add a separator. Windows and Linux do not support separators within PopupMenus, so this adds a row with the text "-" that can be selectable by the user. The following example in the Open event of the control adds two rows to the menu. ``` xojo Me.AddRow("Banana") Me.AddRow("Orange") ```

forsearch

ComboBox.AddRowAt **AddRowAt**(RowNumber As `Integer`, Item As `String`) Creates a new row at *RowNumber* (moving the existing rows down). The first row is numbered 0. The following example adds a row at the 4th position. ``` xojo ComboBox1.AddRowAt(3,"Harry") ```

forsearch

ComboBox.AddSeparator **AddSeparator** Adds a separator line to the popup menu. Windows and Linux do not support separators within PopupMenus, so this adds a row with the text "-" that can be selected by the user. This method is deprecated for ComboBox, which does not support separators on any platform. This method will just add a row with the text "-" that can be selected by the user. The following example adds a separator between some values: ``` xojo Me.AddRow("Banana") Me.AddRow("Orange") #If TargetMacOS Then Me.AddSeparator #Endif Me.AddRow("Tomato") ```

forsearch

ComboBox.Close **Close** Closes a control. Closing a control permanently removes the control from memory, making it impossible to access. You can close both non-indexed controls and indexed controls. When you close an indexed control, the indexes for the remaining controls will shift downward so that the indexes start with zero and are consecutive. The following code closes the control. When this is executed from a visible control, the control disappears from the window. ``` xojo Me.Close ```

forsearch

ComboBox.DrawInto **DrawInto**(g As `Graphics`, x As `Integer`, y As `Integer`) Draws the contents of the RectControl into the specified `Graphics` context. The parameters *x* and *y* are the coordinates of the top, left corner. This method does not work with `HTMLViewer` and `OpenGLSurface`. This example draws the current control into the Graphics of a Picture and then displays it as the Backdrop of a Canvas: ``` xojo Var p As New Picture(Me.Width, Me.Height) Me.DrawInto(p.Graphics, 0, 0) Canvas1.Backdrop = p ```

forsearch

ComboBox.Invalidate **Invalidate**(\[EraseBackground As `Boolean`\]) Similar to RefreshRect, but causes the specified region of the RectControl to be marked dirty and to be redrawn when the window contents need to be redrawn. The region to be redrawn is specified by the *X*, *Y*, *Width*, and *Height* parameters. This form of Invalidate was formerly called InvalidateRect. The following code refreshes the control. EraseBackground defaults to `True`. ``` xojo Me.Invalidate(False) ```

forsearch

ComboBox.Refresh **Refresh**(eraseBackground As `Boolean`) Repaints the portion specified of the contents of the control immediately. Calling this frequently can cause the code executing to slow down. It is often preferable to call `RectControl` instead. Refresh the entire area: ``` xojo Me.Refresh(False) ``` Refresh a portion of the area: ``` xojo Me.Refresh(100, 150, 200, 300) ```

forsearch

ComboBox.RemoveAllRows **RemoveAllRows** Removes all rows in the list. The following example removes all the existing rows prior to adding new rows using `AddAllRows`. ``` xojo Var names() As String names.Add("Abbott") names.Add("Costello") names.Add("Frankenstein") Me.RemoveAllRows Me.AddAllRows(names) ```

forsearch

ComboBox.RemoveRowAt **RemoveRowAt**(Index As `Integer`) Removes the specified row. The first row is numbered zero. The following example removes the third item (index position 2) from the popup menu. ``` xojo Me.RemoveRowAt(2) ```

forsearch

ComboBox.RowTagAt **RowTagAt**(index As `Integer`) As `Variant` A "hidden" identifier associated with the item identified by the *row* parameter (0-based). If you want to compare the value of row tag to another value, you should first convert the Variant to it actual data type. This example populates the RowTagAt identifier with a sequence number. ``` xojo Var nItems As Integer nItems = Me.RowCount - 1 For i As Integer = 0 To nItems Me.RowTagAt(i) = i Next ``` Since a row tag is a `Variant`, you must first convert it to an `Integer` if you want to compare it to another Integer. Do this with an assignment statement such as: ``` xojo Var recID As Integer recID = ComboBox1.RowTagAt(1) ' ComboBox inherits from PopupMenu so it also inherits the RowTagAt method ``` You can also use the `CType` function to do an explicit conversion to any other datatype. Then compare recID to another `Integer`: Displaying the row tag of the selected menu item: ``` xojo TextField1.Text = ComboBox1.RowTagAt(ComboBox1.SelectedRowIndex) ```

forsearch

ComboBox.SelectRowWithTag **SelectRowWithTag**(value As `Variant`) Selects the first row whose tag matches the value passed.

forsearch

ComboBox.SelectRowWithValue **SelectRowWithValue**(value As `String`) Selects the first row whose value matches the provided *value*. If *value* is not found, an `InvalidArgumentException` is raised.

forsearch

ComboBox.SetFocus **SetFocus** If applicable, sets the focus to the RectControl. KeyDown events are directed to the control. If the control cannot get the focus on the platform on which the application is running, SetFocus does nothing. The SetFocus method of the `Window` class or the `ClearFocus` method can be used to remove the focus from the control that currently has the focus, leaving no control with the focus. On the Mac you need Full Keyboard Access turned on in System Preferences (Keyboard-\>Shortcuts) in order to manually set focus to non-text controls. The following example sets the focus to TextField1. If another control has the focus when this line is executed, then the user sees that TextField1 gets the focus. ``` xojo TextField1.SetFocus ``` ## Event descriptions

forsearch

ComboBox.Change **Change** The selected item has changed. Use the `PopupMenu` property to get the index of the newly selected value or the `PopupMenu` property to get the text of the newly selected value. Get the text of the newly selected value: ``` xojo Var newValue As String newValue = Me.SelectedRowValue ```

forsearch

ComboBox.Close **Close** The control is about to close.

forsearch

ComboBox.ConstructContextualMenu **ConstructContextualMenu**(Base As `MenuItem`, x As `Integer`, y As `Integer`) As `Boolean` This event is called when it is appropriate to display a contextual menu for the control. This event handler is the recommended way to handle contextual menus because this event figures out whether the user has requested the contextual menu, regardless of how they did it. Depending on platform, it might be in the MouseUp or MouseDown event and it might be a right+click or by pressing the contextual menu key on the keyboard, for example. *Base* is analogous to the menu bar for the contextual menu. Any items you add to *Base* will be shown as menu items. If you return `False`, the event is passed up the parent hierarchy. If you return `True`, the contextual menu is displayed. The parameters *x* and *y* are the mouse locations. If the event was fired because of a non-mouse event, then *x* and *y* are both set to -1. See the example of a contextual menu in the following section. The following ConstructContextualMenu event handler builds a menu with three menu items plus a submenu with three additional menu items. ``` xojo ' Add some items base.AddMenu(New MenuItem("Test 1")) base.AddMenu(New MenuItem("Test 2")) base.AddMenu(New MenuItem("Test 3")) ' Add a Separator base.AddMenu(New MenuItem(MenuItem.TextSeparator)) ' Add a sub menu Var submenu As New MenuItem("SubMenu") submenu.AddMenu(New MenuItem("SubMenu Test 1")) submenu.AddMenu(New MenuItem("SubMenu Test 2")) submenu.AddMenu(New MenuItem("SubMenu Test 3")) base.AddMenu(submenu) ' Add a Separator base.AddMenu(New MenuItem(MenuItem.TextSeparator)) Return True ```

forsearch

ComboBox.ContextualMenuAction **ContextualMenuAction**(HitItem As `MenuItem`) As `Boolean` Fires when a contextual menuitem *hitItem* was selected but the Action event and the MenuHandler for the menuitem did not handle the menu selection. This event gives you a chance to handle the menu selection by inspecting the menuitem's Text or Tag properties to see which item was selected. Use this in conjunction with ConstructContextualMenu if you have not specified the Action event or the Menu Handler for the items on the contextual menu. See the example of a contextual menu in the examples for the **RectControl** class. `Return` `True` if this event has handled the item the user chose from the contextual menu. Returning `False` will cause the control's parent to execute its ContextualMenuAction event. This can be handy if you have the same contextual menu for several controls who share the same `Parent` (several on the same window for example). By returning `False` you can handle them all in a single event. This simple event handler displays the value of the selected menu item. ``` xojo If hitItem <> Nil Then MessageBox(hitItem.Value) Return True ```

forsearch

ComboBox.DragEnter **DragEnter**(obj As `DragItem`, Action As `Integer`) As `Boolean` Fires when the passed `DragItem` enters the RectControl. Returns a `Boolean`. Return `True` from this event to prevent the drop from occurring. The Action parameter specifies the drag action. It can take the following class constants of the `DragItem` class: | Value | Class Constant | |-------|--------------------------------------------------------------------| | 0 | `DragItem`.DragActionDefault | | 1 | `DragItem`.DragActionCopy | | 2 | `DragItem`.DragActionMove | | 3 | `DragItem`.DragActionLink | To restrict file drops to just folders (and not files), you can put this code in the DragEnter event: ``` xojo If Not obj.FolderItem.IsFolder Then Return True ```

forsearch

ComboBox.DragExit **DragExit**(obj As `DragItem`, Action As `Integer`) Fires when the passed `DragItem` exits the RectControl. The *Obj* parameter is the item being dragged. The *Action* parameter specifies the drag action. It can take the following class constants of the `DragItem` class: | Value | Constant | |-------|--------------------------------------------------------------------| | 0 | `DragItem`.DragActionDefault | | 1 | `DragItem`.DragActionCopy | | 2 | `DragItem`.DragActionMove | | 3 | `DragItem`.DragActionLink |

forsearch

ComboBox.DragOver **DragOver**(x As `Integer`, y As `Integer`, obj As `DragItem`, Action As `Integer`) As `Boolean` Fires when the `DragItem` is over the RectControl. The *Obj* parameter is the object being dragged. The coordinates x and y are relative to the **RectControl**. Returns a `Boolean`. Return `True` from this event to prevent the drop from occurring. The *Action* parameter specifies the drag action, which is typically done by holding down a modifier key (Shift, Alt, Option, Command, etc.) while doing the drag. It can take the following class constants of the `DragItem` class: | Value | Constant | |-------|--------------------------------------------------------------------| | 0 | `DragItem`.DragActionDefault | | 1 | `DragItem`.DragActionCopy | | 2 | `DragItem`.DragActionMove | | 3 | `DragItem`.DragActionLink |

forsearch

ComboBox.DropObject **DropObject**(Obj As `DragItem` Action As `Integer`) The item represented by *Obj* has been dropped on the control. The *Obj* parameter is the object being dragged. The *Action* parameter specifies the drag action. It can take the following class constants of the `DragItem` class: | Value | Constant | |-------|--------------------------------------------------------------------| | 0 | `DragItem`.DragActionDefault | | 1 | `DragItem`.DragActionCopy | | 2 | `DragItem`.DragActionMove | | 3 | `DragItem`.DragActionLink | The following DropObject event handler can handle either a dropped picture or a dropped file. The type of file that it can handle needs to have been specified in a call to AcceptFileDrop prior to the drop, for example, in the Open event. ``` xojo If Obj.PictureAvailable Then Me.Image = obj.Picture ElseIf Obj.FolderItemAvailable Then Me.Image = Picture.Open(obj.FolderItem) End If ```

forsearch

ComboBox.GotFocus **GotFocus** The `PopupMenu` has received the focus and has a selection rectangle around it.

Note

On Macintosh, controls other than text fields and lists will accept focus only if the full keyboard access option is enabled in System Preferences/Keyboard.

forsearch

ComboBox.KeyDown **KeyDown**(Key As `String`) As `Boolean` The user has pressed the *Key* passed while the `control` has the focus. How KeyDown works depends on the type of control. **TextField and TextArea** Returning `True` means the key is intercepted, preventing the key from actually reaching the control at all. This would be useful if you want to override the behavior of the tab key for example. Returning `False` means the key reaches the control. **All Other Controls** Returning `True` prevents the KeyDown event on the parent control (usually the window) from executing. Returning `False` results in the execution of the KeyDown event of the parent control.

forsearch

ComboBox.KeyUp **KeyUp**(Key As `String`) Fires when the passed *Key* is released in the RectControl that has the focus. It is not guaranteed to be the same key that received the KeyDown event.

forsearch

ComboBox.LostFocus **LostFocus** The `PopupMenu` has lost the focus.

Note

On Macintosh, controls other than text fields and lists will accept and lose focus only if the full keyboard access option is enabled in System Preferences/Keyboard.

forsearch

ComboBox.MouseDown **MouseDown**(x As `Integer`, y As `Integer`) As `Boolean` The mouse button was pressed inside the control's region at the location passed in to *x*, *y*. The coordinates *x* and *y* are local to the control, i.e. they represent the position of the mouse click relative to the upper-left corner or the `PopupMenu`. `Return` `True` if you are going to handle the MouseDown. In such a case: - The Action event, if any, will not execute and the state of the object will not change. - You will receive the `MouseUp` event. If you return False, the system handles the MouseDown so the `MouseUp` event handler does not get called. The MouseDown event uses the `DragItem` constructor when the user drags the contents of the control. It is: ``` xojo Var d As DragItem d = New DragItem(Self, Me.Left, Me.Top, Me.Width, Me.Height) d.Picture = Me.Image d.Drag ' Allow the drag ```

forsearch

ComboBox.MouseEnter **MouseEnter** The mouse has entered the area of the control.

forsearch

ComboBox.MouseExit **MouseExit** The mouse has left the area of the control.

forsearch

ComboBox.MouseMove **MouseMove**(X As `Integer`, Y As `Integer`) The mouse has moved within the control to the coordinates passed. The coordinates are local to the control, not to the window.

forsearch

ComboBox.MouseUp **MouseUp**(x As `Integer`, y As `Integer`) The mouse button was released. Use the *x* and *y* parameters to determine if the mouse button was released within the control's boundaries.

Note

This event will not occur unless you return `True` in the MouseDown event. The return value is ignored.

The parameters *x* and *y* are local coordinates, i.e. they represent the position of the mouse click relative to the upper-left corner or the `PopupMenu`. Mouse clicks that are released to the left or above a control are negative.

forsearch

ComboBox.MouseWheel **MouseWheel**(X As `Integer`, Y As `Integer`, DeltaX As `Integer`, DeltaY As `Integer`) As `Boolean` The mouse wheel has been moved. The parameters *X* and *Y* are the mouse coordinates relative to the control that has received the event. The parameters *DeltaX* and *DeltaY* hold the number of scroll lines the wheel has been moved horizontally and vertically, as defined by the operating system. *DeltaX* is positive when the user scrolls right and negative when scrolling to the left. *DeltaY* is positive when the user scrolls down and negative when scrolling up. Returns a `Boolean`. Return `True` to prevent the event from propagating further.

forsearch

ComboBox.Open **Open** The control is about to be displayed. Use this event to initialize a control. The Open event is called after the Constructor. Be warned that initializing control property values using the Constructor instead of the Open event may result in those property values being overwritten by what is set in the Inspector. For best results, use the Open event for control initialization rather than the control Constructor. If the control is supposed to handle drag and drop, you need to tell it which type of item it needs to be able to handle. The following example informs the control that pictures and files can be dropped on it. The type of the file it needs to support is specified via the File Types Editor. ``` xojo Sub Open() Me.AcceptPictureDrop Me.AcceptFileDrop("JPEG") End Sub ```

forsearch

ComboBox.TextChanged **TextChanged** The text in the ComboBox has changed. The following line in the TextChanged event handler displays either the currently selected menu item or the text typed into the ComboBox. ``` xojo Label1.Text = Me.SelectedRowValue ``` ## Notes ### Macos On macOs, the ComboBox height is limited to just a single size, so any changes to the Height property are ignored. Additionally, 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*: ``` xojo Declare Sub setNumberOfVisibleItems Lib "AppKit" Selector "setNumberOfVisibleItems:" (controlHandle As Integer, count As Integer) setNumberOfVisibleItems(MyComboBox.Handle, 30) ``` --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- ### Windows On Windows, the ComboBox height is controlled by the font size, so any changes you make to the Height property are ignored. ## Sample code This code in the Open event handler populates a ComboBox and sets the initial value to the current month: ``` xojo Var s As String Var last As Integer Var 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 SelectedRowIndex property contains the index of the selected item, but it does not indicate whether the user has entered a value into the ComboBox. Examine the Value property to get the current menu selection or the value entered by the user. For example, the following line in the TextChanged event handler displays either the currently selected menu item or the value typed into the ComboBox. ``` xojo Label1.Text = Me.Text ``` --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- This code adds an item to a ComboBox in its Open event handler. ``` xojo Me.AddRow("October") ``` --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- This code opens a new window when an item is chosen. ``` xojo Sub Change() Var w As ListEditorWindow If ComboBox1.Text = "Edit List..." Then w = New ListEditorWindow End If End Sub ``` --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- The following code changes the selected item in a ComboBox ``` xojo ComboBox1.SelectedRowIndex = 3 ``` ## Compatibility All project types on all supported operating systems. ## See also `PopupMenu` parent class; `TextField`, `PopupMenu` controls