Description
Adds a numeric text entry to the UserInterface using the String representation of the target TimeSpan-value destination to determine where to store the user-specified value.
Timing Precision Mode
This page describes functionality in nanosecond timing precision mode.
Click here to see the documentation for this object in millisecond timing precision mode.
Method Signature
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 TimeSpan value for this text entry.
|
rangeMaximum
|
|
Description:
|
The maximum acceptable TimeSpan value for this text entry.
|
units
|
|
Description:
|
The reporting units to use.
|
Valid Values:
|
Value
|
Label
|
"day"
|
days
|
"hr"
|
hours
|
"min"
|
minutes
|
"s"
|
seconds
|
"ms"
|
milliseconds
|
"us"
|
microseconds
|
"ns"
|
nanoseconds
|
|
Return Value
The return value is not used.
Syntax
myVariable1 = myUserInterface1.AddTextEntry(myString1, myString2, myString3, myVariable2, myTimeSpan1, myTimeSpan2, myString4);
|
See also
UserInterface Object
UserInterface.AddTextEntry
Custom User Interface Guide
|