Class: TabPage

Properties  Events  Methods    Index of Classes

Creates a page within a tab-dialog container

Hierarchy

cObject
---cUIObject
------DfBaseObject
---------DfBaseWindow
------------DfBaseUIWindow
---------------DfBaseContainer
------------------DfBaseDialog
---------------------Container3d
------------------------TabPage

Library: Windows Application Class Library

Package: Windows.pkg

Mixins: Tab_Page_Mixin

Description

TabPage is used to create a page within a tab dialog container. These objects should always be created directly inside a TabDialog object. A tab page is assigned a label. That label will appear as a tab at the top of the tab dialog. Any number of tab pages may be assigned to a tab dialog. If all tab pages will not fit within the dialog, then a scroll button will appear in the dialog allowing users to select any tab page by scrolling.

The dbTabPage class is a data-aware class similar to the TabPage class.

Sample

 
Object TabDialog1 is TabDialog
    Set Size to 117 271
    Set Location to 10 15
 
    Object TabPage1 is a TabPage
        Set Label to "TabPage1"
        Set Status_Help to "Tab Page 1 Status Help"
        Set Tab_ToolTip_Value to "Tab Page 1 tool tip"
        :
    End_Object
 
    Object TabPage2 is a TabPage
        Set Label to "Read-Only"
        Set Enabled_State to False
        :
    End_Object
 
End_Object


Syntax

Use windows

Object object_name is a TabDialog
    Set Size to height width
    Set Location to row column
    Set Rotate_mode to RotateMode
    
    Object oObjectName is a TabPage
        Set Label to TabButtonLabel
        Set Status_Help to StatusHelpText
        Set Tab_ToolTip_Value to ToolTipText
        Set Button_Shadow_State to True|False
        Set Enabled_State to True|False
        : 
    End_Object
 
    Object oObjectName is a TabPage
        :
    End_Object
 
End_Object


Note

TabPage objects should only be placed inside of TabDialog objects. Only basic objects (i.e., the non "db" objects such as Form, Edit, Button, Group, etc.) should be placed inside of a TabPage. Data-aware objects (dbForm, dbEdit, dbGroup, etc.) must be placed inside of data-aware page, the dbTabPage. Do not place dbTabPage objects inside of a TabDialog. Likewise do not place TabPage objects inside of a dbTabDialog.

Auto-Size / Auto-Location

The size and location of a tab page is set automatically and is determined by the size and location of its parent tab-dialog object.

Tab Button Labels

The label displayed by the tab page's tab is set and queried with the label property.

Shadowing

Individual pages can be disabled by setting the tab page's button_shadow_state to true (the tab cannot be selected and the tab page cannot be displayed) or by setting the page's enabled_state to false (the tab is enabled, the page can be displayed but it cannot be entered).

Tool-Tips

Tab Pages support tool-tips. When the mouse is moved over a tab button the tool-tip text for that button is displayed. The text value is stored in the Tab_ToolTip_Value property. The display of a tool-tip is disabled if the text value is blank.