Version www.capesoft.com

Upgrading from SimTabTree? Take a look at FAQ1

Contents
	Capesoft TabTree Basic Documentation and Template Reference Introduction Jump Start (great for new users and beginners) The TabTree Templates Examples
	TabTree Method and Property Reference Class Methods Class Properties
	Frequently Asked Questions (FAQ)
	General Support Installation and Distribution License & Copyright
	Version History

Introduction

TabTree allows you to add a Sheet-Management control to a window. It creates a list of all the tabs in a list box. You can then navigate between tabs using either the keyboard or mouse and the list itself.

This approach is especially useful on windows where the sheet control contains many tabs, so many that the sheet control "overflows". It's also very useful on windows where you have Sheet Controls on another tab. By presenting the tab list as a tree, the layout of the window becomes a lot simpler.

Features:

• User friendly and modern looking tab selection.
• Handles nested Sheet controls (i.e. sheets on tabs).
• Allows you to set the Sheet as Wizard and/or NoSheet at runtime - thus making design easier.
• Tree selection matches tab selection (where tabs are programmatically selected).
• Multiple TabTree controls on each window.
• Automatically scans all the Sheet and Tab properties and builds the list appropriately.
• Supports Single EXE and Multi-DLL.

Open your application in the Clarion IDE. Add the Activate CapeSoft TabTree Global Extension template to your application. To do this, Click on Global, then Extensions, then Insert, scroll down to the Class TabTree templates and double-click on the Activate CapeSoft TabTree template. Now open the window containing a sheet that you want to replace with the TabTree list, and proceed to the window formatter. Make some space in your window for the TabTree list box (usually on the left). Place the TabTree control template on your window. To do this, From the Populate menu, select Control Template... and select the SimTree control template from the Class SimTabTreeControl items. You don't need to select a Queue in the From field - and if Clarion prompts you for one, simply click the cancel button.
If you are adding this to a MultiDLL application, then follow the steps in the Multi-DLL section of this document.

The TabTree Templates

• Global Extension Template
• TabTree Control Template

The Global Extension Template

• Click the Disable all TabTree features checkbox to disabled TabTree globally. This is useful for debugging - if you suspect that TabTree is causing problems in your application (compile or otherwise).

• The Icons group is used to specify icons used by default for the items in the tab tree lists throughout your application.
  • The Header Icon is used to show sheet entries in the tab list
  • The Header Disabled Icon is used to show sheet entries (or tabs with sheets on them) that are disabled.
  • The Branch Icon is used to show selectable tabs
  • The Branch Disabled Icon is used to show tabs that are disabled.
  • The Selected Icon is used to show the tab that is currently selected.
• The Listbox Line Height is used to globally set the listbox lineheight. If KeepingTabs or Makeover is added to this application, then this entry field will not be available.

• If this is the Data DLL of a Multi-DLL application, then check the Export Class from this DLL checkbox.
• If this application is using the TabTree class exported from the DataDLL, then check the TabTree class exported from another DLL.

TabTree Control Template

• Check the Disable TabTree control to disable this instance of the TabTree control.
• Select the Sheet Control that is the primary control for this TabTree control (required).
• Heading is the column heading in the listbox.
• Root Name is the displayed text for the tree root.
• Check the Make List, not Tree checkbox if you don't want the sheets and tabs displayed as a tree, but would rather they are displayed in a simple list format.
• If you check the Enable column tooltips checkbox,  then you can enter a Tooltip for disabled tab - which can be either a string or a variable (for translation purposes) - or a combination of both.

This tab is used to select the sheet properties that you can set to a list of possible sheet controls on the window. Use the listbox containing all the sheet controls to select to which TabTree must apply the settings that are checked on this tab.

• Checking Set prop:wizard will mean that prop:wizard is applied to the sheets selected - so the user cannot select the tabs via the sheet in the normal manner. They must select the tab via the tabtree listbox.

• Checking Set prop:nosheet will mean that prop:nosheet is applied to the sheets selected - so that no sheet will be displayed (see prop:nosheet in the clarion help docs).

• Object name is the name of this instance of the TabTree class
• Class Name is the name of the class used.

Using TabTree in Multi-DLL applications

In your Data-DLL:

• Add the TabTree Global Extension template, and check the Export Class from this DLL on the Multi-DLL tab.

In you other applications (that require the use of TabTree in that application):

• Add TabTree as per the JumpStart, but check the TabTree class exported from another DLL checkbox on the Multi-DLL tab of the TabTree global extension template.

TabTree Frequently Asked Questions

Runtime Problems

• I have a contract box on my root - but it won't contract the list?

Feature Questions

• How do I change the icons?
• How do I Hand Code TabTree, do you support hand coding without templates?

Upgrading Issues

• How much does it cost to update to the latest version of TabTree from previous versions?
• How do I upgrade from SimTabTree to TabTree?

---

1.1) I have a contract box on my root - but it won't contract the list?

This is unfortunately a limitation of Clarion (as of writing - C6 9058). You will need to switch to using a root (see the template section) which will not have the contract box.

---

2.1) How do I change the icons?

In the Global extension you can choose which icons to use for the tree. At the local level you can override the icons for any one TabTree control.
You can also set icons for a specific Tab using the

2.2) How do I Hand Code TabTree, do you support hand coding without templates?

TabTree, like almost all of our products, is straight forward to hand code. We recommend using the template as a "quick start" for hand coding, as they generate the project and basic code for you:

• Create a new empty application. This can be ABC or Legacy.
• Add the TabTree global extension, and add a window with one or more Tab controls (you can import a window from an actual application, which can be helpful).
• Add the TabTree local extension.
• Generate the application

This provides you with the basic code that you need to use TabTree, and you can export the Project file from the application in order to see what needs to be added to your Project. This approach in very helpful for using any of the CapeSoft templates in a hand coded application, and allows you to use the templates and generator to build the basic code for you. The code can then be copied and pasted into your hand coded applications and modified as needed.

---

3.1) How much does it cost to update to the latest version of TabTree from previous versions?

It is CapeSoft's policy not to charge for updates for as long as we can, so you typically you can upgrade to the latest release of TabTree from any previous version for free. Visit the CapeSoft web site at www.capesoft.com to get the latest version. If you are currently using SimTabTree, then you need to purchase an upgrade to TabTree at a discounted rate (see www.capesoft.com\accessories\tabtreesp.htm for details)

3.2) How do I upgrade from SimTabTree to TabTree?

You must only add the TabTree global extension to your application. The other settings will remain consistent from the SimTabTree local extension template.

Support

Your questions, comments and suggestions are welcome. See our web page (www.capesoft.com) for new versions. You can also contact us in one of the following ways:

CapeSoft Support
	Email   Telephone +27 21 715 4000 Fax +27 21 715 2535 Post PO Box 511, Plumstead, 7801, Cape Town, South Africa

CapeSoft Sales
	Web www.capesoft.com Email   Telephone +27 21 715 4000 Fax +27 21 715 2535 Post PO Box 511, Plumstead, 7801, Cape Town, South Africa

Buy Online
	Web www.clarionshop.com

Installation

Run the supplied installation file.

Distribution

TabTree is supplied as source and compiled into your application, you do not need to ship additional files.

Examples

Notes on getting started.

Start Here

There is an example in your \Clarion\3rdParty\Examples\TabTree\ directory. The examples are a great way to get started and see a few of the ways you can use CapeSoft TabTree. TabTree ships with the following example:

TabTree  Example
	Demo	The main example application.

Version History

Click Here for the Version History