$root.$iwindows.WINDOW.$objs.Tab Pane

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

Class notation

Properties Methods Events 

Tab pane fields have a number of panes on which you can place other fields. When the user clicks on a tab its associated pane is brought to the front displaying the objects on that pane.

Properties

Object specific 
$alltabcaptionsThe tab captions of all the tabs (or page names of all the pages),separated by carriage returns
$alltabtooltipsThe tab tooltips of all the tabs,separated by carriage returns
$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.
$currenttabThe current tab.For window objects,assigning a different value to $currenttab at runtime generates an evTabSelected event
$fieldstylefocusedThe style in system class #STYLES assigned to this field in addition to $fieldstyle when the control has focus
$gridsectionThe type of the complex grid section containing the object. One of the kGrid... constants
$imagenoroomIf true, only the image is shown when insufficient space
$multirowIf true, tabs are shown on many rows
$secondarytextcolorThe textcolor used by some controls as an alternative to the primary textcolor
$selectedtabcolorThe color of the currently selected tab
$showfocusIf true, the focus is shown for each tab
$showimagesIf true, images are to be displayed for each tab
$styledtextIf true, the field supports styled text. The text styles are stripped for objects on macOS style top toolbars,and for the menus created in place of lists to support vertical docking areas
$tabcaptionThe caption for the current selected tab
$tabcolorThe color of tabs which are not selected
$tabcountThe number of tabs
$tabiconidThe icon id of the 16x16 icon for the current tab
$taborientThe orientation for the tabbed pane control
kBottomTabs kTopTabs
$tabstyleThe tabbed pane's style
kAnimatedArrow kDefaultPanes kIDEPanes kMacOS8Panes kRoundedPanes kSquarePanes kTrianglePanes
$tabtooltipThe tooltip text for the tab
$tooltipposA kTooltipPos... constant that specifies where $tooltip appears relative to the control
kTooltipPosBottom kTooltipPosLeft kTooltipPosMouse kTooltipPosRight kTooltipPosTop
Standard$active $alpha $backcolor $backgroundtheme $backpattern $candropcursor $componentinfo $container $contextmenu $cursor $disablefocus $dragborder $dragiconid $dragmode $dragrange $dropmode $edgefloat $enabled $fieldstyle $font $fontsize $fontstyle $forecolor $framehwnd $gridcolumn $hasfocus $height $helpfile $hwnd $ident $keyevents $left $mouseevents $name $nodropcursor $objtype $order $osdropflags $rmouseevents $selected $sidepanel $sidepanelmode $statusevents $textcolor $tooltip $top $userinfo $visible $width

Methods

Object specific 
$allpanes$allpanes(rField[,bAllPanes]) Gets/Sets the all panes flag for the given field reference
$enablepane$enablepane(iPaneNumber,bEnable) sets the enabled state of the pane
$getpaneinfo$getpaneinfo() Returns three column list containing pane information
$ispaneenabled$ispaneenabled(iPaneNumber) Returns true if the pane is enabled
$ispaneshown$ispaneshown(iPaneNumber) Returns true if pane is visible
$listobjects$listobjects([iPaneNumber=0]) When iPaneNumber is zero,returns the list of all objects directly contained by the control.Otherwise it returns the list of all objects directly contained by page or tab iPaneNumber of the control
$panenumber$panenumber(rField[,iPane]) Gets/Sets the pane number for the given field reference
$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
$setpaneinfo$setpaneinfo(lPaneInfo) Sets the pane information from the three column list specified, returns kTrue if successful
$settabinfo$settabinfo(iTabNumber[,cTabCaption,cTabIcon]) sets a tabstrip or tabpane tab caption and or tab icon
$showpane$showpane(iPaneNumber,bShow) sets whether the pane is visible
$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 
evTabClosingSent to a tab strip control when a tab close box has been selected
Parameters
pEventCodeThe event code
pTabNumberThe number of the tab which was selected
evTabGroupSelectedSent to a tab strip control when a new tab group has been selected
Parameters
pEventCodeThe event code
pTabGroupThe id of the tab group selected
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 

$bobjs$methods$objs