ListBox 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

ListBox items:

The items that are contained in the listbox.

A list consists of a number of items, each one with two parts: item text, which is the visible part that will appear in the listbox, 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. If the Checklist box option is enabled a checkbox is also shown where you can set its initial state.

Items can be added to the list by clicking on one of the fields and entering the desired text. You can manipulate the list using the buttons at the bottom of the dialog. The Insert Row button can be used to insert an item into the list, essentially inserting a new "row." The remove, up, and down buttons allow you to remove or move items in the list. The ascending and descending buttons can be used to sort the list in ascending or descending order.

Options

Checklist box

Whether to display a checkbox for each item in the list control. (Switches between the "normal" list box type and the checklist box type.)

Tip: You can toggle many checkboxes at once by selecting multiple items and pressing the space bar.

Multiple selection

Enable multiple listbox items to be selected at one time.

Sort

Sort and display the listbox items alphabetically at runtime. If this option is unchecked, listbox items will be displayed in the order they appear at design time or added at run time.

Vertical scrollbar

Include a vertical scroll bar for the object.

Horizontal scrollbar

Include a horizontal scroll bar for the object.

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 listbox items. 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.

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 ListBox.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 ListBox.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 listbox 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 Double-click

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

On Select

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

On Key

The actions that will be performed whenever the listbox 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 listbox object is given focus. For example, it will be given focus if the user clicks inside the object.

On Check

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

Note that clicking on an unselected checkbox in the list will trigger an On Select event before the On Check event is fired. This is the normal behaviour for checklist box controls in Windows. Specifically, clicking on a checkbox in the list toggles the check for all selected items. If the item is currently unselected, it is selected first, then the checkbox is toggled.

Note: If the item is already selected, there will be no On Select event first. Do not depend on there being an On Select every time you toggle a check box.