Skip to main content

Text Box Tool Icon Text Box Tool

One Tool Example

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

Use Text Box to display a free-form text box in an app or macro. The user-entered value is passed to downstream tools.

Configure the Tool

  • Enter the text or question to be displayed: Enter any instructional text that you want to display to the user.

  • Default Text: (Optional) Enter the text that displays in the text box that the user can replace. If left blank, the user sees an empty text box to populate.

  • Mask Text (for passwords): (Optional) Select so the user sees an asterisk (*) for every character they enter into the text box.

    DCM Enforced Mode

    When Data Connection Manager (DCM) is configured as DCM Enforced, the Mask Text (for passwords) configuration option is not available in the Text Box tool.

  • Multiline: (Optional) Select this option to allow users to enter multiple lines of text. The displayed text box is larger.

  • Hide control (for API development): (Optional) Select this option to hide the text box from the user, but allow the developer to inject values into the app execution via the API.