TextBox

This topic describes the options and limitations available when using a TextBox component.

Content settings

Text

This setting displays any text that is entered in the field. If you provide text as part of the component specification, that text displays by default and overrides any Placeholder text that might exist.

Users can override any text you might have provided, unless you create the component as a read-only field. Even if they do so, your default text remains as part of the component configuration, though it does not display in runtime.

Note: Keep in mind that this field can only be one line high. Any text that extends beyond the end of the field can only be read by moving the cursor beyond the edge of the field.

Depending on how you intend to use this component, you can:

• Provide text for informational, read-only purposes.
• Use the field for user input that can be further processed.
• Employ another component to populate the field with text from a data service.
• And so on...

Label

This setting determines what text is to display as the label for the text box, if a label is used.

Note: The setting to either display or hide the label is made on the Style tab.

Placeholder

This setting allows you to provide text to be used as a placeholder, typically as a prompt for user input. The text displays in a gray font. As soon as the user enters any text into the field, the placeholder text disappears.

Any text you use in the Text setting overrides and hides any Placeholder text.

Interactions

Trigger Event

The TextBox component can trigger only the On Load event. This event might display as:

• Data Service has run (On Load), where Data Service is the name of a data service assigned to the component
• On Load (No Data Service), where no data service has been assigned to the component

Target Action

Depending on the target, the TextBox component can perform a Get operation, a Run operation, or a Clear operation on the target component.

Style settings

Style

This setting has these component-specific options:

• Masking

  This option allows you to define and use various masking options for the text to be displayed.

  See Masking options.

• Style

  This option includes these sub-options:

  • Show Label

    When selected, this option displays a label over the text area. When this check box is cleared, no label displays.

    Note: The text that is to display as the label is set on the Content tab, Text option.
  • Read-Only

    When this option is selected, the contents of the TextBox are read-only and cannot be changed.

    To enable and disable the TextBox component conditionally, click the lock icon next to this check box.

    See Setting conditional component disablement.

• Width

  This option controls the relative width of the TextBox component. These are the choices and their approximate widths in pixels:

  • Tiny - 85 px.
  • Small - 160 px.
  • Medium - 225 px.
  • Large - 310 px.

  When using boundaries, you can assign a different Width setting for each boundary.