Table of Contents
MultiselectList
com.ergotech.vib.graphics.MultiselectList
Image Examples
 |  |
| MultiselectList in the graphics palette. | MultiselectList graphic example. |
Overview
The MultiselectList graphic is a More Layout list graphic used to display list-style values and allow multiple selections.
MultiselectList is useful when an application needs users to select more than one item from a list.
The selected count can be sent through the output.
Common Uses
- Displaying list-style values
- Allowing multiple item selection
- Filtering list entries
- Showing list values from an array-style source
- Sending the number of selected items into application logic
- Creating selection-based controls in an application screen
Input Behavior
MultiselectList supports list-style input through valueInput and updateDisplayedValue.
Array-style or list-style values update the displayed list contents.
The FilterString property filters the displayed list entries.
Output Behavior
MultiselectList sends selection output through PrimaryOutPort.
When multiple items are selected manually, PrimaryOutPort outputs the number of selected elements.
MultiselectList-Specific Behavior
MultiselectList is designed for multiple-selection list behavior.
MultiselectList-specific settings include:
- Name Sets the name of the MultiselectList graphic.
- FilterString Filters the displayed list entries.
- ListDisabled Controls whether the list is disabled.
- Visible Controls whether the MultiselectList is shown.
Filter Behavior
The FilterString property filters list entries by matching text values.
For example, when the list contains a value such as Cheese, sending Cheese as the filter string filters the list to that matching entry.
Numeric filter input can also update the filter setting. For example, a numeric value such as 50 can appear in the property setting as a filter pattern.
Logic Ports
In the Logic Editor, MultiselectList includes these default ports:
- PrimaryOutPort
- updateDisplayedValue
- valueInput
The PrimaryOutPort sends the number of selected items.
The updateDisplayedValue port updates the displayed list values from another source.
The valueInput port also updates the displayed list values from another source.
Notes
Use MultiselectList when users need to select multiple items from a list.
Use List when users only need to select one item.
Use MultiselectDualList when users need to move or select items between two list areas.
For general graphic behavior, see Active Graphic.