hiCreateOptionsForm

hiCreateOptionsForm(
s_formHandle 
t_formName 
l_fieldEntries 
g_help 
)
=> r_form

Description

Generates a form with the specified field entries, setting it to formHandle.

If the form is created successfully, an internal data structure for the form is returned. Otherwise, if the arguments to hiCreateOptionsForm are invalid, an error message is issued and nil is returned. Options forms may be created using the same fields as those used by standard forms.

This function is only used for enterfunctions and cannot be used independently.

Arguments

s_formHandle	Global SKILL symbol used to reference this form. An options form is to be used with enterFunctions only.
t_formName	Name that appears in the banner of the form.
l_fieldEntries	List of field descriptors returned from the field creation routines. You can specify any number of field entries (but there must be at least one). The fields on the form appear in a column, in the order they are specified.
g_help	Specify g_help as a single string, single symbol, list of strings, or list of symbols that need to be used to reference a `.tgf` help file. If you specify a single string or symbol, it is used to set the `hiHelpAppName` property on the symbol that represents the form name. If you specify a list of strings or a list of symbols, the first element in the list is used to set the `hiHelpAppName` property and the second element is used to set the `hiHelpSymName` property. (If you want to specify the help symbol only, specify a list of two strings or symbols, with `nil` as the first element of the list and the help symbol as the second element. This sets the `hiHelpSymName` property without setting the `hiHelpAppName` property.) When a user clicks Help on the form, the `hiHelp` function is called with the following arguments: appId helpTag If the `hiHelpAppName` property has been set, it is used as the appId, otherwise the application ID of the current window is used as the appId. If the `hiHelpSymName` property has been set, it is used as the helpTag, otherwise the form name is used as the helpTag. The appId and helpTag determine the name of the tag file that is called (appId`.tgf`) and the help tag in the file that is accessed. You can also use the `hiHelpAppName` and `hiHelpSymName` properties directly to specify the help file and help tag that are used to reference the help. See Online Help Mechanism for more information.

Value Returned

r_form

Handle to the form.

Additional Information

Options forms are used only when entering graphical data. Use an options form with enterFunctions only. The form is created with a standard banner containing the name of the form and a Help button, and selectable button at the bottom of the form. The buttons perform these functions:

Hide applies all changes indicated by the form and then removes the form from the screen.
Cancel calls cancelEnterFun and removes the form from the screen.
Defaults sets all values in the form to their default values.
Last cancels any changes or selections made to the form. The selections are returned to the state that existed before the form was brought up.
Help opens Doc Assistant which contains related documents and additional information.

Do not use the following functions for options forms. They apply only to standard forms: