Skip to main content

 

 

 

 
Language:
 
Applies only to Traditional Web Apps
 
 
OutSystems

Dropdown Select

Template:OutSystems/Documentation_KB/ContentCollaboration
  • Edit
    Collaborate with us
    Edit this page on GitHub
  • The Dropdown Select is a pattern that you can apply to other patterns to implement a search functionality or multiple selection in lists. You can use the Dropdown Select UI Pattern when you need an enhanced combo box or list box in forms, as it offers a richer user experience than the list.

    How to use the Dropdown Select UI Pattern

    1. In Service Studio, in the Toolbox, search for Dropdown Select.

      The Dropdown Select widget is displayed.

      If the UI widget does not display, it may be because you used a ready-made app, which deletes unused widgets from the module. To make additional widgets available in your app:

      a. Go to Module > Manage dependencies.

      b. Search for and select the relevant Producer, for example OutSystemsUI. Ensure Show All is selected.

      c. On the Public elements for the selected Producer displayed on the right, ensure Show All is selected.

      d. Search for and select the element you want to add, and click Apply.

      e. In Service Studio, in the Toolbox, search for the widget again.

    2. From the Toolbox, drag the Dropdown Select widget into the Main Content area of your application's screen.

    3. From the Toolbox, drag the Combo Box widget into the Main Content area of your application's screen, and on the Properties tab, enter a name for the widget. In this example, we enter ListofEmployees.

    4. Right-click your screen name, select Add Local Variable, and enter a name for the new variable. In this example, we enter SelectedRecord.

    5. Select the Combo Box widget, and on the Properties tab, enter the values for the Variable and Source Entity properties. In this example, we select SelectedRecord for the Variable property and drag the Employees entity into the Combo Box widget. This automatically becomes the Source Entity property value.

    6. Select the Dropdown Select widget, and on the Properties tab, from the WidgetId drop-down, select the Combo Box widget Id. In this example, we select ListofEmployees.Id.

    7. You can change the Dropdown Select's look and feel by setting the (Optional) properties on the Properties tab.

    After following these steps and publishing the module, you can test the pattern in your app.

    How this pattern behaves depends on the way it is bound.

    • If you bind it to a Combo Box widget, Dropdown Select works as a selectable dropdown.
    • If you bind it to a List Box, Dropdown Select works as a multi-select dropdown with removable tags.

    Properties

  • { searchPlaceholderValue: 'Search' }
  • Property Description
    WidgetId (Text): Mandatory Element name (Combo Box and List Box) that triggers the element.
    NoResultsText (Text): Optional Text to display when there are no results. The default value is "No results found."
    SearchEnabled (Boolean): Optional If False, the search functionality is removed. This property does not work with the List Box. If True, the search functionality is enabled. This is the default value.
    SearchResultsLimit (Long Integer): Optional Limits the number of results shown.
    AdvancedFormat (Text): Optional Enables more options beyond what's provided through the inputs. For more options, go to Choices library. Default value is {}

    Example

    ExtendedClass (Text): Optional Adds custom style classes to the Pattern. You define your custom style classes in your application using CSS.

    Examples

    • Blank - No custom styles are added (default value).
    • "myclass" - Adds the myclass style to the UI styles being applied.
    • "myclass1 myclass2" - Adds the myclass1 and myclass2 styles to the UI styles being applied.
    You can also use the classes available on the OutSystems UI. For more information, see the OutSystems UI Live Style Guide.
    • Was this article helpful?