ListBox Object

Here are the object's settings as they appear in the properties pane:

Object

Name

The name that is used to identify this object.

Items

The items that are contained in the listbox. Click the edit button to open the ListBox Contents dialog where you can create or modify your list.

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 Type is set to CheckListBox, 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 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

Type

The type of listbox control to use. Choose from:

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

ListBox

A "normal' list box type.

CheckListBox

Display a checkbox for each item in the list.

MultipleSelection

Enable multiple listbox items to be selected at one time. Choose from:

True

Multiple items can be selected in the object at one time.

False

Only one listbox item can be selected at one time.

Sort

Sort and display the listbox items alphabetically at runtime. Choose from:

True

Listbox items will be displayed in alphabetical order.

False

Listbox items will be displayed in the order they appear at design time.

VerticalScrollbar

Include a vertical scroll bar for the object. Choose from:

True

Include a vertical scroll bar.

False

Don't include a vertical scroll bar.

HorizontalScrollbar

Include a horizontal scroll bar for the object. Choose from:

True

Include a horizontal scroll bar.

False

Don't include a horizontal scroll bar.

Font

The font that you want to use for the text. Click the edit 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.

FontFamily

The font family that you want to use.

FontSize

The font size, in points.

FontBold

Make the text bolded.

FontItalic

Make the text appear in italics.

BackgroundColor

The background color to use for the object.

TextColor

The text color to use for the listbox items.

Tip: You can click the select button to bring up a color chooser. 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.

BorderMode

The border style to display around the object. Choose from:

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.

ReadOrder

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

TooltipText

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 "&&&".

Enabled

Enable the object so it responds to user interaction. Choose from:

True

The object will respond to mouse overs and clicks and perform any actions assigned to its events.

False

The object 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. Choose from:

True

The object will be visible when the page or dialog is displayed.

False

The object will be invisible 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.

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.

Auto-Resize

ResizeLeft

Whether the left side of the object will move when resized. Choose from:

True

The left side of the object will move when the application is resized.

False

Don't move the left side of the object when the application is resized.

ResizeRight

Whether the right side of the object will move when resized. Choose from:

True

The right side of the object will move when the application is resized.

False

Don't move the right side of the object when the application is resized.

ResizeTop

Whether the top of the object will move when resized. Choose from:

True

The top of the object will move when the application is resized.

False

Don't move the top of the object when the application is resized.

ResizeBottom

Whether the bottom of the object will move when resized. Choose from:

True

The bottom of the object will move when the application is resized.

False

Don't move the bottom of the object when the application is resized.

Actions

On Double-Click

The actions that will be performed when the user double-clicks an item in the listbox. Click the edit button to open the script editor.

On Select

The actions that will be performed when the user selects or deselects items in the listbox. Click the edit button to open the script editor.

On Key

The actions that will be performed whenever the listbox object has focus and the user presses a key. Click the edit button to open the script editor.

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. Click the edit button to open the script editor.

On Check

The actions that will be performed whenever an item is checked/unchecked in the listbox object. Click the edit button to open the script editor.

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.