1. APIリファレンス
  2. APEX_APPLICATION
  3. HELPプロシージャ

6.3 HELPプロシージャ

このプロシージャによって、ページおよびアイテム・レベルのヘルプ・テキストが、書式化されたHTMLページとして出力されます。これを使用すると、ご使用のアプリケーションでのヘルプ情報の表示方法をカスタマイズすることもできます。

構文

APEX_APPLICATION.HELP (
    p_request             IN VARCHAR2 DEFAULT NULL,
    p_flow_id             IN VARCHAR2 DEFAULT NULL,
    p_flow_step_id        IN VARCHAR2 DEFAULT NULL,
    p_show_item_help      IN VARCHAR2 DEFAULT 'YES',
    p_show_regions        IN VARCHAR2 DEFAULT 'YES',
    p_before_page_html    IN VARCHAR2 DEFAULT '<p>',
    p_after_page_html     IN VARCHAR2 DEFAULT NULL,
    p_before_region_html  IN VARCHAR2 DEFAULT NULL,
    p_after_region_html   IN VARCHAR2 DEFAULT '</td></tr></table></p>',
    p_before_prompt_html  IN VARCHAR2 DEFAULT '<p><b>',
    p_after_prompt_html   IN VARCHAR2 DEFAULT '</b></p>:&nbsp;',
    p_before_item_html    IN VARCHAR2 DEFAULT NULL,
    p_after_item_html     IN VARCHAR2 DEFAULT NULL );

パラメータ

パラメータ 説明
p_request 未使用。
p_flow_id 出力するページ・レベルまたはアイテム・レベルのヘルプが含まれているアプリケーションID。
p_flow_step_id 表示するページ・レベルまたはアイテム・レベルのヘルプが含まれているページID。
p_show_item_help アイテム・レベルのヘルプを出力するかどうかを決定するフラグ。このパラメータを指定する場合は、値をYES (デフォルト)またはNOのいずれかに設定する必要があります。
p_show_regions リージョン・ヘッダーが出力されるかどうかを決定するフラグ(ページ・アイテムが含まれているリージョン用)。このパラメータを指定する場合は、値をYES (デフォルト)またはNOのいずれかに設定する必要があります。
p_before_page_html このパラメータは、ページ・レベルのヘルプ・テキストとアイテム・レベルのヘルプ・テキストの間にHTMLを含める場合に使用します。
p_after_page_html このパラメータは、出力の下部の他のすべてのヘルプの後にHTMLを含める場合に使用します。
p_before_region_html このパラメータは、すべてのリージョン・セクションの前にHTMLを含める場合に使用します。p_show_regionsがNOに設定されている場合、このパラメータは無視されます。
p_after_region_html このパラメータは、すべてのリージョン・セクションの後にHTMLを含める場合に使用します。p_show_regionsがNOに設定されている場合、このパラメータは無視されます。
p_before_prompt_html このパラメータは、アイテム・レベルのヘルプのすべてのアイテム・ラベルの前にHTMLを含める場合に使用します。p_show_item_helpがNOに設定されている場合、このパラメータは無視されます。
p_after_prompt_html このパラメータは、アイテム・レベルのヘルプのすべてのアイテム・ラベルの後にHTMLを含める場合に使用します。p_show_item_helpがNOに設定されている場合、このパラメータは無視されます。
p_before_item_html このパラメータは、アイテム・レベルのヘルプのすべてのアイテム・ヘルプ・テキストの前にHTMLを含める場合に使用します。p_show_item_helpがNOに設定されている場合、このパラメータは無視されます。
p_after_item_html このパラメータは、アイテム・レベルのヘルプのすべてのアイテム・ヘルプ・テキストの後にHTMLを含める場合に使用します。p_show_item_helpがNOに設定されている場合、このパラメータは無視されます。

例

次の例では、APEX_APPLICATION.HELPプロシージャを使用して、ヘルプ情報の表示方法をカスタマイズします。

この例では、p_flow_step_idパラメータが:REQUESTに設定されているため、URLのREQUESTセクションに指定されたページIDによって、表示されるヘルプ情報のページが制御されます(これを行うための手順の詳細は、例の後のノートを参照)。

また、ヘルプの表示は、(p_before_region_htmlパラメータによって)リージョンのサブヘッダーが異なる色で表示されるようにカスタマイズされています。さらに、(p_after_prompt_htmlパラメータによって)すべてのアイテム・プロンプトの後にデフォルトで表示される":"は削除されています。 

APEX_APPLICATION.HELP(
    p_flow_id => :APP_ID,
    p_flow_step_id => :REQUEST,
    p_before_region_html => '<p><br/><table class="u-info" width="100%"><tr><td><b>',
    p_after_prompt_html  => '</b></p>&nbsp;&nbsp;');

ご使用のアプリケーションでこのタイプのコールを実装するには、次の手順を実行します。

  1. アプリケーションのヘルプ・ページとなるページを作成します。
  2. 「PL/SQL動的コンテンツ」タイプのリージョンを作成し、APEX_APPLICATION.HELPコールをPL/SQLソースとして追加します。
  3. 「ナビゲーション・バー」リンクをこのページに追加して、このリンクに設定されているREQUESTの値が&APP_PAGE_IDであることを確認します。

親トピック: APEX_APPLICATION