hiFormFinish

hiFormFinish(
r_form
)
=> t

Description

Equivalent to clicking the OK button on a form. This function is identical to the hiFormDone function.

If the form is currently displayed, it gets unmapped according to the value of the ?unmapAfterCB argument of hiCreateAppForm specified when the form was created. If ?unmapAfterCB is nil (the default), the form is unmapped and the values of the form fields are saved before the form’s callback function is called. If ?unmapAfterCB is t, the form is unmapped and the field values are saved after the callback function is called, but only if the callback has called hiSetCallbackStatus with the form as the first argument and t as the second argument.

If the form is not currently displayed, hiFormApply runs instead of this function.

Argument

r_form

Handle to the form. If the form is not currently displayed, hiFormApply runs instead of this function.

Value Returned

t	The function was successful.

Related Topics

Form and Field Functions

hiCreateAppForm

hiFormCancel

hiFormClose

hiFormDefaults

hiFormApply

hiFormDone

Return to top