$root.$iwindows.WINDOW.$objs.HelpMethods $root.$iwindows.WINDOW.$objs.HelpMethods
Parent: $root.$iwindows.WINDOW.$objs
Children
| Object specific | |
| $childiconid | The icon id for nodes which have no children |
| $contentslistname | The dataname for the contents list |
| $fieldstylefocused | The style in system class #STYLES assigned to this field in addition to $fieldstyle when the control has focus |
| $gridsection | The type of the complex grid section containing the object. One of the kGrid... constants |
| $helpfolderpath | Full path to help folder containing the html files |
| $indexlistname | The dataname for the index list |
| $parenticonid | The icon id for nodes which have children |
| $skippedamps | Contains ampersand escapes which have been skipped |
| $tooltippos | A kTooltipPos... constant that specifies where $tooltip appears relative to the control kTooltipPosBottom kTooltipPosLeft kTooltipPosMouse kTooltipPosRight kTooltipPosTop |
| $wordcount | Returns the number of words in word list |
| $wordlistname | The dataname for the word list |
| Standard | $active $alpha $candropcursor $componentctrl $componentinfo $componentlib $componentvalid $container $contextmenu $cursor $disablefocus $disablesystemfocus $dragborder $dragiconid $dragmode $dragrange $dropmode $edgefloat $effect $enabled $fieldstyle $framehwnd $gridcolumn $hasfocus $height $helpfile $hwnd $ident $keyevents $left $mouseevents $name $nodropcursor $objtype $order $osdropflags $rmouseevents $selected $sidepanel $sidepanelmode $statusevents $tooltip $top $userinfo $visible $width |
| Object specific | |
| $addfile | Add html file to word and index list |
| $endbuild | Finishes off the build process |
| $fetchtitles | Returns a sublist from the index list as specified by a word in the word list |
| $locateword | Returns the row number of the specified word or nearest word to it |
| $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 |
| $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 |
| $startbuild | Prepares for building of indexes, contents and word list |
| $stripbyoccurrences | Removes entries from word list which have n number of occurences or more |
| $stripbytitles | Removes entries from word list which have been found in n number of documents or more |
| Standard | $redraw |
| Object specific | |||||||
| evAreaClicked | An area in the picture field has been clicked Parameters
| ||||||
| evWillHide | Sent to a field before it is hidden. Currently only used when the field is set as a side panel Parameters
| ||||||
| evWillShow | Sent to a field before it becomes visible. Currently only used when the field is set as a side panel Parameters
| ||||||
| Standard | evAfter evBefore evCanDrop evDisabled evDrag evDragBorder evDragFinished evDrop evEnabled evHidden evKey evMouseDouble evMouseDown evMouseEnter evMouseLeave evMouseUp evOpenContextMenu evRMouseDouble evRMouseDown evRMouseUp evSent evShiftTab evShown evTab evWillDrop |
| $methods |