Edit D:\app\Administrator\product\11.2.0\dbhome_1\apex\images\doc\AEAPI\apex_app004.htm
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> <head> <meta http-equiv="Content-Type" content="text/html; charset=us-ascii" /> <meta http-equiv="Content-Style-Type" content="text/css" /> <meta http-equiv="Content-Script-Type" content="text/javascript" /> <title>HELP Procedure</title> <meta name="generator" content="Oracle DARB XHTML Converter (Mode = ohj/ohw) - Version 5.1" /> <meta name="date" content="2009-04-14T17:32:16Z" /> <meta name="robots" content="noarchive" /> <meta name="doctitle" content="HELP Procedure" /> <meta name="relnum" content="Release 3.2" /> <meta name="partnum" content="E12510-01" /> <link rel="copyright" href="../dcommon/html/cpyr.htm" title="Copyright" type="text/html" /> <link rel="stylesheet" href="../dcommon/css/blafdoc.css" title="Oracle BLAFDoc" type="text/css" /> <link rel="contents" href="toc.htm" title="Contents" type="text/html" /> <link rel="up" href="preface" title="Home" type="text/html" /> <link rel="up" href="apex_app.htm" title="APEX_APPLICATION" type="text/html" /> <link rel="up" href="apex_app004.htm" title="HELP Procedure" type="text/html" /> <link rel="prev" href="apex_app003.htm" title="Previous" type="text/html" /> <link rel="next" href="apex_auth.htm" title="Next" type="text/html" /> </head> <body> <p id="BREADCRUMBING"><a href="preface" title="Home">Home</a> > <a href="apex_app.htm" title="APEX_APPLICATION">APEX_APPLICATION</a> > HELP Procedure</p> <table class="simple oac_no_warn" summary="" cellspacing="0" cellpadding="0" width="100%"> <col width="86%" /> <col width="*" /> <tr valign="bottom"> <td align="left"></td> <td align="center"><a href="apex_app003.htm"><img src="../dcommon/gifs/leftnav.gif" alt="Previous" /><br /> <span class="icon">Previous</span></a> </td> <td align="center"><a href="apex_auth.htm"><img src="../dcommon/gifs/rightnav.gif" alt="Next" /><br /> <span class="icon">Next</span></a></td> </tr> </table> <p><a id="BGBBHBFJ" name="BGBBHBFJ"></a></p> <hr /> <div class="refsect1"> <h1><a id="sthref630" name="sthref630"></a>HELP Procedure</h1> <p>This function outputs page and item level help text as formatted HTML and can be used to customize how help information is displayed in your application.</p> <a id="sthref631" name="sthref631"></a> <p class="subhead2">Syntax</p> <pre xml:space="preserve" class="oac_no_warn"> 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); </pre> <a id="sthref632" name="sthref632"></a> <p class="subhead2">Parameters</p> <p><a href="#BABFEAID">Table: HELP Parameters</a> describes the parameters available in the HELP procedure.</p> <div class="tblformal"><a id="sthref633" name="sthref633"></a><a id="BABFEAID" name="BABFEAID"></a> <p class="titleintable">HELP Parameters</p> <table class="Formal" title="HELP Parameters" summary="This table describes the parameters available in the REMOVE_PREFERENCE procedure." dir="ltr" border="1" width="100%" frame="hsides" rules="groups" cellpadding="3" cellspacing="0"> <col width="41%" /> <col width="*" /> <thead> <tr align="left" valign="top"> <th align="left" valign="bottom" id="r1c1-t3">Parameter</th> <th align="left" valign="bottom" id="r1c2-t3">Description</th> </tr> </thead> <tbody> <tr align="left" valign="top"> <td align="left" id="r2c1-t3" headers="r1c1-t3"> <p>p_request</p> </td> <td align="left" headers="r2c1-t3 r1c2-t3"> <p>Not used.</p> </td> </tr> <tr align="left" valign="top"> <td align="left" id="r3c1-t3" headers="r1c1-t3"> <p>p_flow_id</p> </td> <td align="left" headers="r3c1-t3 r1c2-t3"> <p>The application ID that contains the page or item level help you want to output.</p> </td> </tr> <tr align="left" valign="top"> <td align="left" id="r4c1-t3" headers="r1c1-t3"> <p>p_flow_step_id</p> </td> <td align="left" headers="r4c1-t3 r1c2-t3"> <p>The page ID that contains the page or item level help you want to display.</p> </td> </tr> <tr align="left" valign="top"> <td align="left" id="r5c1-t3" headers="r1c1-t3"> <p>p_show_item_help</p> </td> <td align="left" headers="r5c1-t3 r1c2-t3"> <p>Flag to determine if item level help is output. If this parameter is supplied, the value must be either 'YES' or 'NO', if not the default value will be 'YES'.</p> </td> </tr> <tr align="left" valign="top"> <td align="left" id="r6c1-t3" headers="r1c1-t3"> <p>p_show_regions</p> </td> <td align="left" headers="r6c1-t3 r1c2-t3"> <p>Flag to determine if region headers are output (for regions containing page items). If this parameter is supplied, the value must be either 'YES' or 'NO', if not the default value will be 'YES'.</p> </td> </tr> <tr align="left" valign="top"> <td align="left" id="r7c1-t3" headers="r1c1-t3"> <p>p_before_page_html</p> </td> <td align="left" headers="r7c1-t3 r1c2-t3"> <p>Use this parameter to include HTML between the page level help text and item level help text.</p> </td> </tr> <tr align="left" valign="top"> <td align="left" id="r8c1-t3" headers="r1c1-t3"> <p>p_after_page_html</p> </td> <td align="left" headers="r8c1-t3 r1c2-t3"> <p>Use this parameter to include HTML at the bottom of the output, after all other help.</p> </td> </tr> <tr align="left" valign="top"> <td align="left" id="r9c1-t3" headers="r1c1-t3"> <p>p_before_region_html</p> </td> <td align="left" headers="r9c1-t3 r1c2-t3"> <p>Use this parameter to include HTML before every region section. Note this parameter is ignored if <code>p_show_regions</code> is set to 'NO'.</p> </td> </tr> <tr align="left" valign="top"> <td align="left" id="r10c1-t3" headers="r1c1-t3"> <p>p_after_region_html</p> </td> <td align="left" headers="r10c1-t3 r1c2-t3"> <p>Use this parameter to include HTML after every region section. Note this parameter is ignored if <code>p_show_regions</code> is set to 'NO'.</p> </td> </tr> <tr align="left" valign="top"> <td align="left" id="r11c1-t3" headers="r1c1-t3"> <p>p_before_prompt_html</p> </td> <td align="left" headers="r11c1-t3 r1c2-t3"> <p>Use this parameter to include HTML before every item label for item level help. Note this parameter is ignored if <code>p_show_item_help</code> is set to 'NO'.</p> </td> </tr> <tr align="left" valign="top"> <td align="left" id="r12c1-t3" headers="r1c1-t3"> <p>p_after_prompt_html</p> </td> <td align="left" headers="r12c1-t3 r1c2-t3"> <p>Use this parameter to include HTML after every item label for item level help. Note this parameter is ignored if <code>p_show_item_help</code> is set to 'NO'.</p> </td> </tr> <tr align="left" valign="top"> <td align="left" id="r13c1-t3" headers="r1c1-t3"> <p>p_before_item_html</p> </td> <td align="left" headers="r13c1-t3 r1c2-t3"> <p>Use this parameter to include HTML before every item help text for item level help. Note this parameter is ignored if <code>p_show_item_help</code> is set to 'NO'.</p> </td> </tr> <tr align="left" valign="top"> <td align="left" id="r14c1-t3" headers="r1c1-t3"> <p>p_after_item_html</p> </td> <td align="left" headers="r14c1-t3 r1c2-t3"> <p>Use this parameter to include HTML after every item help text for item level help. Note this parameter is ignored if <code>p_show_item_help</code> is set to 'NO'.</p> </td> </tr> </tbody> </table> <br /></div> <!-- class="tblformal" --> <a id="sthref634" name="sthref634"></a> <p class="subhead2">Example</p> <p>The following example shows how to use the <code>APEX_APPLICATION.HELP</code> procedure to customize how help information is displayed.</p> <p>In this example, the <code>p_flow_step_id</code> parameter is set to <code>:REQUEST</code>, which means that a page ID specified in the REQUEST section of the URL will be used to control which page's help information to display (see note after example for full details on how this can be achieved).</p> <p>Also, the help display has been customized so that the region sub-header now has a different color (through the <code>p_before_region_html</code> parameter) and also the ':' has been removed that appeared by default after every item prompt (through the <code>p_after_prompt_html</code> parameter).</p> <pre xml:space="preserve" class="oac_no_warn"> 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;'); </pre> <p>In order to implement this type of call in your application, you can do the following:</p> <ol> <li> <p>Create a page that will be your application help page.</p> </li> <li> <p>Create a region of type 'PL/SQL Dynamic Content' and add the <code>APEX_APPLICATION.HELP</code> call as PL/SQL Source.</p> </li> <li> <p>Then you can add a 'Navigation Bar' link to this page, ensuring that the REQUEST value set in the link is <code>&APP_PAGE_ID</code>.</p> </li> </ol> </div> <!-- class="refsect1" --> <!-- Start Footer --> <div class="footer"> <table class="simple oac_no_warn" summary="" cellspacing="0" cellpadding="0" width="100%"> <col width="86%" /> <col width="*" /> <tr> <td align="left"><span class="copyrightlogo">Copyright © 2003, 2009, Oracle and/or its affiliates. All rights reserved.</span><br /> <a href="../dcommon/html/cpyr.htm"><span class="copyrightlogo">Legal Notices</span></a></td> <td align="center"><a href="apex_app003.htm"><img src="../dcommon/gifs/leftnav.gif" alt="Previous" /><br /> <span class="icon">Previous</span></a> </td> <td align="center"><a href="apex_auth.htm"><img src="../dcommon/gifs/rightnav.gif" alt="Next" /><br /> <span class="icon">Next</span></a></td> </tr> </table> </div> <!-- class="footer" --> </body> </html>
Ms-Dos/Windows
Unix
Write backup
jsp File Browser version 1.2 by
www.vonloesch.de