deleteformcustompreference
deleteformcustompreference
DATABASE
,
FORM
,
NAME

The deleteformcustompreference statement deletes a form custom preference.

Parameters

This statement has three parameters:

database – is the database containing the form. If this parameter is `""`, the current database is assumed.

form – is the form in question. If this parameter is `""`, the current form is assumed.

name – is the name of the preference to be deleted. This parameter can be repeated to delete multiple preferences.

Description

Any Panorama form can contain one or more custom preference values. These preference values are saved with the form, much like permanent variables are saved with a database. Each preference value has a name. Each form has its own separate custom preference values. Different forms can have preferences with the same name, or different names. Preference values can be accessed with the getformcustompreference( function and set with the setformcustompreference statement.

The deleteformcustompreference statement deletes a form custom preference. This example deletes the Department preference of the current form.

    deleteformcustompreference "","","Department"

You can delete multiple preference values at once with a single statement:

    deleteformcustompreference "","",
        "Department",
        "Region",
        "Visibility"

If you need to delete a preference value in a specific form (not the current form), just specify the form name:

    deleteformcustompreference "","Form AX87","Department"

You can also delete a preference value in a different database. This example deletes a preference named Type, in the Labels form in the Customer List database.

    deleteformcustompreference "Customer List","Labels","Type"

See Also

- getformcustompreference( -- returns the value of a form custom preference.
- getformcustompreferencenames( -- returns a list of custom preferences associated with a form.
- setformcustompreference -- sets the value of a form custom preference.

History

Version | Status | Notes
10.0 | New | New in this version.