{"id":17357,"date":"2017-12-20T11:44:13","date_gmt":"2017-12-20T03:44:13","guid":{"rendered":"http:\/\/localhost\/help\/?page_id=17357"},"modified":"2024-10-23T14:20:58","modified_gmt":"2024-10-23T06:20:58","slug":"selection-list","status":"publish","type":"page","link":"https:\/\/oihelp.corporate.ifs.com\/help\/p2-explorer\/explorer-studio\/controls\/selection-list\/","title":{"rendered":"Selection List"},"content":{"rendered":"\n

This article applies to versions 4.4.2 and later of IFS OI Explorer. For more, see Release History<\/a>.<\/p>\n

Overview<\/h2>\n

The Selection List can be configured to allow a user to select a single item, or multiple items from a defined list.<\/p>\n

The selection is usually used by some other component or dataset query in the page.<\/p>\n

<\/a><\/p>\n

Related: Using the Selection List<\/a> in display mode, Adding a Selection List style<\/a><\/p>\n

\n

Properties of the Selection List<\/h2>\n
\u00a0<\/div>\n\n\n\n
\n\n\n\n
<\/a><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<\/td>\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
1. Option Values<\/strong><\/td>\n<\/tr>\n
These are the options that set the variable<\/a> defined in Selected Option\/s<\/strong>.<\/td>\n<\/tr>\n
2. Option Names<\/strong><\/td>\n<\/tr>\n
If specified, then these are the options displayed in the Selection list. Each value in Option Names<\/em> is linked to the corresponding (by list position) value in Option Values<\/em>. If Option Names<\/em> are unspecified, then Option Values<\/em> are displayed.<\/td>\n<\/tr>\n
3. Select Mode<\/strong><\/td>\n<\/tr>\n
Choose Single<\/em> if you want to restrict the user to selecting only one option. Otherwise, choose Multiple<\/em>.<\/td>\n<\/tr>\n
4. Selected Option\/s<\/strong><\/td>\n<\/tr>\n
The variable\/s that uses the selected Option Value\/s<\/em>. If the Select Mode<\/em> is Single,<\/em> this is Selected Option<\/em>, otherwise it is Selected Options<\/em>.<\/td>\n<\/tr>\n
5. Style<\/strong><\/td>\n<\/tr>\n
Select a Style, if there are any available.\u00a0If you are a Style Administrator,\u00a0you can\u00a0add a new Selection List\u00a0style<\/a>.<\/td>\n<\/tr>\n
6. Position in Precision Layout<\/strong><\/td>\n<\/tr>\n
This section is available if the component is on a Precision Layout.<\/td>\n<\/tr>\n
7. Position in Grid Layout<\/strong><\/td>\n<\/tr>\n
This section is available if the component is on a Grid Layout.<\/td>\n<\/tr>\n
<\/a><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<\/td>\n <\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n
\n

While this component could be used on a page to select Entities returned from a query, it is important to note that functionality from IFS OI Server, for example Template Filtering, is not available from this component. Explorer treats these items as text only.<\/p>\n<\/blockquote>\n

\n

The Selection List in Display\u00a0Mode<\/h2>\n

Related<\/strong>: See how the Selection List and other selection components are used, in the article Selecting Items<\/a>.<\/p>\n

The Selection List provides an easy interface for the user to make selections.<\/p>\n\n\n\n
\n\n\n\n
<\/a><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<\/td>\n\n\n\n\n\n\n\n\n\n\n\n\n\n
1. Option Names<\/strong><\/td>\n<\/tr>\n
The Option Names (or Option Values, if no names are specified) are listed in the component.<\/td>\n<\/tr>\n
2. Selection Check Box<\/strong><\/td>\n<\/tr>\n
The user can select one or more check boxes alongside the list items, depending on the Select Mode.<\/em><\/td>\n<\/tr>\n
3. Select All<\/strong><\/td>\n<\/tr>\n
If the Select Mode<\/em> is Multiple<\/em>, then this button toggles between Select All <\/em>and Select None. <\/em>If the Select Mode<\/em> is Single, <\/em>this button is replaced by a Clear Selection<\/em> button.<\/td>\n<\/tr>\n
4. Scrollbar<\/strong><\/td>\n<\/tr>\n
A vertical scrollbar is supplied if the list is too long.<\/td>\n<\/tr>\n
5. Filter options...<\/strong><\/td>\n<\/tr>\n
The user can type text into this box, to filter the selection list<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n
\n

Tutorial<\/h2>\n

If you're unfamiliar with the process of building pages, read the article\u00a0Building an Explorer Page<\/a>.<\/p>\n

In this tutorial, we'll add a Selection List and a Pie Chart<\/a>.<\/p>\n

<\/a><\/p>\n

There are three steps in the tutorial:<\/p>\n