$root.$iwindows.WINDOW.$objs.Multi-Line Entry Field

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

Class notation

Properties Methods Events 

A multi-line field for entering data or read-only field for display only.

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
$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
$calculatedIf true, the field is calculated
$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
$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
$negallowedOnly applies when the dataname is a numeric type.If true,the entry field allows negative values
$righttoleftIf true,the edit field edits text with a right-to-left reading direction; the edit field is then suitable for languages such as Arabic
$shownullsIf true, the field displays null values using the text 'NULL'
$showspellingerrorsIf true,the control underlines spelling errors using a dotted line
$textThe text or calculation stored with the object
$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
$zeroemptyIf true, the field shows a value of zero as an empty string
Standard$active $align $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 $horzscroll $hscroll $hwnd $ident $keyevents $labelfontsize $labelhottextcolor $labeltextcolor $left $linestyle $local $mouseevents $name $nodropcursor $objtype $order $osdropflags $pastestripscontrolcharacters $rmouseevents $selected $showcontrolcharacters $sidepanel $sidepanelmode $statusevents $subwindowstyle $textcolor $tooltip $top $userinfo $vertscroll $visible $vscroll $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 
evTabSelectedSent to a tab control when a new tab has been selected
Parameters
pEventCodeThe event code
pTabNumberThe number of the tab which was selected
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 evKey evMouseDouble evMouseDown evMouseEnter evMouseLeave evMouseUp evOpenContextMenu evRMouseDouble evRMouseDown evRMouseUp evSent evShiftTab evShown evTab evWillDrop

Children

Top 

$methods