OOP Interface 

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.

  0 - Always execute Post-Load logic (Default)
  1 - Execute Post-Load logic one time only

OneTimePreLoad$

(Read Only)

Pre-Load logic indicator used with Preserve Controls.

  0 - Always execute Pre-Load logic (Default)
  1 - Execute Pre-Load logic one time only

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

Description

GetAltColour$( )
GetAltColor$( )

(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$( )
GetBackColor$( )

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$).

idx - Table index number

Wdwidx - Window index (0 - 4)

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$).

idx - Table index number

Wdwidx - Window index (0 - 4)

GetColourNum( )
GetColorNum( )

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.

idx - Table index number

Wdwidx - Window index (0 - 4)

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.

idx - Table index number

Wdwidx - Window index (0 - 4)

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.

idx - Table index number

Wdwidx - Window index (0 - 4)

GetFillPattern( )

Returns the fill pattern to be used for the tab. Values returned:

  1 - Solid fill
  2 - Top to bottom
  3 - Left to right
  4 - Crossed line
  5 - Top-left to bottom-right
  6 - Bottom-left to top-right
  7 - Diagonal crossed lines

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.

idx - Table index number

Wdwidx - Window index (0 - 4)

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.

idx - Table index number

Wdwidx - Window index (0 - 4)

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.

idx - Table index number

Wdwidx - Window index (0 - 4)

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.

idx - Table index number

Wdwidx - Window index (0 - 4)

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.

idx - Table index number

Wdwidx - Window index (0 - 4)

GetOcxId(idx,Wdwidx)

Returns the specified OCX IDs defined for the tab. Used with Preserve Controls.

idx - Table index number

Wdwidx - Window index (0 - 4)

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.

idx - Table index number

Wdwidx - Window index (0 - 4)

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. 

idx - Table index number

Wdwidx - Window index (0 - 4)

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.

idx - Table index number

Wdwidx - Window index (0 - 4)

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$( )
GetTabColor$( )

Returns the first fill colour for the tab. See Valid Colour Assignments.

GetTextColour$( )
GetTextColor$( )

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.

idx - Table index number

Wdwidx - Window index (0 - 4)

GetValid$(idx,Wdwidx)

Returns the specified validation rules defined for the tab. Used with Preserve Controls.

idx - Table index number

Wdwidx - Window index (0 - 4)

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.

idx - Table index number

Wdwidx - Window index (0 - 4)

Val$ - Contains the background ID and background logic (each value is separated by a $02$)

LoadClassHelpQry(idx,Wdwidx,Val$)

Loads the specified class, help, and query definitions for the current tab. Used with Preserve Controls.

idx - Table index number

Wdwidx - Window index (0 - 4)

Val$ - Contains the class name, help ID and query name (each value is separated by a $02$)

LoadDemandPersist(idx,Wdwidx,Val$)

Loads the specified load on demand logic and object persistence flags for the current tab. Used with Preserve Controls.

idx - Table index number

Wdwidx - Window index (0 - 4)

Val$ - Contains the load on demand logic and object persistence flag (each value is separated by a $02$)

LoadDepends(idx,Wdwidx,Val$)

Loads the specified dependency definitions for the current tab. Used with Preserve Controls.

idx - Table index number

Wdwidx - Window index (0 - 4)

Val$ - Contains the dependency condition, action and condition value (each value is separated by a $02$)

LoadDragons(idx,Wdwidx,Val$)

Loads the specified drag and drop definitions for the current tab. Used with Preserve Controls.

idx - Table index number

Wdwidx - Window index (0 - 4)

Val$ - Contains the drop on control name, drag from control name, drop on CTL value and drop logic (each value is separated by a $02$)

LoadGridRefresh(idx,Wdwidx,Val$)

Loads the specified grid refresh definition for the current tab. Used with Preserve Controls.

idx - Table index number

Wdwidx - Window index (0 - 4)

Val$ - Contains the grid row refresh flag and no cell refresh flag (each value is separated by a $02$)

LoadGroups(idx,Wdwidx,Val$)

Loads the specified group definitions for the current tab. Used with Preserve Controls.

idx - Table index number

Wdwidx - Window index (0 - 4)

Val$ - Contains the name and value (each value is separated by a $02$)

LoadLogic(idx,Wdwidx,Val$)

Loads the specified logic definitions for the current tab. Used with Preserve Controls.

idx - Table index number

Wdwidx - Window index (0 - 4)

Val$ - Contains the on select logic, validator logic, formatter logic and on focus logic (each value is separated by a $02$)

LoadNameTypeSts(idx,Wdwidx,Val$)

Loads the specified control name, type and control attributes for the current tab. Used with Preserve Controls.

idx - Table index number

Wdwidx - Window index (0 - 4)

Val$ - Contains the control name, object type and control attributes (each value is separated by a $02$)

LoadOcxDefn(idx,Wdwidx,Val$)

Loads the specified OCX definitions for the current tab. Used with Preserve Controls.

idx - Table index number

Wdwidx - Window index (0 - 4)

Val$ - Contains the OCX event name, event function and on event CTL value (each value is separated by a $02$)

LoadOcxId(idx,Wdwidx,Val)

Loads the specified OCX IDs for the current tab. Used with Preserve Controls.

idx - Table index number

Wdwidx - Window index (0 - 4)

Val - Contains the OCX identifier

LoadPopup(idx,Wdwidx,Val$)

Loads the specified popup definitions for the current tab. Used with Preserve Controls.

idx - Table index number

Wdwidx - Window index (0 - 4)

Val$ - Contains the popup name and popup logic (each value is separated by a $02$)

LoadSmartCtl(idx,Wdwidx,Val$)

Loads the specified smart trigger variable/controls for the current tab. Used with Preserve Controls.

idx - Table index number

Wdwidx - Window index (0 - 4)

Val$ - Contains the trigger variable/control

LoadSmartDefn(idx,Wdwidx,Val$)

Loads the specified smart lists definitions for the current tab. Used with Preserve Controls.

idx - Table index number

Wdwidx - Window index (0 - 4)

Val$ - Contains the 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$)

LoadUsrCtls(idx,Wdwidx,Val$)

Loads the specified User CTL definitions for the current tab. Used with Preserve Controls.

idx - Table index number

Wdwidx - Window index (0 - 4)

Val$ - Contains the user CTL value and logic (each value is separated by a $02$)

LoadValid(idx,Wdwidx,Val$)

Loads the specified validation rules for the current tab. Used with Preserve Controls.

idx - Table index number

Wdwidx - Window index (0 - 4)

Val$ - Contains the validation rules

SetAltColour(Aclr$)
SetAltColor(Aclr$)

Sets the secondary fill colour for the tab. Returns 1 if successful, 0 if unsuccessful. 

Aclr$ - String containing one of four possible colour selections. See Valid Colour Assignments.

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. 

A - Can contain 0 or 1. If 1 is assigned, all opened files will be closed on exit of the tab.

SetBackColour(BC$)
SetBackColor(BC$)

(Internal Use Only)

Sets the background colour for the tab. Returns 1 if successful, 0 if unsuccessful.

BC$ - String containing one of four possible colour selections. See Valid Colour Assignments.

SetColourNum(C)
SetColorNum(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.

F can contain:

  1 - Solid fill
  2 - Top to bottom
  3 - Left to right
  4 - Crossed line
  5 - Top-left to bottom-right
  6 - Bottom-left to top-right
  7 - Diagonal crossed lines

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$)
SetTabColor(Tclr$)

Sets the first fill colour for the tab. Returns 1 if successful, 0 if unsuccessful.

Tclr$ - String containing one of four possible colour selections. See Valid Colour Assignments.

SetTextColour(TC$)
SetTextColor(TC$)

Sets the text colour for the tab. Returns 1 if successful, 0 if unsuccessful.

TC$ - String containing one of four possible colour selections. See Valid Colour Assignments.

SetText(T$)

Sets the text for the tab. Returns 1 if successful, 0 if unsuccessful.

T$ - Can contain a fixed value or an expression. An = (equals sign) must precede the expression.

SetTip(T$)

Sets the tip message that will display below the tab.

T$ - Can contain a fixed value or an expression. An = (equals sign) must precede the expression.

SetSuppress(S)

Sets the suppress tab option.

S - Can contain 0 or 1. If 1 is assigned, 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.