AddTabControl

>>-anAdvancedControl~AddTabControl(--id--,--+---------------+--,--x-->
                                            +-attributeName-+

>--,--y--,--cx--,--cy--+------------------------------+--)----------><
                       |       +-----------------+    |
                       |       V                 |    |
                       +-,--"----+-ALIGNRIGHT--+-+--"-+
                                 +-BUTTONS-----+
                                 +-FIXED-------+
                                 +-FOCUSNEVER--+
                                 +-FOCUSONDOWN-+
                                 +-ICONLEFT----+
                                 +-LABELLEFT---+
                                 +-MULTILINE---+
                                 +-GROUP-------+
                                 +-HIDDEN------+
                                 +-NOTAB-------+
                                 +-NOBORDER----+


The AddTabControl method adds a tab control to the dialog and connects it with a data attribute. For further information on tab controls, refer to TabControl Class.

Arguments:

The arguments are:

id

A unique identifier assigned to the control. You need the ID to refer to this control in other methods.

attributeName

The name of the data attribute associated with the dialog item. See ConnectTreeControl to get information on what happens when this argument is omitted.

x, y

The position of the upper left corner of the control relative to the dialog, in dialog units.

cx, xy

The width and height of the dialog item, in dialog units.

options

This argument determines the behavior and style of the dialog item and can be one or more of the following:

ALIGNRIGHT

Right-justifies tabs. By default, tabs are left-justified within a row.

BUTTONS

Modifies the appearance of the tabs to look like buttons.

FIXED

Makes all tabs equal in width. You cannot use this option with the ALIGNRIGHT option.

FOCUSNEVER

A tab never receives the input focus.

FOCUSONDOWN

A tab receives the input focus when clicked (typically with option BUTTONS).

ICONLEFT

Forces the icon to the left, but leaves the tab label centered. By default, the control centers the icon and label, with the icon being to the left of the label.

LABELLEFT

Left-aligns both the icon and the label.

MULTILINE

Causes a tab control to display several rows of tabs, enabling all tabs to be displayed at the same time.

GROUP

Specifies the first control of a group of control in which the user can move from one control to the next with the arrow keys.

HIDDEN

The control is initially hidden.

NOTAB

The tab key cannot be used to move to this control.

NOBORDER

No border is drawn around the control.

Return value:

The possible return values are:

0

Success.

less than 0

Error with the in-memory dialog template or with the resource ID.

Example:

The following example creates a tab control with ID PAGES and multiline capability. Its data (the selected tab) is associated with attribute CURRENTPAGE.

MyDialog~AddTabControl("PAGES","CURRENTPAGE", 10, 120, 200, 20, ,
"MULTILINE FIXED")