SAS/AF Software: Class Dictionary

Using the List Box Control

Key Properties to set
Setting list box items
Build-time attributes

Key Properties to set

List Box Control: selectedItem (default attribute) Specify which of the list items you want selected by default.
You can also query this attribute to find out what the user has selected. For example, the following line of SCL code queries the item that is currently selected:
choice = listbox1.selectedItem;

Note: The following line of code is also valid since the selectedItem attribute is the default attribute:
choice = listbox1;
[cautionend]

List Box Control: title Specify the title of the list box.
You can also query or set this attribute using SCL. For example, the following line of SCL code sets the title of the list box to 'Colors.'
listbox1.title='Colors';

Setting list box items

You must tell every list box control what items to display. Use one of the following ways to add items to a list box control:

You can set the items attribute in the Properties window. When you click the value cell for the items attribute, the Items window appears where you can enter each of the items you want.
You can populate the list box with items from a list model by setting the value of the model attribute in the Properties window to the name of the list model.
You can also populate the list box with items from a list model by dragging the model from the Components window onto the list box in the frame.
You can specify the value of the item attribute in the list box at run time. See Using SCL to specify list box items for more information.

Build-time attributes

The following attribute is a build-time attribute, meaning it can only be set at build-time if you choose to use it:

List Box Control: selectionMode

Using SCL to specify list box items

You can specify list box items using an SCL program.

For example, the following code creates a list and assigns the list to a list box:

petList = makelist(); 
rc = insertc(petList, 'Dog', -1); 
rc = insertc(petList, 'Cat', -1); 
rc = insertc(petList, 'Bird', -1);
listbox1.items = petList;

You could just as easily fill a list box with a list of items that already exists in a model that you have instantiated. The following code assigns color list model items to a list box:

listbox1.items = colorlist1.items;

Chapter Contents
Previous
Next
Top of Page