âShow Table of Contents
List Box tool will display a multi-selection check box list in an app or macro. The selections specified by the user are passed as values to downstream tools.
Example of a List Box:
Enter the text or question to be displayed: The text here will be presented to the user instructing them how to use the List Box control.
All Checked by Default: when checked, all items in the list box will be selected (checked) for the user.
Select the mode in which this control should behave. Choices are:
Select tool Mode: Use this option when updating a Select tool.
Generate custom list: Not visible to the App Consumer, this option returns a list of the selected values with the specified Start, Separator, and End characters. This option is usually used in tandem with the List Values: "External Source" or "Manually set values" described below.
The List Box tool configuration set to Generate Custom List.
This is how the Question appears to the user:
And the returned values look like:
List Values: Drop down selection determining how the list is populated. Options are explained in detail below:
Example: If the app/macro requires the App Consumer to select a numeric field, the App Author may choose any combination of: Int16, Int32, Int64, Float, Double and Fixed Decimal.
This can be any file that the Input Data Tool can read (including database connections). The App Consumer will see the Name field records to select, and based on their selection, the Value field will be passed to the downstream tool.
The file MUST contain the fields, "Name" and "Value." The file can be a relative path to the saved workflow, but the end App Consumer must have the external source file saved to that path or they will receive the error: "Root Element Missing" upon launching the Analytic App.
Example: This option is useful for presenting a long list of values to the user, or if the Name is considerably different than the value that needs to be passed. The file needs to be formatted like below:
Example: If the app/macro requires a numeric field, the user may choose any combination of: Int16, Int32, Int64, Float, Double and Fixed Decimal.
Example: If the macro requires a String field, the user may choose any combination of: String, WString, V_String and V_WString.
Example below illustrates a List Box Selection using a "File Browse in this Analytic App/Macro." The field list does not populate until the Input File is configured by the App Consumer. The App Consumer is then presented with, in this case, only numeric fields from their input that will be summed.
Â©2017 Alteryx, Inc., all rights reserved. AllocateÂ®, AlteryxÂ®, GuzzlerÂ®, and SolocastÂ® are registered trademarks of Alteryx, Inc.