TAB CONTROL
Refer to TAB-CONTROL for details about properties, styles and events of this control.
Properties
(name)
Specifies the control name. This property is set automatically when the control is drawn
active-tab-background-color
Opens a dialog that allows the user to choose the background color for the active tab.
 
active-tab-border-color
Opens a dialog that allows the user to choose the border color for the active tab.
 
active-tab-border-width
Opens a dialog that allows the user to choose the border width for the active tab.
 
active-tab-color
Opens a dialog that allows the user to choose the color for the active tab.
 
active-tab-foreground-color
Opens a dialog that allows the user to choose the foreground color for the active tab.
 
additional properties
Allows the user to specify additional properties and styles. The text you write here is generated as is and may generate compile errors if not correct.
allow-container
TRUE...The Allow-Container style is generated. As a consequence, the code generated to manage the tab switch will rely on this style.
FALSE...The Allow-Container style is not generated. As a consequence, the code generated to manage the tab switch will rely visible variables and CMD-TABCHANGED event.
background-bitmap
Opens a dialog box that allows the user to select an image file to load into the control.
background-bitmap-scale
Allows the user to choose if the background-bitmap must be scaled to fit the control area. The Background-Bitmap-Scale property is generated according to this choice.
background-color
Opens a dialog that allows the user to choose the control background color.
bitmap
Opens a dialog box that allows the user to select an image file to load into the control. It’s also possible to generate an image from a series of characters represented with a given font
bitmap-width
Specifies the value for the Bitmap-Width property
color
Opens a dialog that allows the user to choose the control color.
column
Specifies the X coordinate of the control as expressed in cells. This property is set automatically when the control is drawn.
column pixels
Specifies the X coordinate of the control expressed in pixels. This property is set automatically when the control is drawn.
css-base-style-name
css-style-name
Specify the CSS style associated with the control. It works only in a WebDirect environment.
custom-data
Specifies the value for the Custom-Data property.
destroy type
AUTOMATIC...neither the Temporary nor Permanent styles are generated
TEMPORARY...Temporary style is generated
PERMANENT...Permanent style is generated
enabled
NONE...Enabled property is not generated
TRUE... Enabled=1 is generated
FALSE...Enabeld=0 is generated
event list
Opens a dialog that allows you to choose which events must be added to the event list of this control.
exclude event list
NONE... The Exclude-Event-List property is not generated.
0... Exclude-Event-List=0 is generated.
1... Exclude-Event-List=1 is generated.
fixed-width
TRUE...The Fixed-Width style is generated
FALSE...The Fixed-Width style is not generated
font
Opens a dialog that allows the user to choose the control font.
 
The dialog lists the fonts installed in the system and allows you to load new fonts from disc files. Fonts loaded from disc are added to the list with an asterisk before their name. When one of these fonts is selected the Copy Resource option is enabled and can be activated. Activate the option to include the font disc file in the compiled class or be sure to distribute this file along with your application.
foreground-color
Opens a dialog that allows the user to choose the control foreground color.
gradient-color-1
Opens a dialog that allows the user to choose the window gradient start color.
 
gradient-color-2
Opens a dialog that allows the user to choose the window gradient end color.
 
gradient-orientation
Specifies the gradient orientation. Possible values are:
None
0: NORTH-TO-SOUTH
1: NORTHEAST-TO-SOUTHWEST
2: EAST-TO-WEST
3: SOUTHEAST-TO-NORTHWEST
4: SOUTH-TO-NORTH
5: SOUTHWEST-TO-NORTHEAST
6: WEST-TO-EAST
7: NORTHWEST-TO-SOUTHEAST
height-in-cells
TRUE...The Height-In-Cells style is generated
FALSE... The Height-In-Cells style is not generated
help-id
Specifies the control Help-id.
hint
Specifies the value for the Hint property.
hot-track
TRUE...The Hot-Track style is generated
FALSE...The Hot-Track style is not generated
id
Specifies the control id. This property is set automatically when the control is drawn.
key
Specifies the value for the Key property.
layout-data
Opens a dialog that allows the user to choose the control resize rules.
If the option "Follows Layout-Manager defaults" is checked, the Layout-Data property is not generated.
line
Specifies the Y coordinate of the control as expressed in cells. This property is set automatically when the control is drawn
line pixels
Specifies the Y coordinate of the control expressed in pixels. This property is set automatically when the control is drawn
lines
Specifies the control height as expressed in cells. This property is set automatically when the control is drawn
lines pixels
Specifies the control height expressed in pixels. This property is set automatically when the control is drawn
lines unit
DEFAULT... Either CELLS or nothing is generated after the Lines value depending on the window’s “cell” property setting
None... Neither CELLS nor PIXELS are generated after the Lines value
CELLS... CELLS is generated after the Lines value
PIXELS... PIXELS is generated after the Lines value
lock
TRUE...Locks the control on the Screen Designer so that you cannot move it anymore by dragging it with the mouse.
FALSE...You can move the control on the Screen Designer by dragging it with the mouse
max-height
Specifies the control maximum height as expressed in cells
max-width
Specifies the control maximum width as expressed in cells
min-height
Specifies the control minimum height as expressed in cells
min-width
Specifies the control minimum width as expressed in cells
multiline
TRUE...The Multiline style is generated
FALSE...The Multiline style is not generated
no-box
TRUE...The No-Box style is generated
FALSE...The No-Box style is not generated
no-dividers
TRUE...The No-Dividers style is generated
FALSE...The No-Dividers style is not generated
no-tab
TRUE...The No-Tab style is generated
FALSE...The No-Tab style is not generated
notify-mouse
TRUE...The Notify-Mouse style is generated
FALSE...The Notify-Mouse style is not generated
pop up menu
Associates a pop-up menu with the control. The menu must have been drawn on the same screen.
relative-offset
TRUE...The Relative-Offset style is generated
FALSE...The Relative-Offset style is not generated
size
Specifies the control width as expressed in cells. This property is set automatically when the control is drawn
size pixels
Specifies the control width as expressed in pixels. This property is set automatically when the control is drawn
size unit
DEFAULT... Either CELLS or nothing is generated after the Size value depending on the window’s “cell” property setting
None... Neither CELLS nor PIXELS are generated after the Size value
CELLS... CELLS is generated after the Size value
PIXELS... PIXELS is generated after the Size value
tab order
Sets the ordinal position of the control in the Screen Section. This property is set automatically when the control is drawn
tab orientation
Allows the user to choose one of the following styles:
TOP
VERTICAL LEFT
VERTICAL RIGHT
BOTTOM
text-norotate
TRUE... The Text-Norotate style is generated
FALSE.. The Text-Norotate style is not generated
value
Specifies the value for the Value property
visible
NONE...Visible property is not generated
TRUE... Visible=1 is generated
FALSE...Visible=0 is generated
Events
cmd-goto event
Allows the user to create a paragraph to handle the CMD-GOTO event in the Procedure Division
cmd-help event
Allows the user to create a paragraph to handle the CMD-HELP event in the Procedure Division
cmd-tabchanged event
Allows the user to create a paragraph to handle the CMD-TABCHANGED event in the Procedure Division
msg-end-menu event
Allows the user to create a paragraph to handle the MSG-END-MENU event in the Procedure Division
msg-init-menu event
Allows the user to create a paragraph to handle the MSG-INIT-MENU event in the Procedure Division
msg-menu-input event
Allows the user to create a paragraph to handle the MSG-MENU-INPUT event in the Procedure Division
msg-mouse-clicked event
 
Allows the user to create a paragraph to handle the MSG-MOUSE-CLICKED event in the Procedure Division
msg-mouse-dblclick event
Allows the user to create a paragraph to handle the MSG-MOUSE-DBLCLICK event in the Procedure Division
msg-mouse-enter event
Allows the user to create a paragraph to handle the MSG-MOUSE-ENTER event in the Procedure Division
msg-mouse-exit event
Allows the user to create a paragraph to handle the MSG-MOUSE-EXIT event in the Procedure Division
msg-validate event
Allows the user to create a paragraph to handle the MSG-VALIDATE event in the Procedure Division
other event
Allows the user to create a custom paragraph
Exceptions
cmd-goto exception
Allows the user to create a paragraph to handle the CMD-GOTO event when the Accept terminates with crt status = 96. This is an alternative to the event procedures described above
cmd-help exception
Allows the user to create a paragraph to handle the CMD-HELP event when the Accept terminates with crt status = 96. This is an alternative to the event procedures described above
cmd-tabchanged
Allows the user to create a paragraph to handle the CMD-TABCHANGED event when the Accept terminates with crt status = 96. This is an alternative to the event procedures described above
other exception
Allows the user to create a custom paragraph
Procedures
After procedure
Allows the user to create a paragraph to handle the control AFTER PROCEDURE
After procedure thru
Allows the user to optionally specify a THRU paragraph for the AFTER PROCEDURE.
After-Tabchg Display
Allows the user to create a paragraph that will be executed after CMD-TABCHANGED handling
Before procedure
Allows the user to create a paragraph to handle the control BEFORE PROCEDURE
Before procedure thru
Allows the user to optionally specify a THRU paragraph for the BEFORE PROCEDURE.
Before-Tabchg Display
Allows the user to create a paragraph that will be executed before CMD-TABCHANGED handling
Event procedure
Allows the user to create a paragraph to handle the control EVENT PROCEDURE
Exception procedure
Allows the user to create a paragraph to handle the control EXCETPION PROCEDURE
Variables
active-tab-background-color variable
Numeric variable that hosts the value for the Active-Tab-Background-Color property
active-tab-border-color variable
Numeric variable that hosts the value for the Active-Tab-Border-Color property
active-tab-color variable
Numeric variable that hosts the value for the Active-Tab-Color property
active-tab-foreground-color variable
Numeric variable that hosts the value for the Active-Tab-Foreground-Color property
background-bitmap-scale variable
Numeric variable that hosts the value for the Background-Bitmap-Scale property
bitmap-width variable
Numeric variable that hosts the value for the Bitmap-Width property
color variable
Numeric variable that hosts the color value
column variable
Numeric variable that hosts the column value
css-style-name variable
Alphanumeric variable that hosts the css style associated with the control. It works only in a WebDirect environment.
enabled variable
Numeric variable that hosts the enabled state
gradient-color-1 variable
Numeric variable that hosts the value for the Gradient-Color-1 property
gradient-color-2 variable
Numeric variable that hosts the value for the Gradient-Color-2 property
gradient-orientation variable
Numeric variable that hosts the value for the Gradient-Orientation property
help-id variable
Numeric variable that hosts the help id
hint variable
Alphanumeric variable that hosts the value for the Hint property
id variable
Numeric variable that hosts the control id
key variable
Alphanumeric variable that hosts the value for the Key property
layout-data variable
Numeric variable that hosts the control resize rules
lines variable
Numeric variable that hosts the lines value
line variable
Numeric variable that hosts the line value
max-height variable
Numeric variable that hosts the maximum height
max-width variable
Numeric variable that hosts the maximum width
min-height variable
Numeric variable that hosts the minimum height
min-width variable
Numeric variable that hosts the minimum width
size variable
Numeric variable that hosts the size value
value variable
Numeric variable that hosts the value for the Value property
visible variable
Numeric variable that hosts the visible state