UPD_AD_COLUMN Procedure

If the column name is found within the User Interface Default Attribute Dictionary, the column entry is updated using the provided parameters. If 'null%' is passed in, the value of the associated parameter is set to null.

Syntax

APEX_UI_DEFAULT_UPDATE.UPD_AD_COLUMN (
    p_column_name           IN  VARCHAR2,
    p_new_column_name       IN  VARCHAR2  DEFAULT NULL,
    p_label                 IN  VARCHAR2  DEFAULT NULL,
    p_help_text             IN  VARCHAR2  DEFAULT NULL,
    p_format_mask           IN  VARCHAR2  DEFAULT NULL,
    p_default_value         IN  VARCHAR2  DEFAULT NULL,
    p_form_format_mask      IN  VARCHAR2  DEFAULT NULL,
    p_form_display_width    IN  VARCHAR2  DEFAULT NULL,
    p_form_display_height   IN  VARCHAR2  DEFAULT NULL,
    p_form_data_type        IN  VARCHAR2  DEFAULT NULL,
    p_report_format_mask    IN  VARCHAR2  DEFAULT NULL,
    p_report_col_alignment  IN  VARCHAR2  DEFAULT NULL);

Parameters

Table 41-9 UPD_AD_COLUMN Parameters

Parameter	Description
`p_column_name`	Name of column to be updated
`p_new_column_name`	New name for column, if column is being renamed
`p_label`	Used for item label and report column heading
`p_help_text`	Used for help text for items and interactive report columns
`p_format_mask`	Used as the format mask for items and report columns. Can be overwritten by report for form specific format masks.
`p_default_value`	Used as the default value for items.
`p_form_format_mask`	If provided, used as the format mask for items, overriding any value for the general format mask.
`p_form_display_width`	Used as the width of any items using this Attribute Definition.
`p_form_display_height`	Used as the height of any items using this Attribute Definition (only used by item types such as text areas and shuttles).
`p_form_data_type`	Used as the data type for items (results in an automatic validation). Valid values are `VARCHAR`, `NUMBER` and `DATE`.
`p_report_format_mask`	If provided, used as the format mask for report columns, overriding any value for the general format mask.
`p_report_col_alignment`	Used as the alignment for report column data (for example, number are usually right justified). Valid values are LEFT, CENTER, and RIGHT.

Note:

If p_label through p_report_col_alignment are set to 'null%', the value is nullified. If no value is passed in, that column is not updated.

Example

The following example updates the CREATED_BY column in the UI Defaults Attribute Dictionary within the workspace associated with the current schema, setting the form_format_mask to null.

BEGIN
    apex_ui_default_update.upd_ad_column (
       p_column_name      => 'CREATED_BY',
       p_form_format_mask => 'null%');
END;