| Object specific | |
| $allowcopy | If 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 |
| $animateui | If 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. |
| $bordericonstyle | The style applied to plain border styles. You can set border integrated icons, icon colors and tints. |
| $borderradius | Radius 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 |
| $canedittoken | If 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 |
| $contentpadding | Padding 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 |
| $contents | The current contents of the object |
| $contenttip | Text which is displayed in the field when it is empty,to help the user understand what content should be entered |
| $disabledefaultcontextmenu | If 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) |
| $disablediacriticalpopup | If true,long holding a character will not show a popup if diacritical character alternatives are configured for the character |
| $fadewhendisabled | If true,the field fades its content when $enabled is kFalse |
| $fieldstylefocused | The style in system class #STYLES assigned to this field in addition to $fieldstyle when the control has focus |
| $firstsel | The number of the first selected character or line in the current contents |
| $firstvis | The number of the first visible character or line in the contents |
| $gridsection | The type of the complex grid section containing the object. One of the kGrid... constants |
| $invalidtokenbackcolor | The background color used to display an invalid token.kColorDefault means use the invalidtokenbackcolor property in the token section of appearance.json |
| $invalidtokentextcolor | The color used for the text of an invalid token.kColorDefault means use the invalidtokentextcolor property in the token section of appearance.json |
| $lastsel | The number of the final selected character or line in the current contents |
| $lastvis | The number of the final fully visible character or line in the contents |
| $linecount | The number of lines in the contents of the control |
| $linehtextra | The number of extra pixels added to the height of each line |
| $sendtokenevents | If true,the control sends the events evTokensAdded and evTokensDeleted |
| $showtokendeletebutton | If true,all tokens have a delete button when the control is enabled |
| $tokencase | If true,tokens are case sensitive |
| $tokendelimiters | One 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 |
| $tokenlist | The 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 |
| $tokenmenu | The 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 |
| $tokenregexp | The 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 |
| $tokentagseparator | If 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 |
| $tooltippos | A kTooltipPos... constant that specifies where $tooltip appears relative to the control
kTooltipPosBottom kTooltipPosLeft kTooltipPosMouse kTooltipPosRight kTooltipPosTop |
| $validtokenbackcolor | The background color used to display a valid token.kColorDefault means use the validtokenbackcolor property in the token section of appearance.json |
| $validtokentextcolor | The 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 |
| 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 |
| Object specific | |
| evBorderIconClicked | Sent to a field when the border icon is clicked
Parameters
| pEventCode | The event code |
| pLeftBorderIcon | kTrue if the left border icon was clicked |
|
| evGetTokenList | Sent to the token entry field when $tokenlist is not specified,to get the list of possible token values for the popup
Parameters
| pEventCode | The event code |
| pNewText | The new text entered by the user |
| pTokenList | The list of possible token values to be displayed by the token entry popup.Assign this parameter when processing evGetTokenList |
|
| evTokensAdded | If the token entry field property $sendtokenevents is true, this event is sent to the token entry field when one or more tokens have been added
Parameters
| pEventCode | The event code |
| pTokenChanges | The list of added or deleted tokens.Two or three columns: name (token),display (display text) and optionally tag |
|
| evTokensDeleted | If the token entry field property $sendtokenevents is true, this event is sent to the token entry field when one or more tokens have been deleted
Parameters
| pEventCode | The event code |
| pTokenChanges | The list of added or deleted tokens.Two or three columns: name (token),display (display text) and optionally tag |
|
| evWillHide | Sent to a field before it is hidden. Currently only used when the field is set as a side panel
Parameters
| pEventCode | The event code |
| pSidePanel | If true,this object is being hidden or shown as a side panel |
|
| evWillShow | Sent to a field before it becomes visible. Currently only used when the field is set as a side panel
Parameters
| pEventCode | The event code |
| pSidePanel | If true,this object is being hidden or shown as a side panel |
|
| Standard | evAfter evBefore evCanDrop evClipChangedData evDisabled evDoubleClick evDrag evDragBorder evDragFinished evDrop evEnabled evHidden evKey evMouseDouble evMouseDown evMouseEnter evMouseLeave evMouseUp evOpenContextMenu evRMouseDouble evRMouseDown evRMouseUp evSent evShiftTab evShown evTab evVScrolled evWillDrop |
$root.$iwindows.WINDOW.$objs.newwindow_tokenentry_1020