Tab Object
The purpose of the Tab object is to define each tab within a Folder. The Tab Properties and Tab Methods are listed below.
Tab Properties
Below is a list of Tab properties.
Tab Properties | Description |
|---|---|
Active | (Internal Use Only) Active/enabled tab. If non-zero, the tab is active. |
Bitmap$ | Bitmap to display to the left of the tab if applicable. |
BackgroundCnt | (Read Only) Background controls counter for the current tab. Used with Preserve Controls. |
DefId | (Read Only) Default button ID for the current tab. Used with Preserve Controls. |
Defk$ | (Read Only) Default button key for the current tab. Used with Preserve Controls. |
DependsCnt | (Read Only) Dependency controls counter for the current tab. Used with Preserve Controls. |
DragonCnt | (Read Only) Drag and drop controls counter for the current tab. Used with Preserve Controls. |
DynapicCnt | (Read Only) Dynamic pictures counter for the current tab. Used with Preserve Controls. |
ExtCnt | (Read Only) External (VBX) controls counter for the current tab. Used with Preserve Controls. |
Grps$ | (Read Only) Comma-separated list of group names for the current tab. |
Id | (Read Only) Sequential ID number of the tab. |
NextId | (Read Only) Contains the contents of the NEXT_ID variable. This property is used with the Preserve Controls option only. NOMADS will load this property after the Post-Display logic for the tab executes and if the Execute Post-Disp One Time option is turned On in the Folder definition panel. |
ObjVarlst$ | (Read Only) Comma-separated list of control names for the current tab. |
OcxCnt | (Read Only) OCX controls counter for the current tab. Used with Preserve Controls. |
OnExit$ | (Read Only) Logic that will execute on exit of the active tab. |
OneTimePostLoad$ | (Read Only) Post-Load logic indicator used with Preserve Controls. |
OneTimePreLoad$ | (Read Only) Pre-Load logic indicator used with Preserve Controls. |
PanelName$ | Panel name for the current tab. |
PersistenceCnt | (Read Only) Object persistence counter for the current tab. Used with Preserve Controls. |
PostLoad$ | (Read Only) Logic that executes after all controls on the active tab are drawn. |
PreLoad$ | (Read Only) Logic that executes before the active tab is drawn. |
Renamed | (Read Only) Flag indicating whether the controls on the tab have yet been renamed (0 or 1). Used with Preserve Controls. |
Resize | (Internal Use Only - Not Used in iNomads) Resize indicator for current tab (0 or 1). |
ScrollCol | (Read Only) Contains the starting scroll column. |
Scrolled | (Read Only) Scrollable tab indicator (0 or 1). |
ScrollLn | (Read Only) Contains the starting scroll line. |
SmartCnt | (Read Only) Smart controls counter for the current tab. Used with Preserve Controls. |
TabTable$ | (Read Only) Contains the tab table definition for the current tab. Used with Preserve Controls. |
Tag$ | User defined information for the tab. |
UsrCnt | (Read Only) User controls counter for the current tab. Used with Preserve Controls. |
Tab Methods
Below is a list of Tab methods.
Tab Methods | Description |
|---|---|
GetAltColour$( ) | (Optional) Returns the secondary fill colour for the tab. See Valid Colour Assignments. |
GetAltkey$( ) | Returns the Alt key for the tab. |
GetAutoCloseFiles( ) | Returns Auto Close Files option (0 or 1). If 1, then all opened files will be closed on exit of the tab. |
GetBackColour$( ) | Returns background colour for the tab. This colour will fill the text background (not the whole region) as long as an S is included in the font attributes. See Valid Colour Assignments. |
GetBackground$(idx,Wdwidx) | (Used Internally by NOMADS) Returns the specified background ID and background logic defined for the tab (each value is separated by a $02$). |
GetButtonSts( ) | Returns the button status for the tab. Returns 1 if enabled, 0 if disabled. |
GetClassHelpQry$(idx,Wdwidx) | (Used Internally by NOMADS) Returns the specified class names, help IDs and query names defined for the tab (each value is separated by a $02$). |
GetColourNum( ) | Returns the colour number (0 - 15). Used for panels created in an older version of NOMADS. |
GetCtlId( ) | Returns the CTL value for the tab. |
GetDeleteImages$( ) | Returns a string containing the images to be deleted for the current tab. |
GetDemandPersist$(idx,Wdwidx) | Returns the specified load on demand logic and the object persistence flags defined for the tab (each value is separated by a $02$). Used with Preserve Controls. |
GetDepends$(idx,Wdwidx) | Returns the specified dependency definitions (conditions, actions and condition values) defined for the tab (each value is separated by a $02$). Used with Preserve Controls. |
GetDragons$(idx,Wdwidx) | Returns the specified drag and drop definition for the tab - drop on control name, drag from control name, drop on CTL value and drop logic (each value is separated by a $02$). Used with Preserve Controls. |
GetFillPattern( ) | Returns the fill pattern to be used for the tab. Values returned: |
GetFocus( ) | Returns the index number of the tab with focus. |
GetGridRefresh$(idx,Wdwidx) | Returns the specified grid information for the current tab - row refresh flag and no cell refresh flag (each value is separated by a $02$). Used with Preserve Controls. |
GetGroups$(idx,Wdwidx) | Returns the specified group definition for the current tab - name and value (each value is separated by a $02$). Used with Preserve Controls. |
GetHideImages$( ) | Returns a string containing the hidden images for the current tab. |
GetInitDraw( ) | Returns the initial draw indicator (0 or 1). |
GetLogic$(idx,Wdwidx) | Returns the specified on select logic, validator logic, formatter logic and on focus logic defined for the tab (each value is separated by a $02$). Used with Preserve Controls. |
GetNameTypeSts$(idx,Wdwidx) | Returns the specified control name, object type and control attributes defined for the tab (each value is separated by $02$). Used with Preserve Controls. |
GetObjCount( ) | Returns the number of controls on the current tab. Used with Preserve Controls. |
GetOcxDefn$(idx,Wdwidx) | Returns the specified OCX definition for the current tab - event name, event function and on event CTL value (each value is separated by a $02$). Used with Preserve Controls. |
GetOcxId(idx,Wdwidx) | Returns the specified OCX IDs defined for the tab. Used with Preserve Controls. |
GetOrigText$( ) | Returns the original text for the tab. Used with Preserve Controls. |
GetPopup$(idx,Wdwidx) | Returns the specified popup name and popup logic defined for the tab (each value is separated by a $02$). Used with Preserve Controls. |
GetShowImages$( ) | Returns a string of images to be shown for the current tab. |
GetSmartCtl$(idx,Wdwidx) | Returns the specified smart trigger variable/control information for the current tab. Used with Preserve Controls. |
GetSmartDefn$(idx,Wdwidx) | Returns the specified smart list definition for the current tab - smart query name, CTL, IOL definition, test condition, MSG, pre-load logic, post load logic, selection logic, format definition, record definition, button IOList and button record definition (each value is separated by a $03$). Used with Preserve Controls. |
GetSuppress$( ) | Returns the suppress tab option (0 or 1). If 1, then at run time, the tab will not be drawn if the sub-panel does not exist or the sub-panel does not have security access. |
GetTabColour$( ) | Returns the first fill colour for the tab. See Valid Colour Assignments. |
GetTextColour$( ) | Returns the colour of the text in the tab. See Valid Colour Assignments. |
GetText$( ) | Returns the text for the tab. Can contain a fixed value or expression ("=" precedes the expression text). |
GetUsrCtls$(idx,Wdwidx) | Returns the specified user CTL definition for the current tab - user CTL value and logic (each value is separated by a $02$). Used with Preserve Controls. |
GetValid$(idx,Wdwidx) | Returns the specified validation rules defined for the tab. Used with Preserve Controls. |
GetTip$( ) | Returns the tip that is displayed below the tab. |
LoadBackGround(idx,Wdwidx,Val$) | Loads the specified background definition for the current tab. Used with Preserve Controls. |
LoadClassHelpQry(idx,Wdwidx,Val$) | Loads the specified class, help, and query definitions for the current tab. Used with Preserve Controls. |
LoadDemandPersist(idx,Wdwidx,Val$) | Loads the specified load on demand logic and object persistence flags for the current tab. Used with Preserve Controls. |
LoadDepends(idx,Wdwidx,Val$) | Loads the specified dependency definitions for the current tab. Used with Preserve Controls. |
LoadDragons(idx,Wdwidx,Val$) | Loads the specified drag and drop definitions for the current tab. Used with Preserve Controls. |
LoadGridRefresh(idx,Wdwidx,Val$) | Loads the specified grid refresh definition for the current tab. Used with Preserve Controls. |
LoadGroups(idx,Wdwidx,Val$) | Loads the specified group definitions for the current tab. Used with Preserve Controls. |
LoadLogic(idx,Wdwidx,Val$) | Loads the specified logic definitions for the current tab. Used with Preserve Controls. |
LoadNameTypeSts(idx,Wdwidx,Val$) | Loads the specified control name, type and control attributes for the current tab. Used with Preserve Controls. |
LoadOcxDefn(idx,Wdwidx,Val$) | Loads the specified OCX definitions for the current tab. Used with Preserve Controls. |
LoadOcxId(idx,Wdwidx,Val) | Loads the specified OCX IDs for the current tab. Used with Preserve Controls. |
LoadPopup(idx,Wdwidx,Val$) | Loads the specified popup definitions for the current tab. Used with Preserve Controls. |
LoadSmartCtl(idx,Wdwidx,Val$) | Loads the specified smart trigger variable/controls for the current tab. Used with Preserve Controls. |
LoadSmartDefn(idx,Wdwidx,Val$) | Loads the specified smart lists definitions for the current tab. Used with Preserve Controls. |
LoadUsrCtls(idx,Wdwidx,Val$) | Loads the specified User CTL definitions for the current tab. Used with Preserve Controls. |
LoadValid(idx,Wdwidx,Val$) | Loads the specified validation rules for the current tab. Used with Preserve Controls. |
SetAltColour(Aclr$) | Sets the secondary fill colour for the tab. Returns 1 if successful, 0 if unsuccessful. |
SetAltkey(A$) | Sets the Alt key for the tab. Returns 1 if successful, 0 if unsuccessful. |
SetAutoCloseFiles(A) | (Internal Use Only) Sets the auto close files option. Returns 1 if successful, 0 if not. |
SetBackColour(BC$) | (Internal Use Only) Sets the background colour for the tab. Returns 1 if successful, 0 if unsuccessful. |
SetColourNum(C) | (Internal Use Only) Sets the colour number (0 - 15) for the tab (used for panels created in older NOMADS versions). Returns 1 if successful, 0 if unsuccessful. |
SetCtlId(C) | (Internal Use Only) Sets the CTL value for the tab. Returns 1 if successful, 0 if unsuccessful. |
SetDeleteImages(DI$) | (Internal Use Only) Sets the deleted images for the current tab. Returns 1 if successful, 0 if unsuccessful. |
SetFillPattern(F) | Sets the fill pattern for the tab. Returns 1 if successful, 0 if unsuccessful. |
SetFocus(F) | (Internal Use Only) Sets the index number of the tab with focus. Returns 1 if successful, 0 if unsuccessful. |
SetHideImages(HI$) | (Internal Use Only) Sets the hidden images for the current tab. Returns 1 if successful. |
SetInitDraw(ID) | (Internal Use Only) Sets the initial draw flag for the current tab. Returns 1 if successful. |
SetObjCount(OC) | (Internal Use Only) Sets the control count for the current tab. Returns 1 if successful, 0 if unsuccessful. |
SetOrigText(T$) | (Internal Use Only) Sets the original text for the tab. |
SetShowImages(SI$) | (Internal Use Only) Sets the hidden images for the current tab. Returns 1 if successful, 0 if unsuccessful. |
SetTabColour(Tclr$) | Sets the first fill colour for the tab. Returns 1 if successful, 0 if unsuccessful. |
SetTextColour(TC$) | Sets the text colour for the tab. Returns 1 if successful, 0 if unsuccessful. |
SetText(T$) | Sets the text for the tab. Returns 1 if successful, 0 if unsuccessful. |
SetTip(T$) | Sets the tip message that will display below the tab. |
SetSuppress(S) | Sets the suppress tab option. |
Valid Colour Assignments
The four options for colour assignment are:
1. | Predefined system colour: Default, Dark Gray, Black, Dark Red, Light Red, Dark Green, Light Green, Dark Yellow, Light Yellow, Dark Blue, Light Blue, Dark Magenta, Light Magenta, Dark Cyan, Light Cyan, Light Gray, White. | |
2. | RGB setting; i.e. RGB: n n n where n = 0 - 255. | |
3. | User defined colour; i.e. Colourn or Colorn where n = 16 - 255. | |
4. | An expression containing one of the above colour assignments. An = (equals sign) must precede the expression. |