Oracle Forms Developer – Form Builder Reference, Volume 1

VBX.GET_PROPERTY built-in
Description
Obtains the value of a property from a VBX control.
Syntax
VBX.GET_PROPERTY
(item_id ITEM,
property VARCHAR2);
VBX.GET_PROPERTY
(item_name VARCHAR2,
property VARCHAR2);
Built-in Type unrestricted function
Returns VARCHAR2
Enter Query Mode yes
Parameters
item_id Specifies the unique ID that Form Builder assigns to the item when created.
Use the FIND_ITEM built-in to return the ID to an appropriately typed
variable. The data type of the ID is ITEM.
item_name Specifies the name of the object created at design time. The data type of
the name is VARCHAR2 string.
property Specifies a property or an element of a property array for a VBX control. A
set of VBX properties exists for any given VBX control. Examples of
VBX properties are Width, Height, and FontSize. The data type of
property is a VARCHAR2 string.
VBX.GET_PROPERTY restrictions
Valid only on Microsoft Windows.
VBX.GET_PROPERTY examples
/*
** Built-in: VBX.GET_PROPERTY
** Example: Uses the VBX.GET_PROPERTY built-in to obtain the
** CURRTAB property of the VBX item named TABCONTROL.
** The property value of CURRTAB is returned to the
** TabNumber variable and is used as input in the
** user-defined Goto_Tab_Page subprogram.
** trigger: When-Custom-Item-Event
*/
DECLARE
TabEvent varchar2(80);
TabNumber char;
BEGIN
TabEvent := :system.custom_item_event;
IF (UPPER(TabEvent) = ’CLICK’) then
459