Name
|
Description
|
Attributes
|
DefaultValue
|
The default value that the parameter will have when the input dialog is launched. This can either be a string or a value. If it is a string, FreeFlyer will treat the string as an object parameter, and the default value will be the evaluation of that string. If EntryType = DropDown, the user must enter all desired options in this field separated with a comma (",").
This property has been Deprecated. See the 'Custom User Interfaces' guide in the help file for more information on setting up a UserInterface Object.
|
Type: StringArray
Access: Read/Write
|
EntryType
|
The type of input field presented to the engineer. This parameter can only have the values of: "Drop Down", "Enter Value", "True/False", or "Yes/No".
This property has been Deprecated. See the 'Custom User Interfaces' guide in the help file for more information on setting up a UserInterface Object.
|
Type: StringArray
Access: Read/Write
|
ExplicitEdit
|
Boolean flag used to indicate whether the user must click a check box for a given field before exiting the dialog. 0 = False, 1 = True.
This property has been Deprecated. See the 'Custom User Interfaces' guide in the help file for more information on setting up a UserInterface Object.
|
Type: Array
Access: Read/Write
|
FormatString
|
The FormatString parameter allows the user to define how the default entry value is formatted on the input dialog. The FormatString can take one of two forms. The simplest form is to specify the total field width and decimal precision inside of triangle brackets ( ie. <width, precision> ). The other method is to provide a format specifier. The format specifiers are standard C/C++ specifiers for use with the sprintf function.
This property has been Deprecated. See the 'Custom User Interfaces' guide in the help file for more information on setting up a UserInterface Object.
|
Type: StringArray
Access: Read/Write
|
MaximumRange
|
The maximum value that the inputted parameter value may have. If this value is set less than the MinimumRange, then no range checking is done.
This property has been Deprecated. See the 'Custom User Interfaces' guide in the help file for more information on setting up a UserInterface Object.
|
Type: Array
Access: Read/Write
|
MinimumRange
|
The minimum value that the input parameter value may have. If this value is set higher than the MaximumRange, then no range checking is done.
This property has been Deprecated. See the 'Custom User Interfaces' guide in the help file for more information on setting up a UserInterface Object.
|
Type: Array
Access: Read/Write
|
NumberOfInputs
|
The number of user entries to be displayed in the input dialog. Each of the following entry control parameters is an array indexed from 0 to NumberOfInputs 1, with the index corresponding to the input entry field, starting at 0.
This property has been Deprecated. See the 'Custom User Interfaces' guide in the help file for more information on setting up a UserInterface Object.
|
Type: Variable
Access: Read/Write
|
ObjectNameToDisplay
|
The name of the object for which to show a pre-defined user interface. Not used at this time.
This property has been Deprecated. See the 'Custom User Interfaces' guide in the help file for more information on setting up a UserInterface Object.
|
Type: String
Access: Read/Write
|
ParameterLabel
|
Text used when displaying the user parameter entry on the input dialog.
This property has been Deprecated. See the 'Custom User Interfaces' guide in the help file for more information on setting up a UserInterface Object.
|
Type: StringArray
Access: Read/Write
|
ParameterName
|
The FreeFlyer object name and parameter that the provided value will be set into.
This property has been Deprecated. See the 'Custom User Interfaces' guide in the help file for more information on setting up a UserInterface Object.
|
Type: StringArray
Access: Read/Write
|
Response
|
Stores the values that the operational user enters into the UserInterface panel on run time.
This property has been Deprecated. See the 'Custom User Interfaces' guide in the help file for more information on setting up a UserInterface Object.
|
Type: StringArray
Access: Read-Only
|
Units
|
Read-only field indicating the units in which the user must input the value.
This property has been Deprecated. See the 'Custom User Interfaces' guide in the help file for more information on setting up a UserInterface Object.
|
Type: StringArray
Access: Read/Write
|
UseWideFormat
|
0/1 Flag indicating whether or not to use a wide formatted UserInterface panel.
This property has been Deprecated. See the 'Custom User Interfaces' guide in the help file for more information on setting up a UserInterface Object.
|
Type: Variable
Access: Read/Write
|
