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

パラメータ

表3-2では、HELPプロシージャで使用可能なパラメータについて説明します。

表3-2 HELPのパラメータ

パラメータ	説明
p_request	未使用。
p_flow_id	出力するページ・レベルまたはアイテム・レベルのヘルプが含まれているアプリケーションID。
p_flow_step_id	表示するページ・レベルまたはアイテム・レベルのヘルプが含まれているページID。
p_show_item_help	アイテム・レベルのヘルプが出力されるかどうかを決定するフラグ。このパラメータを指定する場合は、値を「YES」または「NO」のいずれかに設定する必要があり、設定しないと、デフォルトの「YES」に設定されます。
p_show_regions	リージョン・ヘッダーが出力されるかどうかを決定するフラグ(ページ・アイテムが含まれているリージョン用)。このパラメータを指定する場合は、値を「YES」または「NO」のいずれかに設定する必要があり、設定しないと、デフォルトの「YES」に設定されます。
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 bgcolor="#A3BED8" 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であることを確認します。