A script-enabled browser is required for this page to function properly.

GET_ITEM_INSTANCE_PROPERTY Built-in

Description

Returns property values for the specified item instance. GET_ITEM_INSTANCE_PROPERTY returns the initial value or the value last specified by SET_ITEM_INSTANCE_PROPERTY for the specified item instance. It does not return the effective value of a property (i.e. the value derived from combining properties specified at the item instance, item, and block levels). See SET_ITEM_INSTANCE_PROPERTY for information about effective property values.

Syntax

FUNCTION GET_ITEM_INSTANCE_PROPERTY
(item_id ITEM,
record_number NUMBER,
property
NUMBER);

FUNCTION GET_ITEM_INSTANCE_PROPERTY
(item_name VARCHAR2,
record_number NUMBER,
property
NUMBER);

Built-in Type unrestricted function

Returns VARCHAR2

Enter Query Mode yes

Parameters

item_id 
 
The unique ID that Oracle Forms assigns to the object when it creates it. Use the FIND_ITEM Built-in to return the ID to a variable of datatype ITEM.
 
item_name 
 
The name you gave the object when you created it.
 
record_number 
 
A record number or the constant CURRENT_RECORD to indicate the record that currently has focus within the block.
 
property 
 
The property the value of which you want to get for the given item. Valid properties are:

BORDER_BEVEL Returns RAISED, LOWERED, or PLAIN if the BORDER_BEVEL property is set to RAISED, LOWERED, or PLAIN, respectively at the item instance level. If BORDER_BEVEL is not specfied at the item instance level, this property returns " ".

INSERT_ALLOWED Returns the VARCHAR2 string TRUE if the item instance INSERT_ALLOWED property is set to true. Returns the string FALSE if the property is set to false.

NAVIGABLE Returns the VARCHAR2 string TRUE if the item instance NAVIGABLE property is set to true. Returns the string FALSE if the property is set to false.

REQUIRED Returns the VARCHAR2 string TRUE if the item instance REQUIRED property is set to true. Returns the string FALSE if the property is set to false.

SELECTED_RADIO_BUTTON Returns the label of the selected radio button within the radio group in the specified record. Returns NULL if the radio group for the specified record does not have a selected radio button or if the specified record has been scrolled out of view.

UPDATE_ALLOWED Returns the VARCHAR2 string TRUE if the item instance UPDATE_ALLOWED property is set to true. Returns the string FALSE if the property is set to false.

VISUAL_ATTRIBUTE Returns the name of the visual attribute currently in force. If no named visual attribute is assigned to the item instance, returns DEFAULT for a default visual attribute. Returns '' if VISUAL_ATTRIBUTE is not specified at the item instance level.