GET_INPUT_NAME_FOR_PAGE_ITEM Function (Deprecated)

44.4 GET_INPUT_NAME_FOR_PAGE_ITEM Function (Deprecated)

Caution:

This API is deprecated and will be removed in a future release.

Use this function when you want to render an HTML input element in the rendering function of an item type plug-in. For the HTML input element, for example, <input type="text" id="P1_TEST" name="xxx">, you have to provide a value for the name attribute so that Oracle APEX can map the submitted value to the actual page item in session state. This function returns the mapping name for your page item.

Note:

This function is only useful when called in the rendering function of an item type plug-in.

Syntax

FUNCTION GET_INPUT_NAME_FOR_PAGE_ITEM (
    P_IS_MULTI_VALUE IN BOOLEAN )
    RETURN VARCHAR2;

Parameters

Parameter	Description
`p_is_multi_value`	If the HTML input element has multiple values, such as a select list with `multiple="multiple"`, then set `p_is_multi_value` to TRUE.

Example

The following example outputs the necessary HTML code to render a text field where the value gets stored in session state when the page is submitted.

sys.htp.prn (
    '<input type="text" id="'||p_item.name||'" '||
    'name="'||apex_plugin.get_input_name_for_page_item(false)||'" '||
    'value="'||sys.htf.escape_sc(p_value)||'" '||
    'size="'||p_item.element_width||'" '||
    'maxlength="'||p_item.element_max_length||'" '||
    coalesce(p_item.element_attributes, 'class="text_field"')||' />' );

Parent topic: APEX_PLUGIN