Tree Object

Here are the object's settings as they appear on the "double-click" Properties dialog.

There are three tabs on the Properties dialog:

Settings

Attributes

Script

Settings Tab

Object

Tree items

The items that are contained in the tree.

A tree consists of a number of items, each one with two parts: item text, which is the visible part that will appear in the tree, and item data, which is an invisible part that is associated with that item. You can use the item data to store any information that you want to associate with the item text, such as a file path or page name.

Items can be added to the tree by clicking add button and entering the desired text. You can manipulate structure of the tree using the buttons at the bottom of the dialog.

Properties

Opens the Tree Item dialog, allowing you to edit the properties of the currently selected tree item.

Options

Show checkboxes

Show checkboxes next to each item in the tree.

Has lines

Include lines linking the items in the tree.

Lines at root

Includes lines at the root level of the tree linking sub items.

Has buttons

Include expand/collapse buttons by each item with child elements.

Edit labels

Allow the items in the tree to be edited or renamed, similar to how files and folders are renamed in windows.

Always show selection

Causes a selected item to remain selected when the tree-view control loses focus.

Font...

The font that you want to use for the text. Click the Select Font button to open the Font dialog where you can edit all of the font settings.

Tip: You can set the default font for this object type by configuring its settings on the Objects tab in Edit > Preferences.

Special

Background:

The background color to use for the object. You can click the select button to bring up a color chooser.

Tip: Clicking the "More Colors..." button on the color menu allows you to choose either a standard color/custom color, or use the eyedropper to pick a color from somewhere within the AutoPlay application window.

Text:

The text color to use for the items in this object. You can click the select button to bring up a color chooser.

Border mode:

The style of border to display around the object.

None

Don't display any border around the object.

Flat

Display a thin black border around the object.

Sunken

The object will have a "sunken" appearance on the page or dialog.

Read order:

The order the text will display when typed into the object. Choose from:

Standard

Display the text normally, from left to right.

Right to Left

If the shell language is Hebrew, Arabic, or another language that supports reading-order alignment, the text is displayed using right-to-left reading-order properties. For other languages, this style is ignored.

Image List

Use image list

If checked, the specified image list file will be used in the tree object. If unchecked, no image list file will be used.

Image list

A bitmap image (maximum 32bit supported) that contains 16x16 icons to be used by the Tree object as icons for each tree item.

Note: The image used as the image list must be a bitmap image (.bmp).

The following example illustrates a proper image list:

The picture above includes three 16x16 icons. The orange icon (left-most) has an index of 0. The purple icon (middle) has an index of 1. The circle icon (right-most) has an index of 2.

Note: To specify which icon each tree item will display, specify the Image index in each item's properties.

Transparent color:

The color that will be transparent in the image list. Click the select button to bring up a color chooser. The color that you click on will be used to represent transparency in the image list.

Tip: Clicking the "More Colors..." button on the color menu allows you to choose either a standard color/custom color, or use the eyedropper to pick a color from somewhere within the AutoPlay application window.

Attributes Tab

Identification

Object name:

The name that is used to identify this object.

State

Enabled

Enable the object so it responds to user interaction. When an object is disabled, it will not respond to any mouse overs or clicks and will not perform any actions until it is enabled.

Note: You can use the Tree.SetEnabled action to enable this object.

Visible

Set the object's initial visibility (whether it's visible when the page or dialog is displayed).

Note: You can use the Tree.SetVisible action to make the object visible or invisible at run time.

Auto-Resize

Left

If checked, the left side of the object will move when the application is resized. If unchecked, the left side of the object will not move.

Right

If checked, the right side of the object will move when the application is resized. If unchecked, the right side of the object will not move.

Top

If checked, the top of the object will move when the application is resized. If unchecked, the top of the object will not move.

Bottom

If checked, the bottom of the object will move when the application is resized. If unchecked, the bottom of the object will not move.

Position

Left:

The distance in pixels from the left edge of the object to the left edge of the page or dialog.

Tip: You can also change the position of an object by dragging it.

Top:

The distance in pixels from the top edge of the object to the top edge of the page or dialog.

Width:

The width of the object in pixels.

Tip: You can also resize an object by dragging one of the resize handles on its bounding box.

Height:

The height of the object in pixels.

Restore Original

Set's the object's size back to the original values.

Feedback

Tooltip:

A short string of text that will appear after the mouse hovers over this object for a moment.

Tip: You can choose from several tooltip styles for all tooltips in your project, Standard, Balloon and Extended. This setting can be found on the Appearance tab of the Project > Settings.

Tip: If you want a newline in your tooltip text, use "\r\n". For example, for an Extended tooltip, "My First Line\r\nMy Second Line|My Title". Newlines are not supported in the Title text for Balloon or Extended styles.

Tip: If you want a "&" character in the text, you must enter "&&&".

Spelling

Check the spelling of the tooltip text.

Cursor:

Note: This option is not available for tree objects.

Script Tab

You can use the script editor on this tab to edit the script of actions that will be performed on each of this object's events.

This object supports the following events:

On Select

The actions that will be performed when the user selects or deselects items in the tree.

The following event variables are automatically set whenever this event is triggered:

e_NodeIndex

(string) The index of the selected node.

On Double-click

The actions that will be performed when the user double-clicks an item in the tree.

The following event variables are automatically set whenever this event is triggered:

e_NodeIndex

(string) The index of the node that was double-clicked.

On Key

The actions that will be performed whenever the tree object has focus and the user presses a key.

The following event variables are automatically set whenever this event is triggered:

e_Key

(number) The virtual key code of the key that was pressed.

e_Modifiers

(table) A table containing three boolean values that describe which modifier keys were held down while the key was pressed. A modifier key is a key that can be held down while another key is pressed, to "modify" it.

There are three true/false values in the table, one for each type of modifier key on the keyboard: shift, ctrl, and alt. You can access these values as e_Modifiers.shift, e_Modifiers.ctrl, and e_Modifiers.alt.

On Focus

The actions that will be performed whenever the tree object is given focus. For example, it will be given focus if the user clicks inside the object.

On EditLabel

The actions that will be performed whenever an item's label is changed in the tree object.

The following event variables are automatically set whenever this event is triggered:

e_NodeIndex

(string) The index of the node being edited.

e_NewText

(string) The text that has just been set.

e_OldText

(string) The text that existed previously before the user edited the current node.

On Check

The actions that will be performed whenever an item is checked/unchecked in the tree object.

e_NodeIndex

(string) The index of the node being checked/unchecked.

e_Checked

(boolean) True if the node has been checked, false if it has been unchecked.

On Expanded

The actions that will be performed whenever an item is expanded/collapsed in the tree object.

e_NodeIndex

(string) The index of the node being expanded/collapsed.

e_Expanded

(boolean) True if the node has been expanded, false if it has been collapsed.