$root.$iwindows.WINDOW.$objs.Combo Box

Parent: $root.$iwindows.WINDOW.$objs
 
Children 

Class notation

Properties Methods Events 

Lets you enter a value into the field or select a value from the dropdown list.

Properties

Object specific 
$allowcopyIf true,when the field is active and disabled,the user can set focus to the field,select text with mouse or select all,and copy to clipboard.Note that the field does not generate click events when it is active,disabled and $allowcopy is kTrue
$animateuiIf the library preference $animateui is true, all objects that support $animateui will animate aspects of their interface. The object property only applies when the library preference is false.
$autocorrectspellingIf true,and the user types a separator (e.g. space or comma) when no text is selected,the control replaces a misspelt word immediately before the selection with a correctly spelt word
$autofindIf true, the field is an automatic find field
$autotablenThe number of characters entered before automatically tabbing out of the field
$bordericonstyleThe style applied to plain border styles. You can set border integrated icons, icon colors and tints.
$borderradiusRadius for rounded border corners.1 to 4 pixel values separated by -,in order topleft,topright,bottomright,bottomleft.If bottomleft is omitted it is topright.If bottomright is omitted it is topleft.If topright is omitted it is topleft
$calculationThe calculation used to format the variable for display
$contentpaddingPadding inside a border. 1 to 4 pixel values separated by -,in order left,top,right,bottom. If bottom is omitted it is top.If right is omitted it is left.If top is omitted it is left
$contentsThe current contents of the object
$contenttipText which is displayed in the field when it is empty,to help the user understand what content should be entered
$defaultlinesThe default lines used to initialise the list; this allows the droplist/combo box to be setup without a list variable. Assigning a list to the droplist $dataname or combo box $listname property clears $defaultlines
$disabledefaultcontextmenuIf true, the default context menu for the object will not be generated in response to a context click ($clib.$disabledefaultcontextmenu and $cobj.$disabledefaultcontextmenu must both be false for the menu to be generated)
$disablediacriticalpopupIf true,long holding a character will not show a popup if diacritical character alternatives are configured for the character
$disablesearchonopenIf true,the combo box list is not used to populate the edit field based on the content of the edit field when the popup list is opened (for the data grid this property is used for columns with $columntype kDataGridComboPicker)
$fieldstylefocusedThe style in system class #STYLES assigned to this field in addition to $fieldstyle when the control has focus
$firstselThe number of the first selected character or line in the current contents
$gridsectionThe type of the complex grid section containing the object. One of the kGrid... constants
$lastselThe number of the final selected character or line in the current contents
$listdroppedIf true, the combo box or dropdown list is dropped
$listheightThe maximum number of lines displayed in the dropped list for a combo box or dropdown list.For the data grid,this property applies to combo boxes or dropdown lists used to manipulate cell data.Ignored on macOS when the dropped list is a menu
$listnameThe name of of the list variable used to populate the field
$negallowedOnly applies when the dataname is a numeric type.If true,the entry field allows negative values
$selectionbackcolorThe color of selected lines. kColorDefault means use the default color. When not kColorDefault only applies when the control has the focus
$selectiontextcolorThe text color of selected lines. kColorDefault means use the default color. When not kColorDefault applies irrespective of whether the control has the focus
$showspellingerrorsIf true,the control underlines spelling errors using a dotted line
$stripspacesIf true,the control strips leading and trailing spaces from the data before storing it in the dataname
$studioideIf true,the control draws in a platform independent IDE style
$tooltipposA kTooltipPos... constant that specifies where $tooltip appears relative to the control
kTooltipPosBottom kTooltipPosLeft kTooltipPosMouse kTooltipPosRight kTooltipPosTop
$unqindexIf true, the field corresponds to a unique index
$uppercaseIf true, the entry field is upper case only
$vertcentertextIf true,single line text (or any text in a kText background object) is vertically centered in the height of the field. If false,the text is vertically positioned according to the rules of Omnis Studio 5.0.0
$zeroemptyIf true, the field shows a value of zero as an empty string
Standard$active $alpha $backcolor $backgroundtheme $backpattern $bordercolor $candropcursor $componentinfo $container $contextmenu $cursor $dataname $disablefocus $disablesystemfocus $dragborder $dragiconid $dragmode $dragrange $dropmode $edgefloat $effect $enabled $fieldstyle $font $fontsize $fontstyle $forecolor $framehwnd $gridcolumn $hasfocus $height $helpfile $horzscroll $hwnd $ident $keyevents $labelfontsize $labelhottextcolor $labeltextcolor $left $linestyle $local $mouseevents $name $nodropcursor $objtype $order $osdropflags $pastestripscontrolcharacters $rmouseevents $selected $showcontrolcharacters $sidepanel $sidepanelmode $statusevents $textcolor $tooltip $top $userinfo $visible $width

Methods

Object specific 
$sendevent$sendevent(iEvent[,eventParameters...]) Sends event iEvent (an ev... constant value) to the object with eventParameters passed as name,value pairs, for example $sendevent(evClick,'pLineNumber',2).Returns kFalse if the event is discarded
$setbordericonstyle$setbordericonstyle(bLeftIcon[,cIcnID,iIcnTintColor,iBackTintColor,iAlign]) sets $bordericonstyle for left or right icon.cIcnID icon id of SVG.iIcnTintColor,iBackTintColor icon and background tint colors.iAlign is kJstVert... constant
$showpanel$showpanel(iAction[,iMode=kSidePanelModeAuto]) executes kSidePanelAction... on a side panel object. iMode only applies to kSidePanelActionShow,and must be kSidePanelModeCover/Push/Auto. For JS client,$showpanel must be executed on the client
Standard$redraw

Events

Object specific 
evColumnDividerMovedSent to a complex grid when a divider has moved
Parameters
pEventCodeThe event code
pDividerThe column number that has been moved
pDividerMovedByThe amount the divider moved by ( can be negative )
evExtendSent to grid field when the list is to be extended
Parameters
pEventCodeThe event code
pRowA reference to the list row
pLineNumberThe line number in the list
evRowChangeSent to complex grid field when a field on a different row becomes the target field
Parameters
pEventCodeThe event code
pRowA reference to the list row
pLineNumberThe line number in the list
evWillHideSent to a field before it is hidden. Currently only used when the field is set as a side panel
Parameters
pEventCodeThe event code
pSidePanelIf true,this object is being hidden or shown as a side panel
evWillShowSent to a field before it becomes visible. Currently only used when the field is set as a side panel
Parameters
pEventCodeThe event code
pSidePanelIf true,this object is being hidden or shown as a side panel
StandardevAfter evBefore evCanDrop evClick evClipChangedData evDisabled evDoubleClick evDrag evDragBorder evDragFinished evDrop evEnabled evHidden evHScrolled evKey evMouseDouble evMouseDown evMouseEnter evMouseLeave evMouseUp evOpenContextMenu evRMouseDouble evRMouseDown evRMouseUp evSent evShiftTab evShown evTab evVScrolled evWillDrop

Children

Top 

$methods