$root.$iwindows.WINDOW.$objs.TokenEntry

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

Class notation

Properties Methods Events 

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.
$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
$canedittokenIf true,pressing return when a single token is selected,or double clicking a token,allows the token to be edited as text. When using tags,you would typically set this property to kFalse
$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
$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
$fadewhendisabledIf true,the field fades its content when $enabled is kFalse
$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
$firstvisThe number of the first visible character or line in the contents
$gridsectionThe type of the complex grid section containing the object. One of the kGrid... constants
$invalidtokenbackcolorThe background color used to display an invalid token.kColorDefault means use the invalidtokenbackcolor property in the token section of appearance.json
$invalidtokentextcolorThe color used for the text of an invalid token.kColorDefault means use the invalidtokentextcolor property in the token section of appearance.json
$lastselThe number of the final selected character or line in the current contents
$lastvisThe number of the final fully visible character or line in the contents
$linecountThe number of lines in the contents of the control
$linehtextraThe number of extra pixels added to the height of each line
$sendtokeneventsIf true,the control sends the events evTokensAdded and evTokensDeleted
$showtokendeletebuttonIf true,all tokens have a delete button when the control is enabled
$tokencaseIf true,tokens are case sensitive
$tokendelimitersOne or more characters.Each character separates tokens in the data stored in $dataname.If empty,defaults to comma.The first delimiter character is the default. \t and \f can be entered to use chr(9) and chr(12) respectively
$tokenlistThe name of the list variable containing all possible token values.Used for popup assistance and token validation.If omitted or empty,the list for popup assistance is obtained by sending the evGetTokenList event
$tokenmenuThe token menu.If this is not empty,all valid tokens have a drop down button that can be used to open this menu (as a context menu).The token is available as the pToken event parameter of evOpenContextMenu
$tokenregexpThe regular expression used to validate the syntax of a token.If $tokenlist has a list of all possible tokens then you can still use $tokenregexp for a pre-validation step that reduces searches of $tokenlist
$tokentagseparatorIf not empty,a single character that separates the token tag from the rest of the data for a token. Defaults to empty, meaning tags are not being used. \t and \f can be entered to use chr(9) and chr(12) respectively
$tooltipposA kTooltipPos... constant that specifies where $tooltip appears relative to the control
kTooltipPosBottom kTooltipPosLeft kTooltipPosMouse kTooltipPosRight kTooltipPosTop
$validtokenbackcolorThe background color used to display a valid token.kColorDefault means use the validtokenbackcolor property in the token section of appearance.json
$validtokentextcolorThe color used for the text of a valid token.kColorDefault means use the validtokentextcolor property in the token section of appearance.json
Standard$active $alpha $backcolor $backgroundtheme $backpattern $bordercolor $candropcursor $componentinfo $container $contextmenu $cursor $dataname $disablefocus $disablefontsizekeys $disablesystemfocus $dragborder $dragiconid $dragmode $dragrange $dropmode $edgefloat $effect $enabled $fieldstyle $font $fontsize $fontstyle $forecolor $framehwnd $gridcolumn $hasfocus $height $helpfile $hwnd $ident $keyevents $labelfontsize $labelhottextcolor $labeltextcolor $left $linestyle $local $mouseevents $name $nodropcursor $objtype $order $osdropflags $pastestripscontrolcharacters $rmouseevents $selected $sidepanel $sidepanelmode $statusevents $subwindowstyle $textcolor $tooltip $top $userinfo $vertscroll $visible $vscroll $width

Methods

Object specific 
$droptokens$droptokens([bRemove=kFalse,bSetFocus=kTrue]) call this during evDrop for token entry field to insert dragged tokens into current drop location,optionally remove them from drag source,and optionally set focus to field.Returns true for success
$gettokens$gettokens([bSelOnly=kFalse,bIncludeInval=kFalse,bIncludeDispString=kFalse,bSort=kFalse,bRemoveDups=kFalse,bSplit=kFalse]) returns list of tokens stored in the control (1 column unless bSplit is kTrue).bRemoveDups only works if bSort is kTrue
$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 
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 evDisabled evDrag evDragBorder evDragFinished evDrop evEnabled evHidden evKey evMouseDouble evMouseDown evMouseEnter evMouseLeave evMouseUp evOpenContextMenu evRMouseDouble evRMouseDown evRMouseUp evSent evShiftTab evShown evTab evWillDrop

Children

Top 

$methods