Combo Box (PRIM_CMBX)

Drop down list of values

Ancestors - Control (PRIM_CTRL)Object (PRIM_OBJT)

Details

A combo box or dropdown is a list based control that when clicked expands to show the list of available values.
 
Depending on configuration, a combo can also allow data entry in the edit portion of the control.
 
When an item is chosen from the combo, the field values associated with underlying list entry will be returned to the parent component.

Example

Simple 2 column combo
Function Options(*DIRECT)
Begin_Com Role(*EXTENDS #PRIM_FORM) Height(284) Left(196) Top(211) Width(549) Clientwidth(533) Clientheight(245)
   Define_Com Class(#PRIM_CMBX) Name(#ComboBox) Componentversion(1) Displayposition(1) Fixedheight(False) Left(128) Parent(#COM_OWNER) Showselection(False) Showselectionhilight(False) Tabposition(1) Top(40) Height(37) Width(272) Comboboxstyle(DropDownList)
   Define_Com Class(#PRIM_CBCL) Name(#CBCL1) Displayposition(1) Parent(#ComboBox) Source(#xDemoAlpha128) Usepicklist(False)
   Define_Com Class(#PRIM_CBCL) Name(#CBCL2) Displayposition(2) Parent(#ComboBox) Source(#xDemoNumber) Usepicklist(False)
 
   Evtroutine Handling(#Com_owner.CreateInstance)
 
      #Com_owner.AddEntry( 1 "One" )
      #Com_owner.AddEntry( 2 "Two" )
      #Com_owner.AddEntry( 3 "Three" )
      #Com_owner.AddEntry( 4 "Four" )
      #Com_owner.AddEntry( 5 "Five" )
 
   Endroutine
 
   Mthroutine Name(AddEntry)
      Define_Map For(*input) Class(#xDemoNumber) Name(#Value)
      Define_Map For(*input) Class(#xDemoAlpha128) Name(#Caption)
 
      #xDemoNumber := #Value
      #xDemoAlpha128 := #Caption
 
      Add_Entry To_List(#ComboBox)
 
      Endroutine
 
      Evtroutine Handling(#ComboBox.ItemGotFocus)
 
      #Com_owner.Caption := #xDemoAlpha128
 
   Endroutine
 
End_Com
 

Properties

Name Description
AutoSelect Automatically select the text when the control receives focus
AutoSelectItem Automatically select the first item when the list is loaded
BusyUpdates BusyUpdates specifies how the control updates itself Inherited from Control (PRIM_CTRL)
BusyUpdatesOfParent BusyUpdatesOfParent specifies whether the parent controls updates Inherited from Control (PRIM_CTRL)
CanFocus CanFocus returns a value indicating whether the control can receive keyboard focus Inherited from Control (PRIM_CTRL)
Cell Reference to a specific cell in the list
Columns Collection of columns in the list
ComboBoxStyle Determines the type of combo box used
ComponentClassName ComponentClassName is the name of the component's class. Inherited from Object (PRIM_OBJT)
ComponentMembers ComponentMembers provides access to all the member components of this component Inherited from Object (PRIM_OBJT)
ComponentPatternName ComponentPatternName is used to qualify the class of the component. Inherited from Object (PRIM_OBJT)
ComponentTag Generic space allowing a value to be stored for the instance Inherited from Object (PRIM_OBJT)
ComponentType ComponentType gives you access to the type information about the component Inherited from Object (PRIM_OBJT)
ComponentTypeName ComponentTypeName is the fully qualified name of the component's class. Inherited from Object (PRIM_OBJT)
ComponentVersion Variant of the control being used
CurrentItem The last item in the list touched either in the UI or via a list related command
Cursor Cursor sets the cursor image Inherited from Control (PRIM_CTRL)
DataClass Reference to a repository field or fundamental product data class used to control data entry
DisplayPosition DisplayPosition determines the order in which components are shown Inherited from Control (PRIM_CTRL)
DragStyle DragStyle determines how a component can be dragged Inherited from Control (PRIM_CTRL)
DropDownCount DropDownCount sets the number of items shown
DropDownOpen Is the combo box open
DropDownWidth The width of the drop down as a percentage of the width property.
Enabled Enable activates/deactivates the component Inherited from Control (PRIM_CTRL)
Entries The number of entries in the underlying data list
FixedHeight Set the height of combo automatically based on the text height
FixedPosition Fix the control position so that it does not move if the parent is scrolled Inherited from Control (PRIM_CTRL)
Focus Focus tells whether the component has focus Inherited from Control (PRIM_CTRL)
FocusedStyle Reference to a style to be applied when the control is focus Inherited from Control (PRIM_CTRL)
FocusedStyles Collection of styles to be applied when the control is focus Inherited from Control (PRIM_CTRL)
FocusItem Reference to the focus item in the list
Handle Returns the Windows handle in desktop applications Inherited from Control (PRIM_CTRL)
HasSelection True if some of the editable text is selected
Height The height of the control in pixels Inherited from Control (PRIM_CTRL)
Hint Caption displayed when the mouse hovers over the control Inherited from Control (PRIM_CTRL)
HintPopup HintPopup allows a PopupPanel instance to be used instead of the default hint text box Inherited from Control (PRIM_CTRL)
HintShow Enabled or disable the appearance of hints Inherited from Control (PRIM_CTRL)
HintShowOfParent Delegate hints appearance to the parent control Inherited from Control (PRIM_CTRL)
HintTitle HintTitle defines the text shown at the top of the hint window in emphasized text Inherited from Control (PRIM_CTRL)
IntegralHeight Determines how the last visible item in a list is shown
IsAnimating IsAnimating indicates that a control is currently being animated Inherited from Control (PRIM_CTRL)
IsRealized True if the control is currently realized Inherited from Control (PRIM_CTRL)
Items Collection of items in the component
Left Position of the control relative to the left boundary of its parent Inherited from Control (PRIM_CTRL)
MessageSet LANSA Internal Use
MessagesOfComponent LANSA Internal Use
MessagesOfFeature LANSA Internal Use
Modified Modified indicates that the contents of the component have changed Inherited from Control (PRIM_CTRL)
ModifiedRules Controls when the Modified property is set to True
MouseOver MouseOver determines whether the mouse is directly over a control Inherited from Control (PRIM_CTRL)
MouseOverStyle MouseOverStyle defines the style to be applied to a control when the mouse is over it Inherited from Control (PRIM_CTRL)
MouseOverStyles MouseOverStyles is a collection of styles to be applied to a control when the mouse is over it Inherited from Control (PRIM_CTRL)
Name Name identifies the component Inherited from Object (PRIM_OBJT)
NotificationStyle NotificationStyle controls how events are triggered
Opacity Opacity denotes the appearance of a control in terms of its interaction with its background Inherited from Control (PRIM_CTRL)
Owner Owner owns this component Inherited from Object (PRIM_OBJT)
Parent Reference to the control in which this control is visually positioned Inherited from Control (PRIM_CTRL)
Popup Popup allows a PopupPanel instance to be used instead of the typical right click popup menu Inherited from Control (PRIM_CTRL)
PopupMenu Reference to a PopupMenu to be shown on a right click Inherited from Control (PRIM_CTRL)
ReadOnly ReadOnly controls whether a component can be used for input
Rotation Rotation allows a control to rotate a number of degrees about a given origin Inherited from Control (PRIM_CTRL)
RotationOriginLeft RotationOriginLeft defines the left coordinate of an imaginary point around which a control will rotate Inherited from Control (PRIM_CTRL)
RotationOriginTop RotationOriginTop defines the top coordinate of an imaginary point around which a control will rotate Inherited from Control (PRIM_CTRL)
RowHeight Height of a rows in the drop down in pixels
ScaleHeight ScaleHeight is the percentage of the height to use in the visual appearance of a control Inherited from Control (PRIM_CTRL)
ScaleOriginLeft ScaleOriginLeft defines the left coordinate of an imaginary point from which a control will scale Inherited from Control (PRIM_CTRL)
ScaleOriginTop ScaleOriginTop defines the top coordinate of an imaginary point from which a control will scale Inherited from Control (PRIM_CTRL)
ScaleWidth ScaleWidth is the percentage of the width to use in the visual appearance of a control Inherited from Control (PRIM_CTRL)
ScreenLeft ScreenLeft sets the distance from the left of the screen Inherited from Control (PRIM_CTRL)
ScreenTop ScreenTop sets the distance from the top of the screen Inherited from Control (PRIM_CTRL)
ScrollLeft Left position of a horizontally scrolled child control relative to its parent control Inherited from Control (PRIM_CTRL)
ScrollTop Top position of a vertically scrolled child control relative to its parent control Inherited from Control (PRIM_CTRL)
SelectionEnd Position in the value that selection ends
SelectionStart Position in the value that selection starts
SelectionStyle Specifies the rules for item selection within the list
ShowSelection Show selection when the control does not have focus
ShowSelectionHilight Highlight selected items when the control does not have focus
SkewLeft SkewLeft defines the angle at which to skew the control horizontally Inherited from Control (PRIM_CTRL)
SkewOriginLeft SkewOriginLeft defines the left coordinate of an imaginary point from which a control will skew Inherited from Control (PRIM_CTRL)
SkewOriginTop SkewOriginTop defines the top coordinate of an imaginary point from which a control will skew Inherited from Control (PRIM_CTRL)
SkewTop SkewTop defines the angle at which to skew the control vertically Inherited from Control (PRIM_CTRL)
Style Style defines the style to be applied to a control Inherited from Control (PRIM_CTRL)
Styles Collection of styles to be applied to the control Inherited from Control (PRIM_CTRL)
TabPosition TabPosition sets the order of focus when the Tab key is used Inherited from Control (PRIM_CTRL)
TabStop Set to false to stop focus being given to the control via the Tab key Inherited from Control (PRIM_CTRL)
Text Text contains the formatted data currently showing in the edit area
ThemeDrawStyle Name of the Theme DrawStyle to be applied to the control Inherited from Control (PRIM_CTRL)
Top Position of the control relative to the top boundary of its parent Inherited from Control (PRIM_CTRL)
TouchMove Determines how the control will respond to touch move processing Inherited from Control (PRIM_CTRL)
TouchRotate Determines how the control will respond to touch rotation Inherited from Control (PRIM_CTRL)
TouchScale Determines how the control will respond to touch scaling Inherited from Control (PRIM_CTRL)
TouchSize Determines whether a control can be resized Inherited from Control (PRIM_CTRL)
Value Value of the data class
ValueAt Value at the specified location
Visible Show or hide the control Inherited from Control (PRIM_CTRL)
VisualStyle VisualStyle sets the appearance Inherited from Control (PRIM_CTRL)
VisualStyleOfParent Adopt the Visual style from the parent control Inherited from Control (PRIM_CTRL)
Width Width of the component in pixels Inherited from Control (PRIM_CTRL)

Events

Name Description
AnimationEnded Fired when an animation is ended Inherited from Control (PRIM_CTRL)
Cancelled
AutoCompleting Fired as a value is being edited allowing for a replacement value to be returned
Value
Changed Changed is a change in the component
CloseUp Fired when the dropdown is closed
ComboChanged Changed is a change in the component
CreateInstance CreateInstance is signalled when an instance of a component is created Inherited from Control (PRIM_CTRL)
DestroyInstance DestroyInstance is signalled when an instance of a component is about to be destroyed Inherited from Control (PRIM_CTRL)
DoubleClick Fired when the user double clicks
Origin, Handled
DragDrop Fired on mouse up to signify the end of a drag process Inherited from Control (PRIM_CTRL)
PosX, PosY, Source, Payload, AggregatedSource, Origin, Handled, DragResult
DragOver Fired during the drag and drop process when the cursor moves over the control Inherited from Control (PRIM_CTRL)
PosX, PosY, Source, Payload, DragState, AcceptDrop, DragCursor, ShowDropHilight, AggregatedSource, Origin, Handled
DropDown DropDown occurs when the list portion of the box drops down
Continue
EndDrag Fired when the drag and drop process has completed Inherited from Control (PRIM_CTRL)
Source, Payload, DragResult, AggregatedSource, Origin, Handled
Enter Fired when the Enter key is pressed
KeyCode, Char, IsAltDown, IsControlDown, IsShiftDown, Handled
GotFocus Fired when the control receives the focus
Initialize Fired after a component has been realized for the first time Inherited from Control (PRIM_CTRL)
ItemGotFocus Fired when an item receives the focus
ItemGotFocusAccept ItemGotFocusAccept is fired when the item gets focus
Accept, Reason
ItemGotSelection Fired when an item in the list becomes selected
ItemGotSelectionAccept Fired when an item in the list is about to become selected
Accept, Reason
ItemLostFocus Fired when the item loses focus
ItemLostFocusAccept Fired when an item in the list is about to lose focus
Accept, Reason
ItemLostSelection ItemLostSelection happens when another item is selected
ItemLostSelectionAccept Fired when an item in the list is about to lose selection
Accept, Reason
KeyPress Fired when a key is pressed on the keyboard
KeyCode, Char, IsAltDown, IsControlDown, IsShiftDown, Handled
LostFocus LostFocus happens when a component is no longer active
MouseEnter The mouse has entered the bounds of the control Inherited from Control (PRIM_CTRL)
MouseHover The mouse has hovered over the control Inherited from Control (PRIM_CTRL)
Origin, Handled
MouseLeave The mouse has left the bounds of the control Inherited from Control (PRIM_CTRL)
StartDrag Fired when the user starts a drag and drop process Inherited from Control (PRIM_CTRL)
Source, Payload, Continue, DragList, AggregatedSource, Origin, Handled
TouchChange Fired repeatedly between the TouchStart and TouchEnd boundaries to provide details of the touch events Inherited from Control (PRIM_CTRL)
MoveLeft, MoveTop, ScaleWidth, ScaleHeight, Rotation, Continue
TouchEnd Fired when the user stops touching the screen Inherited from Control (PRIM_CTRL)
TouchStart Fired when the user first makes physical contact with the screen Inherited from Control (PRIM_CTRL)
Origin, TouchMove, TouchRotate, TouchScale, TouchSize

Methods

Name Description
CloseDropDown Forces the listbox portion of a DropDown or DropDownList style combo box to be closed
Result
FadeIn Animate from invisible to visible Inherited from Control (PRIM_CTRL)
Duration, Delay
FadeOut Animate from visible to invisible Inherited from Control (PRIM_CTRL)
Duration, Delay, Visible
MoveFrom Move a control from the specified position to the current position Inherited from Control (PRIM_CTRL)
Left, Top, Duration, Delay
MoveTo Animate a move from the specified number of pixels Inherited from Control (PRIM_CTRL)
Left, Top, Duration, Delay
OpenDropDown Forces the listbox portion of a DropDown or DropDownList style combo box to be shown
Result
Realize Creates the visual portion of dynamically created controls Inherited from Control (PRIM_CTRL)
Scale Animate a change of scale Inherited from Control (PRIM_CTRL)
ScaleWidth, ScaleHeight, Duration, Delay
SelectText Set selection within the value
StartPosition, Length
SetFocus Sets the control to be the focus control Inherited from Control (PRIM_CTRL)
SetValueAt Set the value at the specified position
Result, Row, Column, Value
ShowMessages LANSA Internal Use Inherited from Control (PRIM_CTRL)
SizeTo Changes and animates control size changing Inherited from Control (PRIM_CTRL)
Width, Height, Duration, Delay
Unrealize Destroys the visual portion of dynamically created controls Inherited from Control (PRIM_CTRL)
UpdateDisplay UpdateDisplay updates the display immediately Inherited from Control (PRIM_CTRL)

See also

All Component Classes

Technical Reference

LANSA Version 15, April 2020