Text Controls

Text controls are used to collect string-based information from users, ranging from short names to multi-line descriptions and secure passwords.

TextBox

The standard single-line input control for names, server addresses, or short descriptions.

powershell

Add-UITextBox -Step 'Config' -Name 'ServerName' -Label 'Server Name' -Placeholder 'e.g. SRV-01'

Parameter	Type	Description
`-Placeholder`	String	Faded text shown when the field is empty.
`-MaxLength`	Int	Limits the number of characters the user can type.
`-ValidationPattern`	String	Regex to validate input (e.g., `'^[A-Z0-9]+$'`).
`-ValidationMessage`	String	Message shown when the regex fails.

A larger text area designed for notes, scripts, or long descriptions. It supports automatic word wrap and vertical scrolling.

powershell

Add-UIMultiLine -Step 'Config' -Name 'Notes' -Label 'Deployment Notes' -Rows 6

Parameter	Type	Description
`-Rows`	Int	The initial height of the control in text lines (default: 4).

A secure input control that masks characters as they are typed. It returns a SecureString object for safety.

powershell

Add-UIPassword -Step 'Credentials' -Name 'AdminPassword' -Label 'Administrator Password'

Encryption: Values are handled as SecureString throughout the framework.
Reveal Button: An optional eye icon allows users to briefly view the password they typed.
Complexity Validation: Use -ValidationPattern to enforce strong password policies.

WARNING

Always handle password results as SecureString. Avoid converting them back to plain text unless absolutely necessary for your target cmdlet.