hiCreateLabel
hiCreateLabel(
?name s_fieldName
[?labelText t_labelText]
[?labelIcon g_labelIcon]
[?justification s_justification]
[?font t_font]
[?enabled g_enabled]
[?invisible g_invisible]
[?help g_fieldHelp]
)
=> r_fieldHandle
Description
Creates a standalone label entry for a form or two-dimensional menu. This label-only field contains a descriptive label and can provide additional features to a form or two-dimensional menu.
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
|
|
?labelText t_labelText
|
|
|
String which appears as the label.
You can change the label text after the form has been instantiated with the value property. For example:
form->labelField->value="NewLabelText"
Before the form is instantiated, however, the _labelOnly property contains the value of the label text and you can change it with:
form->labelField->_labelOnly="NewLabelText"
This means that you should set both properties when you want to modify the label text to ensure that it is correct:
form->labelField->value="NewLabelText"
form->labelField->_labelOnly="NewLabelText"
If you specify both the t_labelText and g_labelIcon arguments, g_labelIcon is used.
|
|
?labelIcon g_labelIcon
|
|
|
Icon which appears as the label.
If you specify both the t_labelText and g_labelIcon arguments, g_labelIcon is used.
|
|
?justification s_justification
|
|
|
Must be one of the following symbols: ’left, ’center, or ’right. ’left is the default.
|
|
?font t_font
|
A font argument is accepted but not supported at this time.
|
|
?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.
|
|
?help g_fieldHelp
|
A string or symbol used to reference help. If not specified, s_fieldName is used. This argument is currently not used.
|
Values Returned
|
r_fieldHandle
|
Handle to the label.
|
Related Topics
Form and Field Functions
Creating Context Menus for Fields
Return to top
