$root.$iwindows.WINDOW.$objs.Rtf Viewer

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
$gridsectionThe type of the complex grid section containing the object. One of the kGrid... constants
$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 
evIconPickedSent to the control when a new icon is picked
Parameters
pEventCodeThe event code
pLinenumThe line number of the icon selected in the sidebar
evSetBeingPickedSent to the control when a new icon strip is being picked
Parameters
pEventCodeThe event code
pStripnumThe new strip that is being picked
evSetPickedSent to the control when a new icon strip is picked
Parameters
pEventCodeThe event code
pStripnumThe new strip that is being picked
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