The Multi Select control allows users to select multiple items at a time and is commonly used to create a list of items for selecting.
Like almost all SPARK controls, you can trigger events that are fired when the user interacts with the control (see the Event and Methods sections below and the Event Handling article for more information).
This control is commonly used to create a list of items that allows selecting more than one item at a time.
Tab Index Form control tabbing sequence index, tab indices start at 1, and may be set sparsely
Item Lookup Mode Method by which to populate selection list; Start Empty, Items From Service, Items From Static List, Items From Config Option; note: make sure the correct options is selected, otherwise the Multi Select control will not work
List Items Service Service to populate item selection
Service Input Data Data to be passed to the AJAX service that populates the select list items
Items List Bound list of items to populate selection
A list in BPM also tracks selection from the server side. If you have an items list in the config options, the items in the list selected in the UI will also be flagged as selected in the backing list.
Data Mapping Set which property to take as the selection value, and which to display in the selection
Business Data Mapping Refers to the Binding when bound to a complex type. Set which property to take as the selection value, and which to display in the selection.
Static List Static list of items to populate selection
Size Default, Large, Small
Width Width in px, %, em; for example: 50px, 20%, 0.4em, if no unit is specified, px is assumed
Label Placement Top Left
These are the configuration option settings...
This is the result...
Note: When selecting items that are not next to each other, hold down the Ctrl key on the keyboard while clicking on the desired items or when selecting items next to each other click and hold the mouse and drag over the items you'd like to select.
When either using a Static List to populate the control, or if leaving the Data Mapping blank, the Multi Select by default uses the value property as the display value.
For example, if using the following configuration options...
This will be the result...
With the Multi Select control, there are 4 types of event handlers:
- On Load When the page loads
- On Service Items When there is an item service return
- On Service Error When there is a service error
- On Change When there is a change
For detailed information on the available methods for this control, access the JS Doc file.
- Author: Courtney Silva
- Date Created: June 23, 2015
- Date Modified: December 23, 2015