hiCreateOutputStringField
hiCreateOutputStringField(
?name s_fieldName
[ ?value t_currentValue ]
[ ?prompt t_fieldPrompt ]
[ ?help g_fieldHelp ]
[ ?defValue t_defaultValue ]
[ ?enabled g_enabled ]
[ ?invisible g_invisible ]
)
=> r_fieldHandle
Description
Creates a field that displays text. You cannot type into this field.
This field can also have a context menu, that is, a pop-up menu that is displayed when you right-click on the field.
For information on creating tooltips for fields, see Creating Tool Tips for Fields.
Arguments
|
?name s_fieldName
|
Handle to this field within a form. To reference it, use:
formHandle->hiFieldSym
|
|
?value t_currentValue
|
|
|
Text to be displayed in the field. This is the initial and current value of the field. To reference it, use:
formHandle->hiFieldSym->value
The text is displayed in the text font, which you can set in the User Preferences form or with the hiSetFont function.
|
|
?prompt t_fieldPrompt
|
|
|
String specifying the prompt for the field. To reference it, use:
formHandle->hiFieldSym->prompt
The prompt, or label, is displayed in the label font, which you can set with the hiSetFont function.
|
|
?help g_fieldHelp
|
A string or symbol used to reference help. If this argument is not specified, s_fieldName is used. This argument is currently not used.
|
|
?defValue t_defaultValue
|
|
|
Default value of the field. This value is equal to the initial entry in t_currentValue if t_defaultValue is not specified. To reference the default value, use:
formHandle->hiFieldSym->defValue
|
|
?enabled g_enabled
|
|
|
Specifies whether the fields in the layout are enabled. The default value is t.
|
|
?invisible g_invisible
|
|
|
Specifies whether the layout and the fields within are invisible. The default value is nil.
|
Value Returned
|
r_fieldHandle
|
Handle to the string field.
|
Related Topics
Form and Field Functions
Creating Context Menus for Fields
hiCreateStringField
Return to top
