UserInterface.AddTextEntry(String, String, String, Variable, String) Method

Top

Description

Adds a non-numeric text entry to the UserInterface using the String representation of the target String-value destination to determine where to store the user-written text.

Timing Precision Mode

This page describes functionality in millisecond timing precision mode. Millisecond timing precision mode is deprecated and will be removed in a future release. We recommend that you migrate your Mission Plans to nanosecond timing precision mode.

Click here to see the documentation for this object in nanosecond timing precision mode.

Method Signature

UserInterface.AddTextEntry(	String valueDestination,
	String elementLabel,
	String defaultValue,
	Variable doPerformRegexValidation,
	String validatingRegex)

Arguments

valueDestination
Description:	A String that represents either an object or a writeable property of an object where the value will be stored.

elementLabel
Description:	The label shown to the left of the input element.

defaultValue
Description:	The default value for the text entry. Must match the type of valueDestination.

doPerformRegexValidation

Description:

Determines whether regular expression validation is active. If active, the user will be required to match the specified regular expression before continuing.

Valid Values:

Value	Label
0	false
1	true

validatingRegex
Description:	A regular expression to match against the entered text.

Return Value

Type:

number

The return value is not used.

Syntax

myVariable1 = myUserInterface1.AddTextEntry(myString1, myString2, myString3, myVariable2, myString4);