Skip to main content

List Box Tool List Box Tool

User Role Requirements

User Role*

Tool/Feature Access

Full User

✓

Basic User

X

*Applies to Alteryx One Professional and Enterprise Edition customers on Designer versions 2025.1+.

Use List Box to add a list box where users can make multiple selections in an application or macro.

One Tool Example

List Box has a One Tool Example. Go to Sample Workflows to learn how to access this and many other examples directly in Alteryx Designer.

Configure the Tool

Use these options to configure the List Box tool:

  1. Enter the text or question to be displayed: Instruction text that you want to display to the end-user.

  2. All Checked by Default: Select this option to show all items in the list as selected by default, to the end user.

  3. Select Tool Mode: Select this option to populate the list with the data types found in the connected tool.

  4. Generate Custom List: Select this option to generate a list of the selected values. Specify the format by defining an indicator for Start Text, Separator, and End Text.

  5. List Values: Select from one of these list-value types to populate the list:

List Value

Description

Field Types

Populates the list with the Designer-supported field types.

External Source

Populates the list with values from a specified file or database connection.

The workflow reads directly from a connected file or database and pulls the latest values each time the app is run.

Properties

  • Specify the file location of the External Source File.

  • Format the file to contain the Name field in the first column and the Value field in the second column.

The end-user selects a name from the list to generate the corresponding value. The file can be a relative path to the saved workflow, but the end-user must have the external source file saved to the same path.

Fields from Connected Tool

Populates the list with the fields found in a connected tool. A tool must be connected to the optional input anchor.

The original workflow must be run manually in Designer for the values to update in the app.

Properties

  • Show only fields of the following types: Select the field types to populate the list for end-user selection.

  • Include [None]: Include "None" as a valid end-user selection.

Manually set values

Populates the list with manually-entered values.

Properties

Enter one data pair per line in the format Name:Value. If no Value is specified, Name is returned as the Value.

  • Allocate Datasets

  • Geocoder Datasets

  • Drivetime Datasets

  • Behavior Analysis Datasets

  • Reference Base Maps

Select a dataset to populate the list.

If the user does not have access to the dataset, the workflow displays an error when the application or macro runs.

File Browse in this Analytic App/Macro

Populates the list with the fields found in the connected File Browse tool. A File Browse interface tool must be connected to the optional input anchor.

Properties

  • Show only fields of the following types: Select the field types to populate the list for end-user selection.

  • Include [None]: Include "None" as a valid end-user selection.

Fields from Macro Input

Populates the list with the fields found in the connected Macro Input tool. A Macro Input tool must be connected to the optional input anchor.

Properties

  • Show only fields of the following types: Select the field types to populate the list for end-user selection.

  • Include [None]: Include "None" as a valid end-user selection.

In this section: