33.1 ADD_AD_COLUMNプロシージャ

指定された定義で、ユーザー・インタフェースのデフォルト値の属性ディクショナリのエントリを追加します。作成時には、最大3つのシノニムを指定できます。作成後に、apex_ui_default_update.add_ad_synonymを使用して追加のシノニムを追加できます。シノニムはそのベース列の列定義を共有します。

構文

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); 

パラメータ

表33-1 ADD_AD_COLUMNのパラメータ

パラメータ	説明
p_column_name	作成する列の名前。
p_label	アイテム・ラベルおよびレポートの列ヘッダーに使用されます。
p_help_text	アイテムおよび対話モード・レポート列のヘルプ・テキストに使用されます。
p_format_mask	アイテムおよびレポート列の書式マスクとして使用されます。フォーム固有の書式マスクのレポートで上書きできます。
p_default_value	アイテムのデフォルト値として使用されます。
p_form_format_mask	指定した場合、アイテムの書式マスクとして使用されます。一般的な書式マスクの値をオーバーライドします。
p_form_display_width	この属性定義を使用するすべてのアイテムの幅として使用されます。
p_form_display_height	この属性定義を使用するすべてのアイテムの高さとして使用されます(テキスト領域、シャトルなどのアイテム・タイプでのみ使用されます)。
p_form_data_type	アイテムのデータ型として使用されます(自動検証になります)。有効な値は、VARCHAR、NUMBERおよびDATEです。
p_report_format_mask	指定した場合、レポート列の書式マスクとして使用されます。一般的な書式マスクの値をオーバーライドします。
p_report_col_alignment	レポート列のデータの位置合せに使用されます(たとえば数値は、一般に右揃えにします)。有効な値は、LEFT、CENTERおよびRIGHTです。
p_syn_name1	この列とともに作成するシノニムの名前。4つ目以上は、APEX_UI_DEFAULT_UPDATE.ADD_AD_SYNONYMを使用します。
p_syn_name2	この列とともに作成する2つ目のシノニムの名前。4つ目以上は、APEX_UI_DEFAULT_UPDATE.ADD_AD_SYNONYMを使用します。
p_syn_name3	この列とともに作成する3つ目のシノニムの名前。4つ目以上は、APEX_UI_DEFAULT_UPDATE.ADD_AD_SYNONYMを使用します。

例

次の例では、現在のスキーマに関連付けられているワークスペース内のUIのデフォルト値の属性ディクショナリに、新しい属性を作成します。また、その属性のシノニムも作成します。

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;