$root.$iwindows.WINDOW.$objs.HTML Control

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

Class notation

Properties Methods Events 

Properties

Object specific 
$eventhwndThe control to which the component sends events
$fieldstylefocusedThe style in system class #STYLES assigned to this field in addition to $fieldstyle when the control has focus
$filenameThe pathname of the document to display
$fontsizeadjA numeric adjustment between -3 and 3 to apply to the font size
$gridsectionThe type of the complex grid section containing the object. One of the kGrid... constants
$pointsizeforpreandxmpThe point size (2-63) to use for the fixed width font used by the <pre> and <xmp> tags
$searchwordsA space separated list of up to five words which will be highlighted in the displayed document when the document is opened
$tooltipposA kTooltipPos... constant that specifies where $tooltip appears relative to the control
kTooltipPosBottom kTooltipPosLeft kTooltipPosMouse kTooltipPosRight kTooltipPosTop
Standard$active $alpha $candropcursor $componentctrl $componentinfo $componentlib $componentvalid $container $contextmenu $cursor $dataname $disablefocus $disablesystemfocus $dragborder $dragiconid $dragmode $dragrange $dropmode $edgefloat $effect $enabled $fieldstyle $framehwnd $gridcolumn $hasfocus $height $helpfile $horzscroll $hwnd $ident $keyevents $left $mouseevents $name $nodropcursor $objtype $order $osdropflags $rmouseevents $selected $sidepanel $sidepanelmode $statusevents $tooltip $top $userinfo $vertscroll $visible $width

Methods

Object specific 
$getselectedtextSets cText to the text which is currently selected in the document
$pathtoapiConverts cPath from the HTML syntax to the syntax for the current platform, and sets cPath to the result
$pathtohtmlConverts cPath from the syntax for the current platform to the HTML syntax, and sets cPath to the result
$printdocumentPrints the document
$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
$startanimatescrollStarts scrolling the document once every iInterval milliseconds by the specified units
$stopanimatescrollStops automatic scrolling of the document
Standard$redraw

Events

Object specific 
evLinkClickedSent to the control when a link is selected
Parameters
pEventCodeThe event code
pLinkgroupThe group number of the selected link
pLinkidThe command number of the selected link
evLinkKeyModifiersChangedSent to the control when the keyboard modifiers change
Parameters
pEventCodeThe event code
pKeyModifiersThe new key modifiers
evMousePosSent to the control when mouse entered or left control
Parameters
pEventCodeThe event code
pEnteredIf true,the mouse entered the control
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 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