Skip to Content

List Box

Introduction

The List Box creates a drop-down selection box viewer control that you can use to select amongst a known list of items. You can build the List Box manually in the Property Panel or send it a single-attribute entryset containing the entries you want to select from.

Viewer Control:

Selecting a List Box Item

  • Click the List Box once to expand it and display its contained items.
  • In an expanded List Box, click on a highlighted item to select it and trigger the "Get Selected Entry" and "Get Selected Entry Index" output connectors.

Property Panel:

List Box Setup
List Control
The style of the list displayed in the Viewer. "Combo Box" produces a drop-down menu which displays all its items when clicked. "List Box" produces a box with all its items visible at all times allowing for the selection of multiple items.
Add Item
Type a desired item into the text box and click the "Add Item" button to add it to the List Box
Current List Box Items
A list of all the List Box items
Move Up
Moves the selected item one position up in the list
Move Down
Moves the selected item one position down in the list
Delete
Deletes the selected item from the list
Allow Duplicates
This check box toggles whether or not not duplicate items are allowed in the List Box. By default, this is unchecked and the List Box can contain only unique items.

Input Menu:

Set Entryset

Sets the entries in the incoming entryset as items in the List Box. Duplicate items are not included if the "Allow Duplicates" check box in the Property Panel is not checked.

Accepted Datatypes:
Entryset
Requires an entryset with exactly one attribute.
Set Selected Item By Index

Sets which item is selected in the List Box according to its index value.

Accepted Datatypes:
Number
Triggered Outputs:
Output Message:
Get Selected Item
Set Selected Item By Value

Sets the item that matches the incoming text value as the selected item in the List Box.

Accepted Datatypes:
Text
Triggered Outputs:
Output Message:
Get Selected Item

Output Menu:

Get Selected Item

Gets the List Box's currently selected item.

Output Datatype:
Text
Triggered By:
Input Message:
Set Selected Item By Value
Input Message:
Set Selected Item By Index
Action:
Selecting an item from the List Box control in the Viewer
Action:
Fire-On-Connect