hiSetFormBlock

hiSetFormBlock(
r_form
[ g_blockUpdates ]
[ g_unmanage ]
)
=> t / nil

Description

Prevents time-consuming multiple updates to a form during multiple changes (such as adding, deleting, moving, or resizing elements). You can also blank out the form during extensive changes. Updates are blocked until you call hiSetFormBlock(r_form nil) or hiUpdateFormBlock(r_form).

Use the hiSetFormBlock function only if you are making extensive changes to a form.

Arguments

r_form	Handle to the form, returned by hiCreateAppForm.
g_blockUpdates	Blocks update to the form. Specify nil to reset the form to allow updates. You can also reset the form with the hiUpdateFormBlock function.
g_unmanage	Blanks out the form during extensive changes. Specify nil when you reset the form to allow updates. You can also reset the form with the hiUpdateFormBlock function.

Values Returned

t	In all cases except when r_form is not valid.
nil	r_form is not valid.

Examples

hiSetFormBlock ( r_form t )

<add/delete/move/resize functions>

hiSetFormBlock ( r_form nil )

Related Topics

Form and Field Functions

hiUpdateFormBlock

Return to top