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

Top

Description

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

Timing Precision Mode

This page describes functionality in nanosecond timing precision mode.

Method Signature

UserInterface.AddTextEntry(	String valueDestination,
	String elementLabel,
	String defaultValue,
	Variable doPerformRangeValidation,
	Variable rangeMinimum,
	Variable rangeMaximum,
	String formatString,
	String units)

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.

doPerformRangeValidation

Description:

Determines whether numeric range validation is active. If active, the user will be required to satisfy the specified range before continuing. If a property has system wide limits, they will be enforced regardless of the value of this property.

Valid Values:

Value	Label
0	false
1	true

rangeMinimum
Description:	The minimum acceptable numerical value for this text entry.

rangeMaximum
Description:	The maximum acceptable numerical value for this text entry.

formatString
Description:	A printf style format string used to format numeric data before it is presented to the user.

units
Description:	A unit string to be shown to the right of the Text Entry. If the valueDestination has a unit string specified then it will be used instead of this value.

Return Value

Type:

number

The return value is not used.

Syntax

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