57.1 ADD_AD_COLUMN Procedure
Adds a User Interface Default Attribute Dictionary entry with the provided definition. Up to three synonyms can be provided during the creation. Additional synonyms can be added post-creation using apex_ui_default_update.add_ad_synonym. Synonyms share the column definition of their base column.
Syntax
APEX_UI_DEFAULT_UPDATE.ADD_AD_COLUMN (
p_column_name IN VARCHAR2,
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,
p_syn_name1 IN VARCHAR2 DEFAULT NULL,
p_syn_name2 IN VARCHAR2 DEFAULT NULL,
p_syn_name3 IN VARCHAR2 DEFAULT NULL);
Parameters
Table 57-1 ADD_AD_COLUMN Parameters
Parameter | Description |
---|---|
|
Name of column to be created. |
|
Used for item label and report column heading. |
|
Used for help text for items and interactive report columns |
|
Used as the format mask for items and report columns. Can be overwritten by report for form specific format masks. |
|
Used as the default value for items. |
|
If provided, used as the format mask for items, overriding any value for the general format mask. |
|
Used as the width of any items using this Attribute Definition. |
|
Used as the height of any items using this Attribute Definition (only used by item types such as text areas and shuttles). |
|
Used as the data type for items (results in an automatic validation). Valid values are VARCHAR, NUMBER and DATE. |
|
If provided, used as the format mask for report columns, overriding any value for the general format mask. |
|
Used as the alignment for report column data (for example, number are usually right justified). Valid values are |
|
Name of synonym to be created along with this column. For more than 3, use APEX_UI_DEFAULT_UPDATE.ADD_AD_SYNONYM. |
|
Name of second synonym to be created along with this column. For more than 3, use APEX_UI_DEFAULT_UPDATE.ADD_AD_SYNONYM. |
|
Name of third synonym to be created along with this column. For more than 3, use APEX_UI_DEFAULT_UPDATE.ADD_AD_SYNONYM. |
Example
The following example creates a new attribute to the UI Defaults Attribute Dictionary within the workspace associated with the current schema. It also creates a synonym for that attribute.
BEGIN
apex_ui_default_update.add_ad_column (
p_column_name => 'CREATED_BY',
p_label => 'Created By',
p_help_text => 'User that created the record.',
p_form_display_width => 30,
p_form_data_type => 'VARCHAR',
p_report_col_alignment => 'LEFT',
p_syn_name1 => 'CREATED_BY_USER' );
END;
Parent topic: APEX_UI_DEFAULT_UPDATE