hiCreateFormButton
hiCreateFormButton(
?name s_fieldName
?buttonText t_buttonText
?callback g_callback
[ ?buttonIcon g_buttonIcon ]
[ ?help g_fieldHelp ]
[ ?font t_font ]
[ ?enabled g_enabled ]
[ ?invisible g_invisible ]
[ ?showTextWithIcon g_showTextWithIcon ]
)
=> r_fieldHandle
Description
Creates a standalone push button for a form or two-dimensional menu. This function is the same as hiCreateButton.
The button must have an associated callback procedure to be executed when the button is selected. A button-only field differs from a button box field in that there is no prompt associated with this button.
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
|
|
?buttonText t_buttonText
|
|
|
String that appears on the button.
|
|
?callback g_callback
|
|
|
Callbackthat is executed if the button is activated.
If the callback is of string type, you can specify one or more SKILL functions or even multiple SKILL statements that should be executed when the value of the field changes.
|
|
?buttonIcon g_buttonIcon
|
|
|
The icon for the button.
This argument overrides t_buttonText, if it is specified.
|
|
?help g_fieldHelp
|
A string or symbol used to reference help. If not specified, s_fieldName is used. This argument is currently not used.
|
|
?font t_font
|
A font argument is accepted but is 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.
|
|
?showTextWithIcon g_showTextWithIcon
|
|
|
nil or non-nil. If you specify a non-nil value for this argument, and if both g_buttonIcon and t_buttonText are specified, then the button displays both an icon and text. The default value of this argument is nil.
|
Values Returned
|
r_fieldHandle
|
Handle to the button.
|
Related Topics
hiCreateButton
hiCreateFormButton
hiDeleteForm
Creating Context Menus for Fields
Form and Field Functions
Return to top
