OPTIONS....................................................................................................................... 472
About Form Builder Components .......................................................................................................472 Starting Form Builder Components ....................................................................................................473 Starting Form Builder Components from the Command Line ............................................................474

Oracle Corporation welcomes your comments and suggestions on the quality and usefulness of this publication. Your input is an important part of the information used for revision. • • • • • Did you find any errors? Is the information clearly presented? Do you need more information? If so, where? Are the examples correct? Do you need more examples? What features did you like most about this manual?

If you find any errors or have any other suggestions for improvement, please indicate the part number, chapter, section, and page number (if available). You can send comments to us by electronic mail to oddoc@us.oracle.com. If you have any problems with the software, please contact your local Oracle World Wide Support Center.

xiii

Preface
Welcome to Release 6i of the Forms Developer Form Builder Reference . This reference guide includes information to help you effectively work with Forms Developer Form Builder and contains detailed information about the following: • • • • • Built-in subprograms Options Properties System variables Triggers

This preface explains how this user’s guide is organized and introduces other sources of information that can help you use Forms Developer Form Builder.

Prerequisites
You should be familiar with your computer and its operating system. For example, you should know the commands for deleting and copying files and understand the concepts of search paths, subdirectories, and path names. Refer to your Microsoft Windows 95 or NT and DOS product documentation for more information. You should also understand the fundamentals of Microsoft Windows, such as the elements of an application window. You should also be familiar with such programs as the Explorer, Taskbar or Task Manager, and Registry.

Notational Conventions
The following typographical conventions are used in this guide:

Convention fixed-width font

Meaning Text in a fixed-width font indicates commands that you enter exactly as shown. Text typed on a PC is not case-sensitive unless otherwise noted. In commands, punctuation other than brackets and vertical bars must be entered exactly as shown.

lowercase UPPERCASE boldface C>

Lowercase characters in a command statement represent a variable. Substitute and appropriate value. Uppercase characters within the text represent command names, SQL reserved words, and keywords. Boldface is used to indicate user interface items such as menu choices and buttons. Represents the DOS prompt. Your prompt may differ.

Built-in syntax
Named parameters are shown in an italic monospaced font. You can replace any named parameter with the actual parameter, which can be a constant, a literal, a bind variable, or a number. SET_TIMER(timer_name, milliseconds, iterate); In this example, the timer name you supply must be enclosed in single quotes, because the timer_name is a CHAR value. The milliseconds parameter is passed as a number and, as such, does not require single quotes. The iterate parameter is passed as a constant, and, as such, must be entered exactly as shown in the parameter description, without single quotes. Capitalization is unimportant. In those cases where a number of optional elements are available, various alternate syntax statements are presented. These alternatives are presented to preclude having to decipher various complicated syntactical conventions. Note that you sometimes use variables instead of including a specific object name. In those cases, do not enclose the variable within single quotes. The following example illustrates a When-Timer-Expired trigger that calls the SET_TIMER built-in and references a variable that contains a valid timer name: DECLARE the_timer CHAR := GET_APPLICATION_PROPERTY(TIMER_NAME); BEGIN SET_TIMER(the_timer, 60000, REPEAT); END;

1

Built-in named parameters
The named parameter should be followed with the equal/greater than signs (=>), which point to the actual parameter that follows the named parameter. For example, if you intend to change the milliseconds in the SET_TIMER Built-in you can directly use that parameter with the following syntax: SET_TIMER(timer_name => ’my_timer’, milliseconds => 12000, iterate => NO_REPEAT); Also, you can continue to call the built-in with the following syntax: SET_TIMER(’my_timer’, 12000, NO_REPEAT);

Built-in code examples
Examples have been included for the built-in subprograms. Some examples are simple illustrations of the syntax. Others are more complex illustrations of how to use the Built-in either alone or in conjunction with other built-ins. A few points to keep in mind regarding the syntax of examples: • • • • Examples are shown exactly as they can be entered. Casing and use of italics can be ignored and is included for readability. Built-in names and other PL/SQL reserved words, such as IF, THEN, ELSE, BEGIN, and END are shown in capital letters for easier readability. Named parameters, when illustrated, are shown in an italic typeface. If you choose to use named parameters, enter these parameter names exactly as shown, without quotes and follow them with the equal/greater than symbols (=>). CHAR type arguments must be enclosed in single quotes. Any other data type argument should not be enclosed in quotes. Special characters other than single quotes (’), commas (,), parentheses, underscores (_), and semicolons(;) should be ignored.

• • •

Built-in object IDs
Some built-in subprograms accept object IDs as actual parameters. An object ID is an internal, opaque handle that is assigned to each object when created in the Form Builder. Object IDs are internally managed and cannot be externally viewed by the user. The only method you can use to retrieve the ID is to define a local or global variable and assign the return value of the object to the variable. You make the assignment by way of the FIND_ built-in functions. Once you have used FIND_ within a PL/SQL block, you can use the variable as an object ID while still in that block. The valid PL/SQL type for each object is included in the syntax descriptions for each parameter. The description for the FIND_BLOCK built-in provides an example of how to obtain an object ID.

Built-in form coordinate units
Many built-in subprograms allow you to specify size and position coordinates, using properties such as: • HEIGHT

When you specify coordinates or width and height, you express these measurements in units of the current form coordinate system, set on the Form Module property sheet. The form coordinate system defines the units for specifying size and position coordinates of objects in the Form Builder. Use the Coordinate System form module property to set the form’s coordinate units: • • character cells or real units: inches centimeters pixels points

When you design in the character cell coordinate system, all object dimensions and position coordinates are expressed in character cells, so Form Builder accepts only whole numbers for size and position properties. When you design using real units (inches, centimeters, or points), all object dimensions and position coordinates are expressed in the units you specify, so Form Builder will accept decimals as well as whole numbers for size and position properties. The precision of real units is three digits, so you can specify coordinates to thousandths. If you use pixels or character cells, coordinates are truncated to whole numbers.

Built-in uppercase return values
The GET_X_PROPERTY built-ins, such as GET_FORM_PROPERTY, return CHAR arguments as uppercase values. This will affect the way you compare results in IF statements.

Restricted built-in subprograms
Restricted built-ins affect navigation in your form, either external screen navigation, or internal navigation. You can call these built-ins only from triggers while no internal navigation is occurring. Restricted built-ins cannot be called from the Pre and Post triggers, which fire when Form Builder is navigating from object to another. Restricted built-ins can be called from the When triggers that are specific to interface items, such as When-Button-Pressed or When-Checkbox-Changed. Restricted built-ins can also be called from any of the When-New-"object"-Instance triggers and from key triggers. Unrestricted built-ins do not affect logical or physical navigation and can be called from any trigger.

3

The built-in descriptions include a heading, Built-In Type, that indicates if the built-in is restricted or unrestricted.

Built-in constants
Many of the built-in subprograms take numeric values as arguments. Often, constants have been defined for these numeric arguments. A constant is a named numeric value. When passing a constant to a builtin do not enclose the constant value in quotation marks. Constants can only appear on the right side of an operator in an expression. In some cases, a built-in can take a number of possible constants as arguments. Possible constants are listed in the descriptions for each parameter. In the following example, BLOCK_SCOPE is a constant that can be supplied for the parameter constant VALIDATION_UNIT. Other constants listed in the description are FORM, RECORD, and ITEM. SET_FORM_PROPERTY(’my_form’, VALIDATION_UNIT, BLOCK_SCOPE);

Individual built-in descriptions
The remainder of this chapter presents individual built-in descriptions. Each built-in is presented in the following format or a subset of the format, as applicable: Syntax Describes the syntax of the built-in. If there are multiple formats for a Built-in then all formats are shown. For example, if the target object of a built-in can be called by name or by object ID, then both forms of syntax are displayed Built-in Type Indicates whether the built-in is restricted or unrestricted Returns Indicates the return value or data type of a built-in function Enter Query Mode Indicates the capability to call the built-in during enter query mode. Description Indicates the general purpose and use of the built-in. Parameters Describes the parameters that are included in the syntax diagrams. Underlined parameters usually are the default.

Individual built-in descriptions examples
Provides an actual example that can be used in conjunction with the syntax to develop a realistic call to the built-in.

4

ABORT_QUERY built-in
Description Closes a query that is open in the current block. A query is open between the time the SELECT statement is issued and the time when all the rows have been fetched from the database. In particular, a query is not open when the form is in Enter Query mode, because the SELECT statement has not yet been issued. Syntax PROCEDURE ABORT_QUERY; Built-in Type unrestricted procedure Enter Query Mode yes A query is open between the time the SELECT statement is issued and the time when all the rows have been fetched from the database. In particular, a query is not open when the form is in Enter Query mode, because the SELECT statement has not yet been issued. Parameters none Usage Notes ABORT_QUERY is not the equivalent of the Query, Cancel runtime default menu command. It does not prevent the initial fetch from the database, but rather interrupts fetch processing, thus preventing subsequent fetches.

ABORT_QUERY restrictions
Do not use ABORT_QUERY in the following triggers: • On-Fetch. The On-Fetch trigger is provided for applications using transactional triggers to replace default Form Builder functions when running against non-Oracle data sources. To signal that your On-Fetch trigger is done fetching rows, exit the On-Fetch trigger without issuing the CREATE_QUERIED_RECORD built-in. Pre-Query. The Pre-Query trigger fires before the query is open, so there is no open query to close and ABORT_QUERY is ignored. To programmatically cancel Enter Query mode, call the built-in EXIT_FORM, using a When-New-Record-Instance trigger to check a flag as follows: IF (:global.cancel_query = ’Y’ and :system.mode = ’ENTER-QUERY’) THEN Exit_Form; :global.cancel_query = ’N’; END IF; Then set the flag to ’TRUE’ either from a Pre-Query trigger or an On-Error trigger that traps for the FRM-40301 error.

•

•

5

ACTIVATE_SERVER built-in
Description Activates an OLE server associated with an OLE container and prepares the OLE server to receive OLE automation events from the OLE container. Syntax PROCEDURE ACTIVATE_SERVER (item_id Item); PROCEDURE ACTIVATE_SERVER (item_name VARCHAR2); Built-in Type unrestricted procedure Enter Query Mode no 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. Specifies the name of the object created at design time. The data type of the name is VARCHAR2 string.

item_name

Usage Notes • The OLE container must contain an OLE object and the OLE Server must be available for activation.

ACTIVATE_SERVER restrictions
Valid only on Microsoft Windows and Macintosh.

ADD_GROUP_COLUMN built-in
Description Adds a column of the specified type to the given record group. Syntax FUNCTION ADD_GROUP_COLUMN (recordgroup_id RecordGroup, groupcolumn_name VARCHAR2, column_type NUMBER); FUNCTION ADD_GROUP_COLUMN (recordgroup_name VARCHAR2, groupcolumn_name VARCHAR2, NUMBER); column_type FUNCTION ADD_GROUP_COLUMN (recordgroup_id, RecordGroup groupcolumn_name VARCHAR2, column_type NUMBER, NUMBER); column_width FUNCTION ADD_GROUP_COLUMN (recordgroup_name VARCHAR2, groupcolumn_name VARCHAR2, column_type NUMBER, column_width NUMBER); Built-in Type unrestricted function Enter Query Mode yes Returns GroupColumn Parameters recordgroup_id recordgroup_name groupcolumn_name column_type The unique ID that Form Builder assigns when it creates the group. The data type of the ID is RecordGroup. The name you gave to the record group when creating it. The data type of the name is VARCHAR2. Specifies the name of the column. The data type of the column name is VARCHAR2. Specifies the data type of the column. The allowable values are the following constants: CHAR_COLUMN Specify if the column can only accept VARCHAR2 data. DATE_COLUMN Specify if the column can only accept DATE data. LONG_COLUMN Specify if the column can only accept LONG data. NUMBER_COLUMN Specify if the column can only accept NUMBER data.

7

column_width

If you specify CHAR_COLUMN as the column_type, you must indicate the maximum length of the data. COLUMN_WIDTH cannot exceed 2000, and must be passed as a whole number.

Error Conditions: An error is returned under the following conditions: • • • You enter the name of a non-existent record group. You specify the name for a group or a column that does not adhere to standard Oracle naming conventions. You enter a column type other than CHAR, NUMBER, DATE, or LONG.

ADD_GROUP_COLUMN restrictions
• • • • • • • • You must add columns to a group before adding rows. You cannot add a column to a group that already has rows; instead, delete the rows with DELETE_GROUP_ROW, then add the column. You can only add columns to a group after it is created with a call to CREATE_GROUP. If the column corresponds to a database column, the width of CHAR_COLUMN-typed columns cannot be less than the width of the corresponding database column. If the column corresponds to a database column, the width of CHAR_COLUMN-typed columns can be greater than the width of the corresponding database column. Only columns of type CHAR_COLUMN require the width parameter. Performance is affected if a record group has a large number of columns. There can only be one LONG column per record group.

If you add a row to any but the last position in a group. an alphabetic character). The name you gave to the record group when creating it. PROCEDURE ADD_GROUP_ROW (recordgroup_name VARCHAR2.
9
.
ADD_GROUP_ROW restrictions
• • • • A group can consist of 0 or more rows. The data type of the name is VARCHAR2. If you specify a row number greater than the number of rows already in the group (or a negative number). You cannot add rows to a static group without a query. A whole number that specifies a row in the group. Syntax PROCEDURE ADD_GROUP_ROW (recordgroup_id RecordGroup. row_number NUMBER).
Error Conditions: Form Builder returns a runtime error given either of the following conditions: • • If you enter the name of a non-existent record group. You can add rows to a group only after it has been created and columns have been added. the row is inserted at the end of the group. The data type of the ID is RecordGroup. Built-in Type unrestricted procedure Enter Query Mode yes Parameters recordgroup_id recordgroup_name row_number The unique ID that Form Builder assigns when it creates the group. use the END_OF_GROUP constant.ADD_GROUP_ROW built-in
Description Adds a row to the given record group. If you supply a row number that is out of range or is invalid (for example. row_number NUMBER). all rows below that are logically renumbered.
ADD_GROUP_ROW examples
/* ** Built-in: ** Example: */ ADD_GROUP_ROW Add ten rows to a new record group and populate. To add a row to the end of a group.

i).’YYYY’). i. BEGIN /* ** Check to see if Record Group already exists */ rg_id := Find_Group( rg_name ). rg_id RecordGroup. ** ** Row# NumCol CharCol ** --------------** 1 1 one ** 2 2 two ** : : : ** 10 10 ten */ IF NOT Id_Null(rg_id) THEN Delete_Group_Row( rg_id.
10
. /* ** If it does. in_words).. i. END IF. gc_id GroupColumn.’year’).NumCol’.10 LOOP /* ** Add the i-th Row to the end (bottom) of the ** record group. in_words VARCHAR2(15). Add_Group_Row( rg_id.10 along ** with the equivalent number in words. END. FOR i IN 1.PROCEDURE Populate_My_Group IS rg_name VARCHAR2(20) := ’My_Group’. END LOOP. and set the values of the two cells */ in_words := TO_CHAR(TO_DATE(i.. ALL_ROWS ). then clear all the rows from the group and ** populate ten rows with the numbers from 1. Set_Group_Number_Cell( rg_col1. rg_col2 VARCHAR2(20) := rg_name||’.CharCol’. END_OF_GROUP ). Set_Group_Char_Cell( rg_col2. rg_col1 VARCHAR2(20) := rg_name||’.

Specifies the list index value. list_label VARCHAR2. The data type of the name is VARCHAR2. NUMBER list_label VARCHAR2.
list_name list_index list_label list_value
ADD_LIST_ELEMENT restrictions
For a base table list with the List Style property set to Poplist or T-list. Use the FIND_ITEM built-in to return the ID to an appropriately typed variable. This situation can occur if you have previously used DELETE_LIST_ELEMENT or CLEAR_LIST to remove the other values element that was specified at design time by the Mapping of Other Values list item property setting.ADD_LIST_ELEMENT built-in
Description Adds a single element to a list item. Built-in Type unrestricted procedure Enter Query Mode yes Parameters list_id Specifies the unique ID that Form Builder assigns when it creates the list item. The list index is 1 based.
ADD_LIST_ELEMENT examples
/* ** ** Built-in: ADD_LIST_ELEMENT Example: Deletes index value 1 and adds the value "1994" to
11
. Form Builder does not allow you to add another values element when the block contains queried or changed records. The data type of the ID is ITEM. list_value NUMBER). The block status is CHANGED when a block contains records that have been either inserted or updated. PROCEDURE ADD_LIST_ELEMENT ITEM. (list_id list_index VARCHAR2. Note: The block status is QUERY when a block contains queried records. list_value NUMBER). The name you gave to the list item when you created it. The actual list element value you intend to add to the list item. Doing so causes an error. Syntax PROCEDURE ADD_LIST_ELEMENT (list_name VARCHAR2. Specifies the VARCHAR2 string that you want displayed as the label of the list element. list_index.

vtype VT_TYPE := VT_VARIANT). Its type (NUMBER.. starting with the first argument. ADD_OLEARG VARCHAR2.. The calls should be in order..
vtype
13
. the default is VT_TYPE := VT_BSTR. Usage Notes A separate ADD_OLEARG call is needed for each argument to be passed. Syntax PROCEDURE (newvar .or.. the default is VT_TYPE := VT_R8.. For an OLEVAR argument.
Built-in Type unrestricted procedure Parameters newvar The value of this argument. PROCEDURE (newvar
ADD_OLEARG NUMBER. PROCEDURE (newvar ... the default is VT_TYPE := VT_VARIANT. ADD_OLEARG OLEVAR. vtype VT_TYPE := VT_BSTR). or OLEVAR) is its FORMS or PL/SQL data type.ADD_OLEARGS built-in
Description Establishes the type and value of an argument that will be passed to the OLE object’s method.. vtype VT_TYPE := VT_R8). VARCHAR2. The type of the argument as understood by the OLE method For a NUMBER argument. A list of the supported OLE VT_TYPEs can be found in OLE Variant Types .or. For a VARCHAR2 argument.

ADD_PARAMETER built-in
Description Adds parameters to a parameter list. use ID_NULL to check to see if a parameter list already exists before creating one. If you are passing a text parameter.
key paramtype
ADD_PARAMETER restrictions
• • A parameter list can consist of 0 (zero) or more parameters. value VARCHAR2). value VARCHAR2). The name of the parameter. Data type of the value is VARCHAR2. PROCEDURE ADD_PARAMETER VARCHAR2. the maximum length is 64K characters. (name key VARCHAR2. or the VARCHAR2 name of the parameter list. Specifies one of the following two types: TEXT_PARAMETER A VARCHAR2 string literal. You cannot add a parameter of type DATA_PARAMETER if the parameter list is being passed to another form. If a parameter list already exists. You cannot create a parameter list if one already exists. The data type of the key is VARCHAR2. to do so will cause an error. value The actual value you intend to pass to the called module. delete it with DESTROY_PARAMETER_LIST before creating a new list. key VARCHAR2. When Form Builder passes a data parameter to Report Builder or Graphics Builder. Built-in Type unrestricted procedure Enter Query Mode yes Parameters list or name Specifies the parameter list to which the parameter is assigned. its type. To avoid this error.
•
14
. paramtype VARCHAR2. paramtype VARCHAR2. and an associated value. DATA_PARAMETER A VARCHAR2 string specifying the name of a record group defined in the current form. the data in the specified record group can substitute for a query that Report Builder or Graphics Builder would ordinarily execute to run the report or display. The actual parameter can be either a parameter list ID of type PARAMLIST. Syntax PROCEDURE ADD_PARAMETER (list VARCHAR2. Each parameter consists of a key.

If offset_type is PARENT_OFFSET.Find the record group. If offset_type is SIBLING_OFFSET.Find the tree itself. then data is the text of the query. adds the new data as a sibling to the specified node. Possible values are: PARENT_OFFSET SIBLING_OFFSET If offset_type is PARENT_OFFSET. htree := Find_Item(’tree_block. If data source is QUERY_TEXT.
offset
Indicates the position of the new node.offset_type
Specifies the type of offset for the node. Possible values are: RECORD_GROUP QUERY_TEXT
data
Specifies the data to be added. then offset can be either NEXT_NODE or PREVIOUS_NODE. BEGIN -.
17
. rg_data RECORDGROUP. rg_data := FIND_GROUP(’new_data_rg’).htree3’). then data is an item of type RECORDGROUP or the name of a record group.
ADD_TREE_DATA examples
/* ** Built-in: */ -----ADD_TREE_DATA
This code copies a set and adds them as a top nodes specified by the The new top level node top level node.
of values from a record group level node with any children structure of the record group.
data_source
Indicates the type of data source. -. If data source is RECORD_GROUP. adds a data subset immediately under the specified node at the location among its children indicated by offset. will be inserted as the last
DECLARE htree ITEM. then offset can be either 1-n or LAST_CHILD. If offset_type is SIBLING_OFFSET.

Ftree. Ftree.Add_Tree_Data(htree. Ftree.PARENT_OFFSET. rg_data). Ftree. Ftree.-.LAST_CHILD.ROOT_NODE.Add the new node at the top level and children. END.RECORD_GROUP.
18
.

The data type of the name is VARCHAR2 string. offset NUMBER. state NUMBER. Possible values are: PARENT_OFFSET SIBLING_OFFSET offset Indicates the position of the new node.
node offset_type
19
.ADD_TREE_NODE built-in
Description Adds a data element to a hierarchical tree item. icon VARCHAR2. offset_type NUMBER. label VARCHAR2.NODE.NODE. FUNCTION ADD_TREE_NODE (item_id ITEM. icon VARCHAR2. node FTREE. offset NUMBER. offset_type NUMBER. value VARCHAR2). state NUMBER. Specifies a valid node. value VARCHAR2). Built-in Type unrestricted procedure Returns NODE Enter Query Mode no Parameters item_name Item_id Specifies the name of the object created at design time. 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. node FTREE. Syntax FUNCTION ADD_TREE_NODE (item_name VARCHAR2. Specifies the type of offset for the node. label VARCHAR2. The data type of the ID is ITEM.

DECLARE htree ITEM. Specifies the VARCHAR2 value of the node.Add an expanded top level node to the tree -.If offset_type is PARENT_OFFSET.Find the tree itself. Ftree. then offset can be either NEXT_NODE or PREVIOUS_NODE. NULL. htree := Find_Item(’tree_block.adds it to the tree as a top level node.
ADD_TREE_NODE examples
/* ** Built-in: ADD_TREE_NODE */ -. -.Add_Tree_Node(htree. new_node FTREE.NODE. Ftree. Ftree.NODE.This code copies a value from a Form item and -.Copy the item value to a local variable. BEGIN -. item_value. then offset can be either 1-n or LAST_CHILD. top_node FTREE. state Specifies the state of the node.EXPANDED_NODE. Possible vaues are: COLLAPSED_NODE EXPANDED_NODE LEAF_NODE label icon value The displayed text for the node. -.LAST_CHILD. item_value := :wizard_block.
20
. new_node := Ftree.value is set to be the same as the label.with no icon.htree3’). Ftree.ROOT_NODE. The filename for the node’s icon. If offset_type is SIBLING_OFFSET. item_value). item_value VARCHAR2(30).new_node_data.PARENT_OFFSET. END. The -.

Built-in Type unrestricted procedure Enter Query Mode yes Failure: If no parameters are defined for the current menu. in the Enter Parameter Values dialog box.
21
. and their current values.APPLICATION_PARAMETER built-in
Description Displays all the parameters associated with the current menu. Syntax PROCEDURE APPLICATION_PARAMETER. Form Builder issues error message FRM-10201: No parameters needed.

Built-in Type unrestricted procedure Enter Query Mode yes Parameters none
BELL examples
The following example rings the bell three times: FOR i in 1. SYNCHRONIZE. Syntax PROCEDURE BELL. END LOOP.BELL built-in
Description Sets the terminal bell to ring the next time the terminal screen synchronizes with the internal state of the form.
22
. This synchronization can occur as the result of internal processing or as the result of a call to the SYNCHRONIZE built-in subprogram.3 LOOP BELL..

however. and prints a message if ** the user chooses a new block out of the list to ** which to navigate.BLOCK_MENU built-in
Description Displays a list of values (LOV) containing the sequence number and names of valid blocks in your form. */ DECLARE prev_blk VARCHAR2(40) := :System.Cursor_Block <> prev_blk THEN Message(’You successfully navigated to a new block!’). Built-in Type restricted procedure Enter Query Mode yes. END. Form Builder sets the input focus to the first enterable item in the block you select from the LOV.
23
. IF :System. BEGIN BLOCK_MENU. END IF. it is illegal to navigate out of the current block in Enter Query mode Parameters none
BLOCK_MENU examples
/* ** Built-in: BLOCK_MENU ** Example: Calls up the list of blocks in the form when the ** user clicks a button. Syntax PROCEDURE BLOCK_MENU.Cursor_Block.

From the Debugger you can make selections to view the values of global and system variables. Syntax PROCEDURE BREAK.Job = ’CLERK’ THEN Break. Built-in Type unrestricted procedure Enter Query Mode yes Parameters none
BREAK restrictions
If the current form is not running in debug mode. issuing a call to the BREAK built-in subprogram has no effect. Break.BREAK built-in
Description Halts form execution and displays the Debugger. while the current form is running in debug mode. END.
BREAK examples
/* ** Built-in: BREAK ** Example: Brings up the debugging window for a particular ** value of the ’JOB’ item anytime the user ** changes records. The BREAK built-in is primarily useful when you need to inspect the state of a form during trigger execution. Call_Form(’clerk_timesheet’). ** trigger: When-New-Record-Instance */ BEGIN IF :Emp.
24
. END IF.

You can optionally include a parameter list as initial input to the called form. Datatype is VARCHAR2.Parameters formmodule_name display The name of the called form (must be enclosed in single quotes).
paramlist_name
CALL_FORM restrictions
• Form Builder ignores the query_mode parameter when the calling form is running in QUERY_ONLY mode. but not to insert.) Form Builder will run the indicated form in normal mode. query_mode NO_QUERY_ONLY (The default. allowing the end user to query. allowing the end user to perform inserts. DO_REPLACE Form Builder will replace the default menu module of the calling form with the default menu module of the called form. and deletes from within the called form. Failing to specify DO_REPLACE will result in no menu being displayed for the called form. Form Builder runs any form that is called from a QUERY_ONLY form as a QUERY_ONLY form. Only text parameters can be passed with CALL_FORM. A parameter list passed to a form via CALL_FORM cannot contain parameters of type DATA_PARAMETER. HIDE (The default.) Form Builder will hide the calling form before drawing the called form. data_mode NO_SHARE_LIBRARY_DATA (The default. Exercise caution when creating a large stack of called forms. Form Builder will not share data between forms that have identical libraries attached (at design time). update. updates. QUERY_ONLY Form Builder will run the indicated form in query-only mode. Form Builder will share data between forms that have identical libraries attached (at design time). or delete records. paramlist_id The unique ID Form Builder assigns when it creates the parameter list.)
• • •
26
. On-Logon. Some memory allocated for CALL_FORM is not deallocated until the Runform session ends. When you execute CALL_FORM in a Pre-Logon. (An alternative solution is to call the REPLACE_MENU built-in from a When-New-Form-Instance trigger in the called form. SHARE_LIBRARY_DATA At runtime. switch_menu NO_REPLACE (The default.) Form Builder will keep the default menu module of the calling form active for the called form. Datatype is VARCHAR2. NO_HIDE Form Builder will display the called form without hiding the calling form. even if the CALL_FORM syntax specifies that the called form is to run in NO_QUERY_ONLY (normal) mode.) At runtime. The name you gave the parameter list object when you defined it. or Post-Logon trigger. always specify the DO_REPLACE parameter to replace the calling form’s menu with the called form’s menu. Datatype is PARAMLIST.

28
. Form Builder resumes processing from the point at which the call to CALL_INPUT occurred. Syntax PROCEDURE CALL_INPUT.CALL_INPUT built-in
Description Accepts and processes function key input from the end user. Built-in Type restricted procedure Enter Query Mode no Parameters none
CALL_INPUT restrictions
CALL_INPUT is included for compatibility with previous versions. When CALL_INPUT is terminated. You should not include this built-in in new applications.

Built-in Type unrestricted procedure Parameters obj memberid Usage Notes
•
Name of the OLE object. type.CALL_OLE
Description Passes control to the identified OLE object’s method. no values are returned. memberid PLS_INTEGER). use one of the function versions of this call (CALL_OLE_CHAR. using the INIT_OLEARGS and ADD_OLEARGS procedures. As a procedure call. Syntax PROCEDURE CALL_OLE (obj OLEOBJ. the number. _OBJ.
•
•
29
. and value of the arguments must have been established. Member ID of the method to be run.
Before this call is issued. To obtain a return value from the method. _NUM. you can use the function LAST_OLE_EXCEPTION to obtain more information. The method can raise a FORM_OLE_FAILURE exception. If so. or _VAR).

and value of the arguments must have been established.. memberid PLS_INTEGER) RETURN returnval NUMBER. type. .or.. one for each of the argument types CHAR.or. FUNCTION CALL_OLE_VAR (obj OLEOBJ. memberid PLS_INTEGER) RETURN returnval OLEVAR. NUM.or. . FUNCTION CALL_OLE_OBJ (obj OLEOBJ.. Receives a return value of the specified type. using the INIT-OLEARGS and ADD-OLEARGS procedures. Built-in Type unrestricted function Returns the method’s return value in the specified format Parameters obj memberid Usage Notes
•
Name of the OLE object.
Before this call is issued. and VAR. memberid PLS_INTEGER) RETURN returnval VARCHAR2.. OBJ. memberid PLS_INTEGER) RETURN returnval OLEOBJ.
Syntax FUNCTION CALL_OLE_CHAR (obj OLEOBJ... The method can raise a FORM_OLE_FAILURE exception... If so... the number.CALL_OLE_<returntype> built-in
Description Passes control to the identified OLE object’s method.. FUNCTION CALL_OLE_NUM (obj OLEOBJ..
•
30
. Member ID of the object’s method. There are four versions of the function (denoted by the value in returntype). . you can use the function LAST_OLE_EXCEPTION to obtain more information.

Usage Notes • CANCEL_REPORT_OBJECT is useful only when a report is run asynchronously. Syntax PROCEDURE CANCEL_REPORT_OBJECT (report_id VARCHAR2 ). This value uniquely identifies the report that is currently running either locally or on a remote report server. Built-in Type unrestricted procedure Enter Query Mode yes Parameters report_id The VARCHAR2 value returned by the RUN_REPORT_OBJECT built-in.CANCEL_REPORT_OBJECT built-in
Description Cancels a long-running. You cannot cancel an report that is run synchronously. You should verify the report is canceled by checking the status of the report using REPORT_OBJECT_STATUS . asynchronous report.
31
.

depending ** on an indicator checkbox item. If the item is not a check box. ITEM_TYPE) can be used to verify the item type before calling CHECKBOX_CHECKED.CHECKBOX_CHECKED built-in
Description A call to the CHECKBOX_CHECKED function returns a BOOLEAN value indicating the state of the given check box. BEGIN it_id := Find_Item(it_name).
Syntax FUNCTION CHECKBOX_CHECKED (item_id ITEM). To set the value of a check box programmatically. */ PROCEDURE Set_Case_Sensitivity( it_name VARCHAR2) IS indicator_name VARCHAR2(80) := ’control.
32
. FUNCTION CHECKBOX_CHECKED (item_name VARCHAR2). It does not return the actual value of the check box nor does it return the value you might have indicated for the Mapping of Other Values property. Form Builder returns the following error: FRM-41038: Item <item_name> is not a check box.
CHECKBOX_CHECKED examples
/* ** Built-in: CHECKBOX_CHECKED ** Example: Sets the query case-sensitivity of the item ** whose name is passed as an argument.
CHECKBOX_CHECKED restrictions
The CHECKBOX_CHECKED built-in returns a BOOLEAN value regarding the state of the given check box. assign a valid value to the check box using standard bind variable syntax. Built-in Type unrestricted function Returns BOOLEAN Enter Query Mode yes A call to GET_ITEM_PROPERTY( item_name.case_indicator’. Specifies the string you defined as the name of the item at design time. Parameters item_id item_name Specifies the unique ID that Form Builder assigns to the item when it creates it. it_id Item. The data type of the name is VARCHAR2. The data type of the ID is ITEM.

/* ** Otherwise. Built-in Type unrestricted procedure Enter Query Mode yes Parameters none
CHECK_RECORD_UNIQUENESS restrictions
Valid only in an On-Check-Unique trigger. Syntax PROCEDURE CHECK_RECORD_UNIQUENESS. END.Using_Transactional_Triggers = ’TRUE’ THEN User_Exit(’chkuniq block=EMP’). ** trigger: On-Check-Unique */ BEGIN /* ** Check the global flag we set during form startup */ IF :Global.
CHECK_RECORD_UNIQUENESS examples
/* ** Built-in: CHECK_RECORD_UNIQUENESS ** Example: Perform Form Builder record uniqueness checking ** from the fields in the block that are marked as ** primary keys based on a global flag setup at ** startup by the form. perhaps based on a ** parameter.
34
. This built-in is included primarily for applications that will run against a non-ORACLE data source. do the right thing. */ ELSE Check_Record_Uniqueness. END IF.CHECK_RECORD_UNIQUENESS built-in
Description When called from an On-Check-Unique trigger. initiates the default Form Builder processing for checking the primary key uniqueness of a record.

Empno. and flushes the current block without prompting the end user. or "flush. END. and ** deposits the primary key value which the user ** has typed into a global variable which a ** Pre-Query trigger will use to include it as a ** query criterion.Empno IS NOT NULL THEN :Global. /* ** trigger: Pre-Query */
35
.CLEAR_BLOCK built-in
Description Causes Form Builder to remove all records from." the current block. Built-in Type restricted procedure Enter Query Mode no Parameters If the end user has made changes to records in the current block that have not been posted or committed.Employee_Id := :Emp. following the directions indicated by the argument supplied for the commit_mode parameter: commit_mode The optional action parameter takes the following possible constants as arguments: ASK_COMMIT Form Builder prompts the end user to commit the changes during CLEAR_BLOCK processing. committing the changes. END IF. Form Builder processes the records.
CLEAR_BLOCK examples
/* ** Built-in: CLEAR_BLOCK ** Example: Clears the current block without validation. PROCEDURE CLEAR_BLOCK (commit_mode NUMBER). performs a commit. or prompting the end user. NO_COMMIT Form Builder validates the changes and flushes the current block without performing a commit or prompting the end user. Clear_Block(No_Validate). DO_COMMIT Form Builder validates the changes. Syntax PROCEDURE CLEAR_BLOCK. NO_VALIDATE Form Builder flushes the current block without validating the changes. ** trigger: When-New-Item-Instance */ BEGIN IF :Emp.

** trigger: When-New-Item-Instance */ BEGIN IF Get_Item_Property(:System. Built-in Type restricted procedure Enter Query Mode yes
CLEAR_EOL examples
/* ** Built-in: CLEAR_EOL ** Example: Clears out the contents of any number field when ** the end user navigates to it. Syntax PROCEDURE CLEAR_EOL.trigger_Item.
37
.CLEAR_EOL built-in
Description Clears the current text item’s value from the current cursor position to the end of the line. END IF. DATATYPE) = ’NUMBER’ THEN Clear_Eol. END.

PROCEDURE CLEAR_FORM (commit_mode NUMBER). Form Builder interprets that statement as a CLEAR_FORM built-in subprogram with no parameters. the current form. To prevent losing the locks issued by the calling form.CLEAR_FORM built-in
Description Causes Form Builder to remove all records from. Form Builder processes the records. and those records have not been posted or committed. FULL_ROLLBACK Form Builder rolls back all uncommitted changes (including posted changes) which were made during the current Runform session. or prompting the end user. NO_VALIDATE Form Builder flushes the current form without validating the changes. PROCEDURE CLEAR_FORM (commit_mode NUMBER. committing the changes. Syntax POROCEDURE CLEAR_FORM. rollback_mode TO_SAVEPOINT Form Builder rolls back all uncommitted changes (including posted changes) to the current form’s savepoint. or flush. NO_COMMIT Form Builder validates the changes and flushes the current form without performing a commit or prompting the end user. Built-in Type restricted procedure Enter Query Mode no Parameters If the end user has made changes to records in the current form or any called form. following the directions indicated by the argument supplied for the following parameter: commit_mode ASK_COMMIT Form Builder prompts the end user to commit the changes during CLEAR_FORM processing. rollback_mode NUMBER). (Post-only mode can occur when your form issues a call to another form while unposted records exist in the calling form.
38
. and flushes the current form without prompting the end user.)
CLEAR_FORM restrictions
If you use a PL/SQL ROLLBACK statement in an anonymous block or a user-defined subprogram. and puts the input focus in the first item of the first block. You cannot specify a FULL_ROLLBACK from a form that is running in post-only mode. DO_COMMIT Form Builder validates the changes. Form Builder prevents any commit processing in the called form. performs a commit.

40
. Syntax PROCEDURE CLEAR_ITEM.’DD’) <> ’01’ THEN Clear_Item. ** trigger: When-New-Item-Instance */ BEGIN IF TO_CHAR(:Emp. regardless of the current cursor position. END IF.Hiredate. and changes the text item value to NULL.CLEAR_ITEM built-in
Description Clears the value from the current text item. END. Built-in Type restricted procedure Enter Query Mode yes
CLEAR_ITEM examples
/* ** Built-in: CLEAR_ITEM ** Example: Clear the current item if it does not represent ** the first day of a month. Message(’This date must be of the form 01-MON-YY’).

The block status is CHANGED when a block contains records that have been either inserted or updated (queried records have been modified). assume that a list item contains the values A. an error will occur because Form Builder will attempt to display the previously fetched values (A. The data type of the name is VARCHAR2. but will be unable to because the list was cleared. Use the FIND_ITEM built-in to return the ID to an appropriately typed variable. The name you gave to the list item when you created it. After Form Builder clears the list. Before clearing a list. and C and the Mapping of Other Values property is defined. CLEAR_LIST will not clear the default value element or the other values element from the list if they do not meet the criteria specified for deleting these elements with DELETE_LIST_ELEMENT. Syntax PROCEDURE CLEAR_LIST (list_id ITEM). Use the ABORT_QUERY built-in to close an open query. Built-in Type unrestricted procedure Enter Query Mode yes Parameters list_id Specifies the unique ID that Form Builder assigns when it creates the list item.
CLEAR_LIST restrictions
• For a Poplist or T-list-style list item. if you clear the list with CLEAR_LIST. At this point. Assume also that these values have been fetched from the database (a query is open). The data type of the ID is ITEM. Note: The block status is QUERY when a block contains queried records. For example. and C).
41
. B. the list will contain only one element (the null element).
list_name
Usage Notes • Do not use the CLEAR_LIST built-in if the Mapping of Other Values property is defined and there are queried records in the block.CLEAR_LIST built-in
Description Clears all elements from a list item. close any open queries. B. Doing so may cause Form Builder to be unable to display records that have already been fetched. regardless of the item’s Required property. PROCEDURE CLEAR_LIST (list_name VARCHAR2).

When either the default value or other values element cannot be deleted.
CLEAR_LIST examples
/* ** ** */ Built-in: Example: CLEAR_LIST See POPULATE_LIST
42
. Refer to the restrictions on DELETE_LIST_ELEMENT for more information. CLEAR_LIST leaves these elements in the list and clears all other elements.

END.Last_Record = ’TRUE’ AND :System. If a query is open in the block. Bell.CLEAR_RECORD built-in
Description Causes Form Builder to remove. Built-in Type restricted procedure Enter Query Mode yes
CLEAR_RECORD examples
/* ** Built-in: CLEAR_RECORD ** Example: Clear the current record if it’s not the last ** record in the block.Cursor_Record = ’1’ THEN Message(’You cannot clear the only remaining entry.’). Syntax PROCEDURE CLEAR_RECORD. or flush. In a default master-detail block relation. if the record space is no longer filled after removing the current record. clearing the master record causes all corresponding detail records to be cleared without validation. END IF. the current record from the block. A database record that has been cleared is not processed as a delete by the next Post and Commit Transactions process. ELSE Clear_Record. */ BEGIN IF :System. Form Builder fetches the next record to refill the block. without performing validation.
44
.

Built-in Type restricted procedure Enter Query Mode no Parameters form_name form_id Specifies the name of the form to close as a VARCHAR2. then Form_B cannot close Form_A. The unique ID that is assigned to the form dynamically when it is instantiated at runtime. CLOSE_FORM is equivalent to EXIT_FORM.
•
45
.
CLOSE_FORM restrictions
•
You cannot close a form that is currently disabled as a result of having issued CALL_FORM to invoke a modal called form. For example. closes the indicated form. Use the FIND_FORM built-in to an appropriately typed variable. The data type of the form ID is FORMMODULE.CLOSE_FORM built-in
Description In a multiple-form application. PROCEDURE CLOSE_FORM (form_id FORMMODULE). if Form_A calls Form_B. You cannot close a form that has called you. When the indicated form is the current form. Syntax PROCEDURE CLOSE_FORM (form_name VARCHAR2).

The data type of the ID is Item. END.CLOSE_SERVER built-in
Description Deactivates the OLE server associated with an OLE container.
CLOSE_SERVER examples
/* ** Built-in: CLOSE_SERVER ** Example: Deactivates the OLE server associated with the object ** in the OLE container.Close_Server(item_id). item_name VARCHAR(25) := ’OLEITM’.
item_name
CLOSE_SERVER restrictions
Valid only on Microsoft Windows and Macintosh.
46
. Use the FIND_ITEM built-in to return the ID to an appropriately typed variable. ELSE Forms_OLE. Syntax PROCEDURE CLOSE_SERVER (item_id Item). Specifies the name of the object created at design time. Built-in Type unrestricted procedure Enter Query Mode no Parameters item_id Specifies the unique ID that Form Builder assigns to the item when created. The data type of the name is VARCHAR2 string. Terminates the connection between an OLE server and the OLE container. PROCEDURE CLOSE_SERVER (item_name VARCHAR2). END IF. BEGIN item_id := Find_Item(item_name). ** trigger: When-Button-Pressed */ DECLARE item_id ITEM. IF Id_Null(item_id) THEN message(’No such item: ’||item_name).

and performs a database commit. inserts. If the end user has posted data to the database during the current Runform session. /* ** Commit if anything is changed */ IF :System. Syntax PROCEDURE COMMIT_FORM. then do so. Built-in Type restricted procedure Enter Query Mode no
COMMIT_FORM restrictions
If you use a PL/SQL COMMIT statement in an anonymous block or a form-level procedure.Form_Status = ’CHANGED’ THEN Commit_Form. As a result of the database commit. */
47
. END IF. Form Builder interprets that statement as a call to the COMMIT_FORM built-in. */ BEGIN /* ** Force validation to happen first */ Enter. and updates to the database. Form Builder first validates the form. the database releases all row and table locks.COMMIT_FORM built-in
Description Causes Form Builder to update data in the database to match data in the form. /* ** A successful commit operation sets Form_Status back ** to ’QUERY’. Form Builder does not recognize changes that occur in triggers that fire during commit processing.
COMMIT_FORM examples
Example 1 /* ** Built-in: COMMIT_FORM ** Example: If there are records in the form to be ** committed. Raise an error if the ** commit was not successful. for each block in the form. then. a call to the COMMIT_FORM built-in commits this data to the database. Form Builder treats all records in all base-table blocks as if they are queried records from the database. IF NOT Form_Success THEN RAISE Form_trigger_Failure. deletes. Following a commit operation.

END IF. END IF.IF :System. Decide whether to use this Built-in ** or a user exit based on a global flag setup at ** startup by the form. */ ELSE Commit_Form. RAISE Form_trigger_Failure. Bell.’). /* ** Otherwise. do the right thing.Form_Status <> ’QUERY’ THEN Message(’An error prevented your changes from being committed. Example 2 /* ** Built-in: COMMIT_FORM ** Example: Perform Form Builder database commit during commit ** processing. perhaps based on a ** ** trigger: On-Commit */ BEGIN /* ** Check the global flag we set during form startup */ IF :Global. END IF. END.Using_Transactional_Triggers = ’TRUE’ THEN User_Exit(’my_commit’). END.
48
.

CONVERT_OTHER_VALUE built-in
Description Converts the current value of a check box.Marital_Status’). or with the current radio group button or list item element. Form Builder returns error FRM-41026: Item does not understand operation. radio group. Syntax PROCEDURE CONVERT_OTHER_VALUE (item_id ITEM).
CONVERT_OTHER_VALUE examples
/* ** Built-in: CONVERT_OTHER_VALUE ** Example: Ensure that a particular checkbox’s value ** represents either the checked or unchecked ** value before updating the record. ** trigger: Pre-Update */ BEGIN Convert_Other_Value(’Emp. The data type of the ID is ITEM.
CONVERT_OTHER_VALUE restrictions
If the item is not a check box. END. or list item. or list item to the value associated with the current check box state (Checked/Unchecked).
49
. PROCEDURE CONVERT_OTHER_VALUE (item_name VARCHAR2). To avoid this error. radio group. Specifies the VARCHAR2 string you defined as the name of the item at design time. ITEM_TYPE) before calling CONVERT_OTHER_VALUE. Built-in Type restricted procedure Enter Query Mode yes Parameters item_id item_name Specifies the unique ID that Form Builder assigns to the item when it creates the item. determine the item type by issuing a call to GET_ITEM_PROPERTY(item_name.

standard validation checks are performed on the copied value.
COPY examples
Example 1 /* ** Built-in: COPY ** Example: Force a wildcard search on the EmpNo item during ** query. BEGIN
50
. ** trigger: Pre-Query */ DECLARE cur_val VARCHAR2(40). Use specifically to write a value into an item that is referenced through the NAME_IN built-in. To use a text item as the source reference. for all other types of items. COPY exists for two reasons: • • You cannot use standard PL/SQL syntax to set a referenced item equal to a value. you can use the following code: COPY(NAME_IN( source).0. Usage Notes • When using COPY with date values. VARCHAR2). destination). If this property is set to 4.
Syntax PROCEDURE COPY (source destination
VARCHAR2.5 COPY will expect date strings to be formatted using the default American format. the format defined in the BUILTIN_DATE_FORMAT property will be used if the DATE_FORMAT_COMPATIBILITY_MODE property is set to 5. However.
Built-in Type unrestricted procedure Enter Query Mode yes Parameters source The source is a literal value.
destinatioThe destination can be either a text item or another global variable. You might intend to programmatically place characters such as relational operators in NUMBER and DATE fields while a form is in Enter Query mode.
•
COPY restrictions
No validation is performed on a value copied to a text item.COPY built-in
Description Copies a value from one item or variable into another item or global variable.

Empno’). ’Emp.’||global_var_name ). */ Copy( cur_val.Choice = 5 THEN global_var_name := ’Storage_1’. /* ** Use the name in the ’global_var_name’ variable as the ** name of the global variable in which to copy the ** current ’Yes’ value.EMPNO as a string */ cur_val := Name_In(’Emp.Empno’ ). */ cur_val := cur_val || ’%’.
51
. ELSE global_var_name := ’Storage_2’. */ DECLARE global_var_name VARCHAR2(80)./* ** Get the value of EMP. BEGIN IF :Selection. END IF. END. /* ** Copy the new value back into the item so Form Builder ** will use it as a query criterion. */ COPY( ’Yes’. Example 2 /* ** Built-in: COPY ** Example: Set the value of a global variable whose name is ** dynamically constructed. END. ’GLOBAL. /* ** Add a percent to the end of the string.

Syntax PROCEDURE COPY_REGION. on text and image items only. the cut or copied content is pasted onto the target location. as well as the other editing functions.COPY_REGION built-in
Description Copies the selected region of a text item or image item from the screen and stores it in the paste buffer until you cut or copy another selected region.
52
. Built-in Type restricted procedure Enter Query Mode yes Parameters none Usage Notes Use COPY_REGION. The cut and copy functions transfer the selected region into the system clipboard until you indicate the paste target. At that time.

BEGIN repid := find_report_object(’report4’). This value uniquely identifies the report that is currently running either locally or on a remote report server.pdf’). v_rep := RUN_REPORT_OBJECT(repid).
53
. To copy the output of a report from a remote machine. if rep_status = ’FINISHED’ then message(’Report Completed’).
COPY_REPORT_OBJECT_OUTPUT examples
DECLARE repid REPORT_OBJECT. copy_report_object_output(v_rep.
output_file Usage Notes • •
Use the Report Destination Type property to specify the format of the output file. else message(’Error when running report. Built-in Type unrestricted procedure Enter Query Mode yes Parameters report_id The VARCHAR2 value returned by the RUN_REPORT_OBJECT built-in.’d:\temp\ local. The name of the file where the report output will be copied. Syntax PROCEDURE COPY_REPORT_OBJECT_OUTPUT (report_id VARCHAR2(20).’).COPY_REPORT_OBJECT_OUTPUT built-in
Description Copies the output of a report to a file. v_rep VARCHAR2(100). rep_status varchar2(20). you must set the Report Destination Type property to Cache. host(’netscape d:\temp\local.pdf’). END. rep_status := report_object_status(v_rep). end if. output_file VARCHAR2 ).

COUNT_QUERY built-in
Description In an On-Count trigger. ** Decide whether to use this Built-in or a user ** exit based on a global flag setup at startup by ** the form. Form Builder prompts the end user to commit them during COUNT_QUERY processing.
COUNT_QUERY examples
Example 1 /* ** Built-in: COUNT_QUERY ** Example: Display the number of records that will be retrieved ** by the current query. This built-in is included primarily for applications that will run against a non-ORACLE data source. Syntax PROCEDURE COUNT_QUERY. Example 2 /* ** Built-in: COUNT_QUERY ** Example: Perform Form Builder count query hits processing. perhaps based on a parameter. If there are changes to commit in the block. Form Builder returns the following message as a result of a valid call to COUNT_QUERY: FRM-40355: Query will retrieve <number> records. ** trigger: On-Count */ BEGIN /* ** Check the global flag we set during form startup */
54
. */ BEGIN Count_Query. END. Built-in Type restricted procedure Enter Query Mode yes Parameters none
COUNT_QUERY restrictions
Valid only in triggers that allow restricted built-ins. performs the default Form Builder processing for identifying the number of rows that a query will retrieve for the current block. and clears the current block.

GLOBAL_SCOPE Indicates that the record group is global. Takes the following constants as arguments: FORM_SCOPE Indicates that the record group can by used only within the current form. Syntax FUNCTION CREATE_GROUP (recordgroup_name VARCHAR2.
scope
CREATE_GROUP examples
/* ** Built-in: CREATE_GROUP ** Example: Creates a record group and populates its values ** from a query. Specifies whether tlhe record group can be used only within the current form or within every form in a multi-form application. array_fetch_size Specifies the array fetch size. Built-in Type unrestricted function Returns RecordGroup Enter Query Mode yes Parameters recordgroup_name The string you defined as the name of the record group at design time. This is the default value.CREATE_GROUP built-in
Description Creates a non-query record group with the given name. */ DECLARE rg_name VARCHAR2(40) := ’Salary_Range’. errcode NUMBER. You can call the record group by name or by ID in later calls to record group or record group column builtin subprograms. BEGIN /* ** Make sure the record group does not already exist. and that it can be used within all forms in the application. scope NUMBER. rg_id RecordGroup. When Form Builder creates the record group object it also assigns the object a unique ID of type RecordGroup.
56
. and the POPULATE_GROUP_WITH_QUERY built-ins. Once created. gc_id GroupColumn. a global record group persists for the remainder of the runtime session. The new record group has no columns and no rows until you explicitly add them using the ADD_GROUP_COLUMN. array_fetch_size NUMBER). the ADD_GROUP_ROW. The default array size is 20.

A valid SQL SELECT statement. the query SELECT 1 + 1 FROM DUAL would result in a column named ICRGGQ_1. The default array size is 20. then Form Builder creates only those columns in the record group Specifies whether tlhe record group can be used only within the current form or within every form in a multi-form application. This is the default value. Any columns retrieved as a result of the query take the data types of the columns in the table. a global record group persists for the remainder of the runtime session. Add rows to the record group with the POPULATE_GROUP built-in. Takes the following constants as arguments: FORM_SCOPE Indicates that the record group can by used only within the current form. and the
58
. Form Builder creates ICRGGQ with a dummy counter <NUM>. array_fetch_size NUMBER). and that it can be used within all forms in the application. query VARCHAR2. When Form Builder creates the record group object it also assigns the object a unique ID of type RecordGroup. Note: If you do not pass a formal column name or alias for a column in the SELECT statement. The first dummy name-counter always takes the number one. The record group has columns representing each column you include in the select list of the query.CREATE_GROUP_FROM_QUERY built-in
Description Creates a record group with the given name. Built-in Type unrestricted function Returns RecordGroup Enter Query Mode yes Parameters recordgroup_name query The name of the record group. If you restrict the query to a subset of the columns in the table. This happens whenever the column name would have been invalid.
CREATE_GROUP_FROM_QUERY restrictions
• If a global record group is created from (or populated with) a query while executing form A. GLOBAL_SCOPE Indicates that the record group is global. Once created.
scope
array_fetch_size
Specifies the array fetch size. Syntax FUNCTION CREATE_GROUP_FROM_QUERY (recordgroup_name VARCHAR2. scope NUMBER. enclosed in single quotes. For example.

59
. */ DECLARE rg_name VARCHAR2(40) := ’Salary_Range’. errcode NUMBER. END.query string contains bind variable references which are local to A (:block. rg_id RecordGroup. BEGIN /* ** Make sure group doesn’t already exist */ rg_id := Find_Group( rg_name ).item or :PARAMETER. when form A terminates execution.1000) BASE_SAL_RANGE. ’SELECT SAL-MOD(SAL. but a subsequent call to POPULATE_GROUP is considered an error). the global query record group is converted to a global non-query record group (it retains the data. */ IF Id_Null(rg_id) THEN rg_id := Create_Group_From_Query( rg_name. create it and add the two ** necessary columns to it. /* ** Populate the record group */ errcode := Populate_Group( rg_id ). END IF.
CREATE_GROUP_FROM_QUERY examples
/* ** Built-in: CREATE_GROUP_FROM_QUERY ** Example: Create a record group from a query.’ ||’COUNT(EMPNO) EMPS_IN_RANGE ’ ||’FROM EMP ’ ||’GROUP BY SAL-MOD(SAL. and populate it. /* ** If it does not exist.1000) ’ ||’ORDER BY 1’).param).

alters the persistence of a previously-instantiated OLE object. creates an OLE object. FUNCTION CREATE_OLEOBJ (localobject VARCHAR2.or. A boolean value of TRUE establishes the object as persistent.. persistence_boolean := TRUE) RETURN objpointer OLEOBJ. Built-in Type unrestricted function Returns pointer to the OLE object Parameters name localobject persistence_boolean The program ID of the OLE object’s server. This is an optional parameter. In its second form. the default value is persistent.
Usage Notes A persistent object exists across trigger invocations.. If not supplied. A pointer to the OLE object whose status is to be changed from non-persistent to persistent..CREATE_OLEOBJ built-in
Description In its first form. Syntax FUNCTION CREATE_OLEOBJ (name OLEOBJ. . and establishes the object’s persistence.. A non-persistent object exists only as long as the trigger that spawned the call runs.
60
. persistence_boolean := TRUE) RETURN objpointer OLEOBJ.

A parameter list can be passed as an argument to the CALL_FORM. To avoid this error. The parameter list has no parameters when it is created. First ** make sure the list does not already exist. IF Id_Null(pl_id) THEN Message(’Error creating parameter list ’||pl_name). pl_name VARCHAR2(10) := ’tempdata’. then ** attempt to create a new list.
CREATE_PARAMETER_LIST examples
/* ** Built-in: CREATE_PARAMETER_LIST ** Example: Create a parameter list named ’TEMPDATA’. it assigns it a unique ID of type PARAMLIST. */ DECLARE pl_id ParamList. they must be added using the ADD_PARAMETER built-in subprogram. You can call the parameter list by name or by ID in later calls to parameter list-related built-in subprograms. Syntax FUNCTION CREATE_PARAMETER_LIST (name VARCHAR2). delete it before creating a new list. OPEN_FORM. to do so will cause an error. Signal an error ** if the list already exists or if creating the ** list fails. You cannot create a parameter list if one already exists.
61
. BEGIN pl_id := Get_Parameter_List(pl_name).CREATE_PARAMETER_LIST built-in
Description Creates a parameter list with the given name.
CREATE_PARAMETER_LIST restrictions
• • You cannot create a parameter list named DEFAULT. If a parameter list already exists. use ID_NULL to check to see if a parameter list already exists before creating one. Built-in Type unrestricted function Returns ParamList Enter Query Mode yes Parameters name Specifies the VARCHAR2 name of the parameter list object. and RUN_PRODUCT built-in subprograms. DEFAULT is reserved for the parameter list that Form Builder creates at the initiation of a runtime session. When Form Builder creates the object. NEW_FORM. IF Id_Null(pl_id) THEN pl_id := Create_Parameter_List(pl_name).

. Consequently. BEGIN OPEN next_seq. ** trigger: On-Fetch */ DECLARE fetch_count NUMBER. the application must ensure that there is data available to be used for populating the record programmatically. Built-in Type restricted procedure Enter Query Mode no Parameters none
CREATE_QUERIED_RECORD restrictions
• In blocks with a large number of records. Note that there is no way to remove a record from the waiting list. FETCH next_seq INTO tmp.Record_Count. FOR i IN 1. tmp NUMBER. Syntax PROCEDURE CREATE_QUERIED_RECORD. FUNCTION The_Next_Seq RETURN NUMBER IS CURSOR next_seq IS SELECT uniq_seq.CREATE_QUERIED_RECORD built-in
Description When called from an On-Fetch trigger. This built-in is included primarily for applications using transactional triggers to run against a non-ORACLE data source.RECORDS_TO_FETCH). The waiting list is an intermediary record buffer that contains records that have been fetched from the data source but have not yet been placed on the block’s list of active records. BEGIN /* ** Determine how many records Form Builder is expecting us to ** fetch */ fetch_count := Get_Block_Property(’MYBLOCK’. CLOSE next_seq. memory allocation. END. this procedure can have side effects on disk I/O.
CREATE_QUERIED_RECORD examples
/* ** Built-in: CREATE_QUERIED_RECORD ** Example: Fetch the next N records into this block. Record ** count kept in Global. RETURN tmp.NEXTVAL FROM DUAL.fetch_count LOOP /*
63
. or both. creates a record on the block’s waiting list.

64
. /* ** Populate the item in the queried record with a ** sequence function we declared above */ :myblock.** Create the Queried Record into which we’ll deposit ** the values we’re about to fetch. END. END LOOP. :Global.Record_Count := NVL(:Global.Record_Count. */ Create_Queried_Record.numbercol := the_next_seq.0)+1.

First_Record. : Milestone.milestone_name. /* Loop thru the records in the cursor */ FOR rec IN tempcur( projid ) LOOP /* ** Create an empty record and set the current row’s ** Milestone_Name and Due_Date items. END LOOP.
65
.due_date.CREATE_RECORD built-in
Description Creates a new record in the current block after the current record. */ Create_Record. due_date FROM milestone WHERE project_id = cp_projid ORDER BY due_date. Built-in Type restricted procedure Enter Query Mode no Parameters none
CREATE_RECORD examples
/* ** Built-in: CREATE_RECORD ** Example: Populate new records in a block based on return ** values from a query */ PROCEDURE Populate_Rows_Into_Block( projid NUMBER) IS CURSOR tempcur( cp_projid NUMBER ) IS SELECT milestone_name.Milestone_Name := rec.Due_Date := rec. END. : Milestone. Form Builder then navigates to the new record. BEGIN /* Add these records to the bottom of the block */ Last_Record. Syntax PROCEDURE CREATE_RECORD.

but is to be used once only. subsequent repetitions are canceled. Default. Syntax FUNCTION CREATE_TIMER (timer_name VARCHAR2. See Restrictions below for more information. iterate Built-in Type unrestricted function Returns Timer Enter Query Mode yes Parameters timer_name Specifies the timer name of up to 30 alphanumeric characters. No two timers can share the same name in the same form instance. You can indicate the interval and whether the timer should repeat upon expiration or execute once only. The data type of the name is VARCHAR2. The name must begin with an alphabetic character. regardless of case. If there is no When-Timer-Expired trigger defined at the execution of a timer. The data type of the parameter is NUMBER. If there is no When-Timer-Expired trigger defined at the execution of a timer. When the timer expires. If there is no When-Timer-Expired trigger defined at the execution of a timer. but the timer is retained. The range of values allowed for this parameter is 1 to 2147483648 milliseconds. until explicitly called again. Form Builder returns an error. NUMBER). Note that only positive numbers are allowed. Milliseconds cannot be expressed as a decimal. Specifies whether the timer should repeat or not upon expiration. and the timer is not a
66
. Takes the following constants as arguments: REPEAT Indicates that the timer should repeat upon expiration.
milliseconds
iterate
CREATE_TIMER restrictions
• • • • • • Values > 2147483648 will be rounded down to 2147483648. NO_REPEAT Indicates that the timer should not repeat upon expiration. milliseconds NUMBER. Specifies the duration of the timer in milliseconds. Values > 2147483648 will be rounded down to 2147483648.CREATE_TIMER built-in
Description Creates a new timer with the given name. and the timer is a repeating timer. Form Builder fires the WhenTimer-Expired trigger.

This is an optional parameter.in which case its elements have the type you specify. the default value is non-persistent. FUNCTION CREATE_VAR (bounds OLE_SAFEARRAYBOUNDS.. vtype The OLE variant type (VT_TYPE) of the elements in the created array. unnamed variant. See also DESTROY_VARIANT
•
•
68
. If not specified. A persistent variant exists across trigger invocations.. a value of FALSE establishes the variant as non-persistent. vtype VT_TYPE. unless it is an array -. specify VT_VARIANT. persistence BOOLEAN) RETURN newvar OLEVAR. Use the SET_VAR function to assign an initial value and type to the variant..
Usage Notes
•
The created variant is untyped. A non-persistent variant exists only as long as the trigger that spawned the call runs.. bounds A PL/SQL table that specifies the dimensions to be given to the created array. There are two versions of the function. A boolean value of TRUE establishes the variant as persistent. Built-in Type unrestricted function Returns the created OLE variant. . one for scalars and the other for arrays. Syntax FUNCTION CREATE_VAR (persistence BOOLEAN) RETURN newvar OLEVAR.or. see ARRAY TYPES FOR OLE SUPPORT.CREATE_VAR built-in
Description Creates an empty. If the array will contain mixed element types. Parameters persistence Controls the persistence of the variant after its creation. The created variant is also without a value. For more information about the contents and layout of this parameter and the type OLE_SAFEARRAYBOUNDS.

Built-in Type restricted procedure Enter Query Mode yes Parameters none Usage Notes Use CUT_REGION. the cut or copied content is pasted onto the target location. as well as the other editing functions.CUT_REGION built-in
Description Removes a selected region of a text item or an image item from the screen and stores it in the paste buffer until you cut or copy another selected region.
69
. Syntax PROCEDURE CUT_REGION. The cut and copy functions transfer the selected region into the system clipboard until you indicate the paste target. on text and image items only. At that time.

END IF. END. END IF. */ Message(’Insert failed because of ’||dbmserrtext).** Printout a generic message with the database ** error string in it.
73
.

Form Builder issues an appropriate message when a menu item command executes.DEBUG_MODE built-in
Description Toggles debug mode on and off in a menu. It does not place the form in Debug Mode.
74
. When debug mode is on in a menu. Built-in Type unrestricted procedure Enter Query Mode yes Parameters none
DEBUG_MODE restrictions
The DEBUG_MODE applies only to a menu module. Syntax PROCEDURE DEBUG_MODE.

DEFAULT_VALUE examples
/* ** Built-in: DEFAULT_VALUE ** Example: Make sure a Global variable is defined by ** assigning some value to it with Default_Value */ BEGIN /* ** Default the value of GLOBAL. DEFAULT_VALUE does nothing. Built-in Type unrestricted procedure Enter Query Mode yes Parameters value_string variable_name A valid VARCHAR2 string. or text item name. A valid variable. then it must have not existed before */ IF :Global. Syntax PROCEDURE DEFAULT_VALUE (value_string VARCHAR2.
DEFAULT_VALUE restrictions
The DEFAULT_VALUE built-in is not related to the Initial Value item property. RAISE Form_trigger_Failure. for text items this built-in works identically to using the COPY built-in on a NULL item. variable_name VARCHAR2).Command_Indicator = ’***’ THEN Message(’You must call this screen from the Main Menu’). global variable. Any object passed as an argument to this built-in must be enclosed in single quotes. variable. or text item containing a valid string.Command_Indicator if it is ** NULL or does not exist. END IF. If the variable’s current value is not NULL. Form Builder creates the variable. END. /* ** If the global variable equals the string we defaulted ** it to above. The data type of the variable_name is VARCHAR2. Therefore.
75
. */ Default_Value(’***’.’global. If the variable is an undefined global variable.command_indicator’).DEFAULT_VALUE built-in
Description Copies an indicated value to an indicated variable if the variable’s current value is NULL.

The data type of the name is VARCHAR2.
DELETE_GROUP examples
/* ** Built-in: DELETE_GROUP ** Example: Delete a programmatically created record group */ PROCEDURE Remove_Record_Group( rg_name VARCHAR2 ) IS rg_id RecordGroup. */ rg_id := Find_Group( rg_name ). BEGIN /* ** Make sure the Record Group exists before trying to ** delete it.
DELETE_GROUP restrictions
This built-in cannot be used to delete a record group that was created at design time. The data type of the ID is RecordGroup.DELETE_GROUP built-in
Description Deletes a programmatically created record group. END. Built-in Type unrestricted procedure Enter Query Mode yes Parameters recordgroup_id recordgroup_name The unique ID that Form Builder assigns when it creates the group.
76
. IF NOT Id_Null(rg_id) THEN Delete_Group( rg_id ). The name you gave to the record group when creating it. END IF. PROCEDURE DELETE_GROUP (recordgroup_name VARCHAR2). Syntax PROCEDURE DELETE_GROUP (recordgroup_id RecordGroup).

subsequent rows are renumbered so that row numbers remain contiguous.
77
. Row number parameter data type is NUMBER. When rows are deleted. Syntax PROCEDURE DELETE_GROUP_ROW (recordgroup_id RecordGroup. PROCEDURE DELETE_GROUP_ROW (recordgroup_name VARCHAR2. When a single row is deleted. If you choose to delete all rows of the group by supplying the ALL_ROWS constant. The data type of the name is VARCHAR2. Specifies the row to be deleted from the record group. row_number NUMBER). rg_name VARCHAR2 ) IS rg_id RecordGroup.DELETE_GROUP_ROW built-in
Description Deletes the indicated row or all rows of the given record group. row_number NUMBER). Form Builder automatically decrements the row numbers of all rows that follow a deleted row. ALL_ROWS is a constant. The name you gave to the record group when you created it. */ PROCEDURE Delete_Tail_Records( recs_to_del NUMBER. but the group still exists until you perform the DELETE_GROUP subprogram. the appropriate memory is freed and available to Form Builder. ALL_ROWS Specifies that Form Builder is to delete all rows without deleting the record group.
DELETE_GROUP_ROW restrictions
This built-in cannot be used to delete rows from a static record group. Built-in Type unrestricted procedure Enter Query Mode yes Parameters recordgroup_id recordgroup_name row_number The unique ID that Form Builder assigns the group when it creates it.
DELETE_GROUP_ROW examples
/* ** Built-in: DELETE_GROUP_ROW ** Example: Delete certain number of records from the tail ** of the specified record group. Rows are automatically numbered from 1 to n. Form Builder deletes the rows. The data type of the ID is RecordGroup.

.recs_to_del LOOP Delete_Group_Row( rg_id. /* ** Get a count of the records in the record group */ rec_Count := Get_Group_Row_Count( rg_id ).’). IF rec_Count < recs_to_del THEN Message(’There are only ’||TO_CHAR(rec_Count)|| ’ records in the group.j + 1 ). RAISE Form_trigger_Failure. END. rec_Count .
78
. END LOOP. /* ** Loop thru and delete the last ’recs_to_del’ records */ FOR j IN 1.rec_count NUMBER. BEGIN /* ** Check to see if Record Group exists */ rg_id := Find_Group( rg_name ). END IF.

The data type of the ID is ITEM. The name you gave to the list item when you created it.
DELETE_LIST_ELEMENT restrictions
For a Poplist or T-list-style list item.
79
. Syntax PROCEDURE DELETE_LIST_ELEMENT (list_name VARCHAR2.
list_name list_index Usage Notes •
Do not use the DELETE_LIST_ELEMENT built-in if the Mapping of Other Values property is defined and there are queried records in the block. Built-in Type unrestricted procedure Enter Query Mode yes Parameters list_id Specifies the unique ID that Form Builder assigns when it creates the list item. if you delete B from the list using DELETE_LIST_ELEMENT. Before deleting a list element. Specifies the list index value. and C). The data type of the name is VARCHAR2. an error will occur because Form Builder will attempt to display the previously fetched values (A. Form Builder returns error FRM-41331: Could not delete element from <list_item> if you attempt to delete the default value element. At this point. list_index NUMBER). For example. Note: A list does not contain an other values element if none was specified at design time or if it was programmatically deleted from the list at runtime.DELETE_LIST_ELEMENT built-in
Description Deletes a specific list element from a list item. B. but will be unable to because B was deleted from the list. B. Use the FIND_ITEM built-in to return the ID to an appropriately typed variable. and C and the Mapping of Other Values property is defined. assume that a list item contains the values A. The list index is 1 based. The default value element is the element whose label or value was specified at design time for the Initial Value property setting. PROCEDURE DELETE_LIST_ELEMENT ITEM (list_id. Use the ABORT_QUERY built-in to close an open query. Assume also that these values have been fetched from the database (a query is open). Doing so may cause Form Builder to be unable to display records that have already been fetched. close any open queries. list_index NUMBER).

For a base table Poplist or T-list list item. attempt to delete any element from a list that does not contain an other values element when the block contains queried or changed records.For a Combobox list item. Form Builder returns error FRM-41331: Could not delete element from <list_item> if you: • • attempt to delete the other values element when the block contains queried or changed records.
DELETE_LIST_ELEMENT examples
/* ** ** */ Built-in: Example: DELETE_LIST_ELEMENT See ADD_LIST_ELEMENT
80
. rather than an element label. you can delete the default value element only if the Initial Value property was set to an actual value. Note: The block status is QUERY when a block contains queried records. The block status is CHANGED when a block contains records that have been either inserted or updated (queried records have been modified).

*/ BEGIN Delete_Parameter(’tempdata’. key VARCHAR2).
81
. The actual parameter can be either a parameter list ID of type PARAMLIST.DELETE_PARAMETER built-in
Description Deletes the parameter with the given key from the parameter list. or the VARCHAR2 name of the parameter list. The data type of the key is VARCHAR2.’number_of_copies’). The name of the parameter. To delete the parameter list. either by list ID or name. VARCHAR2). END. Built-in Type unrestricted procedure Enter Query Mode yes Parameters list or name Specifies the parameter list.
DELETE_PARAMETER examples
/* ** Built-in: DELETE_PARAMETER ** Example: Remove the ’NUMBER_OF_COPIES’ parameter from the ** already existing ’TEMPDATA’ parameter list. key PROCEDURE DELETE_PARAMETER (name VARCHAR2.
key
DELETE_PARAMETER restrictions
• Deleting the last parameter from a list does not automatically delete the list itself. issue a call to the DESTROY_PARAMETER_LIST subprogram. Syntax PROCEDURE DELETE_PARAMETER (list VARCHAR2.

DELETE_RECORD initiates the default Form Builder processing for deleting a record during the Post and Commit Transaction process. If a query is open in the block. Syntax PROCEDURE DELETE_RECORD.
82
. Built-in Type restricted procedure Enter Query Mode no Parameters none
DELETE_RECORD examples
Example 1 /* ** Built-in: DELETE_RECORD ** Example: Mark the current record in the current block for ** deletion.Using_Transactional_Triggers = ’TRUE’ THEN User_Exit(’my_delrec block=EMP’). as shown in Example 2 below. See also the description for the CLEAR_RECORD built-in subprogram. Example 2 /* ** Built-in: DELETE_RECORD ** Example: Perform Form Builder delete record processing ** during commit-time. END. removes the current record from the block and marks the record as a delete. ** trigger: On-Delete */ BEGIN /* ** Check the global flag we set during form startup */ IF :Global. */ BEGIN Delete_Record. perhaps based on ** a parameter. but are added to a list of records that are deleted during the next available commit process.DELETE_RECORD built-in
Description When used outside an On-Delete trigger. In an On-Delete trigger. Records removed with this built-in are not removed one at a time. If the record corresponds to a row in the database. Form Builder fetches a record to refill the block if necessary. Decide whether to use this ** Built-in or a user exit based on a global flag ** setup at startup by the form. Form Builder locks the record before removing it and marking it as a delete.

the timer is deleted. but the ID continues to exist.’).DELETE_TIMER built-in
Description Deletes the given timer from the form. specifically as a response to a successful call to the CREATE_TIMER built-in. Syntax PROCEDURE DELETE_TIMER (timer_id Timer). you must issue a FIND_TIMER call before attempting to call ID_NULL to check on availability of the timer object. BEGIN tm_id := Find_Timer( tm_name ). PROCEDURE DELETE_TIMER (timer_name VARCHAR2). hence. the following example is incorrect because the call to DELETE_TIMER does not set the value of the ID. ELSE Message(’Timer ’||tm_name||’ has already been cancelled.
84
. That data type of the ID is Timer.. In other words. Built-in Type unrestricted procedure Enter Query Mode yes Parameters timer_id Specifies the unique ID that Form Builder assigns when it creates the timer. Specifies the name you gave the timer when you defined it..
DELETE_TIMER examples
/* ** Built-in: DELETE_TIMER ** Example: Remove a timer after first checking to see if ** it exists */ PROCEDURE Cancel_Timer( tm_name VARCHAR2 ) IS tm_id Timer. IF (ID_Null(timer_id)). For instance. The data type of the timer_name is VARCHAR2.Invalid Example timer_id := Find_Timer(’my_timer’). yet points to a non-existent timer. -. Use the FIND_TIMER built-in to return the ID to an appropriately typed variable. END IF. Delete_Timer(timer_id). IF NOT Id_Null(tm_id) THEN Delete_Timer(tm_id). it is not null.
timer_name
DELETE_TIMER restrictions
• If you delete a timer.

85
.END.

The data type of the ID is ITEM.
86
. node NODE). DECLARE htree ITEM.NODE. Use the FIND_ITEM built-in to return the ID to an appropriately typed variable. delete_node FTREE. Specifies a valid node. PROCEDURE DELETE_TREE_NODE (item_id ITEM.
node Usage Notes
Removing a branch node also removes all child nodes. Specifies the unique ID that Form Builder assigns to the item when created. htree := Find_Item(’tree_block. The data type of the name is VARCHAR2 string.
DELETE_TREE_NODE examples
/* ** Built-in: */ DELETE_TREE_NODE
-. Built-in Type unrestricted procedure Enter Query Mode no Parameters item_name Item_id Specifies the name of the object created at design time. BEGIN -.DELETE_TREE_NODE built-in
Description Removes the data element from the tree.and deletes it and all of its children. node NODE).This code finds a node with the label "Zetie" -. Syntax PROCEDURE DELETE_TREE_NODE (item_name VARCHAR2.htree3’).Find the tree itself.

END.-. delete_node). delete_node := Ftree.Delete_Tree_Node(htree. -. Ftree.ROOT_NODE.FIND_NEXT. Ftree. Ftree.Start searching from the root of the tree.ROOT_NODE).ID_NULL(delete_node) then Ftree.
87
.NODE_LABEL. Ftree. ’Zetie’.Find_Tree_Node(htree. END IF.Delete the node and all of its children. -. IF NOT Ftree.Find the node with a label of "Zetie".

Use the GET_PARAMETER_LIST built-in to return the ID to a variable of the type PARAMLIST. PROCEDURE DESTROY_PARAMETER_LIST (name VARCHAR2). IF NOT Id_Null(pl_id) THEN Destroy_Parameter_List(pl_id). either by list ID or name. BEGIN pl_id := Get_Parameter_List(’tempdata’). Syntax PROCEDURE DESTROY_PARAMETER_LIST (list VARCHAR2).
Usage Notes: When a parameter list is destroyed using DESTROY_PARAMETER_LIST the parameter list handle is NOT set to NULL. or the VARCHAR2 name of the parameter list.
DESTROY_PARAMETER_LIST examples
/* ** Built-in: DESTROY_PARAMETER_LIST ** Example: Remove the parameter list ’tempdata’ after first ** checking to see if it exists */ DECLARE pl_id ParamList. END IF.
88
.DESTROY_PARAMETER_LIST built-in
Description Deletes a dynamically created parameter list and all parameters it contains. Built-in Type unrestricted procedure Enter Query Mode yes Parameters list or name Specifies the parameter list. The actual parameter can be either a parameter list ID of type PARAMLIST. END.

DISPATCH_EVENT(RESTRICTED_ALLOWED).
90
. Built-in Type unrestricted procedure Enter Query Mode yes Parameters sync Specifies the dispatch mode as either restricted (RESTRICTED).
DISPATCH_EVENT examples
/* ON-DISPATCH-EVENT trigger */ BEGIN IF :SYSTEM. or unrestricted (RESTRICTED_ALLOWED). allow it to apply to different items */ FORMS4W. you can call DISPATCH_EVENT to specify the dispatch mode as either restricted or unrestricted. Using the On-Dispatch-Event trigger. END IF. see Responding to ActiveX Control Events in the online help system.CUSTOM_ITEM_EVENT = 4294966696 THEN /*when event occurs. This requires that the event be dispatched as unrestricted. However. all PL/SQL event procedures that are associated with ActiveX events are restricted. END. By default. PROCEDURE DISPATCH_EVENT ).DISPATCH_EVENT(RESTRICTED). For more information about working with ActiveX control events. that does not allow applying any other item */ FORMS4W.DISPATCH_EVENT built-in
Description Specifies the dispatch mode for ActiveX control events. Syntax PROCEDURE DISPATCH_EVENT (sync NUMBER. This means that go_item cannot be called from within the procedure code and OUT parameters are not observed. there are instances when the same event may apply to multiple items and a go_item is necessary. ELSE /*run the default. ).

Form Builder ignores the call and does not display the DISPLAY ERROR screen. Form Builder redisplays the form.DISPLAY_ERROR built-in
Description Displays the Display Error screen if there is a logged error. Syntax PROCEDURE DISPLAY_ERROR. If there is no error to display when you call this built-in. Built-in Type unrestricted procedure Enter Query Mode yes Parameters none
91
. When the operator presses a function key while viewing the Display Error screen.

or the current form is exited
Syntax PROCEDURE DISPLAY_ITEM (item_id ITEM. through a CLEAR_RECORD or a query). The data type of the ID is ITEM. Specifies a named visual attribute that should exist. Built-in Type unrestricted procedure Enter Query Mode yes Parameters item_id item_name attribute Specifies the unique ID that Form Builder assigns to the item when it creates the item. You can also specify a valid attribute from your Oracle*Terminal resource file. custom. Specifies the VARCHAR2 string you gave to the item when you created it. you should use the SET_ITEM_INSTANCE_PROPERTY built-in.DISPLAY_ITEM built-in
Description Maintained for backward compatibility only. DISPLAY_ITEM modifies an item’s appearance by assigning a specified display attribute to the item.. or the same item instance is referenced by the SET_ITEM_INSTANCE_PROPERTY built-in (with VISUAL_ATTRIBUTE property). but only if your form does not contain a visual attribute or logical (character mode or otherwise) called Normal. You can also specify NULL as a method for returning an item to its initial visual attributes (default. Form Builder will search for named visual attribute first. attribute VARCHAR2). SET_ITEM_INSTANCE_PROPERTY does not change mirror items. DISPLAY_ITEM has the side-effect of also changing the appearance of any items that mirror the changed instance. then re-enter the record. You can reference any item in the current form. Note: You can specify Normal as a method for applying the default attributes to an item. Any change made by a DISPLAY_ITEM built-in is effective until: • • • • • the same item instance is referenced by another DISPLAY_ITEM built-in. attribute VARCHAR2). or you modify a record (whose status is NEW). For new applications. or the instance of the item is removed (e.g.
DISPLAY_ITEM examples
/* ** Built-in: DISPLAY_ITEM
92
. or named). PROCEDURE DISPLAY_ITEM (item_name VARCHAR2. navigate out of the record.

Syntax PROCEDURE DOWN. DOWN navigates to the first navigable item in the record. Form Builder fetches a record. Built-in Type restricted procedure Enter Query Mode no Parameters none
94
.DOWN built-in
Description Navigates to the instance of the current item in the record with the next higher sequence number. If Form Builder has to create a record. If necessary.

Use DUMMY_REFERENCE to ensure that a formula calculated item (that contains indirect references to bind variables) will be marked for recalculation by Form Builder. Number. Note: DUMMY_REFERENCE need not be executed for the referenced bind variable to be recognized by Form Builder (thereby causing the related formula calculated item to be marked for recalcuation). or Date. Typically the expression will consist of a single reference to a bind variable. Built-in Type unrestricted procedure Enter Query Mode yes Parameters none
DUMMY_REFERENCE restrictions
none
97
. Syntax PROCEDURE DUMMY_REFERENCE(expression).DUMMY_REFERENCE built-in
Description Provides a mechanism for coding an explicit reference to a bind variable that otherwise would be referred to only indirectly in a formula (or in a function or procedure called by the formula). The expression can be an arbitrary expression of type Char.

Syntax PROCEDURE DUPLICATE_ITEM. or Form Builder returns error FRM-41803: No previous record to copy value from.
98
.DUPLICATE_ITEM built-in
Description Assigns the current item the same value as the instance of this item in the previous record. Built-in Type restricted procedure Enter Query Mode no Parameters none
DUPLICATE_ITEM restrictions
A previous record must exist in your current session.

END.DUPLICATE_RECORD built-in
Description Copies the value of each item in the record with the next lower sequence number to the corresponding items in the current record. */ DECLARE n NUMBER. BEGIN /* ** Remember the value of the ’line_sequence’ from the ** current record */ n := :my_block. instead. Note: The duplicate record does not inherit the record status of the source record.line_sequence := n + 1. an error occurs. If it does.
99
. */ Create_Record. its record status is INSERT. */ :my_block. Syntax PROCEDURE DUPLICATE_RECORD.
DUPLICATE_RECORD examples
/* ** Built-in: DUPLICATE_RECORD. The current record must not correspond to a row in the database. ** Example: Make a copy of the current record and increment ** the "line_sequence" item by one. /* ** Set the new record’s ’line_sequence’ to one more than ** the last record’s.line_sequence. Duplicate_Record. and copy all the values from the ** previous record into it. Built-in Type restricted procedure Enter Query Mode no Parameters none
DUPLICATE_RECORD restrictions
A previous record must exist in your current session. /* ** Create a new record.

or its equivalent. (x y NUMBER. You can use the optional EDIT_TEXTITEM parameters to specify the location and dimensions of the pop-up window with which the item editor is associated. If you do not use these parameters. Form Builder invokes the item editor with its default location and dimensions. width. y NUMBER). Built-in Type restricted procedure Enter Query Mode yes Parameters x y width height Specifies the x coordinate on the screen where you want to place the upper left corner of the pop-up item editor. PROCEDURE EDIT_TEXTITEM (x NUMBER. */ DECLARE itm_x_pos NUMBER. Syntax PROCEDURE EDIT_TEXTITEM. Specifies the width of the entire editor window. including buttons. Specifies the height of the entire editor window.
EDIT_TEXTITEM examples
/* ** Built-in: EDIT_TEXTITEM ** Example: Determine the x-position of the current item ** then bring up the editor either on the left ** side or right side of the screen so as to not ** cover the item on the screen. If you specify a height less than 6 character cells.
EDIT_TEXTITEM restrictions
• The Width must be at least wide enough to display the buttons at the bottom of the editor window.
100
. NUMBER height NUMBER). including buttons. Specifies the y coordinate on the screen where you want to place the upper left corner of the pop-up item editor.EDIT_TEXTITEM built-in
Description Invokes the Runform item editor for the current text item and puts the form in Edit mode. Form Builder sets the height equal to 6. PROCEDURE EDIT_TEXTITEM NUMBER.

102
. and use transactional triggers to replace default Form Builder transaction processing. "Triggers. refer to Chapter . Form Builder performs this operation at form startup. This built-in is included primarily for applications that run against a non-ORACLE data source. Chapter 4. Form Builder makes the corresponding base table items in the form non-updateable by setting the Update Allowed item property to No dynamically. To enforce column security. For more information. For columns to which the operator does not have update privileges.ENFORCE_COLUMN_SECURITY built-in
Description Executes default processing for checking column security on a database column. For more information. processing each block in sequence. refer to Form Builder Advanced Techniques ." in this manual. Default Check Column Security processing refers to the sequence of events that occurs when Form Builder enforces column-level security for each block that has the Enforce Column Security block property set Yes. By default. "Connecting to NonOracle Data Sources.
ENFORCE_COLUMN_SECURITY restrictions
Valid only in an On-Column-Security trigger." Syntax PROCEDURE ENFORCE_COLUMN_SECURITY Built-in Type unrestricted procedure Enter Query Mode yes Usage Notes You can include this built-in subprogram in the On-Column-Security trigger if you intend to augment the behavior of that trigger rather than completely replace the behavior. Form Builder queries the database to determine the base table columns to which the current form operator has update privileges.

locking VARCHAR2). FOR_UPDATE) performs the same actions as ENTER_QUERY except that when EXECUTE_QUERY is invoked. keyword_one ENTER_QUERY(ALL_RECORDS) performs the same actions as ENTER_QUERY except that when EXECUTE_QUERY is invoked. keyword_two VARCHAR2). locking Can be set to NO_WAIT anytime that you use the FOR_UPDATE parameter. If there are changes to commit. Form Builder attempts to lock all of the selected records immediately. Built-in Type restricted procedure Enter Query Mode yes (to redisplay the example record from the last query executed in the block) Parameters no parameters ENTER_QUERY flushes the current block and puts the form in Enter Query mode. Form Builder displays a dialog to notify the operator if a record cannot be reserved for update immediately. When you use NO_WAIT. keyword_two ENTER_QUERY(FOR_UPDATE) performs the same actions as ENTER_QUERY except that when EXECUTE_QUERY is invoked. Form Builder attempts to lock all of the selected records immediately and fetches all of the selected records. PROCEDURE ENTER_QUERY (keyword_one VARCHAR2).
104
. Use the NO_WAIT parameter only when running against a data source that supports this functionality. Form Builder prompts the operator to commit them during the ENTER_QUERY process. PROCEDURE ENTER_QUERY (keyword_one VARCHAR2. Without the NO_WAIT parameter.ENTER_QUERY built-in
Description The behavior of ENTER_QUERY varies depending on any parameters you supply. Form Builder fetches all of the selected records. keyword_one/ keyword_two ENTER_QUERY(ALL_RECORDS. PROCEDURE ENTER_QUERY (keyword_two VARCHAR2). Form Builder keeps trying to obtain a lock without letting the operator cancel the process. PROCEDURE ENTER_QUERY (keyword_one VARCHAR2. Syntax PROCEDURE ENTER_QUERY. keyword_two VARCHAR2.

ENTER_QUERY restrictions
Use the ALL_RECORDS and FOR_UPDATE parameters with caution.Record_Status = ’NEW’ THEN Exit_Form(No_Validate). */ BEGIN Enter_Query. It should be ’QUERY’ if at least one row was ** returned. and exit the form if ** the user cancels out of enter-query mode.
105
. */ IF :System. END IF. Locking and fetching a large number of rows can result in long delays due to the many resources that must be acquired to accomplish the task.
ENTER_QUERY examples
/* ** Built-in: ENTER_QUERY ** Example: Go Into Enter-Query mode. /* ** Check to see if the record status of the first record ** is ’NEW’ immediately after returning from enter-query ** mode. END.

always erase any global variable when it is no longer needed.ERASE built-in
Description Removes an indicated global variable. Syntax PROCEDURE ERASE (global_variable_name Built-in Type unrestricted procedure Enter Query Mode yes Parameters global_variable_name Specifies the name of a valid global variable. Globals always allocate 255 bytes of storage.
106
.
ERASE examples
ERASE(’global.var’). and releases the memory associated with the global variable. To ensure that performance is not impacted more than necessary. so that it no longer exists.
VARCHAR2).

to determine processing within an On-Error trigger test the outcome of a built-in to determine further processing within any trigger Indicates an Form Builder error. BEGIN IF errnum = 40107 THEN Message(’You cannot navigate to this non-displayed item. errtxt VARCHAR2(80) := ERROR_TEXT.. you must first cancel Enter Query mode. ELSIF errnum = 40109 THEN Message(’If you want to leave this block. Syntax FUNCTION ERROR_TYPE. you must perform the test immediately after the action executes. before any other action occurs.. ELSE /*
109
.
ERROR_TYPE examples
/* ** Built-in: ERROR_CODE.’). such as pressing a key.ERROR_TYPE built-in
Description Returns the error message type for the action most recently performed during the current Runform session. Try again.ERROR_TEXT. Built-in Type unrestricted function Returns ERROR_TYPE returns one of the following values for the error message type: FRM ORA Enter Query Mode yes Parameters none Usage Notes You can use this function to do one of the following: • • test the outcome of a user action.ERROR_TYPE ** Example: Reword certain FRM error messages by checking ** the Error_Code in an ON-ERROR trigger ** trigger: On-Error */ DECLARE errnum NUMBER := ERROR_CODE.
To get the correct results in either type of test.’). errtyp VARCHAR2(3) := ERROR_TYPE. Indicates an ORACLE error.

EXEC_VERB examples
/* ** Built-in: ** Example: object ** ** trigger: */ DECLARE EXEC_VERB Deactivates the OLE server associated with the in the OLE container. The data type of the ID is Item. Specifies the name of a verb. verb_index VARCHAR2). (item_name verb_index VARCHAR2).Find_OLE_Verb built-in to obtain this value. verb_name VARCHAR2). Specifies the name of the object created at design time. PROCEDURE EXEC_VERB (item_name VARCHAR2. The data type of the name is VARCHAR2 char.
item_name verb_index
verb_name
EXEC_VERB restrictions
Valid only on Microsoft Windows and Macintosh. The data type of index is VARCHAR2 string. The data type of the name is VARCHAR2 string.EXEC_VERB built-in
Description Causes the OLE server to execute the verb identified by the verb name or the verb index. PROCEDURE EXEC_VERB Item. Use the Forms_OLE. Syntax PROCEDURE EXEC_VERB (item_id Item. Built-in Type unrestricted procedure Enter Query Mode no Parameters item_id Specifies the unique ID that Form Builder assigns to the item when created. Specifies the numeric index of a verb. An OLE verb specifies the action that you can perform on an OLE object. PROCEDURE EXEC_VERB VARCHAR2. When-Button-Pressed
111
.Get_Verb_Name builtin to obtain this value. (item_id verb_name VARCHAR2). Use the FIND_ITEM built-in to return the ID to an appropriately typed variable. Use the Forms_OLE.

FOR_UPDATE) performs the same actions as EXECUTE_QUERY except that Form Builder attempts to lock all of the selected records immediately and fetches all of the selected records. locking Built-in Type restricted procedure Enter Query Mode yes Parameters no parameters EXECUTE_QUERY flushes the current block. keyword_two VARCHAR2). PROCEDURE EXECUTE_QUERY (keyword_two VARCHAR2). keyword_two VARCHAR2. keyword_two EXECUTE_QUERY(FOR_UPDATE) performs the same actions as EXECUTE_QUERY except that Form Builder attempts to lock all of the selected records immediately. Form Builder prompts the operator to commit them before continuing EXECUTE_QUERY processing. When you use NO_WAIT. locking Can be set to NO_WAIT anytime that you use the FOR_UPDATE parameter. and fetches a number of selected records. PROCEDURE EXECUTE_QUERY (keyword_one VARCHAR2). PROCEDURE EXECUTE_QUERY (keyword_one VARCHAR2. opens a query. Use the NO_WAIT parameter only when running against a data source that supports this functionality.
113
. keyword_one/ keyword_two EXECUTE_QUERY(ALL_RECORDS. keyword_one EXECUTE_QUERY(ALL_RECORDS) performs the same actions as EXECUTE_QUERY except that Form Builder fetches all of the selected records. opens a query. VARCHAR2). Form Builder displays a dialog to notify the operator if a record cannot be reserved for update immediately.EXECUTE_QUERY built-in
Description Flushes the current block. Syntax PROCEDURE EXECUTE_QUERY. PROCEDURE EXECUTE_QUERY (keyword_one VARCHAR2. and fetches a number of selected records. If there are changes to commit. Without the NO_WAIT parameter. Form Builder keeps trying to obtain a lock without letting the operator cancel the process.

Execute_Query.
114
. Locking a large number of rows at once requires many resources. BEGIN Go_Block(’Exceptions_List’).EXECUTE_QUERY restrictions
Oracle Corporation recommends that you use the ALL_RECORDS and FOR_UPDATE parameters with caution. Go_Block(’Tasks_Competed’).Cursor_Block. Go_Block( block_before ). ** then go back to the block where original block. END.
EXECUTE_QUERY examples
/* ** Built-in: EXECUTE_QUERY ** Example: Visit several blocks and query their contents. */ DECLARE block_before VARCHAR2(80) := :System. Go_Block(’User_Profile’). Execute_Query. Execute_Query. Fetching a large number of rows could cause a long delay.

that failure does not stop the processing of the form. it raises an exception and stops the processing of the form.EXECUTE_TRIGGER built-in
Description EXECUTE_TRIGGER executes an indicated trigger. if the When-Validate-Item trigger fails. Parameters trigger_name Usage Notes Because you cannot specify scope for this built-in. Form Builder always looks for the trigger starting at the lowest level. Specifies the name of a valid user-named trigger. use the DO_KEY built-in instead of EXECUTE_TRIGGER. Syntax PROCEDURE EXECUTE_TRIGGER (trigger_name VARCHAR2).
EXECUTE_TRIGGER restrictions
Although you can use EXECUTE_TRIGGER to execute a built-in trigger as well as a user-named trigger. Built-in Type restricted procedure (if the user-defined trigger calls any restricted built-in subprograms) Enter Query Mode yes Note: EXECUTE_TRIGGER is not the preferred method for executing a user-named trigger: writing a user-named subprogram is the preferred method. depending on a menu checkbox. then working up. For example.
EXECUTE_TRIGGER examples
/* ** Built-in: ** Example: ** ** */ DECLARE Cur_Setting EXECUTE_TRIGGER Execute a trigger dynamically from the PL/SQL code of a Menu item. in default processing.
115
. this usage is not recommended. Use instead: Do_Key(’NEXT_ITEM’). VARCHAR2(5). if the When-Validate-Item trigger fails when it is invoked by EXECUTE_TRIGGER. but only sets Form_Failure to FALSE on return from the EXECUTE_TRIGGER built-in. For example. because the default fail behavior follows a different rule than when invoked automatically by Form Builder as part of default processing. To execute a built-in associated with a key. However. rather than: Execute_trigger (’KEY-NEXT-ITEM’).

To prevent losing the locks issued by the calling form. DO_COMMIT Form Builder validates the changes. NO_VALIDATE Form Builder exits the current form without validating the changes. NO_COMMIT Form Builder validates the changes and exits the current form without performing a commit or prompting the operator. (Post-only mode can occur when your form issues a call to another form while unposted records exist in the calling form. if RECORD_STATUS is INSERT but the record is not valid. If the operator is in Enter Query mode. FULL_ROLLBACK Form Builder rolls back all uncommitted changes (including posted changes) that were made during the current Runform session. EXIT_FORM terminates the CALL_INPUT function. If there are changes in the current form that have not been posted or committed. You cannot specify a FULL_ROLLBACK from a form that is running in post-only mode. If the operator says yes. performs a commit. Built-in Type restricted procedure Enter Query Mode yes Parameters commit_mode ASK_COMMIT Form Builder prompts the operator to commit the changes during EXIT_FORM processing. Form Builder instead asks the operator if the form should be closed. PROCEDURE EXIT_FORM (commit_mode NUMBER). and exits the current form without prompting the operator. rollback_mode TO_SAVEPOINT Form Builder rolls back all uncommitted changes (including posted changes) to the current form’s savepoint. EXIT_FORM navigates outside the form. rollback_mode NUMBER). However. • In most contexts. confirming commits and specifying rollback action.)
117
. not out of the form. EXIT_FORM navigates out of Enter Query mode. Form Builder prevents any commit processing in the called form. the changes are rolled back before the form is closed. During a CALL_INPUT.EXIT_FORM built-in
Description Provides a means to exit a form. or prompting the operator.
• •
Syntax PROCEDURE EXIT_FORM. PROCEDURE EXIT_FORM (commit_mode NUMBER. Form Builder prompts the operator to commit before continuing EXIT_FORM processing. committing the changes.

Usage Notes Because the default parameters of EXIT_FORM are ASK_COMMIT for commit_mode and TO_SAVEPOINT for rollback_mode. You can leave the top level form without performing a rollback. the user will be prompted to commit the changes. Exit_Form asks to commit and performs a ** rollback to savepoint.
/* ** Form_Status should be ’QUERY’ if all records were ** successfully posted.
118
. if the form is in POST only mode and EXIT_FORM is invoked without parameters. EXIT_FORM and POST Leave the called form. However. regardless of the user’s input at that prompt. invoking EXIT_FORM without specifying any parameters in some contexts may produce undesired results. the default rollback_mode of TO_SAVEPOINT rolls back the changes to the form despite a message confirming that changes have been made. The locks remain in effect when Form Builder returns control to the program. For example. */ IF :System. and we don’t want the posted changes ** to be rolled back. END IF. These locks can also occur when running Form Builder from an external 3GL program. RAISE Form_trigger_Failure. so we do ** not need to commit. */ Exit_Form(NO_COMMIT. END. which means that you retain the locks across a NEW_FORM operation. without rolling back the posted changes so they may be posted and committed by the calling form as part of the same transaction. We’ve already posted. NO_ROLLBACK).Form_Status <> ’QUERY’ THEN Message(’An error prevented the system from posting changes’). To avoid conflicts explicitly specify parameters.
EXIT_FORM examples
/* ** Built-in: ** Example: ** ** ** */ BEGIN Post.NO_ROLLBACK Form Builder exits the current form without rolling back to a savepoint. /* ** By default.

Built-in Type unrestricted procedure Enter Query Mode no This built-in is included primarily for applications that will run against a non-ORACLE data source. we drop through ** and do nothing.FETCH_RECORDS built-in
Description When called from an On-Fetch trigger. BEGIN /* ** Check the global flag we set during form startup */ IF :Global. perhaps based on a ** parameter. The block property RECORDS_TO_FETCH ** allows you to know how many records Form Builder ** is expecting. /* ** Call user exit to determine if there are any ** more records to fetch from its cursor. Form Builder takes this as a signal that
119
. */ User_Exit(’my_fetch block=EMP remaining_records’). If there are no more records. initiates the default Form Builder processing for fetching records that have been identified by SELECT processing. /* ** If there ARE more records. Decide whether to use this built-in ** or a user exit based on a global flag setup at ** startup by the form.Using_Transactional_Triggers = ’TRUE’ THEN /* ** How many records is the form expecting us to ** fetch? */ numrecs := Get_Block_Property(’EMP’.RECORDS_TO_FETCH). Syntax PROCEDURE FETCH_RECORDS. User Exit ** will return failure if there are no more ** records to fetch. ** trigger: On-Fetch */ DECLARE numrecs NUMBER. then loop thru ** and create/populate the proper number of queried ** records. Parameters none
FETCH_RECORDS examples
/* ** Built-in: FETCH_RECORDS ** Example: Perform Form Builder record fetch processing during ** query time.

*/ User_Exit(’my_fetch block=EMP get_next_record’). END IF. /* ** Otherwise. */ ELSE Fetch_Records. do the right thing. */ IF Form_Success THEN /* Create and Populate ’numrecs’ records */ FOR j IN 1. IF NOT Form_Success THEN EXIT. We break out of the ** if we’ve hit the last record. END LOOP.. END IF.numrecs LOOP Create_Queried_Record. END.
120
. END IF.** we are done. /* ** User exit returns false if there are no more ** records left to fetch.

Built-in Type unrestricted function Returns RecordGroup Enter Query Mode yes Parameters recordgroup_name Specifies the valid VARCHAR2 record group name.
FIND_GROUP examples
/* ** Built-in: FIND_GROUP ** Example: See CREATE_GROUP and DELETE_GROUP_ROW */
128
. Syntax FUNCTION FIND_GROUP (recordgroup_name VARCHAR2).
FIND_GROUP restrictions
Performance of this function depends upon the number of record groups. Define the variable with a type of RecordGroup.FIND_GROUP built-in
Description Searches the list of record groups and returns a record group ID when it finds a valid group with the given name. You must define an appropriately typed variable to accept the return value.

Syntax FUNCTION FIND_ITEM (block. Define the variable with a type of Item. RAISE Form_trigger_Failure. BEGIN it_id := Find_Item(item_name). END.NAVIGABLE.PROPERTY_TRUE). Set_Item_Property(it_id. hide_it BOOLEAN) IS it_id Item. ELSE Set_Item_Property(it_id.PROPERTY_TRUE). The data type of the name is VARCHAR2. You must define an appropriately typed variable to accept the return value.ENABLED.FIND_ITEM built-in
Description Searches the list of items in a given block and returns an item ID when it finds a valid item with the given name. Set_Item_Property(it_id.PROPERTY_TRUE). ELSE IF hide_it THEN Set_Item_Property(it_id.PROPERTY_FALSE). END IF. IF Id_Null(it_id) THEN Message(’No such item: ’||item_name).
Built-in Type unrestricted function Returns Item Enter Query Mode yes Parameters block_name. */ PROCEDURE Hide_an_Item( item_name VARCHAR2.
FIND_ITEM examples
/* ** Built-in: FIND_ITEM ** Example: Find an item’s Id before setting several ** of its properties.item_name
VARCHAR2). END IF.VISIBLE.
129
.VISIBLE. item_name Specifies the fully qualified item name.

Returns VARCHAR2 Built-in Type unrestricted function Enter Query Mode no Parameters item_id Specifies the unique ID that Form Builder assigns to the item when created.FIND_OLE_VERB built-in
Description Returns an OLE verb index. verb_index NUMBER. Specifies the name of an OLE verb.Exec_Verb built-in. An OLE verb specifies the action that you can perform on an OLE object. You must define an appropriately typed variable to accept the return value. FUNCTION FIND_OLE_VERB (item_name VARCHAR2.
item_name verb_name
FIND_OLE_VERB restrictions
Valid only on Microsoft Windows and Macintosh.EXE_VERB. The data type of the name is VARCHAR2 string. and each OLE verb has a corresponding OLE verb index.
132
.
FIND_OLE_VERB examples
/* ** Built-in: EXEC_VERB ** Example: Finds an OLE verb index for use with the ** Forms_OLE. The data type of the ID is Item. verb_index_str VARCHAR(20). item_name VARCHAR(25) := ’OLEITM’. Specifies the name of the object created at design time. verb_name VARCHAR2). Syntax FUNCTION FIND_OLE_VERB (item_id Item. The data type of the name is VARCHAR2 string. The OLE verb index is returned as a VARCHAR2 string and must be converted to NUMBER when used in FORMS_OLE.Get_Verb_Name built-in to obtain this value. An OLE verb specifies the action that you can perform on an OLE object. ** trigger: When-Button-Pressed */ DECLARE item_id ITEM. Use the Forms_OLE. Use the FIND_ITEM built-in to return the ID to an appropriately typed variable. verb_name VARCHAR2).

Specifies the starting point in the NODE search. Ftree.FIND_NEXT. -.ROOT_NODE).Find the node with a label "Zetie". Ftree. BEGIN -. find_node Ftree.FIND_NEXT.Find the tree itself. find_node. -.NODE_LABEL.. find_node).
139
. Ftree. Ftree.
DECLARE htree ITEM.ROOT_NODE. htree := Find_Item(’tree_block. ’Zetie’..starting at the first occurance of "Zetie".htree3’).
FIND_TREE_NODE examples
/* ** */ ---Built-in: FIND_TREE_NODE
This code finds a node with a label of "Doran" within the subtree beginning with the a node with a label of "Zetie".Find the node with a label "Doran" -. Ftree.Find_Tree_Node(htree.Find_Tree_Node(htree. find_node := Ftree.NODE. IF NOT Ftree. END IF.NODE_LABEL. find_node := Ftree.ID_NULL(find_node) then . END.search_root start_point
Specifies the root of the search tree. ’Doran’. Ftree.

140
. Syntax FUNCTION FIND_VA (va_name PROPERTY). Built-in Type unrestricted function Returns Visual Attribute Enter Query Mode yes Parameters va_name The name you gave the visual attribute when you created it.FIND_VA built-in
Description Searches for the visual attributes of an item in a given block and returns the value of that attribute as a text string. The data type is VARCHAR2.

then go to the last record */ IF :System. END. Syntax PROCEDURE FIRST_RECORD. END IF.Last_Record <> ’TRUE’ THEN Last_Record. ELSE First_Record. ** trigger: When-Button-Pressed */ BEGIN /* ** If we’re not at the bottom. Built-in Type restricted procedure Enter Query Mode no Parameters none
FIRST_RECORD examples
/* ** Built-in: FIRST_RECORD ** Example: Have a button toggle between the first and last ** records in a block.
143
.FIRST_RECORD built-in
Description Navigates to the first record in the block’s list of records.

Built-in Type unrestricted function Returns BOOLEAN Enter Query Mode yes Parameters none
FORM_FAILURE examples
/* ** Built-in: FORM_FAILURE ** Example: Determine if the most recently executed built-in ** failed. Syntax FUNCTION FORM_FAILURE.
144
. to check that the SYSTEM. /* ** If some validation failed and prevented us from leaving ** the current block. That is. but of the other.FORM_STATUS variable is set to ’QUERY’ after the operation is done. If another action occurs. then stop executing this trigger. */ BEGIN GO_BLOCK(’Success_Factor’).FORM_FAILURE built-in
Description Returns a value that indicates the outcome of the action most recently performed during the current Runform session.
Outcome success failure fatal error
Returned Value FALSE TRUE FALSE
If no action has executed in the current Runform session. you must perform the test immediately after the action executes. another action should not occur prior to the test. FORM_FAILURE may not reflect the status of the built-in you are testing. for example. Use FORM_FAILURE to test the outcome of a built-in to determine further processing within any trigger. when performing a COMMIT_FORM. A more accurate technique is. To get the correct results. Note: "Another action" includes both built-ins and PL/SQL assignment statements. more recently executed action. FORM_FAILURE returns FALSE.

** Rather than explicitly testing for FORM_FAILURE */ IF Form_Failure THEN RAISE Form_trigger_Failure..** ** Generally it is recommended to test ** IF NOT Form_Success THEN . END IF.
145
. END..

*/ BEGIN User_Exit(’Calculate_Line_Integral control. another action should not occur prior to the test. Note: "Another action" includes both built-ins and PL/SQL assignment statements. you must perform the test immediately after the action executes.start control. to check that the SYSTEM. If another action occurs. Built-in Type unrestricted function Return Type: BOOLEAN Enter Query Mode yes Parameters none
FORM_FATAL examples
/* ** Built-in: FORM_FATAL ** Example: Check whether the most-recently executed built-in ** had a fatal error. /* ** If the user exit code returned a fatal error. for example. when performing a COMMIT_FORM.stop’). Syntax FUNCTION FORM_FATAL.
Outcome success failure fatal error
Returned Value FALSE FALSE TRUE
Use FORM_FATAL to test the outcome of a built-in to determine further processing within any trigger. more recently executed action.FORM_FATAL built-in
Description Returns the outcome of the action most recently performed during the current Runform session.FORM_STATUS variable is set to ’QUERY’ after the operation is done. FORM_FATAL may not reflect the status of the built-in you are testing.
146
. print a ** message and stop executing this trigger. That is. but of the other. To get the correct results. A more accurate technique is.

.. END.** ** Generally it is recommended to test ** ** IF NOT FORM_SUCCESS THEN .’). END IF.
147
. ** ** Rather than explicitly testing for FORM_FATAL */ IF Form_Fatal THEN Message(’Cannot calculate the Line Integral due to internal error. RAISE Form_trigger_Failure.

when you evaluate FORM_SUCCESS it may not reflect the status of COMMIT_FORM but of some other. FORM_SUCCESS may not reflect the status of the built-in you are testing. This includes calls to command. A more accurate technique is to check that the SYSTEM. To get the correct results. This is a Microsoft a Win32 issue. FORM_SUCCESS should not be used to test whether a COMMIT_FORM or POST built-in has succeeded. On Microsoft Windows NT. On Windows 95 platforms the FORM_SUCCESS built-in will always return TRUE for HOST commands which fail.FORM_STATUS variable is set to ’QUERY’ after the operation is done. Invalid commands will return FALSE.com or OS functions. Because COMMIT_FORM may cause many other triggers to fire. you must perform the test immediately after the action executes. any 16-bit DOS or
•
•
•
148
. "Another action" includes both built-ins and PL/SQL assignment statements. more recently executed action. If another action occurs.FORM_SUCCESS built-in
Description Returns the outcome of the action most recently performed during the current Runform session. another action should not occur prior to the test. the FORM_SUCCESS built-in will return TRUE whether the application succeeds or fails. more recently executed built-in. 32-bit applications and OS commands will correctly return TRUE if executed sucessfully and FALSE if failed. but of the other. Built-in Type unrestricted function Return Type: BOOLEAN Enter Query Mode yes Parameters none Usage Notes
•
Use FORM_SUCCESS to test the outcome of a built-in to determine further processing within any trigger. when using HOST to execute a 16-bit application.
Outcome success failure fatal error
Returned Value TRUE FALSE FALSE
Syntax FUNCTION FORM_SUCCESS. That is.

If the statement did not execute correctly. Enclose the PL/SQL block in a valid BEGIN/END block structure. are not required.FORM_STATUS variable to check whether there are pending changes in the current form before you issue the FORMS_DDL command. (See Example 4. including server-side PL/SQL and DDL.) If you use FORMS_DDL to execute a valid PL/SQL block: • • • • Use semicolons where appropriate. use the FORM_SUCCESS or FORM_FAILURE Boolean functions. as well as losing any locks Form Builder may have acquired. Use the SYSTEM. Line breaks. Syntax FUNCTION FORMS_DDL (statement VARCHAR2). Note that the values of DBMS_ERROR_CODE and DBMS_ERROR_TEXT are not automatically reset
150
. Make sure all pending changes in the form are committed or rolled back before you call those built-ins.
To check whether the statement issued using FORMS_DDL executed correctly. Do not end the PL/SQL block with a slash.FORMS_DDL built-in
Description Issues dynamic SQL statements at runtime. Built-in Type unrestricted function Enter Query Mode yes Parameters statement Any string expression up to 32K: a literal an expression or a variable representing the text of a block of dynamically created PL/SQL code a DML statement or a DDL statement
Usage Notes Commit (or roll back) all pending changes before you issue the FORMS_DDL command. All DDL operations issue an implicit COMMIT and will end the current transaction without allowing Form Builder to process any pending changes. Note: All DDL operations issue an implicit COMMIT and will end the current transaction without allowing Form Builder to process any pending changes. while permitted. Some supplied stored procedures issue COMMIT or ROLLBACK commands as part of their logic.
If you use FORMS_DDL to execute a single DML or DDL statement: • Omit the trailing semicolon to avoid an invalid character error. check the error code and error text using DBMS_ERROR_CODE and DBMS_ERROR_TEXT.

empno).End. /* ** Now. so their values should only be examined after an error has been detected by a call to FORM_SUCCESS or FORM_FAILURE. IF NOT Form_Success THEN Message (’Table Creation Failed’). ** TEMP(COL1. ELSE Message (’Table Created’). this statement is valid.. FOR I in 2. such as dropping a table or database link.. my_stmt := my_stmt||’)’.following successful execution.. END. However. ... SQL statements and PL/SQL blocks executed using FORMS_DDL cannot return results to Form Builder directly. */ PROCEDURE Create_N_Column_Number_Table (n NUMBER) IS my_stmt VARCHAR2(2000).’).’). (See Example 4. Example 2 /* ** Built-in: FORMS_DDL ** Example: The string can be an expression or variable. you could also call a stored procedure directly. using Oracle8’s shared SQL area over multiple executions with different values for emp. some DDL operations cannot be performed using FORMS_DDL. ** Create a table with n Number columns.COL’||TO_CHAR(i)||’ NUMBER’. COL2.N LOOP my_stmt := my_stmt||’.) In addition. BEGIN my_stmt := ’create table tmp(COL1 NUMBER’. End.empno: Update_Employee (:emp.. if Form Builder is holding a cursor open against the object being operated upon. However. */ BEGIN Forms_DDL(’create table temp(n NUMBER)’). but the values of bind variables can be concatenated into the string before passing the result to FORMS_DDL. and would have the desired effect: Forms_DDL (’Begin Update_Employee (’||TO_CHAR(:emp.
FORMS_DDL examples
Example 1 /* ** Built-in: FORMS_DDL ** Example: The expression can be a string literal. create the table. END LOOP. this statement is not valid: Forms_DDL (’Begin Update_Employee (:emp. For example.empno) ||’).empno). COLn). END IF.
FORMS_DDL restrictions
The statement you pass to FORMS_DDL may not contain bind variable references in the string.
151
.

do the right thing.my_seq. END.
GENERATE_SEQUENCE_NUMBER examples
/* ** Built-in: GENERATE_SEQUENCE_NUMBER ** Example: Perform Form Builder standard sequence number ** processing based on a global flag setup at ** startup by the form. By default. you can reference it as a default value for an item by setting the Initial Value property to SEQUENCE. ** trigger: On-Sequence-Number */ BEGIN /* ** Check the global flag we setup at form startup */ IF :Global.Using_Transactional_Triggers = ’TRUE’ THEN User_Exit(’my_seqnum seq=EMPNO_SEQ’). END IF. you can include a call to this built-in in the On-Sequence-Number trigger Syntax PROCEDURE GENERATE_SEQUENCE_NUMBER. When a sequence object is defined in the database. Built-in Type unrestricted procedure Enter Query Mode yes Parameters none
GENERATE_SEQUENCE_NUMBER restrictions
Valid only in an On-Sequence-Number trigger. perhaps based on a ** parameter. Form Builder gets the next value from the sequence whenever a record is created.
153
. /* ** Otherwise.GENERATE_SEQUENCE_NUMBER built-in
Description Initiates the default Form Builder processing for generating a unique sequence number when a record is created.NEXTVAL. */ ELSE Generate_Sequence_Number. When you are connecting to a nonORACLE data source.

CROSSHAIR. If the current operator does not have a connect string. Syntax FUNCTION GET_APPLICATION_PROPERTY (property NUMBER). DATASOURCE Returns the name of the database that is currently in use. Form Builder returns NULL. HELP. and SQLSERVER.GET_APPLICATION_PROPERTY built-in
Description Returns information about the current Form Builder application. CALLING_FORM Returns the name of the calling form if the current form was invoked by the CALL_FORM built-in. BUILTIN_DATE_FORMAT Returns the current value of the Builtin date format mask (which is held in the Builtin_Date_Format property). TERADATA. and INSERTION.
154
. NONSTOP. Valid VARCHAR2 return values are BUSY. DB2. CONNECT_STRING Returns the database connect string of the current operator. ORACLE. If the current form is not a called form. DATE_FORMAT_COMPATIBILITY_MODE Returns the compatibility setting contained in this property. CURRENT_FORM_NAME Returns the name of the current form as indicated by the form module Name property. This call returns the database name only for connections established by Form Builder. For all other platforms. Form Builder returns NULL. not for connections established by On-Logon triggers. NCR/3600/NCR/3700. Form Builder returns NULL.FMX file name of the form currently being executed. Valid return values are NULL. CURRENT_FORM Returns the . You must call the built-in once for each value you want to retrieve. Only applies to the Microsoft Windows platform. DEFAULT. Built-in Type unrestricted function Returns VARCHAR2 Enter Query Mode yes Parameters property Specify one of the following constants to return information about your application: APPLICATION_INSTANCE Returns the pointer value of an instance handle. CURSOR_STYLE Returns the name of the current cursor style property.

This call is valid only from an On-Savepoint or OnRollback trigger. USER_NLS_LANG is the
155
. MSWINDOWS. TIMER_NAME Returns the name of the most recently expired timer. PASSWORD Returns the password of the current operator. If USER_NLS_LANG is not explicitly set. SunOS. Valid return values are MOTIF. it defaults to the setting of NLS_LANG. VMS. PM. and UNKNOWN. The size of each unit depends on how you defined the Coordinate System property for the form module. WIN32COMMON. SAVEPOINT_NAME Returns the name of the last savepoint Form Builder has issued. The size of each unit depends on how you defined the Coordinate System property for the form module. It is included primarily for developers who are using transactional triggers to access a non-ORACLE data source. UNIX. MACINTOSH.DISPLAY_HEIGHT Returns the height of the display. ERROR_DATE/DATETIME_FORMAT Returns the current value of the error date or datetime format mask (which is established in the FORMSnn_Error_Date/Datetime_Format environment variable). OUTPUT_DATE/DATETIME_FORMAT Returns the current value of the output date or datetime format mask (which is established in the FORMSnn_Output_Date/Datetime_Format environment variable). USER_NLS_CHARACTER_SET Returns the current value of the character set portion only of the USER_NLS_LANG environment variable defined for the form operator. MSWINDOWS32. and HP-UX. it defaults to the setting of NLS_LANG. Form Builder returns NULL in response to this constant if there is no timer. If USER_NLS_LANG is not explicitly set. MACINTOSH. FLAG_USER_VALUE_TOO_LONG Returns the current value of this property. OPERATING_SYSTEM Returns the name of the operating system that is currently in use. for national language support. DISPLAY_WIDTH Returns the width of the display. BLOCKMODE. Valid return values are MSWINDOWS. USER_INTERFACE Returns the name of the user interface that is currently in use. PLSQL_DATE_FORMAT Returns the current value of the PLSQL date format mask (which is held in the PLSQL_Date_Format property). WEB. either ‘TRUE’ or ‘FALSE’. X. WIN32COMMON. CHARMODE. USER_DATE/DATETIME_FORMAT Returns the current value of the user date or datetime format mask (which is established in the FORMSnn_User_Date/Datetime_Format environment variable). USER_NLS_LANG Returns the complete current value of the USER_NLS_LANG environment variable defined for the form operator. MSWINDOWS32. which controls truncation of userentered values that exceed an item’s Maximum Length property. RUNTIME_COMPATIBILITY_MODE Returns the compatibility setting contained in this property.

USER_NLS_TERRITORY. Password. it defaults to the setting of NLS_LANG USERNAME Returns the name of the current operator. If USER_NLS_LANG is not explicitly set. Note: If the user connects by using an OPS$ account.equivalent of concatenating USER_NLS_LANGUAGE. assume that the user has initiated an Microsoft Windows Runform session specifying the following connect string: ifrun60 my_form scott/tiger@corpDB1 Form Builder returns the following string as the result of a call to GET_APPLICATION_PROPERTY(USERNAME): scott Form Builder returns the following string as the result of a call to GET_APPLICATION_PROPERTY(PASSWORD): tiger Form Builder returns the following string as the result of a call to GET_APPLICATION_PROPERTY(CONNECT_STRING): corpDB1
GET_APPLICATION_PROPERTY restrictions
To retrieve the timer name of the most recently executed timer. and based on the username perform a task. USER_NLS_TERRITORY Returns the current value of the territory portion only of the USER_NLS_LANG environment variable defined for the form operator. If USER_NLS_LANG is not explicitly set. it defaults to the setting of NLS_LANG. including an appended connect string. For instance. you should use GET_APPLICATION_PROPERTY(CONNECT_STRING) to retrieve username information.
GET_APPLICATION_PROPERTY examples
Example 1 /* ** Built-in: ** Example: ** ** ** trigger: */
GET_APPLICATION_PROPERTY Determine the name of the timer that just expired. and Connect_String properties. USER_NLS_LANGUAGE Returns the current value of the language portion only of the USER_NLS_LANG environment variable defined for the form operator. Usage Notes To request a complete login. you must initiate a call to GET_APPLICATION_PROPERTY from within a When-Timer-Expired trigger. Otherwise. When-Timer-Expired
156
. and USER_NLS_CHARACTER_SET. the results of the built-in are undefined. use the Username. GET_APPLICATION_PROPERTY(USERNAME) will not return the actual username. In this case.

the built-in returns the VARCHAR2 value NON_COORDINATED. property NUMBER). Specify one of the following constants to return information about the given block: ALL_RECORDS Specifies whether all the records matching the query criteria should be fetched into the data block when a query is executed. Returns the VARCHAR2 value COORDINATED if the block is coordinated with all of its master blocks. The name you gave the block when you created it. the status of the detail block is COORDINATED. COLUMN_SECURITY Returns the VARCHAR2 value of TRUE if column security is set to Yes. Syntax FUNCTION GET_BLOCK_PROPERTY (block_id Block. this property specifies the coordination status of the block with respect to its master block(s). Immediately after records are fetched to the detail block. and the VARCHAR2 string FALSE if it is set to No. You must issue a call to the built-in once for each property value you want to retrieve. If it is not coordinated with all of its master blocks. property NUMBER). Datatype is VARCHAR2. Datatype is BLOCK. BLOCKSCROLLBAR_Y_POS Returns the y position of the block’s scroll bar as a number specified in the form coordinate units indicated by the Coordinate System form property. COORDINATION_STATUS For a block that is a detail block in a master-detail block relation. When a different record becomes the current record in
158
.GET_BLOCK_PROPERTY built-in
Description Returns information about a specified block. BLOCKSCROLLBAR_X_POS Returns the x position of the block’s scroll bar as a number specified in the form coordinate units indicated by the Coordinate System form property. Built-in Type unrestricted function Returns VARCHAR2 Enter Query Mode yes Parameters block_id block_name property The unique ID Form Builder assigned to the block when you created it. FUNCTION GET_BLOCK_PROPERTY (block_name VARCHAR2.

CURRENT_ROW_FOREGROUND_COLOR The color of the object’s foreground region. DEFAULT_WHERE Returns the default WHERE clause in effect for the block. if any item in the block has its Enabled and Keyboard
159
. The list of fonts available is systemdependent. DML_DATA_TARGET_TYPE Returns the VARCHAR2 value that indicates the current setting of the DML Data Target Type property. the status of the detail block again becomes NON_COORDINATED. Patterns are rendered in the two colors specified by Background Color and Foreground Color. as indicated by the current setting of the WHERE block property. STORED PROCEDURE.the master block. ENFORCE_PRIMARY_KEY Returns the VARCHAR2 value TRUE if the Enforce Primary Key property is set to Yes for the block. if the Enforce Primary Key property is set to No. or typeface. CURRENT_ROW_BACKGROUND_COLOR The color of the object’s background region. that is. Otherwise. CURRENT_ROW_WHITE_ON_BLACK Specifies that the object is to appear on a monochrome bitmap display device as white text on a black background. CURRENT_ROW_FONT_WEIGHT The weight of the font. this parameter returns the VARCHAR2 value FALSE. specified in points. the amount of space between characters (kerning). DML_DATA_TARGET_NAME Returns the VARCHAR2 name of the block’s DML data source. CURRENT_ROW_FONT_SPACING The width of the font. For items. This property determines whether the operator or the application is allowed to delete records in the block. Return values for this property are NONE. ENTERABLE Returns the VARCHAR2 value TRUE if the block is enterable. the Foreground Color attribute defines the color of text displayed in the item. CURRENT_ROW_FONT_SIZE The size of the font. or TRANSACTIONAL TRIGGER. CURRENT_ROW_FONT_NAME The font family. CURRENT_ROW_FILL_PATTERN The pattern to be used for the object’s fill region. CURRENT_RECORD Returns the number of the current record. that should be used for text in the object. CURRENT_ROW_FONT_STYLE The style of the font. that is. TABLE. FALSE if it is No. DELETE_ALLOWED Returns the VARCHAR2 value TRUE if the Delete Allowed block property is Yes. CURRENT_RECORD_ATTRIBUTE Returns the VARCHAR2 name of the named visual attribute of the given block.

FIRST_MASTER_RELATION Returns the VARCHAR2 name of the first relation in which the given block is a master. NAVIGATION_STYLE Returns the VARCHAR2 value that indicates the current setting of the block’s NAVIGATION_STYLE property. MAX_QUERY_TIME Returns the VARCHAR2 value that indicates the current setting of the Maximum Query Time property. This property is only useful when the Query All Records property is set to Yes. By default. Return values for this property are UNIQUE_KEY. NEXT_NAVIGATION_BLOCK Returns the VARCHAR2 name of the block’s next navigation block. Returns NULL if one does not exist. FALSE if it is No. MAX_RECORDS_FETCHED Returns a number representing the maximum number of records that can be fetched. UPDATEABLE_PRIMARY_KEY. CHANGE_RECORD. FIRST_ITEM Returns the VARCHAR2 name of the first item in the given block. or CHANGE_BLOCK. otherwise. INSERT_ALLOWED Returns the VARCHAR2 value TRUE if the Insert Allowed block property is Yes. however. or NON_UPDATEABLE_PRIMARY_KEY. This property determines whether the operator can abort a query when the elapsed time of the query exceeds the value of this property. it returns the VARCHAR2 value DELAYED if row locks are to be attempted just prior to a commit. the next navigation block is the next block as defined by the order of blocks in the Object Navigator.Navigable properties set to Yes. FIRST_DETAIL_RELATION Returns the VARCHAR2 name of the first relation in which the given block is a detail. Returns NULL if the indicated block is the last block in the form. Note that the setting of the block’s NEXT_NAVIGATION_BLOCK property has no effect on the value of NEXTBLOCK. KEY_MODE Returns the VARCHAR2 value that indicates the current setting of the Key Mode block property. either SAME_RECORD. Returns the VARCHAR2 string FALSE if the block is not enterable. This property determines whether the operator or the application is allowed to insert records in the block. the NEXT_NAVIGATION_BLOCK block property can be set to override the default block navigation sequence.
160
. LAST_ITEM Returns the name of the last item in the given block. LOCKING_MODE Returns the VARCHAR2 value IMMEDIATE if rows are to be locked immediately on a change to a base table item. NEXTBLOCK Returns the name of the next block. Returns NULL if one does not exist. LAST_QUERY Returns the SQL statement of the last query in the specified block.

QUERY_ALLOWED Returns the VARCHAR2 value TRUE if the Query Allowed block property is Yes. the previous navigation block is the block with the next lower sequence. Corresponds to the Number of Records Displayed block property. QUERY_HITS specifies the number of records that have been retrieved. or SUB-QUERY. FOR_UPDATE. Return values for this property are NONE. QUERY_OPTIONS Returns the VARCHAR2 values VIEW. the NEXT_NAVIGATION_BLOCK block property can be set to override the default block navigation sequence. QUERY_HITS Returns the VARCHAR2 value that indicates the number of records identified by the COUNT_QUERY operation. COUNT_QUERY. as defined by the order of blocks in the Object Navigator. PREVIOUS_NAVIGATION_BLOCK Returns the VARCHAR2 name of the block’s previous navigation block. FALSE if it is No. Note that the setting of the block’s PREVIOUS_NAVIGATION_BLOCK property has no effect on the value of PREVIOUSBLOCK. TRANSACTIONAL TRIGGER. as indicated by the current setting of the ORDER BY block property. PRECOMPUTE_SUMMARIES [Under Construction] PREVIOUSBLOCK Returns the name of the block that has the next lower sequence in the form. ORDER_BY Returns the default ORDER BY clause in effect for the block. This property determines whether the operator or the application is allowed to query records in the block. By default. RECORDS_DISPLAYED Returns the number of records that the given block can display. however.OPTIMIZER_HINT Returns a hint in the form of a VARCHAR2 string that Form Builder passes on to the RDBMS optimizer when constructing queries. Returns NULL if the indicated block is the first block in the form. STORED PROCEDURE. STATUS Returns the VARCHAR2 value NEW if the block contains only new records. TABLE. CHANGED if the block contains at least one changed record. QUERY_DATA_SOURCE_TYPE Returns the VARCHAR2 value that indicates the current setting of the Query Data Source Type property. QUERY_DATA_SOURCE_NAME Returns the VARCHAR2 name of the block’s query data source. or a null value if there are no options. RECORDS_TO_FETCH Returns the number of records Form Builder expects an On-Fetch trigger to fetch and create as queried records.
161
. You can call GET_BLOCK_PROPERTY with this parameter from within a transactional trigger when your user exit needs to know what type of query operation Form Builder would be doing by default if you had not circumvented default processing. as defined by the order of blocks in the Object Navigator. If this value is examined while records are being retrieved from a query.

*/ cur_rec := Get_Block_Property( bk_id. UPDATE_CHANGED_COLUMNS Specifies that only those columns updated by an operator will be sent to the database. This property determines whether the operator or the application is allowed to update records in the block. UPDATE_ALLOWED Returns the VARCHAR2 value TRUE if the Update Allowed block property is Yes. /* ** Determine the position on the screen the first field in ** the multirecord block */ itm_lin := Get_Item_Property( Get_Block_Property (bk_id. BEGIN /* ** Get the block id since we’ll be doing multiple ** Get_Block_Property operations for the same block */ bk_id := Find_Block( cur_blk ). regardless of whether they have been updated. CURRENT_RECORD). cur_rec NUMBER.FIRST_ITEM). /* ** Add the difference between the current record and the ** top record visible in the block to the screen position ** of the first item in the block to get the screen ** position of the current record: */
162
.
GET_BLOCK_PROPERTY examples
/* ** Built-in: GET_BLOCK_PROPERTY ** Example: Return the screen line of the current record in ** a multi-record block. When Update Changed Columns Only is set to No. Could be used to ** dynamically position LOV to a place on the ** screen above or below the current line so as to ** not obscure the current record in question. FALSE if it is No.Y_POS). particularly if the block contains a LONG data type. bk_id Block. ** (2) Current Record which is visible at the ** first (top) line of the multirecord ** block. /* ** Determine the (1) Current Record the cursor is in. cur_lin NUMBER. top_rec NUMBER. itm_lin NUMBER. TOP_RECORD). all columns are sent. This can result in considerable network traffic.and QUERY if the block contains only valid records that have been retrieved from the database. top_rec := Get_Block_Property( bk_id. TOP_RECORD Returns the record number of the topmost visible record in the given block. */ FUNCTION Current_Screen_Line RETURN NUMBER IS cur_blk VARCHAR2(40) := :System.Cursor_Block.

RETURN cur_lin.cur_lin := itm_lin + (cur_rec .
163
.top_rec). END.

The list of fonts available is system-dependent. For items. the Foreground Color attribute defines the color of text displayed in the item. Use the FIND_CANVAS built-in to return the ID to a variable with datatype of CANVAS.GET_CANVAS_PROPERTY built-in
Description Returns the given canvas property for the given canvas. The property for which you want to get a value for the given canvas. that should be used for text in the object. or typeface. that is. You can enter the following constants for return values: BACKGROUND_COLOR The color of the object’s background region. FILL_PATTERN The pattern to be used for the object’s fill region. the amount of space between characters (kerning). FONT_SPACING The width of the font. . The name you gave the canvas object when you defined it. Syntax FUNCTION GET_CANVAS_PROPERTY (canvas_id Canvas. Patterns are rendered in the two colors specified by Background Color and Foreground Color. property Built-in Type unrestricted function Returns VARCHAR2 Enter Query Mode yes Parameters canvas_id The unique ID that Form Builder assigns the canvas object when it creates it. NUMBER). property FUNCTION GET_CANVAS_PROPERTY (canvas_name VARCHAR2.
canvas_name property
164
. specified in points. NUMBER). HEIGHT Returns the height of the canvas. FONT_NAME The font family. FONT_STYLE The style of the font. FOREGROUND_COLOR The color of the object’s foreground region. FONT_WEIGHT The weight of the font. specified in the form coordinate units indicated by the Coordinate System form property. FONT_SIZE The size of the font.

centimeter. inch. CANVAS. TAB_PAGE_Y_OFFSET Returns the distance between the top edge of the tab canvas and the top edge of the tab page. := GET_CANVAS_PROPERTY(cn_id. NUMBER. WHITE_ON_BLACK Specifies that the object is to appear on a monochrome bitmap display device as white text on a black background. specified in the form coordinate units indicated by the Coordinate System form property. := FIND_CANVAS(’my_canvas_1’). inch. centimeter. returns CUSTOM for a custom visual attribute or DEFAULT for a default visual attribute.
165
. NUMBER.
GET_CANVAS_PROPERTY Can get the width/height of the canvas. The value returned depends on the form coordinate system—pixel.TAB_PAGE_X_OFFSET Returns the distance between the left edge of the tab canvas and the left edge of the tab page. The value returned depends on the form coordinate system—pixel. := GET_CANVAS_PROPERTY(cn_id.
GET_CANVAS_PROPERTY examples
/* ** Built-in: ** Example: */ DECLARE the_width the_height cn_id BEGIN cn_id the_width the_height END. WIDTH Returns the width of the canvas. or point. WIDTH). TOPMOST_TAB_PAGE Returns the name of the tab page currently topmost on the named tab canvas. VISUAL_ATTRIBUTE Returns the name of the visual attribute currently in force.HEIGHT). If no named visual attribute is assigned to the canvas. or point.

the Java component’s getProperty method is called.GET_CUSTOM_PROPERTY built-in
Description Gets the value of a user-defined property in a Java pluggable component.
Built-in Type unrestricted procedure Returns VARCHAR2 Enter Query Mode yes Parameters item The name or ID of the item associated with the target Java pluggable component. GET_CUSTOM_PROPERTY (item. each custom property type must be represented by a single instance of the ID class.) The particular property of the Java component that you want to get. For each Get_Custom_Property built-in executed in the form. The name of the item can be gained through either Find_Item(‘Item_Name’).
•
•
166
. prop-name). row-number. numeric. or boolean data. created by using ID. Syntax The built-in returns a VARCHAR2 value containing the string. or simply via ‘Item_Name’. (Instance row numbers begin with 1. The name can be in the form of either a varchar2 literal or a variable set to the value of the name.registerProperty. The row number of the instance of the item that you want to get.
row-number prop-name Usage Notes
•
In the Java pluggable component.

Specifies the intended dialog to OPEN_FILE or SAVE_FILE. Syntax FUNCTION GET_FILE_NAME (directory_name VARCHAR2.GET_FILE_NAME built-in
Description Displays the standard open file dialog box where the user can select an existing file or specify a new file. File filters take on different forms. file_filter VARCHAR2. On Windows. The default value is TRUE.
Built-in Type unrestricted function Returns VARCHAR2 Enter Query Mode yes Parameters directory_name Specifies the name of the directory containing the file you want to open.WRI| defaulting to All Files (*. Specifies the name of the file you want to open. The default value is NULL.WRI)|*.*)|*. file_name VARCHAR2.*| if NULL.
167
. The default value is NULL. The default value is NULL. The default value is OPEN_FILE. and currently are ignored on the motif and character mode platforms. select_file BOOLEAN. The default value is NULL. dialog_type NUMBER.
file_name file_filter
message dialog_type select_file
GET_FILE_NAME examples
/* ** Built-in: ** Example: */
GET_FILE_NAME Can get an image of type TIFF. subsequent invocations of the dialog may open the last directory visited. Specifies that only particular files be shown. select_file is internally set to TRUE. message VARCHAR2. On the Macintosh the attribute currently accepts a string such as Text. they take the form of Write Files (*. If dialog_type is set to SAVE_FILE. If directory_name is NULL. Specifies whether the user is selecting files or directories. Specifies the type of file that is being selected.

property NUMBER). COORDINATE_SYSTEM Returns a VARCHAR2 string indicating the coordinate system used in the form module. When Coordinate System is Character Cells. CHARACTER_CELL if the current coordinate system for the form is character cell based. FUNCTION GET_FORM_PROPERTY (formmodule_name VARCHAR2. PIXELS if the current coordinate system for the form is pixels. INCHES if the current coordinate system for the form is inches. Use the FIND_FORM built-in to return the ID to an appropriately typed variable.GET_FORM_PROPERTY built-in
Description Returns information about the given form. When Coordinate System is Character Cells. Built-in Type unrestricted function Returns VARCHAR2 Enter Query Mode yes Parameters formmodule_id Specifies the unique ID Form Builder assigns when it creates the form module. Specifies the VARCHAR2 name that you gave to the form module when you defined it. then you can call this built-in to return information about the calling form. the value is returned in pixels. POINTS if the current coordinate system for the form is points. Syntax FUNCTION GET_FORM_PROPERTY (formmodule_id FormModule.
formmodule_name property
169
. If your application is a multi-form application. CHARACTER_CELL_WIDTH Returns the dimensions of the character cell in the form units specified by the Coordinate System property. or called form. as well as about the current. the value is returned in pixels. CURRENT_RECORD_ATTRIBUTE Returns the VARCHAR2 name of the named visual attribute that should be used for the current row. CENTIMETERS if the current coordinate system for the form is centimeters. The data type of the ID is FormModule. property NUMBER). Returns information about specific elements of the form based on which of the following constants are supplied to the built-in: CHARACTER_CELL_HEIGHT Returns the dimensions of the character cell in the form units specified by the Coordinate System property.

CURRENT_ROW_BACKGROUND_COLOR The color of the object’s background region. The list of fonts available is systemdependent. CURRENT_ROW_FONT_NAME The font family. the FIRST_NAVIGATION_BLOCK block property can be set to specify a different block as the first block at form startup. the amount of space between characters (kerning). that should be used for text in the object. LEFT_TO_RIGHT. Patterns are rendered in the two colors specified by Background Color and Foreground Color. the Foreground Color attribute defines the color of text displayed in the item. however.5. 4. FIRST_BLOCK Returns the name of the block with the lowest sequence number in the indicated form. CURRENT_ROW_FONT_SPACING The width of the font. Valid return values are RIGHT_TO_LEFT. CURRENT_ROW_FILL_PATTERN The pattern to be used for the object’s fill region. either READ_COMMITTED or SERIALIZABLE. For items. specified in points. CURRENT_ROW_FONT_STYLE The style of the font. Valid return values are BLOCKING or NONBLOCKING. CURRENT_ROW_WHITE_ON_BLACK Specifies that the object is to appear on a monochrome bitmap display device as white text on a black background. Valid return values are TRUE. CURSOR_MODE Returns the setting that indicates the intended effect of a commit action on existing cursors. ISOLATION_MODE Returns the form’s isolation mode setting. CURRENT_ROW_FOREGROUND_COLOR The color of the object’s foreground region. DEFER_REQUIRED_ENFORCEMENT Returns the setting that indicates whether enforcement of required fields has been deferred from item validation to record validation. FORM_NAME Returns the name of the form. the first navigation block is the first block defined in the Object Navigator. By default. that is. CURRENT_ROW_FONT_WEIGHT The weight of the font. INTERACTION_MODE Returns the interaction mode for the form.
170
. DIRECTION Returns the layout direction for bidirectional objects. FILE_NAME Returns the name of the file where the named form is stored. FIRST_NAVIGATION_BLOCK Returns the name of the block into which Form Builder attempts to navigate at form startup. and FALSE. or typeface. CURRENT_ROW_FONT_SIZE The size of the font.

This property determines whether the operator can abort a query when the elapsed time of the query exceeds the value of this property. it defaults to the setting of NLS_LANG. it defaults to the setting of NLS_LANG. it defaults to the setting of NLS_LANG. VALIDATION_UNIT Returns a VARCHAR2 string indicating the current validation unit for the form: FORM_SCOPE if the current validation unit is the form. MODULE_NLS_LANG is the equivalent of concatenating MODULE_NLS_LANGUAGE. SAVEPOINT_MODE Returns PROPERTY_ON or PROPERTY_OFF to indicate whether savepoints are supported in the data source. MAX_QUERY_TIME Returns the VARCHAR2 value that indicates the current setting of the Maximum Query Time property. If DEVELOPER_NLS_LANG is not explicitly set. and MODULE_NLS_CHACTER_SET. MODULE_NLS_LANGUAGE Returns the current value of the language portion only of the DEVELOPER_NLS_LANG environment variable defined for the form. BLOCK_SCOPE if the current validation unit is the block. If DEVELOPER_NLS_LANG is not explicitly set. If DEVELOPER_NLS_LANG is not explicitly set. MODULE_NLS_TERRITORY. VALIDATION Returns TRUE or FALSE to indicate whether default Form Builder validation is enabled. MODULE_NLS_LANG Returns the complete current value for national language support contained in the DEVELOPER_NLS_LANG environment variable defined for the form.LAST_BLOCK Returns the name of the block with the highest sequence number in the indicated form. MODULE_NLS_TERRITORY Returns the current value of the territory portion only of the DEVELOPER_NLS_LANG environment variable defined for the form.
GET_FORM_PROPERTY examples
Example 1 /* ** Built-in: ** Example:
GET_FORM_PROPERTY Determine the name of the first block in the form. ITEM_SCOPE if the current validation unit is the item or if the current validation unit is set to DEFAULT. If DEVELOPER_NLS_LANG is not explicitly set.
171
. MODULE_NLS_CHARACTER_SET Returns the current value of the character set portion only of the DEVELOPER_NLS_LANG environment variable defined for the form. it defaults to the setting of NLS_LANG. RECORD_SCOPE if the current validation unit is the record. MAX_RECORDS_FETCHED Returns a number representing the maximum number of records that can be fetched. This property is only useful when the Query All Records property is set to Yes.

preceded by the record group name and a dot. Returns the row number ** where the record was first located.groupcolumn_name.GET_GROUP_CHAR_CELL built-in
Description Returns the VARCHAR2 or LONG value for a record group cell identified by the given row and column. Built-in Type unrestricted function Returns VARCHAR2 Enter Query Mode yes Parameters groupcolumn_id Specifies the unique ID that Form Builder assigns when it creates the record group column. A non-existent row_number results in an index out of bounds error. the_rg_name VARCHAR2. row_number NUMBER). Use the FIND_COLUMN built-in to return the ID to an appropriately typed variable. its name is the same as its corresponding database column. or zero (0) ** if no match was found.
GET_GROUP_CHAR_CELL examples
/* ** Built-in: GET_GROUP_CHAR_CELL ** Example: Search thru names in a static record group to ** determine if the value passed into this subprogram ** exists in the list. The data type of the ID is GroupColumn. FUNCTION GET_GROUP_CHAR_CELL (groupcolumn_name VARCHAR2. Specifies the row from which to retrieve the value of the cell.
groupcolumn_name
row_number
GET_GROUP_CHAR_CELL restrictions
The row_number specified must be within the bounds implied by the number of rows in the record group. Specifies the fully qualified VARCHAR2 record group column name you gave the column when you defined it. the_rg_column VARCHAR2)
173
. Syntax FUNCTION GET_GROUP_CHAR_CELL (groupcolumn_id GroupColumn. as in recordgroup_name. A cell is an intersection of a row and column. row_number NUMBER). If the column was defined as a result of a query. */ FUNCTION Is_Value_In_List( the_value VARCHAR2.

we didn’t find any matches. /* ** If we find a match. col_val VARCHAR2(80). gc_id GroupColumn. /* ** Loop through the records.
174
. j ). rg_id RecordGroup. RAISE Exit_Function. stop and return the ** current row number. */ IF UPPER(col_val) = UPPER(the_value) THEN RETURN j. */ RAISE Exit_Function. END. Exit_Function Exception.’). getting the specified column’s ** value at each iteration and comparing it to ’the_value’ ** passed in. RAISE Exit_Function. END LOOP.’||the_rg_column ).’). END IF. IF Id_Null(gc_id) THEN Message(’Column ’||the_rg_column||’ does not exist. /* ** Make sure the column name specified exists in the ** record Group. BEGIN /* ** Determine if record group exists. END IF. */ gc_id := Find_Column( the_rg_name||’. IF Id_Null(rg_id) THEN Message(’Record Group ’||the_rg_name||’ does not exist.. END IF. */ rg_id := Find_Group( the_rg_name ).RETURN NUMBER IS the_Rowcount NUMBER. /* ** If we get here. EXCEPTION WHEN Exit_Function THEN RETURN 0. Compare the values in a case insensitive ** manner. /* ** Get a count of the number of records in the record ** group */ the_Rowcount := Get_Group_Row_Count( rg_id ). and if so get its ID.the_Rowcount LOOP col_val := GET_GROUP_CHAR_CELL( gc_id. */ FOR j IN 1.

row_number NUMBER). Use the FIND_COLUMN built-in to return the ID to an appropriately typed variable. FUNCTION GET_GROUP_DATE_CELL (groupcolumn_name VARCHAR2. Syntax FUNCTION GET_GROUP_DATE_CELL (groupcolumn_id GroupColumn.
GET_GROUP_DATE_CELL examples
/* ** Built-in: GET_GROUP_DATE_CELL ** Example: Lookup a row in a record group. */ FUNCTION Max_Order_Date_Of( part_no VARCHAR2 ) RETURN DATE IS fnd_row NUMBER. If the column was defined as a result of a query. and return the ** minimum order date associated with that row in ** the record group.GET_GROUP_DATE_CELL built-in
Description Returns the DATE value for a record group cell identified by the given row and column. A cell is an intersection of a row and column. Uses the ’is_value_in_list’ ** function from the GET_GROUP_CHAR_CELL example. its name is the same as its corresponding database column.groupcolumn_name. groupcolumn_name Specifies the fully qualified VARCHAR2 record group column name you gave the column when you defined it. The data type of the ID is GroupColumn.
row_number
GET_GROUP_DATE_CELL restrictions
The row_number specified must be within the bounds implied by the number of rows in the record group. row_number NUMBER). Specifies the row from which to retrieve the value of the cell. A non-existent row_number results in an index out of bounds error. Built-in Type unrestricted function Returns DATE Enter Query Mode yes Parameters groupcolumn_id Specifies the unique ID that Form Builder assigns when it creates the record group column. as in recordgroup_name. BEGIN
175
. preceded by the record group name and a dot.

fnd_row ). */ fnd_row := Is_Value_In_List( part_no. END. ’PARTNO’). ELSE /* ** Get the corresponding Date cell value from the ** matching row. RETURN NULL. */ RETURN Get_Group_Date_Cell( ’TMPPART./* ** Try to lookup the part number among the temporary part ** list record group named ’TMPPART’ in its ’PARTNO’ ** column. ’TMPPART’. END IF.MAXORDDATE’.’). IF fnd_row = 0 THEN Message(’Part Number ’||part_no||’ not found.
176
.

A cell is an intersection of a row and column. its name is the same as its corresponding database column. Uses the ** ’is_value_in_list’ function from the ** GET_GROUP_CHAR_CELL example. Use the FIND_COLUMN built-in to return the ID to an appropriately typed variable. row_number NUMBER).GET_GROUP_NUMBER_CELL built-in
Description Returns the NUMBER value for a record group cell identified by the given row and column. Built-in Type unrestricted function Returns NUMBER Enter Query Mode yes Parameters groupcolumn_id Specifies the unique ID that Form Builder assigns when it creates the record group column. The data type of the ID is GroupColumn.
GET_GROUP_NUMBER_CELL examples
/* ** Built-in: GET_GROUP_NUMBER_CELL ** Example: Lookup a row in a record group. Syntax FUNCTION GET_GROUP_NUMBER_CELL (groupcolumn_id GroupColumn. row_number NUMBER).groupcolumn_name. FUNCTION GET_GROUP_NUMBER_CELL (groupcolumn_name VARCHAR2. If the column was defined as a result of a query. preceded by the record group name and a dot. and return the ** minimum order quantity associated with that row ** in the record group. Specifies the row from which to retrieve the value of the cell. */ FUNCTION Min_Order_Qty_Of( part_no VARCHAR2 ) RETURN NUMBER IS fnd_row NUMBER.
177
. A non-existent row_number results in an index out of bounds error. as in recordgroup_name. Specifies the fully qualified VARCHAR2 record group column name you gave the column when you defined it.
groupcolumn_name
row_number
GET_GROUP_NUMBER_CELL restrictions
The row_number specified must be within the bounds implied by the number of rows in the record group.

IF fnd_row = 0 THEN Message(’Part Number ’||part_no||’ not found. fnd_row ).BEGIN /* ** Try to lookup the part number among the temporary part ** list record group named ’TMPPART’ in its ’PARTNO’ ** column.
178
.’). RETURN NULL. */ RETURN Get_Group_Number_Cell( ’TMPPART. END. */ fnd_row := Is_Value_In_List( part_no. ’PARTNO’). END IF. ’TMPPART’. ELSE /* ** Get the corresponding Number cell value from the ** matching row.MINQTY’.

SAL FROM EMP ORDER BY SAL DESC’).
GET_GROUP_RECORD_NUMBER examples
/* ** Built-in: GET_GROUP_RECORD_NUMBER ** Example: Find the first record in the record group with a ** cell in a column that is identical to the value ** specified in the cell_value parameter. or DATE. */ DECLARE rg_id RecordGroup. Built-in Type unrestricted function Returns NUMBER Enter Query Mode yes Parameters groupcolumn_id Specifies the unique ID that Form Builder assigns to the record group column when it creates it. The comparison is case-sensitive for VARCHAR2 comparisons. status NUMBER. The data type of the name is VARCHAR2. the_recordnum NUMBER. The data type of the name is VARCHAR2. FUNCTION GET_GROUP_RECORD_NUMBER (groupcolumn _name VARCHAR2. The data type of the ID is GroupColumn. match NUMBER := 2212. cell_value NUMBER). cell_value NUMBER). NUMBER.GET_GROUP_RECORD_NUMBER built-in
Description Returns the record number of the first record in the record group with a column value equal to the cell_value parameter. Syntax FUNCTION GET_GROUP_RECORD_NUMBER (groupcolumn _id GroupColumn. Specifies the value to find in the specified record group column.
groupcolumn_name cell_value
GET_GROUP_RECORD_NUMBER restrictions
The dataype of the cell_value parameter must match the datatype of the record group column.EMPNO. 0 (zero) is returned.
179
. ’SELECT ENAME. If there is no match. Use the FIND_COLUMN built-in to return the ID to a variable. BEGIN rg_id := Create_Group_From_Query(’QGROUP’. Specifies the name of the record group column that you gave to the group when creating it.

EMPNO.
recordgroup_name
GET_GROUP_ROW_COUNT examples
/* ** Built-in: GET_GROUP_ROW_COUNT ** Example: Determine how many rows were retrieved by a ** Populate_Group for a query record group.GET_GROUP_ROW_COUNT built-in
Description Returns the number of rows in the record group.SAL FROM EMP ORDER BY SAL DESC’). The data type of the name is VARCHAR2. Specifies the name of the record group that you gave to the group when creating it. BEGIN rg_id := Create_Group_From_Query(’MY_QRY_GROUP’. RAISE Form_trigger_Failure. FUNCTION GET_GROUP_ROW_COUNT (recordgroup_name VARCHAR2). The data type of the ID is RecordGroup. Message(’The query retrieved ’||to_CHAR(the_rowcount)|| ’ record(s)’). Built-in Type unrestricted function Returns NUMBER Enter Query Mode yes Parameters recordgroup_id Specifies the unique ID that Form Builder assigns to the record group when it creates it.’). Syntax FUNCTION GET_GROUP_ROW_COUNT (recordgroup_id RecordGroup). END IF. ELSE Message(’Error creating query record group. */ *** Zero status is success*** / IF status = 0 THEN the_rowcount := Get_Group_Row_Count( rg_id ). END. status := Populate_Group( rg_id ). */ DECLARE rg_id RecordGroup. status NUMBER. the_rowcount NUMBER.
181
. Use the FIND_GROUP built-in to return the ID to a variable. ’SELECT ENAME.

GET_GROUP_SELECTION built-in
Description Retrieves the sequence number of the selected row for the given group. Built-in Type unrestricted function Returns NUMBER Enter Query Mode yes Parameters recordgroup_id Specifies the unique ID that Form Builder assigns to the record group when it creates it. the_val VARCHAR2(20). selection_number NUMBER). given that rows 3. 7. FUNCTION GET_GROUP_SELECTION (recordgroup_name VARCHAR2. sel_row NUMBER. Syntax FUNCTION GET_GROUP_SELECTION (recordgroup_id RecordGroup. the_Rowcount NUMBER. 2. and 3. For example. /* ** Get a count of how many rows in the record group have
182
. rg_id RecordGroup. */ FUNCTION Comma_Separated_Partnumbers RETURN VARCHAR2 IS tmp_str VARCHAR2(2000). BEGIN rg_id := Find_Group(’PARTNUMS’). Identifies the selected rows in order of their selection.
recordgroup_name selection_number
GET_GROUP_SELECTION examples
/* ** Built-in: GET_GROUP_SELECTION ** Example: Return a comma-separated list (string) of the ** selected part numbers from the presumed ** existent PARTNUMS record group. gc_id GroupColumn. The selection_number argument takes a value of the NUMBER data type. Use the FIND_GROUP built-in to return the ID to a variable. their respective selection values are 1. and 21 are selected. The data type of the ID is RecordGroup. gc_id := Find_Column(’PARTNUMS. Specifies the name of the record group that you gave to the group when creating it.PARTNO’). selection_number NUMBER).

Specifies the name of the record group that you gave to the group when creating it. Syntax FUNCTION GET_GROUP_SELECTION_COUNT (recordgroup_id RecordGroup).GET_GROUP_SELECTION_COUNT built-in
Description Returns the number of rows in the indicated record group that have been programmatically marked as selected by a call to SET_GROUP_SELECTION. Built-in Type unrestricted function Returns NUMBER Enter Query Mode yes Parameters recordgroup_id Specifies the unique ID that Form Builder assigns to the record group when it creates it. Use the FIND_GROUP built-in to return the ID to a variable.
recordgroup_name
GET_GROUP_SELECTION_COUNT examples
/* ** Built-in: ** Example: */
GET_GROUP_SELECTION_COUNT See GET_GROUP_SELECTION
184
. FUNCTION GET_GROUP_SELECTION_COUNT (recordgroup_name VARCHAR2). The data type of the ID is RecordGroup.

obj_type is BEGIN RETURN(Get_interface_Pointer(MapName)).
185
.
item_name
GET_INTERFACE_POINTER restrictions
Valid only on Microsoft Windows and Macintosh.
GET_INTERFACE_POINTER examples
/* ** Built-in: GET_INTERFACE_POINTER ** Example: Finds a handle to an OLE object */ FUNCTION HandleMap(MapName VARCHAR2) RETURN OLE2. The data type of the name is VARCHAR2 string. FUNCTION GET_INTERFACE_POINTER (item_name VARCHAR2). Specifies the name of the object created at design time. Syntax FUNCTION GET_INTERFACE_POINTER (item_id Item). Returns PLS_INTEGER Built-in Type unrestricted function Enter Query Mode no Parameters item_id Specifies the unique ID that Form Builder assigns to the item when created. The data type of the ID is Item. END. Use the FIND_ITEM built-in to return the ID to an appropriately typed variable.GET_INTERFACE_POINTER built-in
Description Returns a handle to an OLE2 automation object.

item. property NUMBER). GET_ITEM_INSTANCE_PROPERTY returns the initial value or the value last specified by SET_ITEM_INSTANCE_PROPERTY for the specified item instance. Returns the string FALSE if the property is set to false. LOWERED. If BORDER_BEVEL is not specfied at the item instance level. INSERT_ALLOWED Returns the VARCHAR2 string TRUE if the item instance INSERT_ALLOWED property is set to true. and block levels).
item_name record_number property
186
. or PLAIN if the BORDER_BEVEL property is set to RAISED. Use the FIND_ITEM built-in to return the ID to a variable of datatype ITEM. respectively at the item instance level. property NUMBER). Valid properties are: BORDER_BEVEL Returns RAISED. the value derived from combining properties specified at the item instance. REQUIRED Returns the VARCHAR2 string TRUE if the item instance REQUIRED property is set to true. Built-in Type unrestricted function Returns VARCHAR2 Enter Query Mode yes Parameters item_id The unique ID that Form Builder assigns to the object when it creates it. A record number or CURRENT_RECORD. this property returns " ".e. The property the value of which you want to get for the given item. The name you gave the object when you created it. LOWERED. 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. record_number NUMBER. FUNCTION GET_ITEM_INSTANCE_PROPERTY (item_name VARCHAR2. record_number NUMBER. Syntax FUNCTION GET_ITEM_INSTANCE_PROPERTY (item_id ITEM. or PLAIN.GET_ITEM_INSTANCE_PROPERTY built-in
Description Returns property values for the specified item instance. Returns the string FALSE if the property is set to false. It does not return the effective value of a property (i. See SET_ITEM_INSTANCE_PROPERTY for information about effective property values.

SELECTED_RADIO_BUTTON Returns the label of the selected radio button within the radio group in the specified record. Returns the string FALSE if the property is set to false. Returns ’’ if VISUAL_ATTRIBUTE is not specified at the item instance level. If no named visual attribute is assigned to the item instance. 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.
187
. VISUAL_ATTRIBUTE Returns the name of the visual attribute currently in force. UPDATE_ALLOWED Returns the VARCHAR2 string TRUE if the item instance UPDATE_ALLOWED property is set to true. returns DEFAULT for a default visual attribute.

GET_ITEM_PROPERTY built-in
Description Returns property values for the specified item. Note that in some cases you may be able to get—but not set—certain object properties. Syntax FUNCTION GET_ITEM_PROPERTY (item_id, ITEM property NUMBER); FUNCTION GET_ITEM_PROPERTY (item_name VARCHAR2, property NUMBER); Built-in Type unrestricted function Returns VARCHAR2 Enter Query Mode yes Parameters item_id The unique ID that Form Builder assigns to the object when it creates it. Use the FIND_ITEM built-in to return the ID to a variable of datatype ITEM. The name you gave the object when you created it. The property the value of which you want to get for the given item. Valid properties are: AUTO_HINT Returns the VARCHAR2 string TRUE if the Automatic Hint property is set to Yes, and the VARCHAR2 string FALSE if it is set to No. AUTO_SKIP Returns the VARCHAR2 string TRUE if Automatic Skip is set to Yes for the item, and the string FALSE if it is set to No for the item. BACKGROUND_COLOR The color of the object's background region. BLOCK_NAME Returns the VARCHAR2 block name for the item. BORDER_BEVEL Returns RAISED, LOWERED, or PLAIN if the BORDER_BEVEL property is set to RAISED, LOWERED, or PLAIN, respectively at the item level. CASE_INSENSITIVE_QUERY Returns the VARCHAR2 string TRUE if this property is set to Yes for the item, and the string FALSE if the property is set to No. CASE_RESTRICTION Returns UPPERCASE if text for the item is to display in upper case, LOWERCASE if the text is to display in lower case, or NONE if no case restriction is in force.

item_name property

188

COLUMN_NAME Returns the name of the column in the database to which the datablock item is associated. COMPRESS Returns a value (either TRUE or FALSE) that indicates whether the sound object being read into a form from a file should be compressed when converting to the Oracle internal format. CONCEAL_DATA Returns the VARCHAR2 string TRUE if the text an operator types into the text item is to be hidden, and the VARCHAR2 string FALSE if the text an operator types into the text item is to be displayed. CURRENT_RECORD_ATTRIBUTE Returns the VARCHAR2 name of the named visual attribute of the given item. CURRENT_ROW_BACKGROUND_COLOR The color of the object’s background region. CURRENT_ROW_FILL_PATTERN The pattern to be used for the object’s fill region. Patterns are rendered in the two colors specified by Background Color and Foreground Color. CURRENT_ROW_FONT_NAME The font family, or typeface, that should be used for text in the object. The list of fonts available is systemdependent. CURRENT_ROW_FONT_SIZE The size of the font, specified in points. CURRENT_ROW_FONT_SPACING The width of the font, that is, the amount of space between characters (kerning). CURRENT_ROW_FONT_STYLE The style of the font. CURRENT_ROW_FONT_WEIGHT The weight of the font. CURRENT_ROW_FOREGROUND_COLOR The color of the object’s foreground region. For items, the Foreground Color attribute defines the color of text displayed in the item. CURRENT_ROW_WHITE_ON_BLACK Specifies that the object is to appear on a monochrome bitmap display device as white text on a black background. DATABASE_VALUE For a base table item, returns the value that was originally fetched from the database. DATATYPE Returns the data type of the item: ALPHA, CHAR, DATE, JDATE, EDATE, DATETIME, INT, RINT, MONEY, RMONEY, NUMBER, RNUMBER, TIME, LONG, GRAPHICS, or IMAGE. Note that some item types, such as buttons and charts, do not have data types. To avoid an error message in these situations, screen for item type before getting data type. DIRECTION Returns the layout direction for bidirectional objects. Valid return values are RIGHT_TO_LEFT, LEFT_TO_RIGHT. DISPLAYED Returns the VARCHAR2 string TRUE or FALSE.

189

ECHO Returns the VARCHAR2 string TRUE if the Conceal Data property is set to No for the item, and the VARCHAR2 string FALSE if the Conceal Data property is set to Yes for the item. EDITOR_NAME Returns the name of the editor attached to the text item. EDITOR_X_POS Returns the x coordinate of the editor attached to the text item. (Corresponds to the Editor Position property.) EDITOR_Y_POS Returns the y coordinate of the editor attached to the edit item. (Corresponds to the Editor Position property.) ENFORCE_KEY Returns the name of the item whose value is copied to this item as a foreign key when a new record is created as part of a masterdetail relation. (Corresponds to the Copy property.) ENABLED Returns TRUE if enabled property is set to Yes, FALSE if set to No. FILL_PATTERN The pattern to be used for the object’s fill region. Patterns are rendered in the two colors specified by Background Color and Foreground Color. FIXED_LENGTH Returns the VARCHAR2 string TRUE if the property is set to Yes for the item, and the VARCHAR2 string FALSE if the property is set to No for the item. FONT_NAME The font family, or typeface, that should be used for text in the object. The list of fonts available is system-dependent. FONT_SIZE The size of the font, specified in hundredths of a point (i.e., an item with a font size of 8 points will return 800). FONT_SPACING The width of the font, that is, the amount of space between characters (kerning). FONT_STYLE The style of the font. FONT_WEIGHT The weight of the font. FOREGROUND_COLOR The color of the object’s foreground region. For items, the Foreground Color attribute defines the color of text displayed in the item. FORMAT_MASK Returns the format mask used for the text item. HEIGHT Returns the height of the item. The size of the units depends on the Coordinate System and default font scaling you specified for the form. HINT_TEXT Returns the item-specific help text displayed on the message line at runtime. ICON_NAME Returns the file name of the icon resource associated with a button item having the iconic property set to TRUE. ICONIC_BUTTON Returns the VARCHAR2 value TRUE if the button is defined as iconic, and the VARCHAR2 value FALSE if it is not an iconic button. IMAGE_DEPTH Returns the color depth of the specified image item.

190

IMAGE_FORMAT Returns the format of the specified image item. INSERT_ALLOWED Returns the VARCHAR2 string TRUE if the INSERT_ALLOWED property is set to true at the item level. Returns the string FALSE if the property is set to false. ITEM_CANVAS Returns the name of the canvas to which the item is assigned. ITEM_IS_VALID Returns the VARCHAR2 string TRUE if the current item is valid, and the VARCHAR2 string FALSE if the current item is not valid. ITEM_NAME Returns the name of the item. ITEM_TAB_PAGE Returns the name of the tab page to which the item is assigned. Note that the item must be assigned to a tab canvas in order for Form Builder to return the name of the item’s tab page. ITEM_TYPE Returns the type of the item. Returns BUTTON if the item is a button, CHART ITEM if the item is a chart item, CHECKBOX if the item is a check box, DISPLAY ITEM if the item is a display item, IMAGE if the item is an image item, LIST if the item is a list item, OLE OBJECT if the item is an OCX control or an OLE container, RADIO GROUP if the item is a radio group, TEXT ITEM if the item is a text item, USER AREA if the item is a user area, and VBX CONTROL if the item is a custom item that is a VBX control. JUSTIFICATION Returns the text alignment for text items and display items only. Valid return values are START, END, LEFT, CENTER, RIGHT. KEEP_POSITION Returns the VARCHAR2 string TRUE if the cursor is to re-enter at the identical location it was in when it left the item, and the VARCHAR2 string FALSE if the cursor is to re-enter the item at its default position. LABEL Returns the VARCHAR2 value defined for the item’s Label property. This property is valid only for items that have labels, such as buttons and check boxes. LIST Returns the VARCHAR2 string TRUE if the item is a text item to which a list of values (LOV) is attached; otherwise returns the VARCHAR2 string FALSE. LOCK_RECORD_ON_CHANGE Returns the VARCHAR2 string TRUE if Form Builder should attempt to lock a row based on a potential change to this item, and returns the VARCHAR2 string FALSE if no lock should be attempted. LOV_NAME Returns the VARCHAR2 name of the LOV associated with the given item. If the LOV name does not exist, you will get an error message. LOV_X_POS Returns the x coordinate of the LOV associated with the text item. (Corresponds to the List X Position property.)

191

LOV_Y_POS Returns the y coordinate of the LOV associated with the text item. (Corresponds to the List Y Position property.) MAX_LENGTH Returns the maximum length setting for the item. The value is returned as a whole NUMBER. MERGE_CURRENT_ROW_VA Merges the contents of the specified visual attribute with the current row’s visual attribute (rather than replacing it). MERGE_TOOLTIP_ATTRIBUTE Merges the contents of the specified visual attribute with the tooltip’s current visual attribute (rather than replacing it). MERGE_VISUAL_ATTRIBUTE Merges the contents of the specified visual attribute with the object’s current visual attribute (rather than replacing it). MOUSE_NAVIGATE Returns the VARCHAR2 string TRUE if Mouse Navigate is set to Yes for the item, and the VARCHAR2 string FALSE if it is set to No for the item. MULTI_LINE Returns the VARCHAR2 value TRUE if the item is a multi-line text item, and the VARCHAR2 string FALSE if it is a single-line text item. NAVIGABLE Returns the VARCHAR2 string TRUE if the NAVIGABLE property is set to true at the item level. Returns the string FALSE if the property is set to false. NEXTITEM Returns the name of the next item in the default navigation sequence, as defined by the order of items in the Object Navigator. NEXT_NAVIGATION_ITEM Returns the name of the item that is defined as the "next navigation item" with respect to this current item. POPUPMENU_CONTENT_ITEM Returns the setting for any of the OLE popup menu item properties: POPUPMENU_COPY_ITEM POPUPMENU_CUT_ITEM POPUPMENU_DELOBJ_ITEM POPUPMENU_INSOBJ_ITEM POPUPMENU_LINKS_ITEM POPUPMENU_OBJECT_ITEM POPUPMENU_PASTE_ITEM POPUPEMNU_PASTESPEC_ITEM Returns the VARCHAR2 string HIDDEN if the OLE popup menu item is not displayed. Returns the VARCHAR2 string ENABLED if the OLE popup menu item is displayed and enabled. Returns the VARCHAR2 string DISABLED if the OLE popup menu item is displayed and not enabled. Returns the VARCHAR2 string UNSUPPORTED if the platform is not Microsoft Windows. PREVIOUSITEM Returns the name of the previous item.

192

PREVIOUS_NAVIGATION_ITEM Returns the name of the item that is defined as the "previous navigation item" with respect to this current item. PRIMARY_KEY Returns the VARCHAR2 value TRUE if the item is a primary key, and the VARCHAR2 string FALSE if it is not. PROMPT_ALIGNMENT_OFFSET Returns the distance between the item and its prompt as a VARCHAR2 value. PROMPT_BACKGROUND_COLOR The color of the object’s background region. PROMPT_DISPLAY_STYLE Returns the prompt’s display style, either FIRST_RECORD, HIDDEN, or ALL_RECORDS. PROMPT_EDGE Returns a value that indicates which edge the item’s prompt is attached to, either START, END, TOP, or BOTTOM. PROMPT_EDGE_ALIGNMENT Returns a value that indicates which edge the item’s prompt is aligned to, either START, END, or CENTER. PROMPT_EDGE_OFFSET Returns the distance between the item and its prompt as a VARCHAR2 value. PROMPT_FILL_PATTERN The pattern to be used for the object's fill region. Patterns are rendered in the two colors specified by Background Color and Foreground Color. PROMPT_FONT_NAME The font family, or typeface, that should be used for text in the object. The list of fonts available is system-dependent. PROMPT_FONT_SIZE The size of the font, specified in points. PROMPT_FONT_SPACING The width of the font, that is, the amount of space between characters (kerning). PROMPT_FONT_STYLE The style of the font. PROMPT_FONT_WEIGHT The weight of the font. PROMPT_FOREGROUND_COLOR The color of the object's foreground region. For items, the Foreground Color attribute defines the color of text displayed in the item. PROMPT_TEXT Returns the text label that displays for an item. PROMPT_TEXT_ALIGNMENT Returns a value that indicates how the prompt is justified, either START, LEFT, RIGHT, CENTER, or END. PROMPT_VISUAL_ATTRIBUTE Returns a value that indicates the prompt’s named visual attribute . PROMPT_WHITE_ON_BLACK Specifies that the object is to appear on a monochrome bitmap display device as white text on a black background. QUERYABLE Returns the VARCHAR2 string TRUE if the item can be included in a query, and the VARCHAR2 string FALSE if it cannot.

193

QUERY_LENGTH Returns the number of characters an operator is allowed to enter in the text item when the form is in Enter Query mode. QUERY_ONLY Returns the VARCHAR2 string TRUE if property is set to Yes for the item, and the VARCHAR2 string FALSE if the property is set to No for the item. RANGE_HIGH Returns the high value of the range limit. (Corresponds to the Range property.) RANGE_LOW Returns the low value of the range limit. (Corresponds to the Range property.) REQUIRED For multi-line text items, returns the VARCHAR2 string TRUE if the REQUIRED property is set to true at the item level. Returns the string FALSE if the property is set to false. SCROLLBAR Returns the VARCHAR2 string TRUE if the Show Scroll Bar property is Yes, and the VARCHAR2 string FALSE if the Show Scroll Bar property is No. SHOW_FAST_FORWARD_BUTTON Returns the VARCHAR2 value TRUE if is displayed on the specified sound item, FALSE if not. SHOW_PALETTE Returns the VARCHAR2 value TRUE if the imagemanipulation palette is displayed adjacent to the specified image item, FALSE if not. SHOW_PLAY_BUTTON Returns the VARCHAR2 value TRUE if displayed on the specified sound item, FALSE if not. SHOW_RECORD_BUTTON Returns the VARCHAR2 value TRUE if is displayed on the specified sound item, FALSE if not. SHOW_REWIND_BUTTON Returns the VARCHAR2 value TRUE if is displayed on the specified sound item, FALSE if not. SHOW_SLIDER Returns the VARCHAR2 value TRUE if the Slider position control is displayed on the specified sound item, FALSE if not. SHOW_TIME_INDICATOR Returns the VARCHAR2 value TRUE if is displayed on the specified sound item, FALSE if not. SHOW_VOLUME_CONTROL Returns the VARCHAR2 value TRUE if is displayed on the specified sound item, FALSE if not. TOOLTIP_BACKGROUND_COLOR The color of the object’s background region. TOOLTIP_FILL_PATTERN The pattern to be used for the object’s fill region. Patterns are rendered in the two colors specified by Background Color and Foreground Color. TOOLTIP_FONT_NAME The font family, or typeface, that should be used for text in the object. The list of fonts available is system-dependent. TOOLTIP_FONT_SIZE The size of the font, specified in points. is

194

TOOLTIP_FONT_SPACING The width of the font, that is, the amount of space between characters (kerning). TOOLTIP_FONT_STYLE The style of the font. TOOLTIP_FONT_WEIGHT The weight of the font. TOOLTIP_FOREGROUND_COLOR The color of the object’s foreground region. For items, the Foreground Color attribute defines the color of text displayed in the item. TOOLTIP_WHITE_ON_BLACK Specifies that the object is to appear on a monochrome bitmap display device as white text on a black background. TOOLTIP_TEXT Returns the item’s tooltip text. UPDATE_ALLOWED Returns the VARCHAR2 string TRUE if the UPDATE_ALLOWED property is set to true at the item level. Returns the string FALSE if the property is set to false. UPDATE_COLUMN Returns the VARCHAR2 string TRUE if Form Builder should treat the item as updated, and FALSE if it should not. UPDATE_NULL Returns the VARCHAR2 string TRUE if the item should be updated only if it is NULL, and the VARCHAR2 string FALSE if it can always be updated. (Corresponds to the Update if NULL property.) UPDATE_PERMISSION Returns the VARCHAR2 string TRUE if the UPDATE_PERMISSION property is set to ON, turning on the item's UPDATEABLE and UPDATE_NULL properties. The VARCHAR2 string FALSE indicates that UPDATEABLE and UPDATE_NULL are turned off. VALIDATE_FROM_LIST Returns the VARCHAR2 string TRUE if Form Builder should validate the value of the text item against the values in the attached LOV; otherwise returns the VARCHAR2 string FALSE. VISIBLE Returns the VARCHAR2 string TRUE if the property is set to Yes for the item, and the VARCHAR2 string FALSE if the property is set to No for the item. VISUAL_ATTRIBUTE Returns the name of the visual attribute currently in force. If no named visual attribute is assigned to the item, returns DEFAULT for a default visual attribute. WHITE_ON_BLACK Specifies that the object is to appear on a monochrome bitmap display device as white text on a black background. WIDTH Returns the width of the item. WINDOW_HANDLE Returns the a unique internal VARCHAR2 constant that is used to refer to objects. Returns the VARCHAR2 value ‘0’ if the platform is not Microsoft Windows. WRAP_STYLE Returns VARCHAR2 if the item has wrap style set to VARCHAR2, WORD if word wrap is set, NONE if no wrap style is specified for the item.

195

X_POS Returns the x coordinate that reflects the current placement of the item’s upper left corner relative to the upper left corner of the canvas. Y_POS Returns the y coordinate that reflects the current placement of the item’s upper left corner relative to the upper left corner of the canvas. Usage Notes If you attempt to use GET_ITEM_PROPERTY to get a property for an item that is not valid for that item, an error will occur. For example, an error will occur when you attempt to get LIST from a radio group because LIST is valid only for text items.

GET_ITEM_PROPERTY examples
/* ** Built-in: GET_ITEM_PROPERTY ** Example: Navigate to the next required item in the ** current block. */ PROCEDURE Go_Next_Required_Item IS cur_blk VARCHAR2(40); cur_itm VARCHAR2(80); orig_itm VARCHAR2(80); first_itm VARCHAR2(80); wrapped BOOLEAN := FALSE; found BOOLEAN := FALSE; Exit_Procedure EXCEPTION; /* ** Local function returning the name of the item after the ** one passed in. Using NVL we make the item after the ** last one in the block equal the first item again. */ FUNCTION The_Item_After(itm VARCHAR2) RETURN VARCHAR2 IS BEGIN RETURN cur_blk||’.’|| NVL(Get_Item_Property(itm,NEXTITEM), first_itm); END; BEGIN cur_blk := :System.Cursor_Block; first_itm := Get_Block_Property( cur_blk, FIRST_ITEM ); orig_itm := :System.Cursor_Item; cur_itm := The_Item_After(orig_itm); /* ** Loop until we come back to the item name where we started */ WHILE (orig_itm <> cur_itm) LOOP /* ** If required item, set the found flag and exit procedure */ IF Get_Item_Property(cur_itm,REQUIRED) = ’TRUE’ THEN found := TRUE; RAISE Exit_Procedure; END IF; /* ** Setup for next iteration */ cur_itm := The_Item_After(cur_itm); END LOOP; /*

196

** If we get here we wrapped all the way around the ** block’s item names */ wrapped := TRUE; RAISE Exit_Procedure; EXCEPTION WHEN Exit_Procedure THEN /* ** If we found a required item and we didn’t come back ** to the item we started in, then navigate there */ IF found AND NOT wrapped THEN Go_Item(cur_itm); END IF; END;

197

GET_LIST_ELEMENT_COUNT built-in
Description Returns the total number of list item elements in a list, including elements with NULL values. Syntax FUNCTION GET_LIST_ELEMENT_COUNT (list_id Item); FUNCTION GET_LIST_ELEMENT_COUNT (list_name VARCHAR2); Built-in Type unrestricted function Returns VARCHAR2 Enter Query Mode yes Parameters list_id Specifies the unique ID that Form Builder assigns when it creates the list item. Use the FIND_ITEM built-in to return the ID to an appropriately typed variable. The data type of the ID is ITEM. The name you gave to the list item when you created it. The data type of the name is VARCHAR2.

loop_index_var := loop_index_var + 1; IF list_element_to_add = list_element THEN element_match := ’FALSE’; END IF; EXIT WHEN list_element = list_element_to_add OR loop_index_var = total_list_count; END LOOP; /* ** Compare the current list item values with the value that ** will be added. */ loop_index_var := 1; LOOP list_element_value:= Get_List_Element_Value(list_id, loop_index_var); loop_index_var := loop_index_var + 1; IF list_value_to_add = list_element_value THEN value_match := ’FALSE’; END IF; EXIT WHEN list_element_value = list_value_to_add OR loop_index_var = total_list_count; END LOOP; /* ** Add the element and value if it is not in the current list */ IF element_match AND value_match = ’TRUE’ THEN Add_List_Element(list_id, list_name, list_element_to_add, list_value_to_add); END IF END;

199

GET_LIST_ELEMENT_LABEL built-in
Description Returns information about the requested list element label. Syntax FUNCTION GET_LIST_ELEMENT_LABEL (list_id ITEM, VARCHAR2, list_name list_index NUMBER); FUNCTION GET_LIST_ELEMENT_LABEL VARCHAR2, (list_name list_index NUMBER); Built-in Type unrestricted function Returns VARCHAR2 Enter Query Mode yes Parameters list_id Specifies the unique ID that Form Builder assigns when it creates the list item. Use the FIND_ITEM built-in to return the ID to an appropriately typed variable. The data type of the ID is ITEM. The name you gave to the list item when you created it. The data type of the name is VARCHAR2. Specifies the list index value. The list index is 1 based. If the index is greater than the count of elements in the list, GET_LIST_ELEMENT_LABEL will fail.

list_name list_index

Usage Notes The value associated with a list item element is not necessarily the list item’s current value. That is, the value of :block.list_item.

GET_LIST_ELEMENT_VALUE built-in
Description Returns the value associated with the specified list item element. Syntax FUNCTION GET_LIST_ELEMENT_VALUE (list_id ITEM, list_index NUMBER); FUNCTION GET_LIST_ELEMENT_VALUE VARCHAR2, (list_name list_index NUMBER); Built-in Type unrestricted function Returns VARCHAR2 Enter Query Mode yes Parameters list_id Specifies the unique ID that Form Builder assigns when it creates the list item. Use the FIND_ITEM built-in to return the ID to an appropriately typed variable. The data type of the ID is ITEM. The name you gave to the list item when you created it. The data type of the name is VARCHAR2. Specifies the list index value. The list index is 1 based. It will return a string containing the value of the requested element. If the index is greater than the count of elements in the list, GET_LIST_ELEMENT_VALUE will fail.

list_name list_index

GET_LIST_ELEMENT_VALUE examples
/* ** ** */

Built-in: Example:

GET_LIST_ELEMENT_VALUE See GET_LIST_ELEMENT_COUNT

201

GET_LOV_PROPERTY built-in
Description Returns information about a specified list of values (LOV). You must issue a call to the built-in once for each property value you want to retrieve. Syntax FUNCTION GET_LOV_PROPERTY (lov_id, property LOV); FUNCTION GET_LOV_PROPERTY (lov_name VARCHAR2, property NUMBER); Built-in Type unrestricted function Returns VARCHAR2 Enter Query Mode yes Parameters lov_id Specifies the unique ID that Form Builder assigns the object at the time it creates it. Use the FIND_LOV built-in to return the ID to an appropriately typed variable. The data type of the ID is LOV. Specifies the name that you gave the object when creating it. Specifies the property you want to set for the given LOV. The possible properties are as follows: AUTO_REFRESH Returns the VARCHAR2 string TRUE if the property is set to Yes; that is, if Form Builder re-executes the query each time the LOV is invoked. Returns the VARCHAR2 string FALSE if the property is set to No. GROUP_NAME Returns the name of the record group currently associated with this LOV. The data type of the name is VARCHAR2. HEIGHT Returns the height of the LOV. The size of the units depends on the Coordinate System and default font scaling you specified for the form. WIDTH Returns the width of the LOV. The size of the units depends on the Coordinate System and default font scaling you specified for the form. X_POS Returns the x coordinate that reflects the current placement of the LOV’s upper left corner relative to the upper left corner of the screen. Y_POS Returns the y coordinate that reflects the current placement of the LOV’s upper left corner relative to the upper left corner of the screen.

GET_MENU_ITEM_PROPERTY built-in
Description Returns the state of the menu item given the specific property. You can use this built-in function to get the state and then you can change the state of the property with the SET_MENU_ITEM_PROPERTY built-in. Syntax FUNCTION GET_MENU_ITEM_PROPERTY (menuitem_id MenuItem, property NUMBER); FUNCTION GET_MENU_ITEM_PROPERTY (menu_name.menuitem_name VARCHAR2, property NUMBER); Built-in Type unrestricted function Returns VARCHAR2 Enter Query Mode yes Parameters menuitem_id The unique ID Form Builder assigns to the menu item when you create it. Use the FIND_MENU_ITEM built-in to return the ID to an appropriately typed variable. Datatype is MenuItem.

menu_name. menuitem_name The name you gave the menu item when you created it. If you specify the menu item by name, include the qualifying menu name, for example, menu_name.menuitem_name. Datatype is VARCHAR2. property Specify one of the following constants to retrieve information about the menu item: CHECKED Returns the VARCHAR2 string TRUE if a check box menu item is checked, FALSE if it is unchecked. Returns the VARCHAR2 string TRUE if a radio menu item is the selected item in the radio group, FALSE if some other radio item in the group is selected. Returns TRUE for other menu item types. ENABLED Returns the VARCHAR2 string TRUE if a menu item is enabled, FALSE if it is disabled (thus grayed out and unavailable). ICON_NAME Returns the file name of the icon resource associated with a menu item having the Icon in Menu property set to TRUE. LABEL Returns the VARCHAR2 string for the menu item label. VISIBLE Returns the VARCHAR2 string TRUE if a menu item is visible, FALSE if it is hidden from view.

GET_MESSAGE restrictions
GET_MESSAGE is only instantiated when a message is directed to the display device, either by Form Builder or by a call to the MESSAGE built-in. If you redirect messages using the On-Message trigger, a call to GET_MESSAGE does not return a value. Refer to the On-Message trigger for more information.

GET_OLE_<proptype> built-in
Description Obtains an OLE property. There are four versions of the function (denoted by the value in proptype), one for each of the argument types CHAR, NUM, OBJ, and VAR. Syntax FUNCTION GET_OLE_CHAR (obj OLEOBJ, memberid PLS_INTEGER) RETURN oleprop VARCHAR2; ...or... FUNCTION GET_OLE_NUM (obj OLEOBJ, memberid PLS_INTEGER) RETURN oleprop NUMBER; ...or... FUNCTION GET_OLE_OBJ (obj OLEOBJ, memberid PLS_INTEGER) RETURN oleprop OLEOBJ; ...or... FUNCTION GET_OLE_VAR (obj OLEOBJ, memberid PLS_INTEGER, persistence BOOLEAN) RETURN oleprop OLEVAR; Built-in Type unrestricted function Returns the OLE property. Note that the type varies according to the form of the function chosen. Parameters obj memberid persistenc e A pointer to the OLE object. The member ID of the OLE property. Controls the persistence of the OLEVAR argument after its retrieval. This is an optional parameter; if not specified, the default value is FALSE (that is, nonpersistent).

Usage Notes
•

If INIT_OLEARGS and ADD_OLEARG calls precede this GET_OLE_type call, and there have been no intervening GET_OLE, SET_OLE, or CALL_OLE calls, then this call will retrieve the property by using the arguments specified in those INIT_OLEARGS and ADD_OLEARG calls. In contrast to a returned OLEVAR argument, whose persistence can be user-controlled, a returned OLEOBJ argument is always set to be non-persistent.

•

207

GET_OLEARG_<type> built-in
Description Obtains the nth argument from the OLE argument stack. There are four versions of the function (denoted by the value in type), one for each of the argument types CHAR, NUM, OBJ, and VAR. Syntax FUNCTION GET_OLEARG_CHAR (which NUMBER) RETURN olearg VARCHAR2; ...or... FUNCTION GET_OLEARG_NUM (which NUMBER) RETURN olearg NUMBER; ...or... FUNCTION GET_OLEARG_OBJ (which NUMBER) RETURN olearg OLEOBJ; ...or... FUNCTION GET_OLEARG_VAR (which NUMBER, persistence BOOLEAN) RETURN olearg OLEVAR; Built-in Type unrestricted function Returns the indicated argument. Note that the type varies according to the form of the function used. Parameters which persistence A relative number indicating which argument in the OLE argument stack should be retrieved. Controls the persistence of the OLEVAR argument after its retrieval. This is an optional parameter; if not specified, the default value is FALSE (that is, nonpersistent).

Usage Notes
• •

Use this function to retrieve arguments whose value might change as a result of the method call. In contrast to a returned OLEVAR argument, whose persistence can be user-controlled, a returned OLEOBJ argument is always set to be non-persistent.

208

GET_OLE_MEMBERID built-in
Description Obtains the member ID of a named method or property of an OLE object. Syntax FUNCTION GET_OLE_MEMBERID (obj OLEOBJ, name VARCHAR2) RETURN memberid PLS_INTEGER; Built-in Type unrestricted function Returns member ID of the method or property Parameters obj name Usage Notes The member ID is a hard-coded value. The result returned may vary depending on the language used to run the OLE server. Pointer to the OLE object. Name of the object’s method or property.

209

GET_PARAMETER_ATTR built-in
Description Returns the current value and type of an indicated parameter in an indicated parameter list. Syntax FUNCTION GET_PARAMETER_ATTR (list VARCHAR2, VARCHAR2, key paramtype NUMBER, value VARCHAR2); FUNCTION GET_PARAMETER_ATTR VARCHAR2, (name VARCHAR2, key paramtype NUMBER, VARCHAR2); value Built-in Type unrestricted procedure that returns two OUT parameters Enter Query Mode yes Parameters list or name Specifies the parameter list to which the parameter is assigned. The actual parameter can be either a parameter list ID of type PARAMLIST, or the VARCHAR2 name of the parameter list. The VARCHAR2 name of the parameter. An OUT parameter of type NUMBER. The actual parameter you supply must be a variable of type NUMBER, and cannot be an expression. Executing the parameter sets the value of the variable to one of the following numeric constants: DATA_PARAMETER Indicates that the parameter’s value is the name of a record group. TEXT_PARAMETER Indicates that the parameter’s value is an actual data value. value An OUT parameter of type VARCHAR2. If the parameter is a data type parameter, the value is the name of a record group. If the parameter is a text parameter, the value is an actual text parameter.

key paramtype

For an overview of using OUT parameters with PL/SQL procedures, refer to the PL/SQL 2.0 User’s Guide and Reference .

210

GET_PARAMETER_LIST built-in
Description Searches the list of parameter lists and returns a parameter list ID when it finds a valid parameter list with the given name. You must define an variable of type PARAMLIST to accept the return value. This function is similar to the FIND_ functions available for other objects. Syntax FUNCTION GET_PARAMETER_LIST (name VARCHAR2); Built-in Type unrestricted function Returns ParamList Enter Query Mode yes Parameters name Specifies a valid VARCHAR2 parameter list name.

GET_PARAMETER_LIST examples

See CREATE_PARAMETER_LIST

211

GET_RADIO_BUTTON_PROPERTY built-in
Description Returns information about a specified radio button. Syntax FUNCTION GET_RADIO_BUTTON_PROPERTY (item_id ITEM, button_name VARCHAR2, property NUMBER); FUNCTION GET_RADIO_BUTTON_PROPERTY( item_name VARCHAR2, button_name VARCHAR2, property NUMBER); Built-in Type unrestricted function Returns VARCHAR2 Enter Query Mode yes Parameters item_id Specifies the radio group item ID. Form Builder assigns the unique ID at the time it creates the object. Use the FIND_ITEM built-in to return the ID to an appropriately typed variable. The data type of the ID is ITEM. Specifies the name of the radio group. The radio group is the owner or parent of its subordinate radio buttons. The data type of the name is VARCHAR2. Specifies the name of the radio button whose property you want. The data type of the name is VARCHAR2. Specifies the property for which you want the current state. The possible property constants you can indicate are as follows: BACKGROUND_COLOR The color of the object’s background region. ENABLED Returns the VARCHAR2 string TRUE if property is set to Yes, and the VARCHAR2 string FALSE if property is set to No. FILL_PATTERN The pattern to be used for the object’s fill region. Patterns are rendered in the two colors specified by Background Color and Foreground Color. FONT_NAME The font family, or typeface, that should be used for text in the object. The list of fonts available is system-dependent. FONT_SIZE The size of the font, specified in points. FONT_SPACING The width of the font, that is, the amount of space between characters (kerning). FONT_STYLE The style of the font.

item_name

button_name property

212

FONT_WEIGHT The weight of the font. FOREGROUND_COLOR The color of the object’s foreground region. For items, the Foreground Color attribute defines the color of text displayed in the item. HEIGHT Returns the height of the radio button. The value is returned as a VARCHAR2 and is expressed in the units as set for the form by the form module Coordinate System property. LABEL Returns the actual string label for that radio button. PROMPT_BACKGROUND_COLOR The color of the object’s background region. PROMPT_FILL_PATTERN The pattern to be used for the object’s fill region. Patterns are rendered in the two colors specified by Background Color and Foreground Color. PROMPT_FONT_NAME The font family, or typeface, that should be used for text in the object. The list of fonts available is system-dependent. PROMPT_FONT_SIZE The size of the font, specified in points. PROMPT_FONT_SPACING The width of the font, that is, the amount of space between characters (kerning). PROMPT_FONT_STYLE The style of the font. PROMPT_FONT_WEIGHT The weight of the font. PROMPT_FOREGROUND_COLOR The color of the object’s foreground region. For items, the Foreground Color attribute defines the color of text displayed in the item. PROMPT_WHITE_ON_BLACK Specifies that the object is to appear on a monochrome bitmap display device as white text on a black background. VISIBLE Returns the VARCHAR2 string TRUE if property is set to Yes, returns and the VARCHAR2 string FALSE if property is set to No. VISUAL_ATTRIBUTE Returns the name of the visual attribute currently in force. If no named visual attribute is assigned to the radio button, returns CUSTOM for a custom visual attribute or DEFAULT for a default visual attribute. WHITE_ON_BLACK Specifies that the object is to appear on a monochrome bitmap display device as white text on a black background. WIDTH Returns the width of the radio button, including the label part. The value is returned as a VARCHAR2 and is expressed in the units as set for the form by the form module Coordinate System property. WINDOW_HANDLE Returns the a unique internal VARCHAR2 constant that is used to refer to objects. Returns the number 0 if the platform is not Microsoft Windows. X_POS Returns the x coordinate that reflects the current placement of the button’s upper left corner relative to the upper left corner of the canvas.

213

no luck today.The value is returned as a VARCHAR2 and is expressed in the units defined by the form module Coordinate System property. END. VISIBLE). The value is returned as a VARCHAR2 and is expressed in the units defined by the form module Coordinate System property. disp VARCHAR2(5).
GET_RADIO_BUTTON_PROPERTY examples
/* ** Built-in: GET_RADIO_BUTTON_PROPERTY ** Example: Determine whether a given radio button is ** displayed and has a particular visual ** attribute.’). END IF. BEGIN it_id := Find_Item(’My_Favorite_Radio_Grp’). va_name := Get_Radio_Button_Property( it_id. ’REJECTED’. ’REJECTED’.
214
. ELSE Message(’Sorry. VISUAL_ATTRIBUTE). disp := Get_Radio_Button_Property( it_id. */ DECLARE it_id Item. va_name VARCHAR2(40). Y_POS Returns the y coordinate that reflects the current placement of the button’s upper left corner relative to the upper left corner of the canvas. IF disp = ’TRUE’ AND va_name = ’BLACK_ON_PEACH’ THEN Message(’You win a prize!’).

One property constant is supported: Status.
Record Status Created record with no modified fields . property NUMBER).GET_RECORD_PROPERTY built-in
Description Returns the value for the given property for the given record number in the given block. Returns CHANGED if the record is marked as changed... Specifies the property for which you want the current state. Returns QUERY if the record is marked as query.. Returns INSERT if the record is marked as insert. block_name VARCHAR2. you must pass a valid record number as the argument to the record_number parameter. If you do not pass the proper constants.and all blocks in current form are NEW NEW NEW NEW
Block Status <N|Q|C> NEW NEW
Form Status <N|Q|C> <N|Q|C> NEW
215
. Built-in Type unrestricted function Returns VARCHAR2 Enter Query Mode yes Parameters record_number block_name property Specifies the record in a block for which you want property information. The number must correspond to a record number.and all records in current block are NEW . Usage Notes The following table illustrates the situations which return a NEW status. STATUS returns NEW if the record is marked as new and there is no changed record in the block. Specifies the block containing the target record. The three parameters are required.. For example. Form Builder issues an error. Syntax FUNCTION GET_RECORD_PROPERTY (record_number NUMBER.

Type of Block/Type of Item Changed In a Base Table Block: Change a Base Table Item In a Base Table Block:Change a Base Table Item In a Base Table Block:Change a Control Item ...and no record in current block is changed . they return the same status.. However..The following table illustrates the effect on record. there are specific cases in which the results may differ. even if the value being assigned is the same as the previous value... Both GET_RECORD_PROPERTY and the system variable SYSTEM.
216
.and no block in current form is changed Note:
NEW
INSERT
<Q|C>
<Q|C>
NEW
INSERT
<Q>
<Q|C>
INSERT
QUERY
<Q|C>
INSERT
QUERY
QUERY
In general.. and in most cases.RECORD_STATUS return the status of a record in a given block.and no record in current block is changed .. any assignment to a database item will change a record’s status from QUERY to CHANGED (or from NEW to INSERT). and form status of changes to base table items and control item in base table and control blocks.and no block in current form is changed
Record Status Before Change NEW
Record Status After Change INSERT
Block Status
Form Status
CHANGED
CHANGED
QUERY
CHANGED
CHANGED
CHANGED
QUERY
QUERY
<Q|C>
<Q|C>
QUERY
QUERY
<Q|C>
QUERY
QUERY
QUERY
In a Base Table Block: Change a Control Item In a Control Block: Change a Control Item . Passing an item to a procedure as OUT or IN OUT parameter counts as an assignment to it. block.

’customers’. Form Builder is at the block level in its processing sequence. For example.RECORD_STATUS is NULL. END. QUERY.STATUS) = ’NEW’ THEN Message(’You must enter a customer and order first!’). RAISE Form_trigger_Failure. and the value of SYSTEM. in a When-Clear-Block trigger.
217
. so there is no current record to report on. SYSTEM. on the other hand.RECORD_STATUS.GET_RECORD_PROPERTY always has a value of NEW.STATUS) = ’NEW’ AND Get_Record_Property(1.’orders’.RECORD_STATUS is undefined when there is no current record in the system.
GET_RECORD_PROPERTY examples
/* ** built-in: GET_RECORD_PROPERTY ** Example: Obtain the status of a record in given block */ BEGIN IF Get_Record_Property(1. or INSERT. can in certain cases return a value of NULL. CHANGED. because SYSTEM. END IF. because GET_RECORD_PROPERTY returns the status of a specific record without regard to the processing sequence or whether the record is the current record.

Specifies the property for which you want the current state. DEFERRED_COORDINATION Returns the VARCHAR2 value TRUE if the Deferred relation property is Yes. DETAIL_NAME Returns the VARCHAR2 name of the detail block in the given master-detail relationship. MASTER_NAME Returns the VARCHAR2 name of the master block in the given master-detail relationship. FALSE if it is No. or CASCADING. property NUMBER). Syntax FUNCTION GET_RELATION_PROPERTY (relation_id Relation. FUNCTION GET_RELATION_PROPERTY (relation_name VARCHAR2. ISOLATED. this property determines whether Form Builder automatically populates the detail block when a different record becomes the current record in the master block.GET_RELATION_PROPERTY built-in
Description Returns the state of the given relation property. property NUMBER). The property constants you can use are as follows: AUTOQUERY Returns the VARCHAR2 value TRUE if the Automatic Query relation property is Yes. or the name that Form Builder assigned to the relation when created. Built-in Type unrestricted function Returns VARCHAR2 Enter Query Mode yes Parameters relation_id Specifies the unique ID Form Builder assigns when it creates the relation. MASTER_DELETES Returns one of the following VARCHAR2 values to indicate the current setting of the block’s Delete Record Behavior property: NON_ISOLATED. FALSE if it is No. or left clear until the operator navigates to the detail block.
relation_name property
218
. This property determines whether the detail block is to be immediately coordinated with the current master record. When the Deferred relation property is set to Yes. The data type of the ID is Relation. Use the FIND_RELATION built-in to return the ID to an appropriately typed variable. Specifies the VARCHAR2 name you gave to the relation when you defined it.

219
. mark ** the detail block as being in need of ** coordination for an eventual deferred query. */ PROCEDURE Query_The_Details(rel_id Relation. Returns NULL if one does not exist. IF NOT Form_Success THEN RAISE Form_trigger_Failure. END IF. FALSE if it is No. ELSE Set_Block_Property(detail. and does not allow querying in the detail block when there is no master record from the database. Otherwise. End. issue a call to GET_BLOCK_PROPERTY. if one exists. To get the name of the first relation for a given block. NEXT_MASTER_RELATION Returns the VARCHAR2 name of the next relation. Form Builder does not allow records to be inserted in the detail block when there is no master record in the master block. When set to Yes. END IF. detail VARCHAR2) IS BEGIN IF Get_Relation_Property(rel_id.NEXT_DETAIL_RELATION Returns the VARCHAR2 name of the next detail relation. then go ** coordinate the detail block. To get the name of the first detail for a given block. Returns NULL if none exists.
GET_RELATION_PROPERTY examples
/* ** Built-in: GET_RELATION_PROPERTY ** Example: If the relation is not deferred. PREVENT_MASTERLESS_OPERATION Returns the VARCHAR2 value TRUE if this relation property is Yes. coordination_status. Execute_Query. NON_COORDINATED). if one exists. DEFERRED_COORDINATION) = ’FALSE’ THEN Go_Block(detail). issue a call to GET_BLOCK_PROPERTY.

FILE. MAIL.GET_REPORT_OBJECT_PROPERTY built-in
Description Programmatically obtain a property of a report object. property NUMBER ). CACHE or SCREEN REPORT_FILENAME: Returns a string value of the report filename REPORT_SOURCE_BLOCK: Returns a string value of the report source block name REPORT_QUERY_NAME: Returns a string value of the report query name REPORT_DESNAME: Returns a string value of the report destination name REPORT_DESFORMAT: Returns a string value of the report destination format REPORT_SERVER: Returns a string value of the report server name REPORT_OTHER: Returns a string value of the other user-specified report properties
220
. either PREVIEW. property NUMBER ). Syntax FUNCTION GET_REPORT_OBJECT_PROPERTY (report_id REPORT_OBJECT . either BATCH or RUNTIME REPORT_COMM_MODE: Returns a string value of the report communication mode. One of the following constants: REPORT_EXECUTION_MODE: Returns a string value of the report execution mode. You can get the report ID for a particular report using FIND_REPORT_OBJECT . Built-in Type unrestricted procedure Enter Query Mode yes Parameters report_id report_name property Specifies the unique ID of the report. either SYNCHRONOUS or ASYNCHRONOUS REPORT_DESTYPE: Returns a string value of the report destination type. Specifies the unique name of the report. PRINTER. FUNCTION GET_REPORT_OBJECT_PROPERTY (report_name VARCHAR2.

The list of fonts available is system-dependent. FONT_STYLE The style of the font.. FILL_PATTERN The pattern to be used for the object’s fill region. Patterns are rendered in the two colors specified by Background Color and Foreground Color. CANVAS_NAME Returns the VARCHAR2 name of the canvas to which the tab page belongs.g. greyed out and unavailable). property FUNCTION GET_TAB_PAGE_PROPERTY (tab_page_name VARCHAR2.GET_TAB_PAGE_PROPERTY built-in
Description Returns property values for a specified tab page. FONT_SPACING The width of the font. or typeface.TAB_PG_1). CVS_1.e. property Built-in Type unrestricted function Returns VARCHAR2 Enter Query Mode yes Parameters tab_page_id The unique ID Form Builder assigned to the tab page object when you created it. NUMBER). that is. NUMBER). The name you gave the tab page object when you created it. The property the value of which you want to get for the given tab page.. Note: if two tab pages in the same form module share the same name. FONT_WEIGHT The weight of the font. the amount of space between characters (kerning). FONT_NAME The font family. ENABLED Returns the VARCHAR2 string TRUE if a tab page is enabled.
tab page_name
property
222
. that should be used for text in the object. Use the FIND_TAB_PAGE built-in to return the ID to a variable of datatype TAB_PAGE. The possible properties are as follows: BACKGROUND_COLOR The color of the object’s background region. FALSE if it is disabled (i. you must provide the canvas and tab page (e. FONT_SIZE The size of the font. Syntax FUNCTION GET_TAB_PAGE_PROPERTY (tab_page_id TAB_PAGE. specified in points.

END. FALSE if it is not. For items. live VARCHAR2(32). A tab page is reported visible if it is currently mapped to the screen.
GET_TAB_PAGE_PROPERTY examples
/* Use FIND_TAB_PAGE and GET_TAB_PAGE_PROPERTY to check ** if a tab page is enabled: */ DECLARE tp_id TAB_PAGE. If no named visual attribute is assigned to the tab page. VISIBLE Returns the VARCHAR2 value TRUE if the tab page is visible. LABEL Returns the VARCHAR2 string for the tab page label. VISUAL_ATTRIBUTE Returns the name of the visual attribute currently in force.FOREGROUND_COLOR The color of the object’s foreground region. even if it is entirely hidden behind another tab page. live := GET_TAB_PAGE_PROPERTY(tp_id. WHITE_ON_BLACK Specifies that the object is to appear on a monochrome bitmap display device as white text on a black background. the Foreground Color attribute defines the color of text displayed in the item. enabled). returns CUSTOM for a custom visual attribute or DEFAULT for a default visual attribute.
223
. BEGIN tp_id := FIND_TAB_PAGE(’tab_page_1’).

-.htree3’). Specifies the unique ID that Form Builder assigns to the item when created. The data type of the ID is ITEM.GET_TREE_NODE_PARENT built-in
Description Returns the parent of the specified node. Syntax FUNCTION GET_TREE_NODE_PARENT (item_name VARCHAR2 node NODE).Find the tree itself.
224
. parent_node FTREE. FUNCTION GET_TREE_NODE_PARENT (item_id ITEM node NODE).This code could be used in a WHEN-TREE-NODE-SELECTED -. Specifies a valid node. DECLARE htree ITEM. htree := Find_Item(’tree_block. Returns NODE Built-in Type unrestricted function Enter Query Mode no Parameters item_name Item_id Specifies the name of the object created at design time.
node
GET_TREE_NODE_PARENT examples
/* ** Built-in: */ GET_TREE_NODE_PARENT
-.trigger to locate the parent of the node that was -. The data type of the name is VARCHAR2 string. BEGIN -.NODE. Use the FIND_ITEM built-in to return the ID to an appropriately typed variable.Get the parent of the node clicked on.clicked on.

NODE_DEPTH Returns the nesting level of the hierarchical tree node. Returns VARCHAR2 Built-in Type unrestricted function Enter Query Mode no Parameters item_name Item_id Specifies the name of the object created at design time. Specify one of the following properties: NODE_STATE Returns the state of the hierarchical tree node. The data type of the ID is ITEM. NODE_LABEL Returns the label NODE_ICON Returns the icon name NODE_VALUE Returns the value of the hierarchical tree node. property NUMBER). This is either EXPANDED_NODE. Specifies a valid node. property NUMBER). Specifies the unique ID that Form Builder assigns to the item when created. FUNCTION GET_TREE_NODE_PROPERTY (item_id ITEM. node NODE. Use the FIND_ITEM built-in to return the ID to an appropriately typed variable. or LEAF_NODE. node NODE. The data type of the name is VARCHAR2 string.
node property
GET_TREE_NODE_PROPERTY examples
/*
226
.GET_TREE_NODE_PROPERTY built-in
Description Returns the value of the specified property of the hierarchical tree node. COLLAPSED_NODE. Syntax FUNCTION GET_TREE_NODE_PROPERTY (item_name VARCHAR2.

Use the FIND_ITEM built-in to return the ID to an appropriately typed variable. FUNCTION GET_TREE_PROPERTY (item_id ITEM. QUERY_TEXT Returns the text of the query used to initially populate the hierarchical tree.GET_TREE_PROPERTY built-in
Description Returns property values of the specified hierarchical tree. Specifies the unique ID that Form Builder assigns to the item when created. This may be a null string. This may be a null string. The data type of the name is VARCHAR2 string. RECORD_GROUP Returns the RecordGroup used to initially populate the hierarchical tree. either in Form Builder or by using the SET_TREE_PROPERTY built-in. Returns VARCHAR2 Built-in Type unrestricted function Enter Query Mode no Parameters item_name Item_id Specifies the name you gave the object when you created it. property NUMBER). ALLOW_EMPTY_BRANCHES Returns the character
property
228
. Specify one of the following properties: DATASOURCE Returns the source used to initially populate the hierarchical tree. property NUMBER). Returns EXTERNAL if neither property was set in Form Builder. Syntax FUNCTION GET_TREE_PROPERTY (item_name VARCHAR2. The data type of the ID is ITEM. either in Form Builder or by using the SET_TREE_PROPERTY builtin. SELECTION_COUNT Returns the number of selected rows in the hierarchical tree. either in Form Builder or by using the SET_TREE_PROPERTY builtin.. NODE_COUNT Returns the number of rows in the hierarchical tree data set.

The values returned are those that were set in Form Builder and not those set using the SET_TREE_PROPERTY built-in. Usage Notes The values returned by datasource RECORD_GROUP and QUERY_TEXT do not necessarily reflect the current data or state of the tree.Get the node count of the tree. BEGIN -.NODE_COUNT)..string TRUE or FALSE.in a given tree. . -. ALLOW_MULTI-SELECT Returns the character string TRUE or FALSE..htree3’).Get_Tree_Property(htree.This code could be used to find out how many nodes are -. END. DECLARE htree ITEM. node_count := Ftree.
229
. Ftree. node_count NUMBER. htree := Find_Item(’tree_block.
GET_TREE_PROPERTY examples
/* ** Built-in: */ GET_TREE_PROPERTY
-.Find the tree itself.

DECLARE htree ITEM. Returns FTREE. num_selected NUMBER.Get_Tree_Property(htree.htree3’). -.
selection
GET_TREE_SELECTION examples
/* ** Built-in: */ GET_TREE_SELECTION
-. selection NUMBER). current_node FTREE.Ftree.NODE Built-in Type unrestricted function Enter Query Mode no Parameters item_name Item_id Specifies the name of the object created at design time. Syntax FUNCTION GET_TREE_SELECTION (item_name VARCHAR2. FUNCTION GET_TREE_SELECTION (item_id ITEM.NODE. selection NUMBER). num_selected := Ftree. See the -.
230
. Selection is an index into the list of selected nodes.Find the tree itself.This code will process all tree nodes marked as selected. The data type of the ID is ITEM. Specifies the selection of a single node. BEGIN -. Use the FIND_ITEM built-in to return the ID to an appropriately typed variable. htree := Find_Item(’tree_block.Set_Tree_Selection built-in for a definition of "selected". The data type of the name is VARCHAR2 string.Find the number of nodes marked as selected.GET_TREE_SELECTION built-in
Description Returns the data node indicated by selection. Specifies the unique ID that Form Builder assigns to the item when created.

Get_Tree_Selection(htree. j). If you are deleting -. be sure to loop in reverse! FOR j IN 1.. END LOOP.nodes.SELECTION_COUNT).Loop through selected nodes and process them.Ftree. -.num_selected LOOP current_node := Ftree. ..
231
.. END.

The list of fonts available is system-dependent. Syntax FUNCTION GET_VA_PROPERTY (va_id VISUALATTRIBUTE property NUMBER). FONT_SIZE The size of the font. FILL_PATTERN The pattern to be used for the object’s fill region.
va_name property
232
. Specify one of the following properties: BACKGROUND_COLOR The color of the object’s background region. Built-in Type unrestricted function Returns VARCHAR2 Enter Query Mode yes Parameters va_id The unique ID Form Builder assinged to the visual attribute when you created it. For items. FONT_NAME The font family. the Foreground Color attribute defines the color of text displayed in the item. that is. would be 800. FUNCTION GET_VA_PROPERTY (va_name VARCHAR2 property NUMBER). FONT_SPACING The width of the font. or typeface. The name you gave the visual attribute when you created it. FONT_STYLE The style of the font. For example. Patterns are rendered in the two colors specified by Background Color and Foreground Color. 8pt. specified in hundreds of points. The data type is VARCHAR2. The data type is VISUALATTRIBUTE. that should be used for text in the object. the amount of space between characters (kerning). FOREGROUND_COLOR The color of the object’s foreground region. FONT_WEIGHT The weight of the font.GET_VA_PROPERTY built-in
Description Returns visual attribute property values for the specified property.

WHITE_ON_BLACK Specifies that the object is to appear on a monochrome bitmap display device as white text on a black background.
233
.

GET_VAR_BOUNDS built-in
Description Obtains the bounds of an OLE variant’s array. Built-in Type unrestricted procedure Parameters var bounds The variant. For more information about the contents and layout of this parameter. Syntax PROCEDURE GET_VAR_BOUNDS (var OLEVAR. see Array Types for OLE Support
234
. The PL/SQL table that is populated with the bounds of the array. bounds OLE_SAFEARRAYBOUNDS).

Syntax FUNCTION GET_VAR_DIMS (var OLEVAR) RETURN vardims PLS_INTEGER.GET_VAR_DIMS built-in
Description Determines if an OLE variant is an array. Built-in Type unrestricted function Returns A value of zero (0) if the variant is not an array. Parameters var The variant. obtains the number of dimensions in that array. Otherwise. and if so. the return value is the number of dimensions in the array.
235
.

The data type of the ID is Item. An OLE verb specifies the action that you can perform on an OLE object.
item_name
GET_VERB_COUNT restrictions
Valid only on Microsoft Windows and Macintosh. verb_cnt NUMBER. Syntax FUNCTION GET_VERB_COUNT (item_id Item). verb_cnt_str VARCHAR(20).
GET_VERB_COUNT examples
/* ** Built-in: GET_VERB_COUNT ** Example: Obtains the number of verbs that the OLE server ** issues and recognizes when executed from the OLE container. IF Id_Null(item_id) THEN
237
. Use the FIND_ITEM built-in to return the ID to an appropriately typed variable.GET_VERB_COUNT built-in
Description Returns the number of verbs that an OLE server recognizes. ** trigger: When-Button-Pressed */ DECLARE item_id ITEM. You must define an appropriately typed variable to accept the return value. FUNCTION GET_VERB_COUNT (item_name VARCHAR2). loop_cntr NUMBER. The data type of the name is VARCHAR2 string. item_name VARCHAR(25) := ’OLEITM’. BEGIN item_id := Find_Item(item_name). The number of verbs is returned as a VARCHAR2 string and must be converted to NUMBER for use in determining the verb index and verb name for each verb. verb_name VARCHAR(20). and the number of verbs available depends on the OLE server. Returns VARCHAR2 Built-in Type unrestricted function Enter Query Mode no Parameters item_id Specifies the unique ID that Form Builder assigns to the item when created. Specifies the name of the object created at design time.

FUNCTION GET_VERB_NAME VARCHAR2. verb_index VARCHAR2). (item_name verb_index VARCHAR2).GET_VERB_NAME built-in
Description Returns the name of the verb that is associated with the given verb index. The data type of the ID is Item.
item_name verb_index
GET_VERB_NAME restrictions
Valid only on Microsoft Windows and Macintosh. Specifies the numeric index of a verb.
GET_VERB_NAME examples
/* ** Built-in: GET_VERB_COUNT ** Example: See EXEC_VERB and GET_VERB_COUNT */
239
. Syntax FUNCTION GET_VERB_NAME (item_id Item. Use the FIND_ITEM built-in to return the ID to an appropriately typed variable. Returns VARCHAR 2 Built-in Type unrestricted function Enter Query Mode no Parameters item_id Specifies the unique ID that Form Builder assigns to the item when created. and each OLE verb has a corresponding OLE verb index. Specifies the name of the object created at design time. An OLE verb specifies the action that you can perform on an OLE object. The data type of index is VARCHAR2. You must define an appropriately typed variable to accept the return value. Use the FIND_OLE_VERB built-in to obtain this value. The data type of the name is VARCHAR2.

FUNCTION GET_VIEW_PROPERTY (view_name VARCHAR2. Specifies the name that you gave the object when defining it. VIEWPORT_X_POS_ON_CANVAS Returns the x coordinate that reflects the current placement of the view’s upper left corner relative to the
view_name property
240
. Syntax FUNCTION GET_VIEW_PROPERTY (view_id ViewPort. You must make a separate call to GET_VIEW_PROPERTY for each property you need. returns 0. The value is returned as a VARCHAR2 and is expressed in the units defined by the form module Coordinate System property. For a content view. property NUMBER). Specifies the property whose state you want to get for the given canvas. as shown in the example. For a content view. For a content view. The data type of the ID is ViewPort. the height of the view is actually the height of the window in which the view is currently displayed. property Built-in Type unrestricted function Returns VARCHAR2 Enter Query Mode yes Parameters view_id Specifies the unique ID that Form Builder assigns the canvas when it creates the object. Use the FIND_VIEW built-in to return the ID to an appropriately typed variable. VIEWPORT_Y_POS For a stacked canvas. Valid return values are RIGHT_TO_LEFT. HEIGHT Returns the height of the view. The size of each unit depends on how you defined the Coordinate System property for the form module. VIEWPORT_X_POS For a stacked canvas. The value is returned as a VARCHAR2 and is expressed in the units defined by the form module Coordinate System property. You can enter one of the following constants to obtain return values: DIRECTION Returns the layout direction for bidirectional objects. returns the x coordinate that reflects the current placement of the view’s upper left corner relative to the upper left corner of the window’s current content canvas. NUMBER). returns the y coordinate that reflects the current placement of the view’s upper left corner relative to the upper left corner of the window’s current content canvas.GET_VIEW_PROPERTY built-in
Description Returns the indicated property setting for the indicated canvas. returns 0. LEFT_TO_RIGHT.

y := Get_View_Property(vw_id1. Note that this property is independent of the current window display state.WIDTH). x+w ). width */ vw_id1 := Find_View(View1). View1 VARCHAR2) IS vw_id1 ViewPort. The value is returned as a VARCHAR2 and is expressed in the units defined by the form module Coordinate System property. vw_id2 ViewPort.VIEWPORT_Y_POS. A view is reported visible when it is a) in front of all other views in the window or b) only partially obscured by another view. For a content view. y ). */ PROCEDURE Anchor_To_Right( View2 VARCHAR2. WIDTH Returns the width of the view. Set_View_Property(vw_id2. the width of the view is actually the width of the window in which the view is currently displayed.VIEWPORT_X_POS. FALSE if it is not.VIEWPORT_Y_POS). /* ** Anchor View2 at (x+w.
241
. END. VISIBLE Returns the VARCHAR2 value TRUE if the view is visible. Thus a view can be reported visible even when its window is currently hidden or iconified. A view is reported not visible when it is a) a stacked view that is behind the content view or b) completely obscured by a single stacked view.upper left corner of its canvas. w NUMBER. x NUMBER. and display position of one ** stacked view (View1) to determine where to ** position another one (View2) immediately to its ** right. BEGIN /* Find View1 and get its (x. The value is returned as a VARCHAR2 and is expressed in the units defined by the form module Coordinate System property. Set_View_Property(vw_id2.y) position. The size of each unit depends on how you defined the Coordinate System property for the form module.y+h) */ vw_id2 := Find_View(View2). y NUMBER. VIEWPORT_Y_POS_ON_CANVAS Returns the y coordinate that reflects the current placement of the view’s upper left corner relative to the upper left corner of its canvas. WINDOW_NAME Returns the name of the window where this canvas is displayed. x := Get_View_Property(vw_id1.
GET_VIEW_PROPERTY examples
/* ** Built-in: GET_VIEW_PROPERTY ** Example: Use the Width.VIEWPORT_X_POS). w := Get_View_Property(vw_id1.

Valid return values are RIGHT_TO_LEFT. FONT_SIZE The size of the font. FONT_NAME The font family. specified in points. Specify one of the following constants to get the current value or state of the property: BACKGROUND_COLOR The color of the object’s background region. Built-in Type unrestricted function Returns VARCHAR2 Enter Query Mode yes Usage Notes On Microsoft Windows.
window_name property
242
. the amount of space between characters (kerning). you can reference the MDI application window with the constant FORMS_MDI_WINDOW. Syntax FUNCTION GET_WINDOW_PROPERTY (window_id Window. Parameters window_id Specifies the unique ID that Form Builder assigns the window at the time it creates it. FILL_PATTERN The pattern to be used for the object’s fill region. FONT_SPACING The width of the font. as shown in the FIND_WINDOW example. property FUNCTION GET_WINDOW_PROPERTY (window_name VARCHAR2. LEFT_TO_RIGHT. or typeface. DIRECTION Returns the layout direction for bidirectional objects. Use the FIND_WINDOW built-in to return the ID to an appropriately typed variable. that should be used for text in the object. Specifies the name that you gave the window when creating it.GET_WINDOW_PROPERTY built-in
Description Returns the current setting for the indicated window property for the given window. that is. The list of fonts available is system-dependent. The data type of the ID is Window. You must make a separate call to GET_WINDOW_PROPERTY for each property you need. Patterns are rendered in the two colors specified by Background Color and Foreground Color. NUMBER). property NUMBER).

HIDE_ON_EXIT Returns the VARCHAR2 value TRUE if the window has the Remove On Exit property set to Yes. FALSE if it is not. WHITE_ON_BLACK Specifies that the object is to appear on a monochrome bitmap display device as white text on a black background. it is FALSE. ICON_NAME Returns the file name of the icon resource associated with a window item when it is minimized. Y_POS Returns the y coordinate that reflects the window’s current display position on the screen. separated by commas. WINDOW_STATE Returns the current display state of the window. WIDTH Returns the width of the window. MAXIMIZE. X_POS Returns the x coordinate that reflects the window’s current display position on the screen. Returns the number 0 if the platform is not Microsoft Windows. the Foreground Color attribute defines the color of text displayed in the item. A window is reported visible if it is currently mapped to the screen. HEIGHT Returns the height of the window.FONT_STYLE The style of the font. WIDOW_SIZE Returns the width and height of the window as a string. The display state of a window is the VARCHAR2 string NORMAL. FOREGROUND_COLOR The color of the object’s foreground region. or MINIMIZE. even if it is entirely hidden behind another window or iconified (minimized). WINDOW_HANDLE Returns the a unique internal VARCHAR2 constant that is used to refer to objects.
243
. TITLE Returns the title of the window. FONT_WEIGHT The weight of the font. otherwise. For items. VISIBLE Returns the VARCHAR2 value TRUE if the window is visible.

ELSIF :Global. This method is more reliable than simply ** checking FORM_SUCCESS. an error occurs. END IF.
244
.Flag_Indicator = ’DAY’ THEN Go_Block(’Day_Schedule’). /* ** One method of checking for block navigation success. */ IF :System. */ BEGIN IF :Global. Go_Block(’Main’).GO_BLOCK built-in
Description GO_BLOCK navigates to an indicated block. The data type of the name is VARCHAR2. */ IF NOT FORM_SUCCESS THEN RAISE Form_trigger_Failure. Make sure to check ** that the Go_Block succeeds by checking FORM_SUCCESS. Syntax PROCEDURE GO_BLOCK (block_name VARCHAR2). Execute_Query.Cursor_Block THEN RAISE Form_trigger_Failure.
GO_BLOCK examples
/* ** Built-in: GO_BLOCK ** Example: Navigate to a block by name. If the target block is non-enterable. something went ** wrong. END.trigger_Block = :System.Flag_Indicator = ’NIGHT’ THEN Go_Block(’Night_Schedule’). END IF. END IF. Built-in Type restricted procedure Enter Query Mode no Parameters block_name Specifies the name you gave the block when defining it. If the block the cursor is in hasn’t ** changed after a block navigation. /* ** Another way of checking that block navigation ** succeeds.

245
. which fires for the form that initiates navigation. Syntax PROCEDURE GO_FORM (form_id FORMMODULE). not the name of the . PROCEDURE GO_FORM (form_name VARCHAR2).
form_name
GO_FORM restrictions
The target form cannot be a form that is currently disabled as a result of having invoked another form with CALL_FORM. which fires for the target window in the target form. Attempting to navigate to a form that has not yet been opened raises an error. The data type of name is VARCHAR2. Built-in Type restricted procedure Enter Query Mode no Parameters form_id The unique ID that is assigned to the form dynamically when it is instantiated at runtime.fmx file. When navigating with GO_FORM. Use the FIND_FORM built-in to return the ID to an appropriately typed variable. The name of the target form. no validation occurs and no triggers fire except WHEN-WINDOWDEACTIVATED. and WHEN-WINDOWACTIVATED. The GO_FORM built-in attempts to search for the form module name.GO_FORM built-in
Description In a multiple-form application. The data type of the ID is FORMMODULE. navigates from the current form to the indicated target form.

END. */ PROCEDURE Open_Preference_Dialog IS BEGIN Go_Item(’pref_dialog. Syntax PROCEDURE GO_ITEM (item_id Item).
GO_ITEM examples
/* ** Built-in: GO_ITEM ** Example: Invoke a dialog window by navigating to ** an item which is on the canvas which the window ** displays.
GO_ITEM restrictions
GO_ITEM(’emp. The data type of the ID is Item.GO_ITEM built-in
Description GO_ITEM navigates to an indicated item. • • In Enter Query mode. You cannot use GO_ITEM to navigate to a non-navigable item. GO_ITEM succeeds even if the target item has the Keyboard Navigable property set to No. The data type of the name is VARCHAR2.
246
.printer_name’).ename’). such as a VARCHAR2 item or display item. PROCEDURE GO_ITEM (item_name VARCHAR2). GO_ITEM cannot be used to navigate to an item in a different block. Built-in Type restricted procedure Enter Query Mode yes Parameters item_id item_name Specifies the unique ID that Form Builder assigns to the item when created. Specifies the string you defined as the name of the item at design time.

Also see FIRST_RECORD and ** LAST_RECORD built-ins. This includes values derived from calls to system variables.TRIGGER_RECORD) + 8. Form Builder fetches additional records to satisfy the call to this built-in.
GO_RECORD examples
/* ** Built-in: GO_RECORD ** Example: Navigate to a record in the current block ** by record number.
GO_RECORD restrictions
• If the query is open and the specified record number is greater than the number of records already fetched. Built-in Type restricted procedure Enter Query Mode no Parameters record_number Specifies any integer value that PL/SQL can evaluate to a number. Syntax PROCEDURE GO_RECORD (record_number NUMBER).
247
. END.TRIGGER_RECORD to determine a record’s sequence number.GO_RECORD built-in
Description Navigates to the record with the specified record number. You can use the system variables SYSTEM. such as TO_NUMBER(:SYSTEM. */ BEGIN Go_Record( :control.last_record_number ).CURSOR_RECORD or SYSTEM.

Built-in Type unrestricted procedure Enter Query Mode yes Parameters none
HIDE_MENU examples
/* ** Built-in: HIDE_MENU ** Example: Hides the menu from view on character-mode or ** block-mode devices */ BEGIN Hide_Menu. makes the current menu disappear if it is currently displayed.HIDE_MENU built-in
Description On character mode platforms.
249
. uncovering any part of the form display that the menu had covered. END. Syntax PROCEDURE HIDE_MENU. The menu will redisplay if the SHOW_MENU built-in is invoked or the operator presses [Menu].

/*
251
. Built-in Type unrestricted procedure Enter Query Mode yes Parameters window_id Specifies the unique ID that Form Builder assigns the window at the time it creates it. Specifies the name that you gave the window when creating it. or else that window ** will automatically be re-displayed by forms ** since it has input focus. dest_item VARCHAR2 ) IS rg_id RecordGroup. To ** establish this window hierarchy we might define ** a static record group in the form called ** ’WINDOW_HIERARCHY’ with a structure of: ** ** Parent_Window Child_Window ** ------------------------** MAIN DETAIL1 ** MAIN DETAIL2 ** DETAIL1 DETAIL3 ** DETAIL1 DETAIL4 ** DETAIL2 DETAIL5 ** DETAIL3 DETAIL6 ** ** We also have to make sure we navigate to some ** item not on any of the canvases shown in the ** windows we are closing. */ PROCEDURE Close_Window( wn_name VARCHAR2. gc_child GroupColumn. the_Rowcount NUMBER. gc_parent GroupColumn. Use the FIND_WINDOW built-in to return the ID to an appropriately typed variable. HIDE_WINDOW is equivalent to setting VISIBLE to No by calling SET_WINDOW_PROPERTY. Syntax PROCEDURE HIDE_WINDOW (window_id Window). hide other ** "subordinate" windows automatically. PROCEDURE HIDE_WINDOW (window_name VARCHAR2).
window_name
HIDE_WINDOW examples
/* ** Built-in: HIDE_WINDOW ** Example: When a main window is closed. The data type of the ID is Window.HIDE_WINDOW built-in
Description Hides the given window.

On Microsoft Windows NT.
VARCHAR2).
screen_actioSpecifies one of the following constants: no parameter Specifies that Form Builder will: clear the screen prompt the operator to return from the command NO_PROMPT Specifies that Form Builder will: clear the screen (does not prompt the operator to return from the command) NO_SCREEN Specifies that Form Builder will: not clear the screen not prompt the operator to return from the system command (The HOST command should not send output to the screen when using the NO_SCREEN parameter. where the output of the Host command is displayed in the same window as the form. be sure to check for the operating system and pass the appropriate command string. 32-bit applications and OS commands will correctly return TRUE if executed sucessfully and FALSE if failed. the output of the Host command is displayed in a separate window. This is a Microsoft Win32 issue. • Note that the command interpreter for Microsoft Windows NT is cmd. Before using the HOST built-in to run an external command.HOST built-in
Description Executes an indicated operating system command. VARCHAR2. Invalid commands will return FALSE.
•
253
. NUMBER). while on Windows 95 it is command.) Usage notes
•
Thescreen_action parameter is only relevant to applications running in character mode. In GUI applications. the FORM_SUCCESS built-in will return TRUE whether the application succeeds or fails. when using HOST to execute a 16-bit application. Syntax PROCEDURE HOST (system_command_string PROCEDURE HOST (system_command_string screen_action Built-in Type unrestricted procedure Enter Query Mode yes Parameters system_command_ string Specifies the system command you want to pass to your particular operating system.

proceed to create it.• • • • • • • • • Usage Notes
Item LOV MenuItem ParamList RecordGroup Relation Timer Viewport Window
Use ID_NULL when you want to check for the existence of an object created dynamically at runtime. Use ID_NULL to check whether an object with that ID already exists. you will receive an error message if you try to create that record group. To perform this check. then you need to reissue the appropriate FIND_ every time -.once preceding each use of ID_NULL. more than once during a run). If the object does not exist. if a specific record group already exists. For example. follow this general process: • • • Use the appropriate FIND_ built-in to obtain the object ID.
If you are going to test for an object’s existence at various times (that is.
ID_NULL examples
See CREATE_GROUP
256
.

0. PROCEDURE IMAGE_SCROLL (item_id ITEM.
257
. Y NUMBER ).IMAGE_SCROLL built-in
Description Scrolls the image item as close to the specified offset (the X. and the item coordinates are 0. This is useful if the image is bigger than the image item. that is. Y NUMBER ). X NUMBER. the image coordinates are 0. which offsets the image so that it is displayed from its coordinates of 50 to 150. To roughly center the image. you can set IMAGE_SCROLL X.
Built-in Type unrestricted procedure Enter Query Mode yes Parameters item_id item_name X Y Specifies the unique ID Form Builder assigns when it creates the image item. 200. Y coordinates to 50. The X coordinate of the offset. Specifies the name you gave the image when defining it. 100. The Y coordinate of the offset.
IMAGE_SCROLL examples
For example. This sets the top left corner of the item at 50 50 instead of 0. X NUMBER. suppose the image is twice the size of the image item.Y coordinates) as possible. Syntax PROCEDURE IMAGE_SCROLL (item_name VARCHAR2. 50.

Syntax PROCEDURE IMAGE_ZOOM (image_id ITEM. PROCEDURE IMAGE_ZOOM (image_name VARCHAR2. zoom_type NUMBER). Specify one of the following constants to describe the effect you want to have on the image displayed: ADJUST_TO_FIT Scales the image to fit within the display rectangle: the entire image is visible and the image fills as much of the image item as possible without distorting the image. Supply a whole number for this argument. zoom_factor Usage Notes • Check zoom_factor for reasonableness. The data type of the ID is ITEM. Specifies the name you gave the image when defining it. SELECTION_RECTANGLE Scales the image so the selected region fully fills the image item. (image_id zoom_type NUMBER. zoom_type NUMBER).IMAGE_ZOOM built-in
Description Zooms the image in or out using the effect specified in zoom_type and the amount specified in zoom_factor. ZOOM_PERCENT Scales the image to the percentage indicated in zoom_factor.
258
. For example. specifying a ZOOM_IN_FACTOR of 100 Specifies either the factor or the percentage to which you want the image zoomed. PROCEDURE IMAGE_ZOOM (image_name VARCHAR2. zoom_type NUMBER. PROCEDURE IMAGE_ZOOM ITEM. Built-in Type unrestricted procedure Enter Query Mode yes Parameters image_id image_name zoom_type Specifies the unique ID Form Builder assigns when it creates the image item. zoom_factor NUMBER). zoom_factor NUMBER). ZOOM_OUT_FACTOR Reduces the image by the zoom_factor. ZOOM_IN_FACTOR Enlarges the image by the zoom_factor.

259
. 4. To enlarge the image. zoom_in_factor. When specifying ZOOM_PERCENT. specify a percentage greater than 100. The operator must use the mouse to select a region before specifying SELECTION_RECTANGLE. or 8. Your design should include scroll bars on images that use SELECTION_RECTANGLE.would increase the size of your image 100 times. Valid for both color and black-and-white images. or Form Builder will return an error message. but performance is optimal if you use 2. and could cause your application to run out of memory. you can use any positive integer value for zoom_factor.
IMAGE_ZOOM examples
The following example shows a When-Button-Pressed trigger that doubles the size of the image every time the button is pressed. Image_Zoom(’my_image’. • • • • • When specifying ZOOM_IN_FACTOR or ZOOM_OUT_FACTOR. 2 ). you can use any positive integer value for zoom_factor.

Built-in Type unrestricted procedure Parameters num_args Number of arguments that are to be passed to the method -. It is not necessary to use INIT_OLEARGS before a GET_OLE_* call if that call does not take OLE parameters.
•
•
•
260
. but does no harm in the latter case. Note that the number specified in num_args should be one more than the number of actual arguments. This built-in and ADD_OLEARG would also be used to prepare for GET_OLE_* calls if the property is accessed (for example. not for CALL_OLE. set num_arg to be five ). (Thus.INIT_OLEARGS built-in
Description Establishes how many arguments are going to be defined and passed to the OLE object’s method. This increase is required only in preparation for GET_OLE_* calls.plus one. if four arguments are to be passed. with an index). Syntax PROCEDURE INIT_OLEARGS (num_args NUMBER).
Usage Notes
•
This built-in should be called before establishing the arguments’ types and values with ADD_OLEARG.

’c:\OLE\oleobj.
item_name file_name
INITIALIZE_CONTAINER restrictions
Valid only on Microsoft Windows and Macintosh. END. Include the path of the file location. IF Id_Null(item_id) THEN message(’No such item: ’||item_name). ** trigger: When-Button-Pressed */ DECLARE item_id ITEM. END IF. Specifies the name of the file containing the object for insertion into an OLE container. file_name VARCHAR2).xls’).INITIALIZE_CONTAINER built-in
Description Inserts an OLE object from a server-compatible file into an OLE container. ELSE Initialize_Container(item_id. The data type of the name is VARCHAR2 string. BEGIN item_id := Find_Item(item_name).
261
. Specifies the name of the object created at design time. item_name VARCHAR(25) := ’OLEITM’. file_name VARCHAR2). Use the FIND_ITEM built-in to return the ID to an appropriately typed variable. PROCEDURE INITIALIZE_CONTAINER (item_name VARCHAR2. Built-in Type unrestricted procedure Enter Query Mode no Parameters item_id Specifies the unique ID that Form Builder assigns to the item when created. Syntax PROCEDURE INITIALIZE_CONTAINER (item_id Item. The data type of the ID is Item.
INITIALIZE_CONTAINER examples
/* Built-in: INITIALIZE_CONTAINER ** Example: Initializes an OLE container by inserting an object ** from a specified file into an OLE container.

/* ** Otherwise. ** trigger: On-Insert */ BEGIN /* ** Check the global flag we setup at form startup */ IF :Global. perhaps based on a parameter.Using_Transactional_Triggers = ’TRUE’ THEN User_Exit(’my_insrec block=EMP’). do the right thing. END. Syntax PROCEDURE INSERT_RECORD.INSERT_RECORD built-in
Description When called from an On-Insert trigger. This built-in is included primarily for applications that will run against a non-ORACLE datasource. Built-in Type restricted procedure Enter Query Mode no Parameters none
INSERT_RECORD restrictions
Valid only in an On-Insert trigger. inserts the current record into the database during Post and Commit Transactions processing.
INSERT_RECORD examples
/* ** Built-in: INSERT_RECORD ** Example : Perform Form Builder standard insert processing ** based on a global flag setup at startup by the ** form.
262
. END IF. */ ELSE Insert_Record.

** trigger: On-Rollback */ DECLARE sp_name VARCHAR2(80).ISSUE_ROLLBACK built-in
Description When called from an On-Rollback trigger. (NULL = Full Rollback) */ sp_name := Get_Application_Property(SAVEPOINT_NAME).
ISSUE_ROLLBACK examples
/* ** Built-in: ISSUE_ROLLBACK ** Example: Perform Form Builder standard Rollback processing. ** perhaps based on a parameter. BEGIN /* ** Get name of the savepoint to which Form Builder needs to ** rollback. Syntax PROCEDURE ISSUE_ROLLBACK (savepoint_name VARCHAR2).
ISSUE_ROLLBACK restrictions
Results are unpredictable when ISSUE_ROLLBACK is used outside an On-Rollback trigger or when used with a savepoint other than that provided by a call to GET_APPLICATION_PROPERTY(SAVEPOINT_NAME).Using_Transactional_Triggers = ’TRUE’ THEN User_Exit(’my_rollbk name=’||sp_name).
263
. END. initiates the default Form Builder processing for rolling back to the indicated savepoint. ELSE Issue_Rollback(sp_name). A null savepoint_name causes a full rollback. END IF. /* ** Check the global flag we setup at form startup */ IF :Global. Built-in Type unrestricted procedure Enter Query Mode no Parameters savepoint name Name of the savepoint to which you want to rollback. ** Decide whether to use this built-in based on a ** global flag setup at startup by the form. This built-in is included primarily for applications that will run against a nonORACLE data source.

ISSUE_SAVEPOINT initiates the default processing for issuing a savepoint. /* Check the global flag we setup at form startup */ IF :Global. if no On-Savepoint trigger were present. Syntax PROCEDURE ISSUE_SAVEPOINT (savepoint_name VARCHAR2). You can use GET_APPLICATION_PROPERTY (SAVEPOINT_NAME) to determine the name of the savepoint that Form Builder would be issuing by default. Doing so may cause a conflict with savepoints issued by Form Builder. END IF. BEGIN /* Get the name of the savepoint Form Builder needs to issue */ sp_name := Get_Application_Property(SAVEPOINT_NAME). ** Decide whether to use this built-in based on a ** global flag setup at startup by the form. unless the savepoint name was provided by a call to GET_APPLICATION_PROPERTY.ISSUE_SAVEPOINT built-in
Description When called from an On-Savepoint trigger. ** perhaps based on a parameter. Built-in Type unrestricted procedure Enter Query Mode no Parameters savepoint _name Name of the savepoint you want to be issued
ISSUE_SAVEPOINT restrictions
Never issue a savepoint with the name FM_<number>. /* Otherwise.
ISSUE_SAVEPOINT examples
/* ** Built-in: ISSUE_SAVEPOINT ** Example: Perform Form Builder standard savepoint processing.
264
. ** trigger: On-Savepoint */ DECLARE sp_name VARCHAR2(80).Using_Transactional_Triggers = ’TRUE’ THEN User_Exit(’my_savept name=’||sp_name). */ ELSE Issue_Savepoint(sp_name). do the right thing. This built-in is included primarily for applications that will run against a non-ORACLE datasource.

if the error was a PL/SQL exception. Built-in Type unrestricted function Returns number Parameters None Usage Notes
•
This function can be used for most error conditions. For more information about error values and their meanings.h. refer to winerror.LAST_OLE_ERROR built-in
Description Returns the identifying number of the most recent OLE error condition Syntax FUNCTION LAST_OLE_ERROR RETURN number. Winerror. use the LAST_OLE_EXCEPTION function instead. However.h is supplied by your C compiler vendor.
•
267
.

description OUT VARCHAR2. Syntax FUNCTION LAST_OLE_EXCEPTION (source OUT VARCHAR2. helpfile OUT VARCHAR2. use the LAST_OLE_ERROR function. Error message text. ID of a specific document in the above help file. For information about other types of errors (not PL/SQL exceptions).
Usage Notes This function can be used after a PL/SQL FORM_OLE_FAILURE exception has occurred as a result of calling an OLE object server. Name of the file in which the OLE server has additional error information. Built-in Type unrestricted function Returns error number that the OLE server assigned to this exception condition Parameters source description helpfile helpcontextid Name of the OLE server that raised the exception condition. helpcontextid OUT PLS_INTEGER) RETURN errornumber PLS_INTEGER.LAST_OLE_EXCEPTION built-in
Description Returns the identifying number of the most recent OLE exception that occurred in the called object.
268
.

Form Builder fetches the remaining selected records into the block’s list of records. Syntax PROCEDURE LAST_RECORD. and closes the query. If a query is open in the block. Built-in Type restricted procedure Enter Query Mode no Parameters none
LAST_RECORD examples
See FIRST_RECORD
269
.LAST_RECORD built-in
Description Navigates to the last record in the block’s list of records.

If the text item contains a value.LIST_VALUES built-in
Description LIST_VALUES displays the list of values for the current item. but automatically reads the correct value into the field. an LOV evaluates a text item’s current value as a search value. LIST_VALUES uses the NO_RESTRICT parameter. RESTRICT Specifies that Form Builder will use the automatic search and complete feature. This parameter causes Form Builder not to use the automatic search and complete feature. Form Builder automatically uses that value as if the operator had entered the value into the LOV’s search field and pressed [List] to narrow the list. as long as the input focus is in a text item that has an attached LOV. If you use the RESTRICT parameter. Built-in Type restricted procedure Enter Query Mode no Parameters kwd Specifies one of the following constants: NO_RESTRICT Specifies that Form Builder will not use the automatic search and complete feature. By default. Form Builder does not display the LOV. if an operator presses [List] in a text item that has an LOV. The list of values remains displayed until the operator dismisses the LOV or selects a value. That is. Form Builder checks to see if the item contains a value. If the item value would narrow the list to only one value. Syntax PROCEDURE LIST_VALUES (kwd NUMBER). Form Builder uses the automatic search and complete feature. Automatic Search and Complete Feature With the automatic search and complete feature.
270
.

END. */ ELSE Lock_Record. Syntax PROCEDURE LOCK_RECORD.
271
. regardless of whether the Locking Mode block property is set to Immediate (the default) or Delayed. The following example illustrates this technique. ** trigger: On-Lock */ BEGIN /* ** Check the global flag we set up at form startup */ IF :Global. LOCK_RECORD initiates default database locking. Decide whether to use default ** processing or a user exit by consulting a ** global flag setup at startup by the form. Built-in Type unrestricted procedure Enter Query Mode no Parameters none
LOCK_RECORD examples
/* ** Built-in: LOCK_RECORD ** Example: Perform Form Builder standard record locking on the ** queried record which has just been deleted or ** updated. END IF. LOCK_RECORD locks the record immediately. ** perhaps based on a parameter.Non_Oracle_Datasource = ’TRUE’ THEN User_Exit(’my_lockrec block=EMP’). /* ** Otherwise. do the right thing. When executed from within an On-Lock trigger.LOCK_RECORD built-in
Description Attempts to lock the row in the database that corresponds to the current record.

When logon_screen_on_error is set to FALSE and the logon fails.
LOGON examples
/* ** Built-in: ** Example: ** LOGON Perform Form Builder standard logon to the ORACLE database. Syntax PROCEDURE LOGON (username VARCHAR2. VARCHAR2). PROCEDURE LOGON (username password logon_screen_on_error Built-in Type unrestricted procedure Enter Query Mode yes Parameters This built-in takes the following arguments: username password logon_screen_ on_error Any valid username of up to 80 characters.. the logon screen will not display and FORM_FAILURE is set to TRUE so the designer can handle the condition in an appropriate manner. However. password VARCHAR2). VARCHAR2.name and the database name for the password. when set to TRUE (default). including a database connect string. database links may be used to access multiple databases with a single connection. causes Form Builder to automatically display the logon screen if the logon specified fails (usually because of a incorrect username/password). Decide whether to use Form Builder
272
. a SQL*Net connection to that database must exist at runtime.
VARCHAR2. Form Builder can connect to only one database at a time.LOGON built-in
Description Performs the default Form Builder logon processing with an indicated username and password.
Usage Notes: When using LOGON to connect to an OPS$ database use a slash ’/’ for the user. Call this procedure from an On-Logon trigger when you want to augment default logon processing. Any valid password of up to 80 characters. An optional BOOLEAN parameter that.
LOGON restrictions
• • If you identify a remote database.

** perhaps based on a parameter.** built-in processing or a user exit by consulting a ** global flag setup at startup by the form.pw). END IF. END IF IF cn IS NOT NULL THEN LOGON(un. call the LOGON built-in */ ELSE /* ** Use the following to place a slash in the username field for OPS$ logon */ IF un IS NULL THEN un:=’/’. /* ** Otherwise. */ IF :Global. END. END IF. pw VARCHAR2(80). /* ** If at startup we set the flag to tell our form that we ** are not running against ORACLE.pw.cn). cn VARCHAR2(80). ELSE LOGON(un.Non_Oracle_Datasource = ’TRUE’ THEN User_Exit(’my_logon username=’||un||’ password=’||pw).pw||’@’||cn). BEGIN /* ** Get the connection info */ Get_Connect_Info(un. This example ** uses the ’Get_Connect_Info’ procedure from the ** GET_APPLICATION_PROPERTY example.
273
. then call our ** appropriate MY_LOGON userexit to logon. ** trigger: On-Logon */ DECLARE un VARCHAR2(80).

All open cursors are automatically closed when you issue a call to the LOGOUT built-in. /* ** Otherwise. If you LOGOUT of a multiple-form application with multiple connections. Decide ** whether to use Form Builder built-in processing or a ** user exit by consulting a global flag setup at ** startup by the form. ** trigger: On-Logout */ BEGIN /* ** Check the flag we setup at form startup */ IF :Global.
276
.Non_Oracle_Datasource = ’TRUE’ THEN User_Exit(’my_logout’). Form Builder tries to reestablish all of those connections when you subsequently execute LOGON. */ ELSE Logout. Syntax PROCEDURE LOGOUT. You can programmatically log back on with LOGON. do the right thing. perhaps based on a ** parameter. Built-in Type unrestricted procedure Enter Query Mode yes Parameters none
LOGOUT examples
/* ** Built-in: LOGOUT ** Example: Perform Form Builder standard logout. END IF.LOGOUT built-in
Description Disconnects the application from the ORACLE RDBMS.

277
. Syntax PROCEDURE MENU_CLEAR_FIELD. MENU_CLEAR_FIELD clears the entire field.MENU_CLEAR_FIELD built-in
Description MENU_CLEAR_FIELD clears the current field’s value from the current cursor position to the end of the field. If the current cursor position is to the right of the last nonblank character. making its value NULL. Built-in Type unrestricted procedure Enter Query Mode yes Parameters none
MENU_CLEAR_FIELD restrictions
The Enter Parameter Values dialog must be displayed.

MESSAGE examples
/* ** Built-in: MESSAGE ** Example: Display several messages to the command line ** throughout the progress of a particular ** subprogram.. Specifies one of the following constants: ACKNOWLEDGE Specifies that Form Builder is to display a modal alert that the operator must dismiss explicitly. NUMBER). (0%)’. ACKNOWLEDGE forces the first message to be acknowledged before the second message can be displayed.MESSAGE built-in
Description Displays specified text on the message line. whenever two consecutive messages are issued. however.
Built-in Type unrestricted procedure Enter Query Mode yes Parameters message_string user_response Specify a character string enclosed in single quotes or a variable of VARCHAR2 data type.
283
. ** we can avoid the operator’s having to ** acknowledge each message explicitly. the operator is not expected to respond to the first message displayed before Form Builder displays a second message. Using NO_ACKNOWLEDGE creates a risk that the operator may not see the first message. Syntax PROCEDURE MESSAGE (message_string user_response
VARCHAR2.. including the current font and the limitations of the runtime window manager. */ PROCEDURE Do_Large_Series_Of_Updates IS BEGIN Message(’Working. NO_ACKNOWLEDGE Specifies that. By using the NO_ACKNOWLEDGE parameter. Note. This is the default.
MESSAGE restrictions
The message_string can be up to 200 characters long. that several factors affect the maximum number of characters that can be displayed. because the second message immediately overwrites it without prompting the operator for acknowledgement. NO_ACKNOWLEDGE). when two consecutive messages are issued.

msgtyp VARCHAR2(3) := MESSAGE_TYPE. BEGIN IF msgnum = 40400 THEN Message(’Your changes have been made permanent.’).MESSAGE_TYPE ** Example: Reword certain FRM message messages by checking ** the Message_Code in an ON-MESSAGE trigger ** trigger: On-Message */ DECLARE msgnum NUMBER := MESSAGE_CODE.g. END IF. ELSE /* ** Print the Normal Message that would have appeared ** ** FRM-12345: Message Text Goes Here */ Message(msgtyp||’-’||TO_CHAR(msgnum)||’: ’||msgtxt). before Form Builder generates any messages. Built-in Type unrestricted function Returns NUMBER Enter Query Mode yes Parameters none
MESSAGE_CODE examples
/* ** Built-in: MESSAGE_CODE. Refer to the Messages appendix for a list of messages and message numbers.
285
. MESSAGE_CODE returns zero at the beginning of a session.’).MESSAGE_TEXT. Syntax FUNCTION MESSAGE_CODE. Use MESSAGE_CODE to test the outcome of a user action (e. END. ELSIF msgnum = 40401 THEN Message(’You have no unsaved changes outstanding. pressing a key) to determine processing within an On-Message trigger. msgtxt VARCHAR2(80) := MESSAGE_TEXT.MESSAGE_CODE built-in
Description Returns a message number for the message that Form Builder most recently generated during the current Runform session..

MESSAGE_TEXT returns NULL at the beginning of a session. msgtxt VARCHAR2(80) := MESSAGE_TEXT. Referencing message codes rather than message text is particularly useful in applications that provide national language support.MESSAGE_TEXT. before Form Builder generates any messages. Use MESSAGE_TEXT to test the outcome of a user action (e. Syntax FUNCTION MESSAGE_TEXT..’).g.MESSAGE_TEXT built-in
Description Returns message text for the message that Form Builder most recently generated during the current Runform session. ELSIF msgnum = 40401 THEN Message(’You have no unsaved changes outstanding. Built-in Type unrestricted function Returns VARCHAR2 Enter Query Mode yes Parameters none
MESSAGE_TEXT examples
/* ** Built-in: MESSAGE_CODE. use the MESSAGE_CODE built-in instead of the MESSAGE_TEXT built-in. pressing a key) to determine processing within an On-Message trigger. Note: If your applications must be supported in more than one language.
286
. ELSE /* ** Print the Normal Message that would have appeared ** ** FRM-12345: Message Text Goes Here */ Message(msgtyp||’-’||TO_CHAR(msgnum)||’: ’||msgtxt).’). BEGIN IF msgnum = 40400 THEN Message(’Your changes have been made permanent. END. END IF.MESSAGE_TYPE ** Example: Reword certain FRM message messages by checking ** the Message_Code in an ON-MESSAGE trigger ** trigger: On-Message */ DECLARE msgnum NUMBER := MESSAGE_CODE. msgtyp VARCHAR2(3) := MESSAGE_TYPE.

Indicates that Form Builder has not yet issued any messages during the session. BEGIN IF msgnum = 40400 THEN Message(’Your changes have been made permanent. ELSE /* ** Print the Normal Message that would have appeared ** ** FRM-12345: Message Text Goes Here */ Message(msgtyp||’-’||TO_CHAR(msgnum)||’: ’||msgtxt).
287
. ELSIF msgnum = 40401 THEN Message(’You have no unsaved changes outstanding.g. Built-in Type unrestricted function Returns VARCHAR2 MESSAGE_TYPE returns one of three values for the message type: FRM ORA NULL Enter Query Mode yes Parameters none Indicates that an Form Builder message was generated.
MESSAGE_TYPE examples
/* ** Built-in: MESSAGE_CODE.MESSAGE_TYPE built-in
Description Returns a message type for the message that Form Builder most recently generated during the current Runform session. Use MESSAGE_TYPE to test the outcome of a user action (e.MESSAGE_TEXT. msgtyp VARCHAR2(3) := MESSAGE_TYPE.MESSAGE_TYPE ** Example: Reword certain FRM message messages by checking ** the Message_Code in an ON-MESSAGE trigger ** trigger: On-Message */ DECLARE msgnum NUMBER := MESSAGE_CODE. pressing a key) to determine processing within an On-Message trigger. Indicates that an ORACLE message was generated. msgtxt VARCHAR2(80) := MESSAGE_TEXT. END IF..’).’). Syntax FUNCTION MESSAGE_TYPE.

END.
288
.

x NUMBER. Syntax FUNCTION MOVE_WINDOW (window_id Window. Built-in Type unrestricted function Enter Query Mode yes Parameters window_id Specifies the unique ID that Form Builder assigns the window when created. */ PROCEDURE Anchor_Bottom_Right2( Window2 VARCHAR2. BEGIN /* ** Find Window1 and get its (x.MOVE_WINDOW built-in
Description Moves the given window to the location specified by the given coordinates. FUNCTION MOVE_WINDOW (window_name VARCHAR2. centimeters.
window_name x y
MOVE_WINDOW examples
/* ** Built-in: MOVE_WINDOW ** Example: Move window2 to be anchored at the bottom right ** corner of window1. NUMBER. then your x. If you have specified the form property Coordinate System as Character. then your x. w NUMBER. y NUMBER). y coordinates are specified in characters. or points. wn_id2 Window. y coordinates are specified in the real units you have selected--pixels. If the Coordinate System is specified as Real.y) position. h NUMBER. Specifies the x coordinate on the screen where you want to place the upper left corner of a window. x NUMBER. Window1 VARCHAR2) IS wn_id1 Window. x y NUMBER). Use the FIND_WINDOW built-in to return the ID to an appropriately typed variable. inches. y NUMBER. The data type of the ID is Window. Specifies the y coordinate on the screen where you want to place the upper left corner of a window. width. Specifies the name that you gave the window when creating it. and
289
.

<stackname>nnn ** where ’nnn’ is the number of the element on the ** stack. If you nest the NAME_IN function.
NAME_IN examples
/* ** Built-in: NAME_IN ** Example: Simple implementation of a Last-In-First-Out ** stack mechanism using Global variables. you can use NAME_IN to return numbers and dates as character strings and then convert those strings to the appropriate data types. ** ** str_var := Pop(’MYSTACKNAME’). -. PUSH increments this ** value as new elements are added. Form Builder evaluates the individual NAME_IN functions from the innermost one to the outermost one.Gets ’EOS’
291
. ** ** Usage: ** Push(’MYSTACKNAME’.Gets ’2’ ** str_var := Pop(’MYSTACKNAME’). Syntax FUNCTION NAME_IN (variable_name
VARCHAR2). Values ** PUSH’ed on or POP’ed off the named stack are ** actually stored in GLOBAL variables of a ** conveniently formed name: GLOBAL. ’2’). However.<stackname>_PTR points to the largest ** element on the stack. The returned value is in the form of a character string.NAME_IN built-in
Description Returns the value of the indicated variable. ** Push(’MYSTACKNAME’.
Built-in Type unrestricted function Returns VARCHAR2 Enter Query Mode yes Parameters variable_name Usage Notes If the returned value is a date string. -. -. Specifies a valid variable or text item. ** For each named stack. ’1’). You can use the returned value as you would use any value within an executable statement. a global variable ** GLOBAL. If the DATE_FORMAT_COMPATIBILITY_MODE property is set to 4. The data type of the name is VARCHAR2. NAME_IN will use the format mask specified in the BUILTIN_DATE_FORMAT property.5 the default American format is used to format the returned string.Gets ’1’ ** str_var := Pop(’MYSTACKNAME’).

*/ Default_Value( NULL. /* ** If the index is non-zero.<stackname><cur_idx> ** (2) Get the value of the (cur_idx)-th element to ** return ** (3) Decrement the stack pointer ** (4) Erase the global variable which was used for ** value storage */ ELSE elt_name:= prefix || cur_idx. /* ** Force a default value of NULL so we can test if the ** pointer exists (as a global variable).*/ prefix := ’GLOBAL.<stackname>_PTR Remember that this is the *name* ** of the pointer. ptr_name ). /* ** Otherwise. then: ** (1) Determine the name of the global variable in ** which the value to be POP’ed is stored. ** ** Note that a stack can only be empty if some values ** have been PUSH’ed and then all values subsequently ** POP’ed. Erase( elt_name ). /* ** If the *value* contained in the pointer is NULL. */ ELSE cur_idx := Name_In( ptr_name ) . Get the ** index of the largest stack element from this stack’s ** pointer. then the named stack is already ** empty. ** GLOBAL.1 ) .
293
. Return the constant ** NO_SUCH_STACK in this case and erase the global ** variable that the Default_Value implicitly created. */ ptr_name := prefix || ’_PTR’. then ** the pointer must not have existed prior to the ** Default_Value statement above. we can test in a moment for the NULL. and avoid ** the typical error due to referencing non-existent ** global variables. then no associated stack pointer would have ** been created. */ IF cur_idx = ’0’ THEN the_val := EMPTY_STACK. the named stack already exists. */ IF Name_In( ptr_name ) IS NULL THEN the_val := NO_SUCH_STACK. /* ** This named stack’s pointer resides in ** GLOBAL. Copy( new_idx . If it does not ** exist. new_idx := TO_CHAR( TO_NUMBER( Name_In(ptr_name) ) . so return the constant EMPTY_STACK. Erase( ptr_name ). ptr_name ).’ || the_stackname. and leave ** the stack’s pointer around for later use. the_val := Name_In( elt_name ). /* ** If the index is zero. If no values were ever PUSH’ed on this named ** stack. and we would flag that error with the ** NO_SUCH_STACK case above. ie don’t ** ERASE it.

END IF.
294
. END. RETURN the_val. END IF.

VARCHAR2. NUMBER. Form Builder runs the new form with the same options as the parent form. NUMBER. NUMBER. NUMBER. NUMBER. VARCHAR2. If the parent form was a called form. NUMBER. Syntax PROCEDURE NEW_FORM (formmodule_name PROCEDURE NEW_FORM (formmodule_name rollback_mode PROCEDURE NEW_FORM (formmodule_name rollback_mode query_mode PROCEDURE NEW_FORM (formmodule_name rollback_mode query_mode data_mode PROCEDURE NEW_FORM (formmodule_name rollback_mode query_mode paramlist_id PROCEDURE NEW_FORM (formmodule_name rollback_mode query_mode paramlist_name PROCEDURE NEW_FORM (formmodule_name rollback_mode query_mode data_mode paramlist_id PROCEDURE NEW_FORM (formmodule_name rollback_mode query_mode data_mode paramlist_name
VARCHAR2). Form Builder runs the new form with the same Runform options as the parent form. NUMBER. VARCHAR2. The calling form is terminated as the parent form. VARCHAR2. VARCHAR2. NUMBER. Form Builder keeps the higher call active and treats it as a call to the new form. NUMBER). NUMBER). PARAMLIST). VARCHAR2. NUMBER. NUMBER). NUMBER. VARCHAR2). If the calling form had been called by a higher form. NUMBER. NUMBER.
Built-in Type restricted procedure Enter Query Mode no Parameters
295
. PARAMLIST).NEW_FORM built-in
Description Exits the current form and enters the indicated form. Form Builder releases memory (such as database cursors) that the terminated form was using. VARCHAR2. NUMBER. VARCHAR2).

To avoid losing the locks issued by the calling form. Datatype is VARCHAR2. FULL_ROLLBACK Form Builder rolls back all uncommitted changes (including posted changes) that were made during the current Runform session.formmodule_name rollback_mode
Then name of the called form (must be enclosed in single quotes). */ PROCEDURE GENERIC_CALL(formname VARCHAR2. Form Builder will share data between forms that have identical libraries attached (at design time).)
query_mode
NO_QUERY_ONLY (The default. Datatype is VARCHAR2.
paramlist_name
NEW_FORM examples
/* Create a generic procedure that will invoke the ** formname passed-in using the method indicated by ** the ’newform’ and ’queryonly’ parameters.
296
. A parameter list passed to a form via NEW_FORM cannot contain parameters of type DATA_PARAMETER (a pointer to record group). QUERY_ONLY Runs the indicated form in query-only mode.) At runtime. which means that you retain any locks across a NEW_FORM operation. Specify a parameter list when you want to pass parameters from the calling form to the new form.) Form Builder will roll back all uncommitted changes (including posted changes) to the current form’s savepoint. end users can query records. SHARE_LIBRARY_DATA At runtime. EXCEPTION. The locks are still in effect when you regain control from Form Builder. (Post-only mode can occur when your form issues a call to another form while unposted records exist in the calling form. updates or deletes. These locks can also occur when invoking Form Builder from an external 3GL program. You can leave the top level form without performing a rollback.
paramlist_id
The unique ID Form Builder assigns when it creates the parameter list. newform VARCHAR2. NO_ROLLBACK Form Builder will exit the current form without rolling back to a savepoint. allowing the end user to perform inserts. Form Builder prevents any commit processing in the called form. The name you gave the parameter list object when you defined it. Datatype is PARAMLIST. updates. TO_SAVEPOINT (The default.) Runs the indicated form normally. queryonly VARCHAR2) IS msglvl error_occurred BEGIN VARCHAR2(2). but cannot perform inserts. You cannot specify a FULL_ROLLBACK from a form that is running in post-only mode. and deletes in the form.
data_mode
NO_SHARE_LIBRARY_DATA (The default. A parameter list passed to a form via NEW_FORM cannot contain parameters of type DATA_PARAMETER (a pointer to record group). Form Builder will not share data between forms that have identical libraries attached (at design time).

LAST_ITEM). However.
298
. cur_blk VARCHAR2(80) := :System.’||Get_Block_Property(cur_blk. the Next Navigation Block block property can be set to specify a different block as the next block for navigation purposes. Syntax PROCEDURE NEXT_BLOCK.NEXT_BLOCK built-in
Description Navigates to the first navigable item in the next enterable block in the navigation sequence. BEGIN lst_itm := cur_blk||’. then skip to the next block instead of ** the default of going back to the first item in ** the same block ** trigger: Key-Next-Item */ DECLARE cur_itm VARCHAR2(80) := :System. END IF. END. Built-in Type restricted procedure Enter Query Mode no Parameters none
NEXT_BLOCK examples
/* ** Built-in: NEXT_BLOCK ** Example: If the current item is the last item in the ** block. NEXT_BLOCK navigates to the enterable block with the lowest sequence number. IF cur_itm = lst_itm THEN Next_Block.Cursor_Block. the next block in the navigation sequence is the block with the next higher sequence number. If there is no enterable block with a higher sequence. By default.Cursor_Item. ELSE Next_Item. as defined by the order of blocks in the Object Navigator. lst_itm VARCHAR2(80).

When navigating with NEXT_FORM.NEXT_FORM built-in
Description In a multiple-form application. and WHEN-WINDOWACTIVATED. (Forms are sequenced in the order they were invoked at runtime. which fires for the target form. Syntax PROCEDURE NEXT_FORM. navigates to the independent form with the next highest sequence number. the current form remains current. which fires for the form that initiates navigation. NEXT_FORM navigates to the form with the lowest sequence number. Built-in Type restricted procedure Enter Query Mode no
NEXT_FORM restrictions
The target form cannot be a form that is currently disabled as a result of having invoked another form with CALL_FORM. no validation occurs and no triggers fire except WHENWINDOW-DEACTIVATED.) If there is no form with a higher sequence number. If there is no such form.
299
.

Change Record: A Next Item operation from a block’s last item moves the input focus to the first navigable item in the block. If there is no such item. The function of NEXT_ITEM from the last navigable item in the block depends on the setting of the Navigation Style block property. Syntax PROCEDURE NEXT_ITEM. Oracle forms retrieves additional records as needed. NEXT_ITEM validates any fields with sequence numbers greater than the current item or less than the target item. If there is an open query in the block (the block contains queried records). Change Block: A Next Item operation from a block’s last item moves the input focus to the first navigable item in the first record of the next block. in that same record . If there is no such item. NEXT_ITEM navigates to the current item. Built-in Type restricted procedure Enter Query Mode yes Parameters none
NEXT_ITEM examples
/* ** Built-in: ** Example: */ NEXT_ITEM See NEXT_BLOCK
300
. NEXT_ITEM navigates to the item with the lowest sequence number. in the next record. The valid settings for Navigation Style include: Same Record (Default): A Next Item operation from a block’s last item moves the input focus to the first navigable item in the block. If the current record is the last record in the block and there is no open query. Form Builder creates a new record.NEXT_ITEM built-in
Description Navigates to the navigable item with the next higher sequence number than the current item. If the validation unit is the item.

an error occurs. If there is no such item.NEXT_KEY built-in
Description Navigates to the enabled and navigable primary key item with the next higher sequence number than the current item. Syntax PROCEDURE NEXT_KEY. If there is no primary key item in the current block. NEXT_KEY navigates to the enabled and navigable primary key item with the lowest sequence number. NEXT_KEY validates any fields with sequence numbers greater than the current item or less than the target item. END. NEXT_KEY Jump the cursor to the next primary key item in in the current block. If the validation unit is the item. Built-in Type restricted procedure Enter Query Mode yes Parameters none
NEXT_KEY examples
/* ** Built-in: ** Example: ** */ BEGIN Next_Key.
301
.

Syntax PROCEDURE NEXT_MENU_ITEM.
302
.NEXT_MENU_ITEM built-in
Description Navigates to the next menu item in the current menu. Built-in Type restricted procedure Parameters none
NEXT_MENU_ITEM restrictions
NEXT_MENU_ITEM is available only in a custom menu running in the full-screen menu display style.

END.LAST_ITEM).NEXT_RECORD built-in
Description Navigates to the first enabled and navigable item in the record with the next higher sequence number than the current record. ELSE Next_Item. IF cur_itm = lst_itm THEN Next_Record. END IF. lst_itm VARCHAR2(80). then skip to the next record instead of ** the default of going back to the first item in ** the same block ** trigger: Key-Next-Item */ DECLARE cur_itm VARCHAR2(80) := :System.Cursor_Block. Form Builder will fetch or create a record.’||Get_Block_Property(cur_blk. cur_blk VARCHAR2(80) := :System. BEGIN lst_itm := cur_blk||’. If the current record is a new record. NEXT_RECORD fails. Built-in Type restricted procedure Enter Query Mode no Parameters none
NEXT_RECORD restrictions
Not allowed in Enter Query mode.Cursor_Item.
NEXT_RECORD examples
/* ** Built-in: NEXT_RECORD ** Example: If the current item is the last item in the ** block.
303
. If there is no such record. Syntax PROCEDURE NEXT_RECORD.

NEXT_SET Fetch the next set of records from the database when a button is pressed. When-Button-Pressed
304
. Syntax PROCEDURE NEXT_SET.NEXT_SET built-in
Description Fetches another set of records from the database and navigates to the first record that the fetch retrieves. NEXT_SET succeeds only if a query is open in the current block. Built-in Type restricted procedure Enter Query Mode no Parameters none
NEXT_SET examples
/* ** Built-in: ** Example: ** ** trigger: */ BEGIN Next_Set. END.

Usage Notes This is a non-settable variable. It is useful for supplying empty or non-existant arguments to an OLE call.
305
. Syntax OLEVAR_EMPTY OLEVAR.OLEVAR_EMPTY built-in
Description An OLE variant of type VT_EMPTY.

When you open a form with NO_ACTIVATE specified. On Microsoft Windows. validation. thus hiding the canvases in the original form partially or completely. trigger statements that follow the call to OPEN_FORM will execute after the opened form has been loaded into memory and its initial startup triggers have fired. canvases that are assigned to the root window in the current form and in the opened form will be displayed in the same window. Because there can be only one root window displayed at a time. then the opened form will also run in QUERY_ONLY mode. unless you override the environment variable by setting the Session option from the Runform command line. all Runform invocations inherit its setting. trigger statements that follow the call to OPEN_FORM never execute. POST and COMMIT operations in any form will cause posting.
307
. the PRE-LOGON.
paramlist_name paramlist_id
The name of a parameter list to be passed to the opened form.) At runtime. The unique ID that Form Builder assigns to the parameter list at the time it is created.) Specifies that the opened form should share the same database session as the current form. Form Builder will share data between forms that have identical libraries attached (at design time). the opened form receives focus immediately.
Usage Notes • Whether you open a form with ACTIVATE or NO_ACTIVATE specified. (The GUI display state of a window is controlled by the Window_State property.session_mode
NO_SESSION (The default. Use the GET_PARAMETER_LIST function to return the ID to a variable of type PARAMLIST. ON-LOGON. you should avoid using OPEN_FORM with forms that contain root windows. if any window in the form that opens the independent form is maximized. SESSION Specifies that a new. (However. see the usage note regarding SESSION-specified below.) When you open a form with ACTIVATE specified (the default). Form Builder will not share data between forms that have identical libraries attached (at design time). If the form that issues the OPEN_FORM built-in is running in QUERY_ONLY mode. SHARE_LIBRARY_DATA At runtime. Datatype is VARCHAR2. and commit processing to occur for all forms running in the same session.
data_mode
NO_SHARE_LIBRARY_DATA (The default. and POSTLOGON triggers will not fire. the first window displayed by the opened form will also be maximized. separate database session should be created for the opened form.
• •
• • •
•
OPEN_FORM restrictions
• You can set session On for all Runform invocations by setting the FORMSnn_SESSION environment variable to TRUE. any startup triggers that would normally fire will execute in the opened form. When you open a form with SESSION specified.) For most applications. This causes the opened form to "take over" the root window from the original form. regardless of its original design-time setting. When you set the FORMSnn_SESSION variable.

you cannot set data_mode to SHARE_LIBRARY_DATA (Form Builder will display a runtime error message).•
If you set session_mode to SESSION when you use OPEN_FORM to create a multiple-form application.
308
.

309
. The cut and copy functions transfer the selected region into the system clipboard until you indicate the paste target. the selected region that was cut or copied most recently). positioning the upper left corner of the pasted area at the cursor position. Syntax PROCEDURE PASTE_REGION. as well as the other editing functions. the cut or copied content is pasted onto the target location. on text and image items only..PASTE_REGION built-in
Description Pastes the contents of the clipboard (i. Built-in Type restricted procedure Enter Query Mode yes Parameters none Usage Notes Use PASTE_REGION. At that time.e.

filled_by’). /* Example 2: These procedure calls (attached to a ** When-Button-Pressed trigger) read a sound object from the ** file system and play it. PLAY_SOUND(’about. Built-in Type restricted Enter Query Mode No Parameters: item_id item_name The unique ID Form Builder gave the sound item when you created it. PLAY_SOUND(’orders. ’orders. READ_SOUND_FILE(’t:\orders\clerk\barnes.abc_inc’).last_name EQ ’BARNES’ THEN GO_ITEM(’orders.filled_by’).
PLAY_SOUND examples
/* Example 1: This procedure call (attached to a menu item) ** plays a sound object from the specified sound item: */ GO_ITEM(’about. Note: since an item must have focus ** in order to play a sound.PLAY_SOUND built-in
Description Plays the sound object in the specified sound item.abc_inc’).wav’. PLAY_SOUND(item_name VARCHAR2). END IF.filled_by’). ’wave’. END. the trigger code includes a call ** to the built-in procedure GO_ITEM: */ BEGIN IF :clerks. Syntax PLAY_SOUND(item_id ITEM). The name you gave the sound item when you created it.
311
.

Built-in Type unrestricted function Returns NUMBER Enter Query Mode yes Parameters recordgroup_id recordgroup_name The unique ID that Form Builder assigns when it creates the group. thus limiting network traffic. POPULATE_GROUP returns a 0 (zero). you may want to restrict queries. An unsuccessful query generates an ORACLE error number that corresponds to the particular SELECT statement failure. Syntax FUNCTION POPULATE_GROUP (recordgroup_id RecordGroup). The rows that are retrieved as a result of a successful query replace any rows that exist in the group.POPULATE_GROUP built-in
Description Executes the query associated with the given record group and returns a number indicating success or failure of the query. Upon a successful query. Note: Be aware that the POPULATE_GROUP array fetches 100 records at a time. FUNCTION POPULATE_GROUP (recordgroup_name VARCHAR2). To improve network performance.
POPULATE_GROUP restrictions
Valid only for record groups • • • that were created at design time with a query that were created by a call to the CREATE_GROUP_FROM_QUERY built-in that have been previously populated with the POPULATE_GROUP_WITH_QUERY built-in (which associates a query with the record group)
POPULATE_GROUP examples
/* ** Built-in: POPULATE_GROUP ** Example: See GET_GROUP_ROW_COUNT and CREATE_GROUP_FROM_QUERY */
312
. The data type of the ID is RecordGroup. The name you gave to the record group when creating it. The data type of the name is VARCHAR2.

node NODE). item_id ITEM. PROCEDURE POPULATE_GROUP_FROM_TREE (group_id RECORDGROUP. item_name VARCHAR2. item_id ITEM.
313
. PROCEDURE POPULATE_GROUP_FROM_TREE (group_id RECORDGROUP. indicates a sub-tree used to populate the RecordGroup. Use the FIND_ITEM built-in to return the ID to an appropriately typed variable. Specifies the unique ID that Form Builder assigns to the item when created. node NODE). Specifies the name of the object created at design time. Built-in Type unrestricted procedure Enter Query Mode no Parameters group_name group_id item_name Item_id Specifies the name of the group.POPULATE_GROUP_FROM_TREE built-in
Description Populates a record group with the data from the hierarchical tree. If specified. item_name VARCHAR2. node NODE). The data type of the name is VARCHAR2 string. Specifies the ID assigned to the group. PROCEDURE POPULATE_GROUP_FROM_TREE (group_name VARCHAR2. Specifies a valid node. The data type of the ID is ITEM. Syntax PROCEDURE POPULATE_GROUP_FROM_TREE (group_name VARCHAR2. including the specified node. node NODE).
node
Usage Notes The record group is cleared prior to inserting the hierarchical tree’s data set.

NODE_LABEL. Ftree.POPULATE_GROUP_FROM_TREE examples
/* ** Built-in: */ ----POPULATE_GROUP_FROM_TREE
This code will transfer all the data from a hierarchical tree that is parented by the node with a label of "Zetie" to a pre-created record group.The record group must already exist.Find the tree itself.htree3’). htree := Find_Item(’tree_block.Find_Tree_Node(htree. -. Ftree. find_node := Ftree. -. htree. BEGIN -.ROOT_NODE). find_node NODE. Ftree. Please see the documentation for the structure of the required record group. Ftree. -.ROOT_NODE.Populate_Group_From_Tree(’tree_data_rg’. END.FIND_NEXT. Ftree.Find the node with a label "Zetie".
DECLARE htree ITEM. find_node).
314
. ’Zetie’.Populate the record group with the tree data.

you may want to restrict queries. Any columns retrieved as a result of the query take the data types of the columns in the table. Built-in Type unrestricted function Returns NUMBER Enter Query Mode yes Parameters recordgroup_id recordgroup_name query The unique ID that Form Builder assigns when it creates the group. The data type of the name is VARCHAR2. If the query is successful.POPULATE_GROUP_WITH_QUERY built-in
Description Populates a record group with the given query. A valid SELECT statement. If the SELECT statement fails. this built-in returns 0 (zero). The data type of the query is VARCHAR2. Note: Be aware that the POPULATE_GROUP_WITH_QUERY array fetches 20 records at a time. and will be executed whenever the POPULATE_GROUP built-in is subsequently called. thus limiting network traffic. the indicated query becomes the default query for the group. The name you gave to the record group when creating it. If you restrict the query to a subset of the columns in the table. query VARCHAR2). enclosed in single quotes. then Form Builder creates only those columns in the record group. The record group is cleared and rows that are fetched replace any existing rows in the record group. The data type of the ID is RecordGroup.
POPULATE_GROUP_WITH_QUERY restrictions
• The columns specified in the SELECT statement must match the record group columns in number and type. query VARCHAR2). Syntax FUNCTION POPULATE_GROUP_WITH_QUERY (recordgroup_id RecordGroup. Form Builder returns an ORACLE error number. To improve network performance. FUNCTION POPULATE_GROUP_WITH_QUERY (recordgroup_name VARCHAR2.
315
. You can use this built-in to populate record groups that were created by a call to either: • • the CREATE_GROUP built-in or the CREATE_GROUP_FROM_QUERY built-in
When you use this built-in.

Doing so may cause Form Builder to be unable to display records that have already been fetched. The data type of the ID is RecordGroup. Specifies the unique ID that Form Builder assigns when it creates the record group.
list_name recgrp_id recgrp_name Usage Notes •
Do not use the POPULATE_LIST built-in if the Mapping of Other Values property is defined and there are queried records in the block. assume that a list item contains the values A. and C and the Mapping of Other Values property is defined. The record group must be created at runtime and it must have the following two column (VARCHAR2) structure: Column 1: the list label Column 2: the list value
Syntax PROCEDURE POPULATE_LIST (list_id ITEM. Assume also that these values have been fetched from the database (a query is open). Built-in Type unrestricted procedure Enter Query Mode yes Parameters list_id Specifies the unique ID that Form Builder assigns when it creates the list item.POPULATE_LIST built-in
Description Removes the contents of the current list and populates the list with the values from a record group. The data type of the name is VARCHAR2. PROCEDURE POPULATE_LIST ITEM. an error will occur because
317
. if you populate the list using POPULATE_LIST. PROCEDURE POPULATE_LIST (list_name VARCHAR2. The VARCHAR2 name you gave to the record group when you created it. recgrp_id RecordGroup). recgrp_name VARCHAR2). The data type of the ID is ITEM. For example. PROCEDURE POPULATE_LIST (list_name VARCHAR2. (list_id recgrp_name VARCHAR2). B. At this point. Use the FIND_ITEM built-in to return the ID to an appropriately typed variable. The name you gave to the list item when you created it. recgrp_id RecordGroup).

Form Builder will attempt to display the previously fetched values (A. clears the list. and C). Refer to the restrictions on DELETE_LIST_ELEMENT for more information. Use the ABORT_QUERY built-in to close an open query. ’RECGRP_TWO’). B. close any open queries. and ** populates the list with values from record group ** two when a button is pressed. ’RECGRP_ONE’). but will be unable to because these values were removed from the list and replaced with new values. END. the record group contains an other value element but the list does not meet the criteria specified for adding an other value element with ADD_LIST_ELEMENT.
318
. Refer to the restrictions on ADD_LIST_ELEMENT for more information. ** trigger: When-Button-Pressed */ BEGIN Retrieve_List(list_id.
POPULATE_LIST restrictions
POPULATE_LIST returns error FRM-41337: Cannot populate the list from the record group if: • the record group does not contain either the default value element or the other values element and the list does not meet the criteria specified for deleting these elements with DELETE_LIST_ELEMENT. Clear_List(list_id). • Before populating a list.
•
POPULATE_LIST examples
/* ** Built-in: POPULATE_LIST ** Example: Retrieves the values from the current list item ** into record group one. Populate_List(list_id.

Populate the tree with data.
POPULATE_TREE examples
/* ** Built-in: POPULATE_TREE */ -.htree3’).NODE.NODE. Syntax PROCEDURE POPULATE_TREE (item_name VARCHAR2).
319
.either the record group or query already specified -. The data type of the ID is ITEM.POPULATE_TREE built-in
Description Clears out any data already in the hierarchical tree. Ftree.
Built-in Type unrestricted procedure Enter Query Mode no Parameters item_name item_id Specifies the name of the object created at design time. and obtains the data set specified by the RecordGroup or QueryText properties. Specifies the unique ID that Form Builder assigns to the item when created. DECLARE htree ITEM. top_node FTREE.Find the tree itself.Populate_Tree(htree). The data type of the name is VARCHAR2 string. -. END. Use the FIND_ITEM built-in to return the ID to an appropriately typed variable. find_node FTREE.for the hierarchical tree. BEGIN -. htree := Find_Item(’tree_block.This code will cause a tree to be re-populated using -. PROCEDURE POPULATE_TREE (item_id ITEM).

Alternatively. this data can be rolled back by the next CLEAR_FORM.Form_Status <> ’QUERY’ THEN Message(’An error prevented the system from posting changes’). for each block in the form Form Builder writes deletes. We’ve already posted. and we don’t want the posted changes ** to be rolled back. If there are changes to post to the database.POST built-in
Description Writes data in the form to the database. inserts. /* ** By default.
POST examples
/* ** Built-in: POST and EXIT_FORM ** Example: Leave the called form. */ IF :System. */ BEGIN Post. Built-in Type restricted procedure Enter Query Mode no Parameters none Usage Notes If this form was called via OPEN_FORM with the NO_SESSION parameter specified. Exit_Form asks to commit and performs a ** rollback to savepoint. RAISE Form_trigger_Failure. but does not perform a database commit. and updates to the database. Form Builder first validates the form.
320
. Syntax PROCEDURE POST. so we do ** not need to commit. END. /* ** Form_Status should be ’QUERY’ if all records were ** successfully posted. NO_ROLLBACK). END IF. without rolling back the ** posted changes so they may be posted and ** committed by the calling form as part of the ** same transaction. Any data that you post to the database is committed to the database by the next COMMIT_FORM that executes during the current Runform session. */ Exit_Form(NO_COMMIT. then the POST will validate and write the data both in this form and in the calling form.

321
. ELSE Previous_Item. BEGIN frs_itm := cur_blk||’. END. IF cur_itm = frs_itm THEN Previous_Block. If there is no enterable block with a lower sequence. cur_blk VARCHAR2(80) := :System. Built-in Type restricted procedure Enter Query Mode no Parameters none
PREVIOUS_BLOCK examples
/* ** Built-in: PREVIOUS_BLOCK ** Example: If the current item is the first item in the ** block.PREVIOUS_BLOCK built-in
Description Navigates to the first navigable item in the previous enterable block in the navigation sequence. END IF. However. the previous block in the navigation sequence is the block with the next lower sequence number. Syntax PROCEDURE PREVIOUS_BLOCK. the Previous Navigation Block block property can be set to specify a different block as the previous block for navigation purposes.Cursor_Block.’||Get_Block_Property(cur_blk.Cursor_Item.FIRST_ITEM). By default. then skip back the previous block ** instead of the default of going to the last ** item in the same block ** trigger: Key-Previous-Item */ DECLARE cur_itm VARCHAR2(80) := :System. frs_itm VARCHAR2(80). PREVIOUS_BLOCK navigates to the enterable block with the highest sequence number. as defined by the block order in the Object Navigator.

322
. Built-in Type restricted procedure Enter Query Mode no
PREVIOUS_FORM restrictions
The target form cannot be a form that is currently disabled as a result of having invoked another form with CALL_FORM. Syntax PROCEDURE PREVIOUS_FORM. navigates to the form with the next lowest sequence number. When navigating with PREVIOUS_FORM. (Forms are sequenced in the order they were invoked at runtime. which fires for the target form.PREVIOUS_FORM built-in
Description In a multiple-form application.) If there is no form with a lower sequence number. If there is no such form. which fires for the form that initiates navigation. PREVIOUS_FORM navigates to the form with the highest sequence number. and WHEN-WINDOWACTIVATED. no validation occurs and no triggers fire except WHENWINDOW-DEACTIVATED. the current form remains current.

Change Record: A Previous Item operation from a block’s first item moves the input focus to the last navigable item in the block. PREVIOUS_ITEM navigates to the current item. The function of PREVIOUS_ITEM from the first navigable item in the block depends on the setting of the Navigation Style block property.PREVIOUS_ITEM built-in
Description Navigates to the navigable item with the next lower sequence number than the current item. PREVIOUS_ITEM navigates to the navigable item with the highest sequence number. Change Block: A Previous Item operation from a block’s first item moves the input focus to the last navigable item in the current record of the previous block. Syntax PROCEDURE PREVIOUS_ITEM. The valid settings for Navigation Style include: Same Record (Default): A Previous Item operation from a block’s first item moves the input focus to the last navigable item in the block. in that same record . Built-in Type restricted procedure Enter Query Mode yes Parameters none
PREVIOUS_ITEM examples
/* ** Built-in: ** Example: */ PREVIOUS_ITEM See PREVIOUS_BLOCK
323
. If there is no such item. If there is no such item. in the previous record.

FIRST_ITEM). ELSE Previous_Item. BEGIN frs_itm := cur_blk||’. Syntax PROCEDURE PREVIOUS_RECORD. END. frs_itm VARCHAR2(80). cur_blk VARCHAR2(80) := :System. then skip back to the previous record ** instead of the default of going to the last ** item in the same block ** trigger: Key-Previous-Item */ DECLARE cur_itm VARCHAR2(80) := :System. END IF.
326
.Cursor_Block.Cursor_Item. Built-in Type restricted procedure Enter Query Mode no Parameters none
PREVIOUS_RECORD examples
/* ** Built-in: PREVIOUS_RECORD ** Example: If the current item is the first item in the ** block.PREVIOUS_RECORD built-in
Description Navigates to the first enabled and navigable item in the record with the next lower sequence number than the current record. IF cur_itm = frs_itm THEN Previous_Record.’||Get_Block_Property(cur_blk.

vtype VT_TYPE) RETURN newvar OLEVAR.
Usage Notes In most applications. Built-in Type unrestricted function Returns the created and transformed OLE variant. Then. care must be taken to ensure that the correct address value is placed in the new variant.PTR_TO_VAR built-in
Description First. If the function is used.
328
. there is no need to use this function. passes that variant and type through the function VARPTR_TO_VAR. creates an OLE variant of type VT_PTR that contains the supplied address. Syntax FUNCTION PTR_TO_VAR (address PLS_INTEGER. The type to be given to the final version of the OLE variant (after its processing by VARPTR_TO_VAR). Parameters address vtype A variable whose value is an address.

Syntax PROCEDURE QUERY_PARAMETER (parameter_string VARCHAR2).QUERY_PARAMETER built-in
Description Displays the Query Parameter dialog showing the current values of the specified substitution parameters. BEGIN WHILE TRUE LOOP Query_Parameter(’&p1 &q2 &z6’). End users can set the value of any parameter you include in the list.’).. END IF. /* ** Start a sub-block so we can catch a Value_Error ** exception in a local handler */ BEGIN IF TO_DATE( :z6 ) < SYSDATE THEN Message(’Target Date must name a day in the future. END IF.5000’). */ IF Menu_Success THEN IF TO_NUMBER( :q2 ) NOT BETWEEN 100 AND 5000 THEN Message(’Qty must be in the range 100. /* ** If the user did not Cancel the box the Menu_Success ** function will return boolean TRUE. The syntax for specifying the parameter_string parameter requires the ampersand &parm_name. This means that any PL/SQL statements that follow the call to QUERY_PARAMETER are not executed until the Query Parameter dialog is dismissed.
QUERY_PARAMETER examples
/* ** Built-in: QUERY_PARAMETER ** Example: Prompt for several menu parameters ** programmatically. Bell. Built-in Type unrestricted procedure Parameters parameter_string Specifies a string of substitution parameters for a menu item. Substitution parameters are referenced in PL/SQL code with the colon syntax ":param_name" used for all bind variables). */ PROCEDURE Update_Warehouse IS validation_Err BOOLEAN. validating their contents. The Query Parameter dialog is modal. EXCEPTION
329
. Bell. Validation_Err := TRUE. Validation_Err := TRUE. and control does not return to the calling trigger or procedure until the end user either accepts or cancels the dialog.

*/ IF NOT Validation_Err THEN UPDATE WAREHOUSE SET QTY_TO_ORDER = QTY_TO_ORDER*0. Bell. ELSE /* ** If Menu_Success is boolean false.
330
.18 WHERE TARGET_DATE = TO_DATE(:z6) AND QTY_ON_HAND > TO_NUMBER(:q2) AND COST_CODE LIKE :p1||’%’. /* ** If we get here. END. END IF.WHEN VALUE_ERROR THEN Message(’Target Date must be of the form DD-MON-YY’). then return back ** from the procedure since user cancelled the dialog */ RETURN. Validation_Err := TRUE. END IF. END. all parameters were valid so do the ** Update Statement. END LOOP.

JFIF. or TPIC. Use the FIND_ITEM built-in to return the ID to an appropriately typed variable. Datatype is ITEM. In this example. ** trigger: Post-Query */ DECLARE tiff_image_dir VARCHAR2(80) := ’/usr/staff/photos/’. To optimize performance. For more information on the specific search path for your platform. PROCEDURE READ_IMAGE_FILE (file_name VARCHAR2. GIF. file_type VARCHAR2. refer to the Form Builder documentation for your operating system. file_type VARCHAR2.FMX file. RAS. JPG. The valid image file type: BMP. Datatype is VARCHAR2. PICT. as Form Builder will attempt to deduce it from the source image file. you should specify the file type. photo_filename VARCHAR2(80).
331
. An employee’s photo is a TIFF ** image stored in a file named <Userid>. Built-in Type unrestricted procedure Enter Query Mode yes Parameters file_name file_type Valid file name. TIFF.READ_IMAGE_FILE built-in
Description Reads an image of the given type from the given file and displays it in the Form Builder image item. CALS. but is ** stored on the filesystem. Syntax PROCEDURE READ_IMAGE_FILE (file_name VARCHAR2. however.) The unique ID Form Builder assigns to the image item when it creates it. (Note: File type is optional. item_name VARCHAR2).TIF Each employee’s ** Userid is unique. The file name designation can include a full path statement appropriate to your operating system. item_id ITEM). the scanned picture identification ** for each employee is NOT saved to the database.
item_id
item_name Usage Notes
Form Builder searches for the image file along the same default path as it searches for an . The name you gave the image item when you created it.
READ_IMAGE_FILE examples
/* Read an image from the filesystem into an image item on the ** form.

Message_Level := ’25’. END.tif ** -----** ** Now.userid)||’.
332
. :SYSTEM. take the employee’s ** Userid and concatenate the ’. /* ** For example ’photo_filename’ might look like: ** ** /usr/staff/photos/jgetty.’).emp_photo’). ’emp. The EMP ** record has a non-database image item named ’EMP_PHOTO’ ** into which we read the image.BEGIN /* ** Set the message level high so we can gracefully handle ** an error reading the file if it occurs */ :System.TIF’ extension to derive ** the filename from which to load the TIFF image. /* ** After fetching an employee record.MESSAGE_LEVEL := ’0’. END IF.tif’. IF NOT FORM_SUCCESS THEN MESSAGE(’This employee does not have a photo on file. ’TIFF’. */ photo_filename := tiff_image_dir||LOWER(:emp. */ READ_IMAGE_FILE(photo_filename. read in the appropriate image.

however. file_type VARCHAR2. The name you gave the sound item when you created it. PLAY_SOUND(’orders. END IF. (Note: file type is optional. Valid values are: AU.READ_SOUND_FILE built-in
Description Reads sound object from the specified file into the specified sound item.last_name EQ ’BARNES’ THEN GO_ITEM(’orders.wav’. If you know the file type. READ_SOUND_FILE(’t:\orders\clerk\barnes.
333
. ’orders.
READ_SOUND_FILE restrictions READ_SOUND_FILE examples
/* These procedure calls (attached to a When-Button-Pressed ** trigger) reads a sound object from the file system and plays ** it. AIFF-C. item_id ITEM). Syntax READ_SOUND_FILE(file_name VARCHAR2.filled_by’). specifying it can increase performance. AIFF.) The unique ID Form Builder gave the sound item when you created it. item_name VARCHAR2). the trigger code includes a call to the ** built-in procedure GO_ITEM: */ BEGIN IF :clerks.filled_by’).filled_by’). ’wave’. Note: since a sound item must have focus in order to play ** a sound object. READ_SOUND_FILE(file_name VARCHAR2. but should be specified if known for increased performance. The file type for the sound data file.
item_id item_name Usage Notes •
Specifying a file type for the sound file is optional. Built-in Type unrestricted Enter Query Mode Yes Parameters: file_name file_type The fully-qualified file name of the file that contains the sound object to be read. and WAVE. file_type VARCHAR2.

END.
334
.

if you specify a summary item (or a non-calculated item) as the argument to RECALCULATE.
335
. Typically you would invoke this when the formula (or function or procedure that it invokes) refers to a system variable or built-in function which now would return a different value. Datatype is VARCHAR2.
RECALCULATE restrictions
You can use the RECALCULATE built-in to recalculate formula calculated items only. The unique ID Form Builder assigned to the item when it created the item. Use the FIND_ITEM built-in to return the ID to an appropriately typed variable. Note that actual recalculation doesn’t happen immediately. Built-in Type unrestricted procedure Enter Query Mode yes Parameters item_name item_id The name you gave the item when you defined it.RECALCULATE built-in
Description Marks the value of the specified formula calculated item (in each record of the block) for recalculation. Form Builder will return an error message: FRM-41379: Cannot recalculate non-formula item <block_name. Datatype is Item. PROCEDURE RECALCULATE (item_id Item).item_name>. Syntax PROCEDURE RECALCULATE (item_name VARCHAR2). it occurs sometime after the item is marked but before the new value of the calculated item is referenced or displayed to the end user. Your application’s logic should not depend on recalculation of a calculated item occurring at a specific time.

each carrying different persistence values. Syntax PROCEDURE RELEASE_OBJ (obj OLEOBJ. A boolean value of FALSE releases only a non-persistent object. the default value is NULL (release object unconditionally). The conditional form of this procedure (boolean TRUE or FALSE) should be used only in those rare cases when two instances of an object have been created. Built-in Type unrestricted procedure Parameters obj Kill_persistence_boolean Pointer to the OLE object to be released. and the pointer is ambiguous. A boolean value of NULL releases the object. The procedure will release one of the two objects. If you don’t have a pointer to a non-persistent object. your code will misbehave. A boolean value of TRUE releases only a persistent object. This is an optional parameter. Usage Notes In general. you should not access an object after you release it. If you don’t have a pointer to a persistent object.
337
. kill_persistence_boolean := NULL). ending its persistence.RELEASE_OBJ built-in
Description Shuts down the connection to the OLE object. leaving the other as the sole instance. If not supplied. you will get error FRM-40935.

That is. Form Builder will immediately undo the replacement to keep the focus item visible to the end user. view_id PROCEDURE REPLACE_CONTENT_VIEW (window_id Window. If you replace a content canvas that contains the item that currently has focus. ViewPort). The data type of the name is VARCHAR2. you cannot replace a window’s content view with a content view from a different window. The data type of the ID is Window.
window_name view_id
view_name
REPLACE_CONTENT_VIEW restrictions
• The canvas that replaces the window’s current content canvas must have been assigned to that window at design time. ViewPort). Use the FIND_VIEW built-in to return the ID to an appropriately typed variable. PROCEDURE REPLACE_CONTENT_VIEW (window_name VARCHAR2.
338
. view_id PROCEDURE REPLACE_CONTENT_VIEW (window_name VARCHAR2. Use the FIND_WINDOW built-in to return the ID to an appropriately typed variable. view_name VARCHAR2). Specifies the name that you gave the window when creating it. view_name VARCHAR2).REPLACE_CONTENT_VIEW built-in
Description Replaces the content canvas currently displayed in the indicated window with a different content canvas. Specifies the name that you gave the object when defining it. Built-in Type unrestricted procedure Enter Query Mode yes Parameters window_id Specifies the unique ID that Form Builder assigns the window when created. Syntax PROCEDURE REPLACE_CONTENT_VIEW (window_id Window. Specifies the unique ID that Form Builder assigns the view when it creates the object.
•
REPLACE_CONTENT_VIEW examples
/* ** Built-in: ** Example: ** REPLACE_CONTENT_VIEW Replace the ’salary’ view with the ’history’ view in the ’employee_status’ window. The data type of the name is VARCHAR2. The data type of the ID is ViewPort.

END.*/ BEGIN Replace_Content_View(’employee_status’.’history’).
339
.

menu_type NUMBER). REPLACE_MENU will replace the menu for both the calling form and the called form with the specified menu. group_name VARCHAR2. all or part of the menu does not appear on the screen if the active canvas would cover it. REPLACE_MENU also allows you to change the way the menu displays and the role. Because REPLACE_MENU does not make the new menu active. The following constants can be passed as arguments for this parameter: PULL_DOWN Specifies that you want Form Builder to display the menus in a pull-down style that is characteristic of most GUI platforms and some character mode platforms. PROCEDURE REPLACE_MENU (menu_module_name VARCHAR2. The display style of the menu.
menu_type
340
. Therefore. This parameter is optional. starting_menu_name VARCHAR2). PROCEDURE REPLACE_MENU (menu_module_name VARCHAR2. menu_type NUMBER. Datatype is VARCHAR2. PROCEDURE REPLACE_MENU (menu_module_name VARCHAR2). PROCEDURE REPLACE_MENU (menu_module_name VARCHAR2. If you are using CALL_FORM. menu_type NUMBER. group_name VARCHAR2). PROCEDURE REPLACE_MENU (menu_module_name VARCHAR2. Syntax REPLACE_MENU. Form Builder does not allow the menu to obscure any part of the active canvas.REPLACE_MENU built-in
Description Replaces the current menu with the specified menu. BOOLEAN). starting_menu VARCHAR2. starting_menu VARCHAR2. if it is omitted. but does not make the new menu active. menu_type NUMBER. Form Builder runs the form without a menu. Parameters menu_module _name Name of the menu module that should replace the current menu module. use_file Built-in Type unrestricted procedure Enter Query Mode yes Usage Notes REPLACE_MENU replaces the menu for all windows in the application.

Form Builder uses the current username to determine the role. starting_menu group_name use_file Specifies the menu within the menu module that Form Builder should use as the starting menu.MMX (executable). For example.
341
. The data type of use_file is BOOLEAN. TRUE Specifies that Form Builder should treat the menu_module value as a direct reference to a .MMX menu runfile in the file system. NULL Specifies that Form Builder should read the current form’s Menu Source property and execute REPLACE_MENU accordingly.
REPLACE_MENU examples
/* ** Built-in: REPLACE_MENU ** Example: Use a standard procedure to change which root ** menu in the current menu application appears in ** the menu bar. If you do not specify a role name. A single menu application may ** have multiple "root-menus" which an application ** can dynamically set at runtime. Specifies the security role that Form Builder is to use. Form Builder executes REPLACE_MENU as if the use_file actual parameter was TRUE. Indicates how Form Builder should locate the menu .BAR Specifies that you want Form Builder to display the menu in a bar style horizontally across the top of the root window.MMX file to be run. The data type of the name is VARCHAR2. PULL_DOWN. and should query this module to get the actual name of the . Corresponds to the Menu Source form module property. FULL_SCREEN Specifies that you want Form Builder to display the menu in a full-screen style. root_menu_name). FALSE Specifies that Form Builder should treat the menu_module value as a reference to a . if the form module Menu Source property is set to Yes for the current form. */ PROCEDURE Change_Root_To(root_menu_name VARCHAR2) IS BEGIN Replace_Menu(’MYAPPLSTD’.MMB (binary) menu module in the database. END.

** trigger: When-Button-Pressed */ BEGIN Reset_Group_Selection( ’usersel’ ). END. The name you gave to the record group when creating it. Built-in Type unrestricted procedure Enter Query Mode yes Parameters recordgroup_id recordgroup_name The unique ID that Form Builder assigns when it creates the group.RESET_GROUP_SELECTION built-in
Description Deselects any selected rows in the given group. The data type of the name is VARCHAR2. PROCEDURE RESET_GROUP_SELECTION (recordgroup_name VARCHAR2).
343
. forget ** all of the records in the ’USERSEL’ record ** group that we may have previously marked as ** selected records. Syntax PROCEDURE RESET_GROUP_SELECTION (recordgroup_id RecordGroup).
RESET_GROUP_SELECTION examples
/* ** Built-in: RESET_GROUP_SELECTION ** Example: If the user presses the (Cancel) button. Use this built-in to deselect all record group rows that have been programmatically marked as selected by executing SET_GROUP_SELECTION on individual rows. The data type of the ID is RecordGroup.

NUMBER). as specified by the x and y coordinates of the window’s upper left corner on the screen. even if the window is not currently displayed. height Built-in Type unrestricted procedure Enter Query Mode yes Parameters window_id Specifies the unique ID that Form Builder assigns the window when created. you can resize the MDI application window by specifying the constant FORMS_MDI_WINDOW as the window name. h NUMBER. Syntax PROCEDURE RESIZE_WINDOW (window_id Window. A call to RESIZE_WINDOW sets the width and height of the window. You can also resize a window with SET_WINDOW_PROPERTY. Use the FIND_WINDOW built-in to return the ID to an appropriately typed variable.
window_name width height
RESIZE_WINDOW examples
/* ** Built-in: RESIZE_WINDOW ** Example: Set Window2 to be the same size as Window1 */ PROCEDURE Make_Same_Size_Win( Window1 VARCHAR2. Specifies the new height of the window. The data type of the name is VARCHAR2. in form coordinate units. in form coordinate units. */
344
. Window2 VARCHAR2) IS wn_id1 Window. RESIZE_WINDOW does not change the position of the window. w NUMBER.RESIZE_WINDOW built-in
Description Changes the size of the given window to the given width and height. Specifies the new width of the window. PROCEDURE RESIZE_WINDOW (window_name VARCHAR2. On Microsoft Windows. Specifies the name that you gave the window when creating it. BEGIN /* ** Find Window1 and get it’s width and height. width NUMBER. height NUMBER). width NUMBER. The data type of the ID is Window.

RETRIEVE_LIST built-in
Description Retrieves and stores the contents of the current list into the specified record group. The data type of the ID is RecordGroup. (list_name recgrp_name VARCHAR2). Specifies the unique ID that Form Builder assigns when it creates the record group. The data type of the name is VARCHAR2. The name you gave to the list item when you created it. PROCEDURE RETRIEVE_LIST (list_name VARCHAR2. Syntax PROCEDURE RETRIEVE_LIST (list_id ITEM. The data type of the ID is ITEM. Use the FIND_ITEM built-in to return the ID to an appropriately typed variable. recgrp_name VARCHAR2). (list_id recgrp_id RecordGroup). PROCEDURE RETRIEVE_LIST VARCHAR2. PROCEDURE RETRIEVE_LIST ITEM. Built-in Type unrestricted procedure Returns VARCHAR2 Enter Query Mode yes Parameters list_id Specifies the unique ID that Form Builder assigns when it creates the list item. The VARCHAR2 name you gave to the record group when you created it. The target record group must have the following two-column (VARCHAR2) structure: Column 1: the list label Column 2: the list value
Storing the contents of a list item allows you to restore the list with its former contents. recgrp_id RecordGroup).
list_name recgrp_id recgrp_name
RETRIEVE_LIST examples
/* ** ** */ Built-in: Example: RETRIEVE_LIST See POPULATE_LIST
346
.

If the called product is unavailable at the time of the call. BOOK specifies Oracle Book. commmode NUMBER. Specifies the VARCHAR2 name of the module or module to be executed by the called product. Form Builder returns a message to the end user. report. To run a report from within a form. paramlist_id VARCHAR2. location NUMBER. The application looks for the module or module in the default paths defined for the called product. execmode NUMBER. display VARCHAR2). bind or lexical references. and named queries. Valid values are the name of a form module. PROCEDURE RUN_PRODUCT NUMBER. Specifies the communication mode to be used when running the called product. location NUMBER. Syntax PROCEDURE RUN_PRODUCT (product NUMBER. Graphics Builder display. commmode NUMBER. Valid numeric constants for this parameter are SYNCHRONOUS and ASYNCHRONOUS. the form can pass text and data parameters to the called product that represent values for command line parameters. REPORTS specifies Report Builder. Built-in Type unrestricted procedure Enter Query Mode yes Parameters product Specifies a numeric constant for the Oracle product you want to invoke: FORMS specifies a Runform session. you can alternatively use the dedicated report integration built-in RUN_REPORT_OBJECT . GRAPHICS specifies Graphics Builder. module VARCHAR2. Parameters of type DATA_PARAMETER are pointers to record groups in Form Builder. but not to Form Builder.RUN_PRODUCT built-in
Description Invokes one of the supported Oracle tools products and specifies the name of the module or module to be run. or Oracle Book module. display VARCHAR2). You can pass DATA_PARAMETERs to Report Builder and Graphics Builder. If you create a parameter list and then reference it in the call to RUN_PRODUCT. (product module VARCHAR2.
module
commmode
347
. paramlist_name VARCHAR2. execmode NUMBER.

)
RUN_PRODUCT examples
/* ** Built-in: RUN_PRODUCT ** Example: Call a Report Builder report. When you run Report Builder and Graphics Builder. The name of the chart item must be specified in the format block_name. passing the ** data in record group ’EMP_RECS’ to substitute ** for the report’s query named ’EMP_QUERY’. the ID of the parameter list. BEGIN /* ** Check to see if the ’tmpdata’ parameter list exists.) Note: You can prevent Graphics Builder from logging on by passing a parameter list that includes a parameter with key set to LOGON and value set to NO. ** Presumes the Emp_Recs record group already ** exists and has the same column/data type ** structure as the report’s Emp_Query query. or a null string (’’).
348
. ASYNCHRONOUS specifies that control returns to the calling application immediately. When you run Form Builder. execmode can be either BATCH or RUNTIME. display Specifies the VARCHAR2 name of the Form Builder chart item that will contain the display (such as a pie chart. To specify a parameter list ID. Valid values for this parameter are the VARCHAR2 name of the parameter list. The end user cannot work in the form while the called product is running. Note: You cannot pass a DATA_PARAMETER to a child query in Report Builder.item_name . */ PROCEDURE Run_Emp_Report IS pl_id ParamList. (This parameter is only required when you are using an Graphics Builder chart item in a form. always set execmode to RUNTIME. execmode Specifies the execution mode to be used when running the called product. However. Valid constants for this property are FILESYSTEM and DB. You can pass text parameters to called products in both SYNCHRONOUS and ASYNCHRONOUS mode. bar chart. or graph) generated by Graphics Builder. (SYNCHRONOUS mode is required when invoking Graphics Builder to return an Graphics Builder display that will be displayed in a form chart item. Data passing is supported only for master queries. either the file system or the database. even if the called application has not completed its display. parameter lists that contain parameters of type DATA_PARAMETER (pointers to record groups) can only be passed to Report Builder and Graphics Builder in SYNCHRONOUS mode.
locatioSpecifies the location of the module or module you want the called product to execute.SYNCHRONOUS specifies that control returns to Form Builder only after the called product has been exited. use a variable of type PARAMLIST. Paramlist_name or paramlist_ID Specifies the parameter list to be passed to the called product. Valid numeric constants for this parameter are BATCH and RUNTIME.

*/ pl_id := Create_Parameter_List(’tmpdata’).DATA_PARAMETER. SYNCHRONOUS. /* ** Add a data parameter to this parameter list that will ** establish the relationship between the named query ** ’EMP_QUERY’ in the report.*/ pl_id := Get_Parameter_List(’tmpdata’). */ Add_Parameter(pl_id.’EMP_QUERY’. ’NO’). /* ** If it does. ’empreport’. ’PARAMFORM’.
349
. FILESYSTEM. TEXT_PARAMETER. /* ** Run the report synchronously. RUNTIME. /* **Pass a Parameter into PARAMFORM so that a parameter dialog will not appear **for the parameters being passing in.’EMP_RECS’). and the record group named ** ’EMP_RECS’ in the form. */ Add_Parameter(pl_id. then delete it before we create it again in ** case it contains parameters that are not useful for our ** purposes here. pl_id. passing the parameter list */ Run_Product(REPORTS. /* ** Create the ’tmpdata’ parameter list afresh. END. */ IF NOT Id_Null(pl_id) THEN Destroy_Parameter_List( pl_id ). END IF. NULL).

and CANCEL_REPORT_OBJECT.. END. If you invoke Run_Report_Object with a blank Report Server property.
Usage Notes • Returns a VARCHAR2 value that uniquely identifies the report that is running either locally or on a remote report server. You can use this report ID string as a parameter to REPORT_OBJECT_STATUS . Executing this built-in is similar using the RUN_PRODUCT built-in on a report. the return value will be NULL. BEGIN repid := find_report_object(’report4’). You can get the report ID for a particular report using the built-in FIND_REPORT_OBJECT. Built-in Type unrestricted procedure Returns VARCHAR2 Enter Query Mode yes Parameters report_id Specifies the unique ID of the report to be run..
350
. Syntax FUNCTION RUN_REPORT_OBJECT (report_id REPORT_OBJECT ).. you cannot then use the built-ins Report_Object_Status and Copy_Report_Object_Output. v_rep := RUN_REPORT_OBJECT(repid). rep_status varchar2(20). In that case. v_rep VARCHAR2(100).
RUN_REPORT_OBJECT examples
DECLARE repid REPORT_OBJECT..RUN_REPORT_OBJECT built-in
Description Use this built-in to run a report from within a form.. . because they require an actual ID value. You can run the report against either a local or remote database server. COPY_REPORT_OBJECT .

SCROLL_DOWN puts the input focus in the instance of the current item in the displayed record with the lowest sequence number.SCROLL_DOWN built-in
Description Scrolls the current block’s list of records so that previously hidden records with higher sequence numbers are displayed. END. Syntax PROCEDURE SCROLL_DOWN.
351
. SCROLL_DOWN Scroll records down some. Form Builder fetches records during SCROLL_DOWN processing. SCROLL_DOWN displays the next record in the block’s list of records. If there are available records and a query is open in the block. Built-in Type restricted procedure Enter Query Mode no Parameters none
SCROLL_DOWN examples
/* ** Built-in: ** Example: */ BEGIN Scroll_Down. In a single-line block.

END. SCROLL_UP Scroll records up some.
352
. SCROLL_UP puts the input focus in the instance of the current item in the displayed record that has the highest sequence number. Built-in Type restricted procedure Enter Query Mode no Parameters none
SCROLL_UP examples
/* ** Built-in: ** Example: */ BEGIN Scroll_Up. This action displays records that were "above" the block’s display.SCROLL_UP built-in
Description Scrolls the current block’s list of records so that previously hidden records with lower sequence numbers are displayed. Syntax PROCEDURE SCROLL_UP.

SCROLL_VIEW built-in
Description Moves the view to a different position on its canvas by changing the Viewport X Position on Canvas and Viewport Y Position on Canvas properties.
353
. */ PROCEDURE Scroll_Ten_Percent( viewname VARCHAR2. Specifies the y coordinate of the view’s upper left corner relative to the upper left corner of the canvas. the window in which the canvas is displayed represents the view for that canvas. vw_x NUMBER. y NUMBER). x y NUMBER). x NUMBER. Built-in Type unrestricted procedure Enter Query Mode yes Parameters view_id Specifies the unique ID that Form Builder assigns the view when it creates the object. but does not change the position of the view within the window. Specifies the x coordinate of the view’s upper left corner relative to the upper left corner of the canvas. vw_wid NUMBER. cn_id Canvas. NUMBER.
view_name x y
SCROLL_VIEW examples
/* ** Built-in: SCROLL_VIEW ** Example: Scroll the view whose name is passed in 10% to ** the right or left depending on the ’direction’ ** parameter. The data type of the name is VARCHAR2. The data type of the ID is ViewPort. cn_wid NUMBER. direction VARCHAR2 ) IS vw_id ViewPort. Syntax PROCEDURE SCROLL_VIEW (view_id ViewPort. the view size is controlled by setting the Viewport Width and Viewport Height properties. Note: For a content or toolbar canvas. Moving the view makes a different area of the canvas visible to the operator. PROCEDURE SCROLL_VIEW (view_name VARCHAR2. Specifies the name that you gave the object when defining it. For a stacked canvas. Use the FIND_VIEW built-in to return the ID to an appropriately typed variable.

Built-in Type restricted procedure Enter Query Mode yes Parameters none
355
. Call this procedure prior to issuing a call to CUT_REGION or COPY_REGION. when you want to cut or copy the entire contents of a text item.SELECT_ALL built-in
Description Selects the text in the current item. Syntax PROCEDURE SELECT_ALL.

*/ ELSE Select_Records. /* ** Otherwise. and use transactional triggers to replace default Form Builder transaction processing. initiates default Form Builder SELECT processing. do the right thing. Syntax PROCEDURE SELECT_RECORDS.SELECT_RECORDS built-in
Description When called from an On-Select trigger. Built-in Type restricted procedure Enter Query Mode no Parameters none
SELECT_RECORDS restrictions
Valid only within an On-Select trigger.
SELECT_RECORDS examples
/* ** Built-in: SELECT_RECORDS ** Example: Perform Form Builder standard SELECT processing ** based on a global flag setup at startup by the ** form. END IF. This built-in is included primarily for applications that run against a non-ORACLE data source. ** trigger: On-Select */ BEGIN /* ** Check the flag variable we setup at form startup */ IF :Global.Using_Transactional_Triggers = ’TRUE’ THEN User_Exit(’my_select block=EMP’).
356
. END. perhaps based on a parameter.

Syntax FUNCTION SERVER_ACTIVE (item_id Item). IF active_serv = FALSE THEN Forms_OLE.
SERVER_ACTIVE examples
/* ** Built-in: SERVER_ACTIVE ** Example: Checks to see if the OLE server is active. active_serv BOOLEAN. item_name VARCHAR(25) := ’OLEITM’. The data type of the ID is Item. Use the FIND_ITEM built-in to return the ID to an appropriately typed variable.
item_name
SERVER_ACTIVE restrictions
Valid only on Microsoft Windows and Macintosh.
357
. FUNCTION SERVER_ACTIVE (item_name VARCHAR2). ELSE active_serv := Forms_OLE. Specifies the name of the object created at design time. END IF. IF Id_Null(item_id) THEN message(’No such item: ’||item_name). ** trigger: When-Button-Pressed */ DECLARE item_id ITEM.Activate_Server(item_id). BEGIN item_id := Find_Item(item_name). Returns BOOLEAN Built-in Type unrestricted function Enter Query Mode no Parameters item_id Specifies the unique ID that Form Builder assigns to the item when created. FALSE if the OLE server is not running. END.SERVER_ACTIVE built-in
Description Indicates whether or not the server associated with a given container is running: Returns TRUE if the OLE server is running. The data type of the name is VARCHAR2 string. END IF.Server_Active(item_id). You must define an appropriately typed variable to accept the return value.

LABEL Specifies the label text for the alert button. value VARCHAR2). NUMBER. button property VARCHAR2. or ALERT_BUTTON3. PROCEDURE SET_ALERT_BUTTON_PROPERTY (alert_name VARCHAR2. either ALERT_BUTTON1. ALERT_BUTTON2. Syntax PROCEDURE SET_ALERT_BUTTON_PROPERTY (alert_id ALERT. value Built-in Type unrestricted procedure Enter Query Mode yes Parameters alert_id Specifies the unique ID (data type ALERT) that Form Builder assigns to the alert when it is created. Specifies the VARCHAR2 value to be applied to the property you specified. constant that specifies the alert button you want to change.
alert_name buttoA property value Usage Notes
If the label specified is NULL. button NUMBER.
358
. Use FIND_ALERT to return the ID to an appropriately typed variable.SET_ALERT_BUTTON_PROPERTY built-in
Description Changes the label on one of the buttons in an alert. VARCHAR2). Specifies the VARCHAR2 name of the alert. the button’s label reverts to the label specified at design time. property VARCHAR2.

Return the ID to an appropriately typed variable. or in a string/variable construction. message VARCHAR2). property NUMBER. VARCHAR2).SET_ALERT_PROPERTY built-in
Description Changes the message text for an existing alert. message Specifies the message that is to replace the current alert message.
SET_ALERT_PROPERTY restrictions
If the message text exceeds 200 characters. property NUMBER. it will be truncated. al_id Alert. Specifies the specific alert property you are setting: ALERT_MESSAGE_TEXT Specifies that you are setting the text of the alert message. Pass the message as a string enclosed in single quotes.
SET_ALERT_PROPERTY examples
/* ** Built-in: SET_ALERT_PROPERTY ** Example: Places the error message into a user-defined alert ** named ’My_Error_Alert’ and displays the alert. SET_ALERT_PROPERTY (alert_name VARCHAR2. ** trigger: On-Error */ DECLARE err_txt VARCHAR2(80) := Error_Text. as a variable.
359
. message Built-in Type unrestricted procedure Enter Query Mode yes Parameters alert_id alert_name property Specifies the unique ID (data type ALERT) that Form Builder assigns to the alert when it is created. Specifies the VARCHAR2 name of the alert. al_button Number. Overrides the value specified in Form Builder unless the property value is NULL. Syntax SET_ALERT_PROPERTY (alert_id ALERT. TITLE Specifies the title of the alert.

value VARCHAR2) Built-in Type unrestricted procedure Enter Query Mode yes Parameters property Specifies the property you want to set for the given application. FLAG_USER_VALUE_TOO_LONG Specifies how Form Builder should handle user-entered values that exceed an item’s Maximum Length property. Valid values are PROPERTY_TRUE and PROPERTY_FALSE. PLSQL_DATE_FORMAT Specifies the PLSQL date format mask.
361
. CURSOR_STYLE Specifies the cursor style for the given application. value The new value to be set for this property. DATE_FORMAT_COMPATIBILITY_MODE Specifies how certain date format conversion operations will be performed. Syntax SET_APPLICATION_PROPERTY (property NUMBER. The possible properties are as follows: BUILTIN_DATE_FORMAT Specifies the Builtin date format mask.SET_APPLICATION_PROPERTY built-in
Description Sets (or resets) the application property for the current application.

Specify one of the following constants: ALL_RECORDS Specifies whether all the records matching the query criteria should be fetched into the data block when a query is executed. property VARCHAR. Datatype is VARCHAR2. Syntax SET_BLOCK_PROPERTY (block_id Block. Built-in Type unrestricted procedure Enter Query Mode yes Parameters block_id block_name property The unique ID Form Builder assigned to the block when you created it. SET_BLOCK_PROPERTY (block_name VARCHAR2. property VARCHAR. property VARCHAR. SET_BLOCK_PROPERTY (block_id Block. property VARCHAR. SET_BLOCK_PROPERTY (block_name VARCHAR2. SET_BLOCK_PROPERTY (block_name VARCHAR2. Datatype is BLOCK. x NUMBER. The name you gave the block when you created it. x NUMBER). (block_id property VARCHAR.SET_BLOCK_PROPERTY built-in
Description Sets the given block characteristic of the given block.
362
. value VARCHAR). property VARCHAR. value VARCHAR). x NUMBER y NUMBER). SET_BLOCK_PROPERTY Block. x NUMBER). BLOCKSCROLLBAR_POSITION Specifies both the x and y positions of the block’s scroll bar in the form coordinate units indicated by the Coordinate System form property. y NUMBER).

CURRENT_ROW_BACKGROUND_COLOR The color of the object’s background region. Valid values are PROPERTY_TRUE or PROPERTY_FALSE. COORDINATION_STATUS Specifies a status that indicates whether a block that is a detail block in a master-detail relation is currently coordinated with all of its master blocks. that should be used for text in the object. the amount of space between characters (kerning). CURRENT_ROW_FONT_NAME The font family. CURRENT_ROW_FONT_SIZE The size of the font. CURRENT_ROW_FOREGROUND_COLOR The color of the object’s foreground region. DELETE_ALLOWED Specifies whether the operator or the application is allowed to delete records in the given block. and item values. overriding previous WHERE clauses. form parameters. Patterns are rendered in the two colors specified by Background Color and Foreground Color. or typeface. DEFAULT_WHERE Specifies a default WHERE clause for the block.BLOCKSCROLLBAR_X_POS Specifies the x position of the block’s scroll bar in the form coordinate units indicated by the Coordinate System form property. The default WHERE clause can include references to global variables. CURRENT_ROW_FONT_WEIGHT The weight of the font. CURRENT_ROW_FILL_PATTERN The pattern to be used for the object’s fill region. If the named visual attribute does not exist. Valid values are COORDINATED and NON_COORDINATED CURRENT_RECORD_ATTRIBUTE Specify the VARCHAR2 name of a named visual attribute to be associated with the given block. The WHERE reserved word is optional. CURRENT_ROW_FONT_SPACING The width of the font. CURRENT_ROW_FONT_STYLE The style of the font. (Note: this will not override a value established at design time via the Property Palette for the data block’s WHERE clause property. that is. whether the detail records in the block correspond correctly to the current master record in the master block. The list of fonts available is systemdependent. you will get an error message. CURRENT_ROW_WHITE_ON_BLACK Specifies that the object is to appear on a monochrome bitmap display device as white text on a black background. specified in points. the Foreground Color attribute defines the color of text displayed in the item.
363
. that is. For items.) Enclose in single quotes. specified with standard bind variable syntax. BLOCKSCROLLBAR_Y_POS Specifies the y position of the block scroll bar in the form coordinate units indicated by the Coordinate System form property.

NEXT_NAVIGATION_BLOCK Specifies the name of the block’s next navigation block. the next navigation block is the block with the next higher sequence number. INSERT_ALLOWED Specifies whether the operator or the application is allowed to insert records in the given block. By default. the previous navigation block is the block with the next lower sequence number. Valid values are PROPERTY_TRUE or PROPERTY_FALSE. or CHANGE_BLOCK. LOCKING_MODE Specifies the block’s LOCKING_MODE property. MAX_QUERY_TIME Specifies the maximum query time. however. This property is only useful when the Query All Records property is set to Yes. the NEXT_NAVIGATION_BLOCK block property can be set to override the default block navigation sequence. Valid values are PROPERTY_TRUE or PROPERTY_FALSE. Valid values are SAME_RECORD. This allows the form designer to achieve the highest possible performance when querying blocks. Valid values are PROPERTY_TRUE or PROPERTY_FALSE. ENFORCE_PRIMARY_KEY Specifies that any record inserted or updated in the block must have a unique characteristic in order to be committed to the database. OPTIMIZER_HINT Specifies a hint that Form Builder passes on to the RDBMS optimizer when constructing queries. CHANGE_RECORD. NAVIGATION_STYLE Specifies the block’s NAVIGATION_STYLE property. overriding any prior ORDER BY clause. however. ORDER_BY Specifies a default ORDER BY clause for the block.
364
. Valid values are DELAYED or IMMEDIATE. Form Builder automatically prefixes the statement you supply with "ORDER BY. The operator can abort a query when the elapsed time of the query exceeds the value of this property. KEY_MODE Specifies the key mode for the block.DML_DATA_TARGET_NAME Specifies the name of the block’s DML data source. By default. MAX_RECORDS_FETCHED Specifies the maximum number of records that can be fetched. the NEXT_NAVIGATION_BLOCK block property can be set to override the default block navigation sequence. This is particularly useful when running Form Builder against non-ORACLE data sources." PRECOMPUTE_SUMMARIES [Under Construction] PREVIOUS_NAVIGATION_BLOCK Specifies the name of the block’s previous navigation block. Enclose in single quotes but do not include the actual words ’ORDER BY’. either by an operator or programmatically. QUERY_ALLOWED Specifies whether a query can be issued from the block. Valid values are UPDATEABLE_PRIMARY_KEY and NONUPDATEABLE_PRIMARY_KEY.

NON_COORDINATED Specifies that the COORDINATION_STATUS property should be set to NON_COORDINATED for a block that is a detail block in a master-detail relation. Note: You cannot set a blocks’ QUERY_DATA_SOURCE_NAME when the block’s datasource is a procedure. Specifically. PROPERTY_FALSE Specifies that the property is to be set to the FALSE state. supply as the value for DELETE_ALLOWED. PROPERTY_TRUE Specifies that the property is to be set to the TRUE state. If setting both x and y positions this value refers to the x coordinate. This can result in considerable network traffic. particularly if the block contains a LONG data type. INSERT_ALLOWED. DELAYED Specifies that you want Form Builder to lock detail records only at the execution of a commit action. all columns are sent. or ROWID. NON_UPDATEABLE_PRIMARY_KEY Specifies that you want Form Builder to process records in the block on the basis that the underlying data source does not allow primary keys to be updated. When Update Changed Columns Only is set to No. value The following constants can be passed as arguments to the property values described earlier: COORDINATED Specifies that the COORDINATION_STATUS property should be set to COORDINATED for a block that is a detail block in a master-detail relation. this value refers to the y coordinate. UPDATE_CHANGED_COLUMNS Specifies that only those columns updated by an operator will be sent to the database. x The NUMBER value of the axis coordinate specified in form coordinate system units.
365
. UNIQUE_KEY Specifies that you want Form Builder to process records in the block on the basis that the underlying data source uses some form of unique key. QUERY_HITS. Valid values are PROPERTY_TRUE or PROPERTY_FALSE. QUERY_HITS Specifies the NUMBER value that indicates the number of records identified by the COUNT_QUERY operation. and UPDATE_ALLOWED. When setting the y position only. regardless of whether they have been updated. UPDATE_ALLOWED Specifies whether the operator or the application is allowed to update records in the given block. IMMEDIATE Specifies that you want Form Builder to lock detail records immediately whenever a database record has been modified.QUERY_DATA_SOURCE_NAME Specifies the name of the block’s query data source. UPDATEABLE_PRIMARY_KEY Specifies that you want Form Builder to process records in the block on the basis that the underlying data source allows for primary keys to be updated.

PROPERTY_FALSE). updates.PROPERTY_FALSE).’).UPDATE_ALLOWED. xpos IN NUMBER. */ PROCEDURE Make_Block_Query_Only( blk_name IN VARCHAR2 ) IS blk_id Block.y
The NUMBER value of the y axis coordinate specified in form coordinate system units.DELETE_ALLOWED. xpos. /* ** If the block exists (ie the ID is Not NULL) then set ** the three properties for this block. Otherwise signal ** an error. END. Set_Block_Property(blk_id.
366
. ypos). ELSE Message(’Block ’||blk_name||’ does not exist. ypos IN NUMBER ) IS BEGIN
Set_Block_Property(blk_name. Set_Block_Property(blk_id. and deletes to ** queried records in the block whose name is ** passed as an argument to this procedure. BEGIN /* Lookup the block’s internal ID */ blk_id := Find_Block(blk_name). BLOCKSCROLLBAR_POSITION.PROPERTY_FALSE). This value applies when setting both x and y positions. Using BLOCKSCROLLBAR_POSITION: /* ** Built-in: SET_BLOCK_PROPERTY ** Example: Set the x and y position of the block’s scrollbar ** to the passed x and y coordinates */ PROCEDURE Set_Scrollbar_Pos( blk_name IN VARCHAR2. END. and can be ignored for all other properties. */ IF NOT Id_Null(blk_id) THEN Set_Block_Property(blk_id. RAISE Form_trigger_Failure. END IF.INSERT_ALLOWED.
SET_BLOCK_PROPERTY examples
/* ** Built-in: SET_BLOCK_PROPERTY ** Example: Prevent future inserts.

value VARCHAR2). NUMBER). x y NUMBER). FILL_PATTERN The pattern to be used for the object’s fill region. CANVAS_SIZE The dimensions of the canvas (width.SET_CANVAS_PROPERTY built-in
Description Sets the given canvas property for the given canvas. Use the FIND_CANVAS built-in to return the ID to a variable of datatype CANVAS.
canvas_name property
367
. property NUMBER. property NUMBER. height). x NUMBER. SET_CANVAS_PROPERTY (canvas_name VARCHAR2. property value VARCHAR2). Syntax SET_CANVAS_PROPERTY (canvas_id CANVAS. property NUMBER. Built-in Type unrestricted procedure Enter Query Mode yes Parameters canvas_id The unique ID Form Builder assigned to the canvas object when you created it. NUMBER. Possible properties are: BACKGROUND_COLOR The color of the object’s background region. Datatype is VARCHAR2. The name you gave the canvas object when you defined it. property NUMBER. SET_CANVAS_PROPERTY (canvas_name VARCHAR2. Patterns are rendered in the two colors specified by Background Color and Foreground Color. SET_CANVAS_PROPERTY (canvas_id CANVAS. NUMBER. y SET_CANVAS_PROPERTY (canvas_name VARCHAR2. NUMBER). x NUMBER). x SET_CANVAS_PROPERTY (canvas_id CANVAS. property NUMBER. The property you want to set for the given canvas.

WHITE_ON_BLACK Specifies that the object is to appear on a monochrome bitmap display device as white text on a black background. END.
368
. If Form Builder cannot find a named visual attribute by the name you supply. or the name of a logical attribute definition in a runtime resource file that you want Form Builder to apply to the canvas. VISUAL_ATTRIBUTE Either a valid named visual attribute that exists in the current form. specified in points. FOREGROUND_COLOR The color of the object’s foreground region. depending on the property you specified.e. The NUMBER value of the y coordinate or the height. that should be used for text in the object.FONT_NAME The font family. TOPMOST_TAB_PAGE The name of the tab page that will appear to operators as the top-most (i. Specify the argument in form coordinate system units. The list of fonts available is system-dependent. the amount of space between characters (kerning). Specify the argument in form coordinate system units. FONT_WEIGHT The weight of the font. it looks for the display attribute in your Oracle*Terminal resource file. the Foreground Color attribute defines the color of text displayed in the item. FONT_STYLE The style of the font.
SET_CANVAS_PROPERTY examples
/* Change the "background color" by dynamically setting the ** canvas color at runtime to the name of a visual attribute ** you created: */ BEGIN SET_CANVAS_PROPERTY(’my_cvs’. For items. or typeface. visual_attribute.
y
SET_CANVAS_PROPERTY restrictions
• • You cannot enter a non-existent named visual attribute.. FONT_SIZE The size of the font. overlaying all other tab pages in the tab canvas). ’blue_txt’). The NUMBER value of the x coordinate or the width. HEIGHT The height of the canvas in characters. depending on the property you specified. FONT_SPACING The width of the font. that is. WIDTH The width of the canvas in characters. value x The VARCHAR2 value to be applied to the property you specified.

Syntax The built-in is available for types VARCHAR2. The particular property of the JavaBean container associated with this Bean Area. boolean value ). prop-name. SET_CUSTOM_ITEM_PROPERTY (item..
prop-name value
Usage Notes
•
In the JavaBean container. varchar2 value ). or boolean. Description Sets the value of a property of a JavaBean associated with a Bean Area item. For each Set_Custom_Item_Property built-in executed in the form. SET_CUSTOM_ITEM_PROPERTY (item. prop-name. or BOOLEAN. Value must be of type varchar2. SET_CUSTOM_ITEM_PROPERTY (item. the JavaBean container’s setProperty method is called. NUMBER. Built-in Type unrestricted procedure Enter Query Mode yes Parameters item The name of the Bean Area item associated with the target JavaBean. The name of the Bean Area item can be gained through either Find_Item(‘Item_Name’). number value ). each property type must be represented by a single instance of the ID class. integer.SET_CUSTOM_ITEM_PROPERTY built-in
Note: This built-in has been replaced by the SET_CUSTOM_PROPERTY built-in You should use that builtin in any new form.registerProperty.
•
•
369
. created by using ID. or simply via ‘Item_Name’. prop-name. The following information is provided only for maintenance purposes. The name can be in the form of either a varchar2 literal or a variable set to the value of the name. The value for the specified property.

) If you want to set all the instances. created by using ID. row-number. Value must be of type varchar2. each custom property must be represented by a single instance of the ID class. Syntax The built-in is available for types VARCHAR2. or boolean. The name of the item can be gained through either Find_Item(‘Item_Name’).registerProperty. specify the constant ALL_ROWS. row-number. row-number. number. SET_CUSTOM_PROPERTY (item.
•
•
370
.SET_CUSTOM_PROPERTY built-in
Description Sets the value of a user-defined property in a Java pluggable component. value BOOLEAN). The new value for the specified property. value SET_CUSTOM_PROPERTY (item. value NUMBER). The name can be in the form of either a varchar2 literal or a variable set to the value of the name. prop-name. prop-name. The row number of the instance of the item that you want to set. prop-name. the Java component’s setProperty method is called. The particular property of the Java component that you want to set. SET_CUSTOM_PROPERTY (item. (Instance row numbers begin with 1.
row-number
prop-name value
Usage Notes
•
In the Java pluggable component. VARCHAR2). or simply via ‘Item_Name’. or BOOLEAN. Built-in Type unrestricted procedure Enter Query Mode yes Parameters item The name or ID of the item associated with the target Java pluggable component. NUMBER. For each Set_Custom_Property built-in executed in the form.

’SetAnimationRate’. In the form. Set_Custom_Property(’Juggler_Bean’. ALL_ROWS. NewAnimationRate).) In the container (or wrapper) for the JavaBean: private static final ID SETRATE = ID. (To see the full context for this partial code. the Java pluggable component is a JavaBean. NewAnimationRate is a variable holding the new value for that property that is being passed to the JavaBean container. as part of the PL/SQL code activated by a When_Button_Pressed trigger on a faster button on the end-user’s screen: NewAnimationRate := gb. .SET_CUSTOM_PROPERTY examples
In this example. In this SET_CUSTOM_PROPERTY built-in:
•
Juggler_Bean is the name of the Bean Area item in the form.CurAnimationRate + 25 .
• •
371
. The item is associated with the container of the JavaBean. . SetAnimationRate is a property in the container for the JavaBean. look at the complete example.registerProperty(SetAnimationRate).

CURRENT_ROW_FONT_SPACING The width of the font. or typeface. property value NUMBER). that should be used for text in the object. specified in points. CURRENT_ROW_FONT_WEIGHT The weight of the font.
372
. you will get an error message.SET_FORM_PROPERTY built-in
Description Sets a property of the given form. NUMBER. CURRENT_ROW_FONT_SIZE The size of the font. Syntax SET_FORM_PROPERTY (formmodule_id FormModule. Patterns are rendered in the two colors specified by Background Color and Foreground Color. value Built-in Type unrestricted procedure Enter Query Mode yes Parameters formmodule_id formmodule_name property Specifies the unique ID that Form Builder assigns to the form when created. If the named visual attribute does not exist. The data type of the name is VARCHAR2. CURRENT_ROW_FONT_STYLE The style of the font. property NUMBER. CURRENT_ROW_FILL_PATTERN The pattern to be used for the object’s fill region. The list of fonts available is systemdependent. CURRENT_ROW_BACKGROUND_COLOR The color of the object’s background region. that is. Specifies the property you want to set for the form: CURRENT_RECORD_ATTRIBUTE Specify the VARCHAR2 name of a named visual attribute to be associated with the given form. The data type of the ID is FormModule. Specifies the name of the form module that you gave the form when creating it. SET_FORM_PROPERTY (formmodule_name VARCHAR2. the amount of space between characters (kerning). CURRENT_ROW_FONT_NAME The font family. NUMBER).

however. DEFER_REQUIRED_ENFORCEMENT Specifies whether enforcement of required fields has been deferred from item validation to record validation. VALIDATION_UNIT Specifies the scope of validation for the form. for example. FORM_SCOPE Specify when you want validation to occur at the form level only. for instance. that Form Builder validates all the records in a block when a navigation event forces validation by leaving the block. DEFAULT_SCOPE Sets the Validation Unit form module property to the default setting. the default validation unit is ITEM.CURRENT_ROW_FOREGROUND_COLOR The color of the object’s foreground region. PROPERTY_4_5. Valid values are OPEN_AT_COMMIT and CLOSE_AT_COMMIT. By default. Valid values are DIRECTION_DEFAULT. LEFT_TO_RIGHT. when a form is running against a non-ORACLE database. On GUI window managers. the FIRST_NAVIGATION_BLOCK block property can be set to specify a different block as the first block at form startup. value The following constants can be passed as arguments to the property values described earlier: BLOCK_SCOPE Specify when you want Form Builder to validate data only at the block level. For items. FIRST_NAVIGATION_BLOCK Returns the name of the block into which Form Builder attempts to navigate at form startup. CURRENT_ROW_WHITE_ON_BLACK Specifies that the object is to appear on a monochrome bitmap display device as white text on a black background. RECORD_SCOPE. RIGHT_TO_LEFT. and PROPERTY_FALSE. Valid values are PROPERTY_TRUE and PROPERTY_FALSE. CURSOR_MODE Specifies the cursor state Form Builder should attempt to define. Primarily used when connecting to non-ORACLE data sources.
373
. CLOSE_AT_COMMIT Specify when you do not want cursors to remain open across database commits. Valid values are PROPERTY_TRUE. This means. BLOCK_SCOPE. SAVEPOINT_MODE Specifies whether Form Builder is to issue savepoints. DIRECTION Specifies the layout direction for bidirectional objects. Valid values are PROPERTY_TRUE and PROPERTY_FALSE. the Foreground Color attribute defines the color of text displayed in the item. VALIDATION Specifies whether Form Builder is to perform default validation. the first navigation block is the first block defined in the Object Navigator. and ITEM_SCOPE. Valid values are DEFAULT_SCOPE.

Current_Form). bk_name VARCHAR2(40). PROPERTY_TRUE Specifies that the property is to be set to the TRUE state. OPEN_AT_COMMIT Specify when you want cursors to remain open across database commits. Set_Form_Property(fm_id. Specify when you want Form Builder to validate at the item level. the_locking_mode NUMBER ) IS fm_id FormModule. bk_id Block. BEGIN fm_id := Find_Form(:System. ** ** Usage: Setup_Non_Oracle(PROPERTY_FALSE. This means that Form Builder validates each changed record when.BLOCK_SCOPE). it leaves the record. ** UPDATEABLE_PRIMARY_KEY. ** DELAYED). BEGIN /* ** Validate the settings of the parameters ** */ IF the_savepoint_mode NOT IN (PROPERTY_TRUE. RECORD_SCOPE Specify when you want Form Builder to validate at the record level. Example 2 /* ** Built-in: SET_FORM_PROPERTY ** Example: Setup form and block properties required to run ** against a particular non-Oracle datasource.ITEM_SCOPE. Set_Form_Property(fm_id.
SET_FORM_PROPERTY examples
Example 1 /* ** Built-in: SET_FORM_PROPERTY ** Example: Set the Cursor Mode property in the current form ** to CLOSE_AT_COMMIT and changes the form ** Validation unit to the Block level. END. */ PROCEDURE Setup_Non_Oracle( the_savepoint_mode NUMBER. PROPERTY_FALSE Specifies that the property is to be set to the FALSE state. ** Procedure accepts the appropriate numerical ** constants like DELAYED as arguments. for instance.CURSOR_MODE. the_key_mode NUMBER. This is the normal setting when running against ORACLE. */ DECLARE fm_id FormModule. ** CLOSE_AT_COMMIT.PROPERTY_FALSE)
374
. the_cursor_mode NUMBER.CLOSE_AT_COMMIT).VALIDATION_UNIT. for instance. that Form Builder validates each changed item upon navigating out of an item as a result of a navigation event. This means.

the_cursor_mode). IF the_cursor_mode NOT IN (CLOSE_AT_COMMIT. WHILE bk_name IS NOT NULL LOOP bk_id := Find_Block(bk_name). Set_Block_Property(bk_id. IF the_key_mode NOT IN (UNIQUE_KEY. Set_Block_Property(bk_id. END. NON_UPDATEABLE_PRIMARY_KEY) THEN Set_Block_Property(bk_id. END IF. the_savepoint_mode). RAISE Form_trigger_Failure.’).
375
. RAISE Form_trigger_Failure.’). /* ** Get the id of the current form */ fm_id := Find_Form(:System. /* ** Set the block properties for each block in the form */ bk_name := Get_Form_Property(fm_id. END IF.Current_Form). SAVEPOINT_MODE.the_locking_mode).’).UPDATEABLE_PRIMARY_KEY. END IF. /* ** Set the two form-level properties */ Set_Form_Property(fm_id.DELAYED) THEN Message(’Invalid setting for Locking Mode. END IF.the_key_mode). bk_name := Get_Block_Property(bk_id. RAISE Form_trigger_Failure. END IF. END LOOP. Set_Form_Property(fm_id.FIRST_BLOCK). CURSOR_MODE.’).PRIMARY_KEY. NEXTBLOCK). NON_UPDATEABLE_PRIMARY_KEY) THEN Message(’Invalid setting for Key Mode.THEN Message(’Invalid setting for Savepoint Mode.LOCKING_MODE.KEY_MODE. IF the_locking_mode NOT IN (IMMEDIATE. IF the_key_mode IN (UPDATEABLE_PRIMARY_KEY.PROPERTY_TRUE).OPEN_AT_COMMIT) THEN Message(’Invalid setting for Cursor Mode. RAISE Form_trigger_Failure.

row_number cell_value VARCHAR2). Specify as a whole NUMBER. Not valid for a static record group. Explicitly add the row with the ADD_GROUP_ROW built-in or populate the group with either POPULATE_GROUP or POPULATE_GROUP_WITH_QUERY. as in recordgroup_name. Specifies the row number that contains the cell whose value you intend to set.
•
SET_GROUP_CHAR_CELL examples
/* Built-in: ** Example: SET_GROUP_CHAR_CELL See ADD_GROUP_ROW */
376
. NUMBER. row_number NUMBER. preceded by the record group name and a dot. Syntax SET_GROUP_CHAR_CELL (groupcolumn_id GroupColumn.SET_GROUP_CHAR_CELL built-in
Description Sets the value for the record group cell identified by the given row and column. for a LONG column. VARCHAR2). SET_GROUP_CHAR_CELL (groupcolumn_name VARCHAR2. The data type of the ID is GroupColumn. The data type of the name is VARCHAR2. specifies the LONG value you intend to enter into a cell.
groupcolumn_name
row_number cell_value
SET_GROUP_CHAR_CELL restrictions
• You must create the specified row before setting the value of a cell in that row. specifies the VARCHAR2 value you intend to enter into a cell. Use the FIND_COLUMN built-in to return the ID to an appropriately typed variable. A static record group is a record group that was created at design time and that has the Record Group Type property set to Static.groupcolumn_name. For a VARCHAR2 column. cell_value Built-in Type unrestricted procedure Enter Query Mode yes Parameters groupcolumn_id The unique ID that Form Builder assigns when it creates the column for the record group. Form Builder does not automatically create a new row when you indicate one in this built-in. The name you gave to the column when you created it.

as in recordgroup_name. The data type of the name is VARCHAR2. row_number NUMBER. Specify as a whole NUMBER. Not valid for a static record group. The data type of the ID is GroupColumn. A static record group is a record group that was created at design time and that has the Record Group Type property set to Static. Syntax SET_GROUP_DATE_CELL (groupcolumn_id GroupColumn. The name you gave to the column when you created it. Uses the ’is_value_in_list’ ** function from the GET_GROUP_CHAR_CELL example. DATE). preceded by the record group name and a dot. NUMBER.
•
SET_GROUP_DATE_CELL examples
/* ** Built-in: SET_GROUP_DATE_CELL ** Example: Lookup a row in a record group. Specifies the row number that contains the cell whose value you intend to set. and set the ** minimum order date associated with that row in ** the record group. cell_value Built-in Type unrestricted procedure Enter Query Mode yes Parameters groupcolumn_id The unique ID that Form Builder assigns when it creates the column for the record group.SET_GROUP_DATE_CELL built-in
Description Sets the value for the record group cell identified by the given row and column.groupcolumn_name. Specifies the DATE value you intend to enter into a cell.
groupcolumn_name
row_number cell_value
SET_GROUP_DATE_CELL restrictions
• You must create the specified row before setting the value of a cell in that row. SET_GROUP_DATE_CELL (groupcolumn_name VARCHAR2. Form Builder does not automatically create a new row when you indicate one in this built-in. */ PROCEDURE Set_Max_Order_Date_Of( part_no VARCHAR2. Explicitly add the row with the ADD_GROUP_ROW built-in or populate the group with either POPULATE_GROUP or POPULATE_GROUP_WITH_QUERY. Use the FIND_COLUMN built-in to return the ID to an appropriately typed variable. row_number cell_value DATE).
377
.

END IF.fnd_row. END. ’TMPPART’.new_date ).MAXORDDATE’. */ fnd_row := Is_Value_In_List( part_no. ’PARTNO’). BEGIN /* ** Try to lookup the part number among the temporary part list ** record group named ’TMPPART’ in its ’PARTNO’ column. ELSE /* ** Set the corresponding Date cell value from the ** matching row. RETURN.
378
. */ Set_Group_Date_Cell(’TMPPART.’).new_date DATE ) IS fnd_row NUMBER. IF fnd_row = 0 THEN Message(’Part Number ’||part_no||’ not found.

as in recordgroup_name. row_number NUMBER.groupcolumn_name. preceded by the record group name and a dot.
•
SET_GROUP_NUMBER_CELL examples
/* ** Built-in: ** Example: */ SET_GROUP_NUMBER_CELL See ADD_GROUP_ROW
379
. Specify as a whole NUMBER. The name you gave to the column when you created it. Use the FIND_COLUMN built-in to return the ID to an appropriately typed variable. Specifies the row number that contains the cell whose value you intend to set. Explicitly add a row with the ADD_GROUP_ROW built-in or populate the group with either POPULATE_GROUP or POPULATE_GROUP_WITH_QUERY. Not valid for a static record group. The data type of the name is VARCHAR2. Specifies the NUMBER value you intend to enter into a cell. cell_value Built-in Type unrestricted procedure Enter Query Mode yes Parameters groupcolumn_id The unique ID that Form Builder assigns when it creates the column for the record group. A static record group is a record group that was created at design time and that has the Record Group Type property set to Static. NUMBER. Syntax SET_GROUP_NUMBER_CELL (groupcolumn_id GroupColumn. row_number cell_value NUMBER).
groupcolumn_name
row_number cell_value
SET_GROUP_NUMBER_CELL restrictions
• You must create the specified row before setting the value of a cell in that row. NUMBER). The data type of the ID is GroupColumn. SET_GROUP_NUMBER_CELL (groupcolumn_name VARCHAR2.SET_GROUP_NUMBER_CELL built-in
Description Sets the value for the record group cell identified by the given row and column.

The data type of the ID is RecordGroup. END IF. Specifies the name of the record group that you gave to the group when creating it. row_number NUMBER). */ PROCEDURE Select_Even_Rows ( rg_id RecordGroup ) IS BEGIN FOR j IN 1. NUMBER). row_number SET_GROUP_SELECTION (recordgroup_name VARCHAR2. The value you specify is a NUMBER. If you select rows 3.2)=0 THEN Set_Group_Selection( rg_id. and 3. END. 8. The data type of the name is VARCHAR2. Syntax SET_GROUP_SELECTION (recordgroup_id RecordGroup.
380
. Built-in Type unrestricted procedure Enter Query Mode yes Parameters recordgroup_id Specifies the unique ID that Form Builder assigns to the record group when created. 2. You can undo any row selections for the entire group by calling the RESET_GROUP_SELECTION built-in. and 12. j ). Specifies the number of the record group row that you want to select.. END LOOP. Use the FIND_GROUP built-in to return the ID to a variable. those rows are considered by Form Builder to be selections 1. Rows are numbered sequentially starting at 1.SET_GROUP_SELECTION built-in
Description Marks the specified row in the given record group for subsequent programmatic row operations.Get_Group_Row_Count(rg_id) LOOP IF MOD(j. for example.
recordgroup_name row_number
SET_GROUP_SELECTION examples
/* ** Built-in: SET_GROUP_SELECTION ** Example: Set all of the even rows as selected in the ** record group whose id is passed-in as a ** parameter.

Once trigger processing is completed. */ BEGIN Set_Input_Focus(MENU). ** Only has an effect on character-mode or ** block-mode devices. Built-in Type unrestricted procedure Enter Query Mode yes Parameters MENU
SET_INPUT_FOCUS restrictions
Only for use in character mode and block mode environments.
381
. END. Syntax SET_INPUT_FOCUS (MENU ). Form Builder activates the menu.
SET_INPUT_FOCUS examples
/* ** Built-in: SET_INPUT_FOCUS ** Example: Directs the users input focus to the Menu when ** used with the only support parameter.SET_INPUT_FOCUS built-in
Description Sets the input focus on the menu of the current form. MENU.

Note that SET_ITEM_INSTANCE_PROPERTY only affects the display of the current instance of the item. This means that if you specify a display change for an item that exists in a multi-record block. SET_ITEM_INSTANCE_PROPERTY (item_name VARCHAR2. or the current form is exited
Syntax SET_ITEM_INSTANCE_PROPERTY (item_id ITEM. property NUMBER. Use the FIND_ITEM built-in to return the ID to a variable with datatype of ITEM.SET_ITEM_INSTANCE_PROPERTY built-in
Description Modifies the current item instance in a block by changing the specified item property. SET_ITEM_INSTANCE_PROPERTY does not change the appearance of items that mirror the current instance. value VARCHAR2). Any change made by a SET_ITEM_INSTANCE_PROPERTY remains in effect until: • • • • the same item instance is referenced by another SET_ITEM_INSTANCE_PROPERTY. property NUMBER. value NUMBER). You can specify CURRENT_RECORD if you want to set the block’s current record.. use SET_ITEM_PROPERTY . The record number that you want to set. SET_ITEM_INSTANCE_PROPERTY only changes the instance of that item that belongs to the block’s current record. other instances of the specified item are not affected. record_number NUMBER. If you want to change all instances of an item in a multi-record block. Built-in Type unrestricted procedure Enter Query Mode yes Parameters item_id The unique ID that Form Builder assigned to the object when it created it. or the same item instance is referenced by the DISPLAY_ITEM built-in. record_number NUMBER.g. record_number NUMBER.
record_number
382
. SET_ITEM_INSTANCE_PROPERTY (item_name VARCHAR2. The record number is the record’s position in the block. property NUMBER. or the instance of the item is removed (e. through a CLEAR_RECORD or a query). value VARCHAR2). Specify as a whole number. You can reference any item in the current form.

NAVIGABLE When set to PROPERTY_TRUE at the item instance and item levels. allows the end user to be able to navigate to the item instance using default keyboard navigation. item. and block). item. setting NAVIGABLE to true has no effect at the item instance level unless it is set consistently at the item and item instance levels
•
383
. disables default keyboard navigation to the item instance. Some of the effects of these two rules are as follows: • setting INSERT_ALLOWED to true has no effect at the item instance level unless it is set consistently at the block and item levels. When set to PROPERTY_TRUE at the item instance. allows the end user to modify the item instance. prohibits the end user from modifying the item instance. allows the end user to modify the item instance. Note: You cannot set BORDER_BEVEL if the item’s Bevel property is set to None in Form Builder. item. item. and block levels. Setting this property to PROPERTY_FALSE at the item instance and item levels. Setting this property to PROPERTY_FALSE at the item instance. indicates that the item instance is not required.item_name property
The name you gave the item when you created it. but not at the item or block levels. Setting this property to PROPERTY_FALSE at the item instance or item levels. INSERT_ALLOWED Applies only to records not retrieved from the database. Possible properties are: BORDER_BEVEL Specifies the item border bevel for the specified item instance. item. Valid values are RAISED. VISUAL_ATTRIBUTE Specify a valid named visual attribute that exists in the current form or ’’. LOWERED. or block levels. UPDATE_ALLOWED Applies only to records retrieved from the database. or " ". REQUIRED Specify the constant PROPERTY_TRUE if you want to force the end user to enter a non-null value for the item instance. item. your user cannot type data into an item instance if INSERT_ALLOWED is true at the instance level. or block levels. prohibits the end user from modifying the item instance. When set to PROPERTY_TRUE at the item instance. The property you want to set for the given item. A value of " " causes the border bevel to be determined by the value specified at the item level at design-time or by SET_ITEM_PROPERTY at runtime. Datatype is VARCHAR2. and block levels. When set to PROPERTY_FALSE at the instance. PLAIN (unbeveled). and block levels is called the effective value. consider the following guidelines: • • Required properties specified at multiple levels are ORed together Other boolean properties specified at multiple levels are ANDed together
The value derived from combining properties specified at the item instance. For example. Specifying ’’ leaves visual attribute unspecified at the item instance level.
Usage Notes When working with properties specified at multiple levels (item instance.

selecting a t-list instance's current value will have no effect. setting BORDER_BEVEL at the item instance level will override the item level BORDER_BEVEL setting. its item instance properties are set to values that do not override the values specified at higher levels. that is. Setting an item instance property does not affect the item instance properties of any items that mirror the specified item. the BORDER_BEVEL and VISUAL_ATTRIBUTE properties get set to " ". setting VISUAL_ATTRIBUTE at the item instance level will override the properties at the item and block levels unless you specify a partial visual attribute. REQUIRED is set to false. the item-level settings of this property are used. except when the item instance BORDER_BEVEL property is unspecified (that is. For example. A block’s readonly Enterable property will be true if and only if its current record contains an item instance whose effective value for the NAVIGABLE property is true. If VISUAL_ATTRIBUTE is set to " " at the item instance level. WHILE ( cur_itm IS NOT NULL ) LOOP cur_itm := cur_block||’. NEXTITEM ).Cursor_Block. item. setting UPDATE_ALLOWED to true has no effect at the item instance level unless it is set consistently at the block. set to " "). setting REQUIRED to false has no effect at the item instance level unless it is set consistently at the item and item instance levels. VISUAL_ATTRIBUTE. it will be unselected (leaving the t-list with no selected value) if its Required property is set to false. If its Required property is set to true. When a new record is created. When selecting the current value of an instance of a text list (t-list). cur_block VARCHAR2(80) := :System.’My_Favorite_Named_Attribute’). display an extra null value if its current value is NULL or if its Required property is set to false. END. Set_Item_Instance_Property( cur_itm. An instance of a poplist will. BEGIN cur_itm := Get_Block_Property( cur_block. cur_itm := Get_Item_Property( cur_itm. FIRST_ITEM ). in which case a merge will occur between the partial visual attribute and the item's current visual attribute.
384
. when selected.•
Setting NAVIGABLE to true may affect whether the block is considered enterable. and item instance levels. CURRENT_RECORD. and other boolean properties are set to true.’||cur_itm. END LOOP. the value will remain selected.
• • • •
•
• •
•
SET_ITEM_INSTANCE_PROPERTY examples
/* ** Built-in: SET_ITEM_INSTANCE_PROPERTY ** Example: Change visual attribute of each item instance in the ** current record */ DECLARE cur_itm VARCHAR2(80).

(item_id property NUMBER. x NUMBER). Datatype is VARCHAR2. value SET_ITEM_PROPERTY (item_name VARCHAR2. property NUMBER.
item_name property
385
. Valid values are ALIGNMENT_START. property value VARCHAR2). x NUMBER. Syntax SET_ITEM_PROPERTY (item_id ITEM. SET_ITEM_PROPERTY (item_name VARCHAR2. The name you gave the item when you created it. property NUMBER. x NUMBER). y NUMBER). NUMBER.SET_ITEM_PROPERTY built-in
Description Modifies all instances of an item in a block by changing a specified item property. SET_ITEM_PROPERTY ITEM. Possible properties are: ALIGNMENT The text alignment (text and display items only). SET_ITEM_PROPERTY ITEM. ALIGNMENT_RIGHT. Use the FIND_ITEM built-in to return the ID to a variable with datatype of ITEM. VARCHAR2). x NUMBER. property NUMBER. ALIGNMENT_ CENTER. SET_ITEM_PROPERTY (item_name VARCHAR2. ALIGNMENT_LEFT. (item_id property NUMBER. y NUMBER). ALIGNMENT_END. Note that in some cases you can get but not set certain object properties. The property you want to set for the given item. Built-in Type unrestricted procedure Enter Query Mode yes Parameters item_id The unique ID that Form Builder assigned to the object when it created it.

AUTO_HINT Determines if Form Builder will display help hints on the status line automatically when input focus is in the specified item. Note: You cannot set BORDER_BEVEL if the item’s Bevel property is set to None in Form Builder. AUTO_SKIP Specifies whether the cursor should skip to the next item automatically when the end user enters the last character in a text item. BORDER_BEVEL Specifies the item border bevel for the specified item instance. or typeface. LOWERED. CURRENT_ROW_FONT_STYLE The style of the font. Valid values are COMPRESSION_ON. that is. or NONE. CASE_RESTRICTION Specifies the case restriction applied to any text entered in the indicated text item. CURRENT_ROW_FONT_SPACING The width of the font. CURRENT_ROW_FONT_NAME The font family. LOWERCASE. CONCEAL_DATA Specify the constant PROPERTY_TRUE if you want the item to remain blank or otherwise obscured when the end user enters a value. you will get an error message. the amount of space between characters (kerning). The list of fonts available is systemdependent. Valid only for a text item. Valid values are RAISED. CURRENT_ROW_FONT_SIZE The size of the font. and ORIGINAL_SETTING (retain the default compression setting of the data). CURRENT_ROW_FONT_WEIGHT The weight of the font. that should be used for text in the object. COMPRESSION_OFF. specified in points. Valid values are UPPERCASE. Valid values are PROPERTY_TRUE and PROPERTY_FALSE. or PLAIN (unbeveled). CURRENT_ROW_BACKGROUND_COLOR The color of the object’s background region. Patterns are rendered in the two colors specified by Background Color and Foreground Color. Valid values are PROPERTY_TRUE and PROPERTY_FALSE. BACKGROUND_COLOR The color of the object’s background region. COMPRESSSpecifies whether the sound data from a sound object should be compressed before Form Builder writes the data to the file. CURRENT_RECORD_ATTRIBUTE Specifies the VARCHAR2 name of a named visual attribute to be associated with the given item. Specify the constant PROPERTY_FALSE if you want any value that is typed into the text item to be visible. If the named visual attribute does not exist. CASE_INSENSITIVE_QUERY Specifies whether query conditions entered in the item should be case-sensitive.
386
. Valid values are PROPERTY_TRUE and PROPERTY_FALSE. CURRENT_ROW_FILL_PATTERN The pattern to be used for the object’s fill region.

When Echo is false. ECHO Specifies whether characters an end user types into a text item should be visible. that should be used for text in the object. DIRECTION Specifies the layout direction for bidirectional objects. that is. Valid values are PROPERTY_TRUE and PROPERTY_FALSE. the item is valid only if the number of characters in its value equals the Max Length setting. HEIGHT Specifies the height of the item. Consult the "Propagation of Property Changes" section for details. FONT_SIZE The size of the font. DISPLAYED Specifies whether the item will be displayed/enabled or hidden/disabled. Valid values are PROPERTY_TRUE and PROPERTY_FALSE. the Foreground Color attribute defines the color of text displayed in the item. RIGHT_TO_LEFT. the amount of space between characters (kerning). FONT_STYLE The style of the font. FONT_SPACING The width of the font. For items. specified in hundredths of a point (i.
387
. FOREGROUND_COLOR The color of the object’s foreground region.e. CURRENT_ROW_WHITE_ON_BLACK Specifies that the object is to appear on a monochrome bitmap display device as white text on a black background. FONT_WEIGHT The weight of the font. Valid values are PROPERTY_TRUE and PROPERTY_FALSE. the value should be set to 800). Note: Setting Enabled to false will cause other item property settings to change. or typeface. Used for password protection. The list of fonts available is system-dependent.. FORMAT_MASK Specifies the display format and input accepted for data in text items. When FIXED_LENGTH is true. For items. FIXED_LENGTH Specifies whether the item’s value should be validated against the setting of the item’s Max Length property. Valid values are DIRECTION_DEFAULT. FILL_PATTERN The pattern to be used for the object’s fill region. the Foreground Color attribute defines the color of text displayed in the item. LEFT_TO_RIGHT. ENABLED Specifies whether end users should be able to manipulate an item. Patterns are rendered in the two colors specified by Background Color and Foreground Color. FONT_NAME The font family.CURRENT_ROW_FOREGROUND_COLOR The color of the object’s foreground region. the characters typed are hidden. for a font size of 8 points.

the cursor returns to the same position it was in when it left the text item. ITEM_SIZE Specifies a width and height for the item as two numbers separated by a comma. INSERT_ALLOWED In a new record. IMAGE_DEPTH Specifies the depth of color to be applied to an image item. specified in Form Builder. LOV_NAME Specify the VARCHAR2 name of an LOV to be associated with the given item. will be restored. This property is only valid for items that have labels. MERGE_CURRENT_ROW_VA Merges the contents of the specified visual attribute with the current row’s visual attribute (rather than replacing it). but is displayed normally (not grayed out). MERGE_VISUAL_ATTRIBUTE Merges the contents of the specified visual attribute with the object’s current visual attribute (rather than replacing it). MOUSE_NAVIGATE Specifies whether Form Builder should navigate and set focus to the item when the end user activates the item with the mouse. If the text specified is NULL. Use primarily when connecting to a non-ORACLE data source that does not have row-level locking. MERGE_TOOLTIP_ATTRIBUTE Merges the contents of the specified visual attribute with the tooltip’s current visual attribute (rather than replacing it). Specify the constant
388
. When Keep Cursor Position is false. (Insert_Allowed does not propagate changes to the Enabled property. the original hint text. Specify the constant PROPERTY_FALSE if you do not want the record locked when this item is changed.HINT_TEXT Specifies the item-specific help text displayed on the message line at runtime. y. LABEL Specifies the VARCHAR2 string that you want displayed as the label of the item. Set to PROPERTY_TRUE or PROPERTY_FALSE. the cursor returns to the default position in the text item. If the LOV name does not exist. ICON_NAME Specifies the file name of the icon resource associated with a button item having the Iconic property set to YES. such as buttons. KEEP_POSITION Specifies whether the Keep Cursor Position property should be true or false. When Keep Cursor Position is true. Specify PROPERTY_FALSE to specify that the item does not accept modification. allows end user to insert items normally when set to PROPERTY_TRUE. Use the syntax that includes x. LOCK_RECORD_ON_CHANGE Specify the constant PROPERTY_TRUE if you want the record to be locked when this item is changed. you will get an error message. Valid values are PROPERTY_TRUE and PROPERTY_FALSE.) ITEM_IS_VALID Specifies whether the current item should be considered valid. Specify the constant PROPERTY_TRUE if you want the end user to be able to navigate to the item using the mouse.

Otherwise. or PROMPT_ALL_RECORDS. Use the syntax that includes x. or BOTTOM_EDGE. specify the constant PROPERTY_FALSE. TOP_EDGE.
389
. y. Specify the character string ENABLED for the OLE popup menu item to be displayed and enabled.PROPERTY_FALSE if you want a mouse click to keep the input focus in the current item. END_EDGE. Specify the character string DISABLED for the OLE popup menu item to be displayed and not enabled. PROMPT_BACKGROUND_COLOR The color of the object’s background region. PROMPT_EDGE Determines which edge the item’s prompt is attached to. PROMPT_HIDDEN. y coordinates for the item as NUMBERs separated by a comma. PROMPT_ALIGNMENT_OFFSET Determines the distance between the item and its prompt. (Keyboard Navigable does not propagate changes to the Enabled property. PREVIOUS_NAVIGATION_ITEM Specifies the name of the item that is defined as the "previous navigation item" with respect to this current item. POSITION Specify the x. either PROMPT_FIRST_RECORD. PRIMARY_KEY Specify the constant PROPERTY_TRUE to indicate that any record inserted or updated in the block must have a unique characteristic in order to be committed to the database. Specify the constant PROPERTY_FALSE if you want to disable default keyboard navigation to the item. NAVIGABLE Specify the constant PROPERTY_TRUE if you want the end user to be able to navigate to the item using default keyboard navigation. PROMPT_DISPLAY_STYLE Determines the prompt’s display style.) NEXT_NAVIGATION_ITEM Specifies the name of the item that is defined as the "next navigation item" with respect to this current item. either START_EDGE. POPUPMENU_CONTENT_ITEM Specifies the setting for any of the OLE popup menu item properties: POPUPMENU_COPY_ITEM POPUPMENU_CUT_ITEM POPUPMENU_DELOBJ_ITEM POPUPMENU_INSOBJ_ITEM POPUPMENU_LINKS_ITEM POPUPMENU_OBJECT_ITEM POPUPMENU_PASTE_ITEM POPUPEMNU_PASTESPEC_ITEM Specify the character string HIDDEN for the OLE popup menu item not to be displayed on the OLE popup menu.

that is. the amount of space between characters (kerning). QUERY_ONLY Specify an item to be queried. or typeface. Specify the constant PROPERTY_FALSE if you want to disallow the use of the item in a query. PROMPT_FOREGROUND_COLOR The color of the object's foreground region. PROMPT_FONT_NAME The font family. PROPERTY_FALSE to hide it. Specify the constant PROPERTY_FALSE if the item is not to be required. PROMPT_EDGE_OFFSET Determines the distance between the item and its prompt as a VARCHAR2 value. PROMPT_FILL_PATTERN The pattern to be used for the object's fill region. or ALIGNMENT_END.PROMPT_EDGE_ALIGNMENT Determines which edge the item’s prompt is aligned to. PROMPT_FONT_SIZE The size of the font. REQUIRED Specify the constant PROPERTY_TRUE if you want to force the end user to enter a value for the item. PROMPT_FONT_WEIGHT The weight of the font. and check boxes. For items. PROMPT_FONT_SPACING The width of the font. ALIGNMENT_RIGHT. or ALIGNMENT_CENTER. that should be used for text in the object. QUERY_ONLY is applicable to text items. either ALIGNMENT_START.
390
. specified in points. preventing that item from becoming part of insert or update statements. ALIGNMENT_LEFT. ALIGNMENT_CENTER. ALIGNMENT_END. QUERYABLE Specify the constant PROPERTY_TRUE if you want the end user to be able to initiate a query against the item. Enclose the fullyqualified item name in single quotes. PROMPT_VISUAL_ATTRIBUTE Specifies the named visual attribute that should be applied to the prompt at runtime. radio groups. SHOW_FAST_FORWARD_BUTTON Specify the constant PROPERTY_TRUE to display the fast forward button on a sound item. PROMPT_WHITE_ON_BLACK Specifies that the object is to appear on a monochrome bitmap display device as white text on a black background. PROMPT_TEXT_ALIGNMENT Determines how the prompt is justified. the Foreground Color attribute defines the color of text displayed in the item. The list of fonts available is system-dependent. either ALIGNMENT_START. Patterns are rendered in the two colors specified by Background Color and Foreground Color. PROMPT_TEXT Determines the text label that displays for an item. PROMPT_FONT_STYLE The style of the font.

that is. PROPERTY_FALSE to hide it. SHOW_RECORD_BUTTON Specify the constant PROPERTY_TRUE to display the record on a sound item. but not both. or typeface. TOOLTIP_FONT_NAME The font family. PROPERTY_FALSE to hide it. Specify the constant PROPERTY_FALSE if this
391
. TOOLTIP_FONT_WEIGHT The weight of the font. SHOW_SLIDER Specify the constant PROPERTY_TRUE to display the slider on a sound item. TOOLTIP_FONT_STYLE The style of the font. The list of fonts available is system-dependent. and included in the columns to be written to the database. TOOLTIP_BACKGROUND_COLOR The color of the object’s background region. UPDATE_ALLOWED Specify the constant PROPERTY_TRUE if you want the end user to be able to update the item. SHOW_REWIND_BUTTON Specify the constant PROPERTY_TRUE to display the rewind button on a sound item. TOOLTIP_WHITE_ON_BLACK Specifies that the object is to appear on a monochrome bitmap display device as white text on a black background. Note that Form Builder will hide either play or record. that should be used for text in the object. Specify the constant PROPERTY_FALSE if you want the item protected from update. PROPERTY_FALSE to hide it. PROPERTY_FALSE to hide it. TOOLTIP_TEXT Determines the item’s tooltip text. TOOLTIP_FOREGROUND_COLOR The color of the object’s foreground region. TOOLTIP_FONT_SPACING The width of the font. PROPERTY_FALSE to hide it.SHOW_PLAY_BUTTON Specify the constant PROPERTY_TRUE to display the play button on a sound item. but not both. Note that Form Builder will hide either play or record. TOOLTIP_FONT_SIZE The size of the font. the amount of space between characters (kerning). specified in points. For items. UPDATE_COLUMN Specify the constant PROPERTY_TRUE if this column should be treated as updated. TOOLTIP_FILL_PATTERN The pattern to be used for the object’s fill region. PROPERTY_FALSE to hide it. SHOW_TIME_INDICATOR Specify the constant PROPERTY_TRUE to display the time indicator button on a sound item. SHOW_VOLUME_CONTROL Specify the constant PROPERTY_TRUE to display the volume control on a sound item. the Foreground Color attribute defines the color of text displayed in the item. Patterns are rendered in the two colors specified by Background Color and Foreground Color.

and not be included in the columns to be written to the database. The data type of the property determines the data type of the value you enter. in other words. Note: You cannot set the visual attribute for an image item. WIDTH Specify the width of the item as a NUMBER. Specify PROPERTY_FALSE to specify that Form Builder should not use the LOV for validation. For example. If you want to change the LABEL for the item. The size of the units depends on how you set the Coordinate System property and default font scaling for the form. UPDATE_PERMISSION Use UPDATE_ ALLOWED when you run against non-ORACLE data sources. Y_POS Specify the y coordinate as a NUMBER. enter two single quotes with no space between: ‘’. Specify the constant PROPERTY_TRUE to turn on the item’s UPDATEABLE and UPDATE_NULL properties. Valid values are PROPERTY_TRUE and PROPERTY_FALSE. X_POS Specify the x coordinate as a NUMBER. if you want to set the VISIBLE property to true. Specify the constant PROPERTY_FALSE to turn off the item’s UPDATEABLE and UPDATE_NULL properties. Specify the constant PROPERTY_FALSE if you want the end user to be able to update the value of the item regardless of whether the value is NULL. as a VARCHAR2 string. the label. value Specify the value to be applied to the given property. If you want to reset the value of the property to be the value originally established for it at design time. For instance. UPDATE_NULL Specify the constant PROPERTY_TRUE if you want the end user to be able to update the item only if its value is NULL. Note: Setting Visible to false will cause other item property settings to change. PROPERTY_TRUE Specifies that the property is to be set to the TRUE state.
392
. PROPERTY_FALSE Specifies that the property is to be set to the FALSE state. VISUAL_ATTRIBUTE Specify a valid named visual attribute that exists in the current form. SET_ITEM_PROPERTY(‘DEPTNO’.column should be treated as not updated. VISIBLE Specifies whether the indicated item should be visible or hidden. Consult the "Propagation of Property Changes" section for details. you specify the value. you specify the constant PROPERTY_TRUE for the value. WHITE_ON_BLACK Specifies that the object is to appear on a monochrome bitmap display device as white text on a black background. VALIDATE_FROM_LIST Specifies that Form Builder should validate the value of the text item against the values in the attached LOV when set to PROPERTY_TRUE.

Specify the argument in form coordinate system units. (All)
To this restricted setting
If this target item condition is true: • NULL-canvas item (item's canvas property is null)
true/false
ENABLED
true/false true
• •
current item Visible item property is false
INSERT_ALLOWED
true true
• •
Enabled item property is false Visible item property is false
NAVIGABLE
true/false true
• •
current item Visible item property is false
393
. ‘’). If the change is validated. Form Builder makes the change and leaves it in effect until another SET_ITEM_PROPERTY changes the same property or the current form is exited. Form Builder issues an error message.
You cannot set this property parameter.. x Specifies the NUMBER value of the x coordinate or the width.FORMAT_MASK. depending on the property you specified. Specify the argument in form coordinate system units. Form Builder validates the change before it adjusts the property. Specifies the NUMBER value of the y coordinate or the height. depending on the property you specified.. given the following target item conditions. would reset that format mask to its design-time value.
y
Usage Notes The following issues can affect your decisions on how to apply certain property values to an item: • • validation of property changes propagation of property changes
Validation of Property Changes When you specify a change through the SET_ITEM_PROPERTY built-in. Illegal Settings If the change is not validated. You cannot use SET_ITEM_PROPERTY to set the following item properties true or false.

the end user needs to be able to leave this item (behavior not allowed for a REQUIRED item).item IS NULL THEN :block.QUERYABLE (Query Allowed)
true
•
Visible item property is false
UPDATE_ALLOWED
true true
• •
Enabled item property is false Conceal Data item property is true
UPDATE_NULL (Update if NULL)
true true
• •
Enabled item property is false Conceal Data item property is true
VISIBLE
true/false
• •
current item
Form Builder does not consider the current contents of an item before allowing a property change. Later in the application. such as Employee ID. Form Builder does not automatically change the VALID/INVALID marking. In the application. For example. This is included primarily for compatibility with prior versions. or propagate. If SET_ITEM_PROPERTY changes an item property that would affect how Form Builder validates the data in an item (for example. At this point.. so you temporarily set the REQUIRED property to False.item := NULL. FIXED_LENGTH or REQUIRED). Form Builder marks an existing NULL value as VALID. the intended change. ENABLED
To this setting False
Also causes these propagated changes: • sets the Navigable item property to False sets the Update_Null item
•
394
.. one SET_ITEM_PROPERTY statement can cause changes to more than one item property if the additional changes are necessary to complete. In order to have a NULL value marked as INVALID (expected for a REQUIRED item). The new validation rules do not apply to the item until Form Builder next validates it under normal circumstances. the validation consequences are not retroactive. suppose the application has a required text item. when you set the REQUIRED property to true again. you must make a change in the item that will cause Form Builder to validate it. such as: IF :block. However. The following table shows the SET_ITEM_PROPERTY settings that cause Form Builder to propagate changes across item properties:
Setting this property parameter. Propagation of Property Changes You can only specify a change to one item property at a time through the SET_ITEM_PROPERTY built-in.

VARCHAR2). Note: Setting the column width to NULL results in a hidden. Use the FIND_LOV built-in to return the ID to an appropriately typed variable. colnum property NUMBER. Note: Setting the column title to NULL resets the column title to the title specified at design time. column. The first column is column 1. Specifies the LOV name (as a VARCHAR2). NUMBER. value The VARCHAR2 or NUMBER value that represents the desired property setting.
lov_name colnum property
397
. Specifies the column to be modified (as a NUMBER). The possible properties are as follows: TITLE Sets the Column Title property that controls the title that displays above an LOV column.SET_LOV_COLUMN_PROPERTY built-in
Description Sets the given LOV property for the given LOV. The data type of the ID is LOV. NUMBER. colnum property NUMBER. WIDTH Specifies the width to be reserved in the LOV for displaying column values. SET_LOV_COLUMN_PROPERTY (lov_name VARCHAR2. or nondisplayed. Syntax SET_LOV_COLUMN_PROPERTY (lov_id LOV. Specifies the property you want to set for the given LOV. value Built-in Type unrestricted procedure Enter Query Mode yes Parameters lov_id Specifies the unique ID that Form Builder assigns the LOV when created. value VARCHAR2).

LOV_SIZE Specifies a width. Overrides the value specified in the Form Builder unless the property value is NULL. property NUMBER. Syntax SET_LOV_PROPERTY (lov_id LOV. Specifies the LOV name (as a VARCHAR2). property NUMBER. x NUMBER. NUMBER). GROUP_NAME Specifies the record group with which the LOV is associated. value Specify one of the following constants:
lov_name property
398
. y SET_LOV_PROPERTY (lov_name VARCHAR2. SET_LOV_PROPERTY (lov_name VARCHAR2. The possible properties are as follows: AUTO_REFRESH Specifies whether Form Builder re-executes the query each time the LOV is invoked. height pair indicating the size of the LOV. TITLE Specifies the title of the LOV. POSITION Specifies an x. y pair indicating the position of the LOV. x NUMBER. property NUMBER. value NUMBER). Built-in Type unrestricted procedure Enter Query Mode yes Parameters lov_id Specifies the unique ID that Form Builder assigns the LOV when created. Use the FIND_LOV built-in to return the ID to an appropriately typed variable. property NUMBER. y NUMBER). The data type of the ID is LOV. Specifies the property you want to set for the given LOV. value SET_LOV_PROPERTY (lov_id LOV.SET_LOV_PROPERTY built-in
Description Sets the given LOV property for the given LOV. NUMBER).

BEGIN lov_id := Find_LOV(’My_LOV_1’). Specify either the y coordinate or the height.
SET_LOV_PROPERTY examples
/* ** Built-in: SET_LOV_PROPERTY ** Example: if LOV is currently base on GROUP1.’GROUP2’). depending on the property you specified.GROUP_NAME) = ’GROUP1’ THEN Set_LOV_Property(lov_id.
399
. Recordgroup Name Specify the VARCHAR2 name of the record group you are setting.GROUP_NAME. ** make LOV use GROUP2 */ DECLARE lov_id LOV. You can create this record group in Form Builder or programmatically. depending on the property you specified. as long as the record group exists when the SET_LOV_PROPERTY is called. END. ENDIF. IF Get_LOV_Property(lov_id. PROPERTY_FALSE Specifies that the property is to be set to the FALSE state.
x y
SET_LOV_PROPERTY restrictions
• You can set only one property per call to the built-in. Specify either the x coordinate or the width.PROPERTY_TRUE Specifies that the property is to be set to the TRUE state.

If you specify the menu item by name. which indicates if a check box menu item or a radio menu item is in the checked state or unchecked state. NUMBER). Label Specify the VARCHAR2 label name. include the qualifying menu name.menuitem_name Specifies the VARCHAR2 name you gave to the menu item when you defined it. LABEL Specifies the character string for the menu item label. Use the FIND_MENU_ITEM built-in to return the ID to an appropriately typed variable. value Specify one of the following constants: PROPERTY_TRUE Specifies that the property is to be set to the TRUE state. The data type of the ID is MenuItem. PROPERTY_FALSE Specifies that the property is to be set to the FALSE state. ENABLED Specifies whether the menu item is enabled (thus active) or disabled (thus greyed out and unavailable to the operator). property Specify one of the following constants to set information about the menu item: CHECKED Specifies the Checked property.SET_MENU_ITEM_PROPERTY built-in
Description Modifies the given properties of a menu item. VISIBLE Specifies whether the menu item is visibly displayed. property value NUMBER). as shown in the syntax.menuitem_name property value Built-in Type unrestricted procedure Enter Query Mode yes Parameters menuitem_id Specifies the unique ID Form Builder assigns when it creates the menu item.
VARCHAR2. NUMBER. ICON_NAME Specifies the file name of the icon resource associated with a menu item having the Icon in Menu property set to TRUE. SET_MENU_ITEM_PROPERTY (menu_name.
400
.
menu_name. NUMBER. Syntax SET_MENU_ITEM_PROPERTY (menuitem_id MenuItem.

Runform displays the item in a disabled state. but disabled and the Display w/o Priv property for this menu item was set in Form Builder. In this case. whether you can set the property of a menu item using SET_MENU_ITEM_PROPERTY depends on whether the form operator has access privileges for that item. Runform does not display that item. If the menu item is hidden and the operator does not have security access to a menu item.
•
•
SET_MENU_ITEM_PROPERTY examples
/* ** Built-in: SET_MENU_ITEM_PROPERTY ** Example: See GET_MENU_ITEM_PROPERTY */
401
. You cannot set the property of a menu item using SET_MENU_ITEM_PROPERTY if the item is currently hidden. you can set the menu item properties programmatically.SET_MENU_ITEM_PROPERTY restrictions
These restrictions apply only if the menu module’s Use Security property is set to Yes: • If the menu module Use Security property is Yes. If the menu item is displayed.

Built-in Type unrestricted procedure Parameters obj memberid newval vtype A pointer to the OLE object. and there have been no intervening GET_OLE. For the VARCHAR2 version. vtype VT_TYPE). The member ID of the OLE property. The VT_TYPE of the original variant. one for each of the new-value types: NUMBER. vtype VT_TYPE). memberid PLS_INTEGER newval OLEVAR. memberid PLS_INTEGER newval NUMBER. If not specified. and OLEVAR. VARCHAR.SET_OLE built-in
Description Changes the value of an OLE property. SET_OLE. the default value for the NUMBER version of the procedure is VT_R8. This is an optional parameter. Usage Notes If INIT_OLEARGS and ADD_OLEARG calls precede this SET_OLE call. the default is VT_BSTR. For the OLEVAR version. PROCEDURE SET_OLE (obj OLEOBJ. A new value of the specified type to replace the OLE property. vtype VT_TYPE). then this call will access the property by using the arguments specified in those INIT_OLEARGS and ADD_OLEARG calls. or CALL_OLE calls. Syntax PROCEDURE SET_OLE (obj OLEOBJ. whatever type the variant itself actually specifies . There are three versions of the procedure. PROCEDURE SET_OLE (obj OLEOBJ.
402
. the default is VT_VARIANT: that is. memberid PLS_INTEGER newval VARCHAR2.

The actual parameter can be either a parameter list ID of type PARAMLIST. value The value of the parameter specified as a VARCHAR2 string. (name VARCHAR2. or the VARCHAR2 name of the parameter list.
key paramtype
403
. The VARCHAR2 name of the parameter.SET_PARAMETER_ATTR built-in
Description Sets the type and value of an indicated parameter in an indicated parameter list. key paramtype NUMBER. value VARCHAR2). SET_PARAMETER_ATTR VARCHAR2. value Built-in Type unrestricted procedure Enter Query Mode yes Parameters list or name Specifies the parameter list. TEXT_PARAMETER Indicates that the parameter’s value is an actual data value. Syntax SET_PARAMETER_ATTR (list PARAMLIST. VARCHAR2). Specifies the type of parameter you intend to pass: DATA_PARAMETER Indicates that the parameter’s value is the name of a record group. VARCHAR2. key paramtype NUMBER.

The possible property constants you can set are as follows: BACKGROUND_COLOR The color of the object’s background region. The data type of the name is VARCHAR2. (item_name button_name VARCHAR2. y NUMBER). Specifies the property you want to set. NUMBER. property NUMBER). (item_name button_name VARCHAR2. Syntax SET_RADIO_BUTTON_PROPERTY (item_id VARCHAR2. value SET_RADIO_BUTTON_PROPERTY VARCHAR2. y NUMBER). Use the FIND_ITEM built-in to return the ID to an appropriately typed variable. x NUMBER. Built-in Type unrestricted procedure Enter Query Mode yes Parameters item_id Specifies the radio group item ID. Specifies the name of the radio button whose property you want to set. (item_id button_name VARCHAR2. SET_RADIO_BUTTON_PROPERTY VARCHAR2. The radio group is the owner or parent of its subordinate radio buttons.SET_RADIO_BUTTON_PROPERTY built-in
Description Sets the given property for a radio button that is part of the given radio group specified by the item_name or item_id. button_name VARCHAR2. property NUMBER. property NUMBER.
item_name
button_name property
404
. value NUMBER). Specifies the name of the radio group. SET_RADIO_BUTTON_PROPERTY VARCHAR2. The data type of the name is VARCHAR2. x NUMBER. property NUMBER. Form Builder assigns the unique ID at the time it creates the object. ENABLED Specify PROPERTY_TRUE constant if you want to enable the radio button. Specify PROPERTY_FALSE if you want to disable the radio button from operator control.

The list of fonts available is system-dependent.FILL_PATTERN The pattern to be used for the object’s fill region. POSITION Sets the position of the given radio button. Patterns are rendered in the two colors specified by Background Color and Foreground Color. ITEM_SIZE Sets the width and height of the given radio button. PROMPT_FONT_NAME The font family. The list of fonts available is system-dependent. HEIGHT Specify the height of the given radio button. Use the syntax that shows an x. PROMPT_FILL_PATTERN The pattern to be used for the object’s fill region. PROMPT_FONT_WEIGHT The weight of the font. the amount of space between characters (kerning). that is. FONT_NAME The font family. the amount of space between characters (kerning). PROMPT_FONT_STYLE The style of the font. FONT_SPACING The width of the font.y coordinate pair and specify the values as numbers. FOREGROUND_COLOR The color of the object’s foreground region. PROMPT The text displayed in the object. that should be used for text in the object. FONT_STYLE The style of the font. or typeface. LABEL Specify the actual string label for that radio button. For items. that should be used for text in the object. Patterns are rendered in the two colors specified by Background Color and Foreground Color. PROMPT_FOREGROUND_COLOR The color of the object’s foreground region.
405
. PROMPT_FONT_SPACING The width of the font. Specify the value as a number. For items. the Foreground Color attribute defines the color of text displayed in the item. the Foreground Color attribute defines the color of text displayed in the item.y coordinate pair and specify the values as numbers. or typeface. that is. specified in points. PROMPT_WHITE_ON_BLACK Specifies that the object is to appear on a monochrome bitmap display device as white text on a black background. FONT_WEIGHT The weight of the font. Use the syntax that shows an x. PROMPT_FONT_SIZE The size of the font. PROMPT_BACKGROUND_COLOR The color of the object’s background region. FONT_SIZE The size of the font. specified in points.

VISIBLE Specify PROPERTY_TRUE constant if you want the radio button to be displayed. ’GROUNDED’. or the name of a logical attribute definition in a runtime resource file that you want Form Builder to apply to the radio button. PROPERTY_FALSE Specifies that the property is to be set to the FALSE state.
406
. Specify the value as a number. PROPERTY_TRUE Specifies that the property is to be set to the TRUE state.FLIGHT_STATUS’. The data type of the value you enter is determined by the data type of the property you specified. Specify PROPERTY_FALSE constant if you want the radio button to be hidden. Specify the value as a number. If you enter a VARCHAR2 value.
SET_RADIO_BUTTON_PROPERTY examples
/* ** Built-in: SET_RADIO_BUTTON_PROPERTY ** Example: Set a particular radio button to disabled. Specifies the second numeric value for the ITEM_SIZE and POSITION properties. unless you reference a text item or variable. Y_POS Specify the y-coordinate for the radio button. */ BEGIN Set_Radio_Button_Property(’MYBLOCK. x y Specifies the first numeric value for the ITEM_SIZE and POSITION properties. WIDTH Specify the width of the given radio button. you must enclose it in quotes.ENABLED.PROPERTY_FALSE). Specify the value as a number. END. value Specifies a NUMBER or a VARCHAR2 value. VISUAL_ATTRIBUTE Specifies either a valid named visual attribute that exists in the current form. X_POS Specify the x-coordinate for the radio button. WHITE_ON_BLACK Specifies that the object is to appear on a monochrome bitmap display device as white text on a black background.

Specify as a whole number. a record that has not been marked for insert. Built-in Type unrestricted procedure Enter Query Mode yes Parameters record_number Specifies the number of the record whose status you want to set. Use the following property: STATUS Specifies that you intend to change the record status. value Use one of the following values: CHANGED_STATUS Specifies that the record should be marked for update and should be treated as an update when the next commit action occurs. INSERT_STATUS Specifies that the record is to be marked as an INSERT and should be inserted into the appropriate table when the next commit action occurs.
block_name property
SET_RECORD_PROPERTY restrictions
The following table illustrates the valid transition states of a record. VARCHAR2. The data type of the name is VARCHAR2. Changed but uncleared or uncommitted records cannot be assigned a status of NEW.
407
. or query. whether it actually is. Syntax SET_RECORD_PROPERTY (record_number NUMBER. The record number is the record’s position in the block. NEW_STATUS Specifies that the record is to be treated as a NEW record. update. block_name property NUMBER. See also the CREATE_QUERIED_RECORD built-in. that is.SET_RECORD_PROPERTY built-in
Description Sets the specified record property to the specified value. Specifies the name of the block in which the target record exists. QUERY_STATUS Specifies that the record is to be treated as a QUERY record. value NUMBER). STATUS is a constant.

2. in one of the transactional triggers.
4. Records that have been changed but not yet committed or cleared cannot be assigned a status of NEW. either On-Lock. you must supply the key for a record that goes from Insert to Query. ’EMP’. */ BEGIN Set_Record_Property( 3.
Adheres to the rules described in footnotes 2 and 3. then you must enter a valid value in the ROWID field.Current Status
Target Status NEW QUERY yes1 yes yes3 no INSERT yes2 no yes no CHANGED no yes no yes
NEW QUERY INSERT CHANGED
yes yes4 yes4 yes4
1. On-Update. This transition is not allowed in query mode. if you are connected to a non-ORACLE data source that does not support ROWID.
SET_RECORD_PROPERTY examples
/* ** Built-in: SET_RECORD_PROPERTY ** Example: Mark the third record in the EMP block as if it ** were a queried record. but you are using a unique key. Put another way. or On-Delete. STATUS.
408
. 3. If this transition is performed while Runform is running in Unique Key mode and not all of the transactional triggers exist. because QUERY and INSERT are not valid in query mode. QUERY_STATUS). END. Otherwise Form Builder returns an error.

relation_name property
409
. Valid values are PROPERTY_TRUE and PROPERTY_FALSE. property NUMBER. DEFERRED_COORDINATION Specifies that a block requiring coordination is to be marked but not coordinated until the detail blocks are instantiated. The data type of the name is VARCHAR2. This can occur automatically when you define a master-detail relationship in the Form Builder.SET_RELATION_PROPERTY built-in
Description Sets the given relation property in a master-detail relationship. value NUMBER). Specifies the name you or Form Builder gave the relation object when defining it. Deferred coordination refers only to the population phase of coordination. value NUMBER). The ability to set this property programmatically is included only for designers who are coding their own master-detail coordination. Use one of the following relation properties. Built-in Type unrestricted procedure Enter Query Mode yes Parameters relation_id Specifies the unique ID that Form Builder assigns the relation when it creates the relation object. property NUMBER. Syntax SET_RELATION_PROPERTY (relation_id Relation. SET_RELATION_PROPERTY (relation_name VARCHAR2. This allows potentially expensive processing to be deferred until blocks that are involved in relations are actually visited. It does not alter a default relation that was created at design time. or you can explicitly create the relation. Valid values are PROPERTY_TRUE and PROPERTY_FALSE. MASTER_DELETES Specifies the default relation behavior for deletion of a detail record in the detail block when there is a corresponding master record in the master block. Valid values are NON-ISOLATED. Even deferred detail blocks are cleared during the clear phase of coordination to present the form in a visually consistent state. The data type of the ID is Relation. which can be passed to the built-in as a constant: AUTOQUERY Specifies that the detail block of this relation is to be automatically coordinated upon instantiation of the block. or CASCADING. ISOLATED.

PROPERTY_TRUE). END. BEGIN /* ** Look for the relation’s ID */ rl_id := Find_Relation( rl_name ). however. ISOLATED Specifies that the MASTER_DELETES property is to be set so that an operator can delete a master record for which detail records exist. /* ** Set the two required properties */ Set_Relation_Property(rl_id.
SET_RELATION_PROPERTY restrictions
You can only set one property per call to this built-in.
SET_RELATION_PROPERTY examples
/* ** Built-in: SET_RELATION_PROPERTY ** Example: Set the coordination behavior of a relation to ** be deferred. NON_ISOLATED Specifies that the MASTER_DELETES property is to be set so that if the operator attempts to delete a master record for which detail records exist. Valid values are PROPERTY_TRUE and PROPERTY_FALSE. PROPERTY_TRUE Specifies that the property is to be set to the TRUE state. value The following constants can be supplied for the properties described earlier: CASCADING Specifies that the MASTER_DELETES property is to be set so that when an operator deletes a master record. and auto-query. Form Builder still initiates detail block coordination in this case. */ PROCEDURE Make_Relation_Deferred( rl_name VARCHAR2 ) IS rl_id Relation.AUTOQUERY. Form Builder issues an error message and disallows the deletion.
410
.PREVENT_MASTERLESS_OPERATION Specifies that operations in a detail block are not allowed when no corresponding master record exists. PROPERTY_FALSE Specifies that the property is to be set to the FALSE state. its corresponding detail records are locked at the same time as the master records are locked. This does not cause subsequent locking and deletion of detail records.

as specified above. In contrast.
SET_REPORT_OBJECT_PROPERTY examples
DECLARE repid REPORT_OBJECT. REPORT_EXECUTION_MODE. FILE). report_prop VARCHAR2(20). GET_REPORT_OBJECT_PROPERTY returns a string value for all properties. The value type depends on the particular property being set. SET_REPORT_OBJECT_PROPERTY(repid. SET_REPORT_OBJECT_PROPERTY(repid. END. BEGIN repid := find_report_object(’report4’). REPORT_COMM_MODE. or SCREEN One of the following strings: REPORT_FILENAME: Value must be of type VARCHAR2 REPORT_SOURCE_BLOCK: Value must be of type VARCHAR2 REPORT_QUERY_NAME: Value must be of type VARCHAR2 REPORT_DEST_NAME: Value must be of type VARCHAR2 REPORT_DEST_FORMAT: Value must be of type VARCHAR2 REPORT_SERVER: Value must be of type VARCHAR2 REPORT_OTHER: Value must be of type VARCHAR2 Usage Notes • SET_REPORT_OBJECT_PROPERTY sets properties using constant or string values. REPORT_DESTYPE. BATCH).REPORT_DESNAME: The report destination name REPORT_DESFORMAT: The report destination format REPORT_SERVER: The report server name REPORT_OTHER: The other user-specified report prop erties value One of the following constants: REPORT_EXECUTION_MODE: Value must be BATCH or RUNTIME REPORT_COMM_MODE: Value must be SYNCHRONOUS or ASYNCHRONOUS REPORT_DESTYPE: Value must be PREVIEW. SET_REPORT_OBJECT_PROPERTY(repid. PRINTER. SYNCHRONOUS).
412
. CACHE. FILE. MAIL.

Datatype is TAB_PAGE. FOREGROUND_COLOR The color of the object’s foreground region. make it greyed out and unavailable).e. or typeface. SET_TAB_PAGE_PROPERTY (tab_page_name VARCHAR2. Patterns are rendered in the two colors specified by Background Color and Foreground Color. The name you gave the tab page when you defined it. property NUMBER. FILL_PATTERN The pattern to be used for the object’s fill region. FONT_SIZE The size of the font. For items. FONT_STYLE The style of the font. that is. FONT_WEIGHT The weight of the font. value NUMBER). that should be used for text in the object. value NUMBER). specified in points.SET_TAB_PAGE_PROPERTY built-in
Description Sets the tab page properties of the specified tab canvas page. FONT_NAME The font family.
413
. FALSE to disable it (i. Syntax SET_TAB_PAGE_PROPERTY (tab_page_id TAB_PAGE.. property NUMBER. Possible values are: BACKGROUND_COLOR The color of the object’s background region. the Foreground Color attribute defines the color of text displayed in the item. LABEL The character string for the tab page label. The property you want to set for the given tab page. Datatype is VARCHAR2. Built-in Type unrestricted procedure Enter Query Mode yes Parameters tab_page_id tab_page_name property The unique ID Form Builder assigns to the tab page when it creates it. FONT_SPACING The width of the font. The list of fonts available is system-dependent. ENABLED Specify TRUE to enable the tab page. the amount of space between characters (kerning).

property_true). value You can pass the following constants as arguments to the property values described earlier: PROPERTY_TRUE (sets the property to the TRUE state) PROPERTY_FALSE (sets the property to the FALSE state)
SET_TAB_PAGE_PROPERTY examples
/* Example 1: Use SET_TAB_PAGE_PROPERTY to set the ** ENABLED property to TRUE for a tab page (if it currently ** is set to FALSE: */ DECLARE tb_pg_id TAB_PAGE. FALSE to make it not visible.VISIBLE Specify TRUE to make the tab page visible. VISUAL_ATTRIBUTE Specifies the name of the visual attribute currently in force. enabled) = ’FALSE’ THEN SET_TAB_PAGE_PROPERTY(tb_pg_id. IF GET_TAB_PAGE_PROPERTY(tb_pg_id.
BEGIN tb_pg_id := FIND_TAB_PAGE(’tab_page_1’). enabled.
414
. END IF. A tab page is reported visible if it is currently mapped to the screen. WHITE_ON_BLACK Specifies that the object is to appear on a monochrome bitmap display device as white text on a black background. even if it is entirely hidden behind another tab page. END.

specifically as a response to a successful call to the CREATE_TIMER built-in. The data type of the parameter is NUMBER. NUMBER). Note that only positive numbers are allowed. Values > 2147483648 will be rounded down to 2147483648. You can modify the interval. NO_CHANGE Specifies that the milliseconds property is to remain at its current setting.
Built-in Type unrestricted procedure Enter Query Mode yes Parameters timer_id Specifies the unique ID that Form Builder assigns when it creates the timer. the repeat parameter. The data type of the ID is Timer. NO_CHANGE Specifies that the iterate property is to remain at its current setting. The data type of the name is VARCHAR2. Syntax SET_TIMER (timer_id milliseconds iterate SET_TIMER (timer_name milliseconds iterate
Timer. NUMBER. until explicitly called again. but is to be used once only. The range of values allowed for this parameter is 1 to 2147483648 milliseconds. VARCHAR2. REPEAT Indicates that the timer should repeat upon expiration. iterate Specifies the iteration of the timer. Specifies the name you gave the timer when you defined it.
415
.SET_TIMER built-in
Description Changes the settings for an existing timer. A value less than 1 results in a runtime error. NO_REPEAT Indicates that the timer should not repeat upon expiration. Use the FIND_TIMER built-in to return the ID to an appropriately typed variable. NUMBER. Specifies the duration of the timer in milliseconds. NUMBER). Default. or both. See Restrictions below for more information.
timer_name milliseconds
SET_TIMER restrictions
• • Values > 2147483648 will be rounded down to 2147483648.

No two timers can share the same name in the same form instance. If there is no When-Timer-Expired trigger defined at the execution of a timer. regardless of case. Milliseconds cannot be expressed as a negative number. If there is no When-Timer-Expired trigger defined at the execution of a timer. but the timer is retained.• • • • •
A value greater than the stated upper bound results in an integer overflow.
SET_TIMER examples
/* ** Built-in: ** Example: */ SET_TIMER See FIND_TIMER
416
. subsequent repetitions are canceled. and the timer is a repeating timer. Form Builder returns an error.

node FTREE. PROCEDURE SET_TREE_NODE_PROPERTY (item_name VARCHAR2. The data type of the name is VARCHAR2 string. property NUMBER. value VARCHAR2). node FTREE. value VARCHAR2). value NUMBER). PROCEDURE SET_TREE_NODE_PROPERTY (item_id ITEM. value NUMBER).
node property
417
. Syntax PROCEDURE SET_TREE_NODE_PROPERTY (item_name VARCHAR2. and LEAF_NODE.NODE. Use the FIND_ITEM built-in to return the ID to an appropriately typed variable.SET_TREE_NODE_PROPERTY built-in
Description Sets the state of a branch node.NODE. NODE_ICON Sets the icon of the node. property NUMBER. node FTREE. Specify one of the following properties: NODE_STATE Possible values are EXPANDED_NODE. property NUMBER.NODE. Built-in Type unrestricted procedure Enter Query Mode no Parameters item_name Item_id Specifies the name of the object created at design time. NODE_LABEL Sets the label of the node. Specifies a valid node. Specifies the unique ID that Form Builder assigns to the item when created. node FTREE.NODE. COLLAPSED_NODE. property NUMBER. PROCEDURE SET_TREE_NODE_PROPERTY (item_id ITEM. The data type of the ID is ITEM.

value The actual value you intend to pass.
418
.or in the virtual directory for web deployment.Set_Tree_Node_Property(htree.Change it icon of the clicked node. Ftree.The icon file will be located using the -. END. ’Open’).Find the tree itself. BEGIN -. :SYSTEM. current_node FTREE.This code could be used in a WHEN-TREE-NODE-SELECTED -.NODE. htree := Find_Item(’tree_block.NODE.
SET_TREE_NODE_PROPERTY examples
/* ** Built-in: */ SET_TREE_NODE_PROPERTY
-. DECLARE htree ITEM.NODE_ICON. find_node FTREE.TRIGGER_NODE.trigger to change the icon of the node clicked on. -.htree3’).UI60_ICON environment variable in client/server -.NODE_VALUE Sets the value of the node. -. Ftree.

Use the FIND_ITEM built-in to return the ID to an appropriately typed variable.
property
419
. value RECORDGROUP). PROCEDURE SET_TREE_PROPERTY (item_id ITEM. value NUMBER). Specify one of the following properties: RECORD_GROUP Replaces the data set of the hierarchical tree with a record group and causes it to display. PROCEDURE SET_TREE_PROPERTY (item_name VARCHAR2. property NUMBER. The data type of the ID is ITEM. property NUMBER. Specifies the unique ID that Form Builder assigns to the item when created. PROCEDURE SET_TREE_PROPERTY (item_id ITEM. Built-in Type unrestricted procedure Enter Query Mode no Parameters item_name Item_id Specifies the name of the object created at design time. PROCEDURE SET_TREE_PROPERTY (item_id ITEM. property NUMBER. value RECORDGROUP). Syntax PROCEDURE SET_TREE_PROPERTY (item_name VARCHAR2. property NUMBER.SET_TREE_PROPERTY built-in
Description Sets the value of the indicated hierarchical tree property. value VARCHAR2). property NUMBER. PROCEDURE SET_TREE_PROPERTY (item_name VARCHAR2. value VARCHAR2). property NUMBER. value NUMBER). The data type of the name is VARCHAR2 string.

Check for the existence of the record group. htree := Find_Item(’tree_block. BEGIN -.This code could be used in a WHEN-NEW-FORM-INSTANCE -.QUERY_TEXT Replaces the data set of the hierarchical tree with an SQL query and causes it to display. -.Transfer the data from the record group to the hierarchical
420
. ALLOW_EMPTY_BRANCHES Possible values are PROPERTY_TRUE and PROPERTY_FALSE. v_ignore NUMBER. -. DECLARE htree ITEM. rg_emps := Create_Group_From_Query(’rg_emps’. rg_emps := Find_Group(’emps’). value Specify the value appropriate to the property you are setting: PROPERTY_TRUE The property is to be set to the TRUE state. rg_emps RECORDGROUP.Create the record group. PROPERTY_FALSE The property is to be set to the FALSE state. to_char(empno) ’ || ’from emp ’ || ’connect by prior empno = mgr ’ || ’start with job = ’’PRESIDENT’’’). IF NOT Id_Null(rg_emps) THEN DELETE_GROUP(rg_emps).with data.Populate the record group with data. ename. level. -.htree3’). NULL. END IF.trigger to initially populate the hierarchical tree -. v_ignore := Populate_Group(rg_emps).Find the tree itself. -.
SET_TREE_PROPERTY examples
/* ** Built-in: */ SET_TREE_PROPERTY
-. ’select 1.

Use the FIND_ITEM built-in to return the ID to an appropriately typed variable. The data type of the ID is ITEM. node NODE. Specifies the unique ID that Form Builder assigns to the item when created. SELECT_OFF Deselects the node.This code could be used in a WHEN-TREE-NODE-EXPANDED -. selection_type NUMBER). The data type of the name is VARCHAR2 string. DECLARE htree
ITEM. SELECT_ON Selects the node. Built-in Type unrestricted procedure Enter Query Mode no Parameters item_name Item_id Specifies the name of the object created at design time. Specifies a valid node. selection_type NUMBER).trigger and will mark the clicked node as selected. Specifies the type of selection.SET_TREE_SELECTION built-in
Description Specifies the selection of a single node. SELECT_TOGGLE Toggles the selection state of the node. PROCEDURE SET_TREE_SELECTION (item_id ITEM. Syntax PROCEDURE SET_TREE_SELECTION (item_name VARCHAR2. node NODE.
node selection_type
SET_TREE_SELECTION examples
/* ** Built-in: */ SET_TREE_SELECTION
-.
422
.

The data type is VARCHAR2.SET_VA_PROPERTY built-in
Description Modifies visual attribute property values for the specified property. SET_VA_PROPERTY (va_name VARCHAR2 property NUMBER value NUMBER). that should be used for text in the object. specified in hundreds of points. FILL_PATTERN The pattern to be used for the object’s fill region. SET_VA_PROPERTY (va_id VISUALATTRIBUTE property NUMBER value NUMBER). SET_VA_PROPERTY (va_name VARCHAR2 property NUMBER value VARCHAR2). Syntax SET_VA_PROPERTY (va_id VISUALATTRIBUTE property NUMBER value VARCHAR2).
va_name Property
424
. Specify one of the following properties: BACKGROUND_COLOR The color of the object’s background region. FONT_NAME The font family. or typeface. The name you gave the visual attribute when you created it. The list of fonts available is system-dependent. FONT_SIZE The size of the font. The data type is VISUALATTRIBUTE. Patterns are rendered in the two colors specified by Background Color and Foreground Color. Built-in Type unrestricted function Enter Query Mode yes Parameters va_id The unique ID Form Builder assinged to the visual attribute when you created it.

value Specify the value to be applied to the given property. For instance. enter two single quotes with no space between: ’’. FONT_STYLE The style of the font. The data type of the property determines the data type of the value you enter. that is. if you want to set the WHITE_ON_BLACK property to true. If you want to reset the value of the property to be the value originally established for it at design time. FONT_WEIGHT The weight of the font. PROPERTY_FALSE Specifies that the property is to be set to the FALSE state. the label.
425
. For example. FONT_SIZE. SET_ITEM_PROPERTY(’DEPTNO’. would reset that format size to its design-time value. specify the value.FONT_SPACING The width of the font. specify the constant PROPERTY_TRUE for the value. PROPERTY_TRUE Specifies that the property is to be set to the TRUE state. the Foreground Color attribute defines the color of text displayed in the item. as a VARCHAR2 string. ’’). in other words. WHITE_ON_BLACK Specifies that the object is to appear on a monochrome bitmap display device as white text on a black background. If you want to change the FONT_NAME for the item. For items. FOREGROUND_COLOR The color of the object’s foreground region. the amount of space between characters (kerning).

SET_VAR built-in
Description Sets a newly-created OLE variant to its initial value. source_table arrspec A PL/SQL table whose dimensions and element values are to be given to the variant. newval CHAR vtype VT_TYPE. For more information. There are four versions of the procedure. This is an optional parameter. see Specifiers for OLE Arrays This is an optional parameter. resets an existing OLE variant to a new value. OLEVAR. the default is VT_BSTR. the default value for the NUMBER version of the procedure is VT_R8. If not specified. newval OLEVAR vtype VT_TYPE. arrspec VARCHAR2). PROCEDURE SET_VAR (var OLEVAR. The OLE VT_TYPE to be given to the variant.
426
. the default is VT_VARIANT: that is.. Syntax PROCEDURE SET_VAR (var OLEVAR. arrspec VARCHAR2). the entire source table is used. and table. NUMBER. vtype VT_TYPE. If not specified. one for each of the new value types CHAR. Usage Notes The target variant in this SET_VAR procedure must first be created with the CREATE_VAR function. arrspec VARCHAR2). PROCEDURE SET_VAR (var OLEVAR. The value to be given to the variant. Or. Built-in Type unrestricted procedure Parameters var newval vtype The variant to be set. For the VARCHAR2 version. source_table. arrspec VARCHAR2). whatever type the variant value actually specifies . Indicates which selected element or elements of the source table are to be used in the creation of the new variant. PROCEDURE SET_VAR (var OLEVAR. newval NUMBER vtype VT_TYPE. For the OLEVAR version.

y NUMBER). NUMBER).
view_name property
427
. SET_VIEW_PROPERTY (view_name ViewPort. To change the size of the canvas itself. POSITION_ON_CANVAS An X. the position of the view’s upper-left corner relative to the window’s content view. property NUMBER. Determines where the view is displayed in the window. y SET_VIEW_PROPERTY (view_name VARCHAR2. The name you gave the canvas object when you defined it. LEFT_TO_RIGHT. (view_id property NUMBER. Syntax SET_VIEW_PROPERTY (view_id ViewPort. the height of the view. NUMBER. Use the FIND_VIEW built-in to return the ID to an appropriately typed variable. value SET_VIEW_PROPERTY ViewPort. DISPLAY_POSITION For a stacked view. you cannot split the argument in such a way that the x coordinate applies to X_POS and the y coordinate applies to the HEIGHT. as an X. Specifies one of the following properties: DIRECTION The layout direction for bidirectional objects. Datatype is VIEWPORT. Valid values are DIRECTION_DEFAULT. Datatype is VARCHAR2. HEIGHT For a stacked canvas.SET_VIEW_PROPERTY built-in
Description Sets a property for the indicated canvas. Built-in Type unrestricted procedure Enter Query Mode yes Parameters view_id The unique ID Form Builder assigned the view when you created the canvas/view. In other words. property NUMBER. x NUMBER. use SET_CANVAS_PROPERTY. You can set only one property per call to the built-in. Y pair indicating the location of the view’s upper-left corner relative to its canvas. RIGHT_TO_LEFT. property value NUMBER). x NUMBER. NUMBER). Y pair.

VIEWPORT_X_POS For a stacked view. use SET_CANVAS_PROPERTY. use SET_CANVAS_PROPERTY. the width of the view. VIEW_SIZE For a stacked canvas. To change the size of the canvas itself. To change the size of the canvas itself. height pair. PROPERTY_FALSE The property is to be set to the FALSE state. as a width. depending on the property you specified. Specify the argument in form coordinate system units. value Specify the value appropriate to the property you are setting: PROPERTY_TRUE The property is to be set to the TRUE state.
y
428
. Valid values are PROPERTY_TRUE and PROPERTY_FALSE. VIEWPORT_X_POS_ON_CANVAS The X coordinate for the view’s upper-left corner relative to its canvas. the X coordinate for the view’s upper-left corner relative to the window’s content view. Specify the argument in form coordinate system units. VIEWPORT_Y_POS_ON_CANVAS The Y coordinate for the the view’s upper-left corner relative to its canvas. WIDTH For a stacked canvas. VIEWPORT_Y_POS For a stacked view. the Y coordinate for the view’s upper-left corner relative to the window’s content view. the size of the view. x The NUMBER value of the X coordinate or the width. VISIBLE Whether the view is to be displayed. The NUMBER value of the Y coordinate or the height. depending on the property you specified.

MAXIMIZE. y pair indicating the location for the window on the screen. TITLE Sets the title of the window. The list of fonts available is system-dependent. that is. FOREGROUND_COLOR The color of the object’s foreground region. WINDOW_SIZE Specifies a width. specified in points. HEIGHT Specifies the height of the window. value The following constants can be passed as arguments to the property values described earlier: PROPERTY_TRUE Specifies that the property is to be set to the TRUE state.FILL_PATTERN The pattern to be used for the object’s fill region. height pair indicating the size of the window on the screen.
430
. the amount of space between characters (kerning). that should be used for text in the object. the Foreground Color attribute defines the color of text displayed in the item. WIDTH Specifies the width of the window. FONT_SPACING The width of the font. Patterns are rendered in the two colors specified by Background Color and Foreground Color. Valid values are PROPERTY_TRUE and PROPERTY_FALSE. POSITION Specifies an x. or MINIMIZE. WHITE_ON_BLACK Specifies that the object is to appear on a monochrome bitmap display device as white text on a black background. or typeface. Y_POS Sets the y coordinate for the window’s upper left corner on the screen. HIDE_ON_EXIT Specifies whether Form Builder hides the current window automatically when the operator navigates to an item in another window. This applies specifically to the VISIBLE property. Valid values are NORMAL. ICON_NAME Specifies the file name of the icon resource associated with a window item when the window is minimized. FONT_NAME The font family. FONT_WEIGHT The weight of the font. Valid values are PROPERTY_TRUE and PROPERTY_FALSE. For items. FONT_STYLE The style of the font. VISIBLE Specifies whether the window is to be displayed. WINDOW_STATE Specifies the current display state of the window. X_POS Sets the x coordinate for the window’s upper left corner on the screen. FONT_SIZE The size of the font.

POSITION. MINIMIZE)
SET_WINDOW_PROPERTY restrictions
• If you change the size or position of a window. Specifies the NUMBER value of the y coordinate or the height. The following constants can be passed as arguments for use with the WINDOW_STATE property: NORMAL Specifies that the window is displayed normally according to the current Width. 5. depending on the property you specified. depending on the property you specified.10) Set_Window_Property(FORMS_MDI_WINDOW. X Position. Height. forms run inside the MDI application window . x Specifies the NUMBER value of the x coordinate or the width. WINDOW_STATE. Y_POS
To reference the MDI application window in a call to SET_WINDOW_PROPERTY. and Y Position property settings. You must assign the designtime defaults to variables if you intend to set the window back to those defaults. use the constant FORMS_MDI_WINDOW: Set_Window_Property(FORMS_MDI_WINDOW.PROPERTY_FALSE Specifies that the property is to be set to the FALSE state. MAXIMIZE Specifies that the window is enlarged to fill the screen according to the display style of the window manager. This applies specifically to the VISIBLE property. HEIGHT WINDOW_SIZE WINDOW_STATE X_POS. or until you explicitly change the window’s size or position again. or iconified. Specify the argument in form coordinate system units. Specify the argument in form coordinate system units. You can use SET_WINDOW_PROPERTY to set the following properties of the MDI application window: • • • • • • TITLE POSITION WIDTH. Closing the window and reopening it does not reset the window to its design-time defaults. the change remains in effect for as long as the form is running.
SET_WINDOW_PROPERTY examples
/* ** Built-in: ** Example: */ SET_WINDOW_PROPERTY See FIND_WINDOW
431
. MINIMIZE Specifies that the window is minimized.
y
Usage Notes On Microsoft Windows.

SHOW_ALERT (alert_name VARCHAR2). Built-in Type unrestricted function Returns A numeric constant corresponding to the button the operator selected from the alert.
alert_name
SHOW_ALERT examples
/* ** Built-in: ** Example: */ SHOW_ALERT See FIND_ALERT and SET_ALERT_PROPERTY
432
..SHOW_ALERT built-in
Description Displays the given alert. The name you gave the alert when you defined it. Use the FIND_ALERT built-in to return the ID to an appropriately typed variable. Button 1 Button 2 Button 3
Form Builder returns ALERT_BUTTON1 ALERT_BUTTON2 ALERT_BUTTON3
Enter Query Mode yes Parameters alert_id The unique ID that Form Builder assigns the alert when the alert is created. Syntax SHOW_ALERT (alert_id Alert). Button mappings are specified in the alert design. and returns a numeric value when the operator selects one of three alert buttons. The data type of the name is VARCHAR2..
If the operator selects. The data type of the ID is Alert.

VARCHAR2. NUMBER. The data type of the ID is Editor. BOOLEAN). Specifies a required IN parameter of VARCHAR2 data type. BOOLKAN). VARCHAR2. Editor. VARCHAR2. or retrieves an existing string from the editor. VARCHAR2. The value passed to this parameter can be NULL. VARCHAR2. VARCHAR2. NUMBER. VARCHAR2.
editor_name message_i
x y
433
.SHOW_EDITOR built-in
Description Displays the given editor at the given coordinates and passes a string to the editor. the editor is displayed in the default position specified for the editor at design time. Syntax SHOW_EDITOR (editor_id message_in message_out result SHOW_EDITOR (editor_id message_in x y message_out result SHOW_EDITOR (editor_name message_in message_out result SHOW_EDITOR (editor_name message_in x y message_out result
Editor. Specifies the x coordinate of the editor. Supply a whole number for this argument. You can also reference a text item or variable. If no coordinates are supplied. VARCHAR2. Specifies the y coordinate of the editor. VARCHAR2.
Built-in Type unrestricted procedure that returns two OUT parameters ( result and message_out) Enter Query Mode yes Parameters editor_id Specifies the unique ID that Form Builder assigns when it creates the editor. Supply a whole number for this argument. The data type of the name is VARCHAR2. NUMBER. NUMBER. VARCHAR2. Specifies the name you gave to the editor when you defined it. BOOLEAN). Use the FIND_EDITOR built-in to return the ID to a variable of the appropriate data type. BOOLEAN).

CHECKED) = ’TRUE’ THEN ed_name := ’system_editor’. END IF.14) on the ** screen. */ val := :emp.message_out
Specifies a required OUT parameter of VARCHAR2 data type. 10.comments := val. Specifies a required OUT parameter of BOOLEAN data type. result is FALSE and message_out is NULL. However. because the length of the variable or text item specified for message_out determines the maximum number of characters the editor can accept. */ DECLARE ed_id Editor. Use the system editor if the user has ** checked the "System_Editor" menu item under the ** "Preferences" menu in our custom menu module.comments. result is TRUE. val. Pass the contents of the :emp.14. mi_id MenuItem.comments item ** into the editor and reassign the edited contents if ** ’ed_ok’ returns boolean TRUE. END. You can also reference a text item or variable.SYSTEM_EDITOR’). BEGIN mi_id := Find_Menu_Item(’PREFERENCES. IF ed_ok THEN :emp. ed_ok). ed_ok BOOLEAN. if you are passing message_out to something other than a VARCHAR2 type object. IF Get_Menu_Item_Property(mi_id. ELSE ed_name := ’my_editor1’. ed_id := Find_Editor( ed_name ). The message_in parameter values are always converted to VARCHAR2 by Form Builder when passed to the editor. Show_Editor( ed_id.
•
SHOW_EDITOR examples
/* ** Built-in: SHOW_EDITOR ** Example: Accept input from the operator in a user-defined ** editor. result is FALSE and message_out is NULL. If the operator cancels the editor. /* ** Show the appropriate editor at position (10.
434
. END IF. If the operator accepts the editor. If the operator cancels the editor. val VARCHAR2(32000). you must first perform the conversion by passing the value to a variable and then perform type conversion on that variable with PL/SQL functions TO_DATE or TO_NUMBER. val.
result
SHOW_EDITOR restrictions
• • Message_out should be at least as long as message_in. ed_name VARCHAR2(40). The Width must be at least wide enough to display the buttons at the bottom of the editor window.

Syntax SHOW_LOV (lov_id LOV). y NUMBER). If the record group underlying the LOV contains 0 records.SHOW_LOV built-in
Description Displays a list of values (LOV) window at the given coordinates.
436
. and returns TRUE if the operator selects a value from the list. the BOOLEAN return value for SHOW_LOV will be FALSE. NUMBER. SHOW_LOV (lov_id LOV. x y NUMBER). Form Builder issues an error. Use the FIND_LOV built-in to return the ID to an appropriately typed variable. Built-in Type unrestricted function Returns BOOLEAN Enter Query Mode yes Parameters lov_id Specifies the unique ID that Form Builder assigns the LOV when created. Specifies the x coordinate of the LOV. The data type of the name is VARCHAR2. use the LIST_VALUES built-in. The name you gave to the LOV when you defined it. x NUMBER. and FALSE if the operator Cancels and dismisses the list. Form Builder ignores the LOV’s Automatic Skip property.
lov_name x y Usage Notes
When SHOW_LOV is used to display an LOV. SHOW_LOV (lov_name VARCHAR2). The data type of the ID is LOV. Specifies the y coordinate of the LOV.
SHOW_LOV restrictions
If the lov_name argument is not supplied and there is no LOV associated with the current item. If you want to move the cursor to the next navigable item. SHOW_LOV (lov_name VARCHAR2.

all or part of the menu does not appear on the screen if the current canvas would cover it. Therefore. Form Builder does not allow the menu to obscure any part of the current canvas.
438
. END. Syntax SHOW_MENU. Because SHOW_MENU does not make the menu active. Built-in Type unrestricted procedure Enter Query Mode yes Parameters none
SHOW_MENU restrictions
Only for use in character mode environments.
SHOW_MENU examples
/* ** Built-in: ** Example: */ BEGIN Show_Menu. SHOW_MENU Display the menu if no canvas overlays it. It does not make the menu active.SHOW_MENU built-in
Description Displays the current menu if it is not currently displayed.

SHOW_VIEW raises it in front of any other views in the same window. END. SHOW_VIEW (view_name VARCHAR2). Syntax SHOW_VIEW (view_id ViewPort).
439
.SHOW_VIEW built-in
Description Displays the indicated canvas at the coordinates specified by the canvas’s X Position and Y Position property settings. The data type of the ID is ViewPort.
view_name
SHOW_VIEW examples
/* ** Built-in: SHOW_VIEW ** Example: Programmatically display a view in the window to ** which it was assigned at design time. */ BEGIN Show_View(’My_Stacked_Overlay’). Use the FIND_VIEW built-in to return the ID to an appropriately typed variable. Built-in Type unrestricted procedure Enter Query Mode yes Parameters view_id Specifies the unique ID that Form Builder assigns the view when it creates the object. If the view is already displayed. The data type of the name is VARCHAR2. Specifies the name that you gave the view when defining it.

NUMBER). y SHOW_WINDOW (window_name VARCHAR2). */ BEGIN Show_Window(’online_help’.
window_name x y
SHOW_WINDOW examples
/* ** Built-in: SHOW_WINDOW ** Example: Override the default (x. If the indicated window is a modal window. Specifies the x coordinate of the window.Y coordinates. x NUMBER.y) coordinates for a ** windows location while showing it. The data type of the ID is Window. Use the FIND_WINDOW built-in to return the ID to an appropriately typed variable. Supply a whole number for this argument.Y coordinates. SHOW_WINDOW (window_name VARCHAR2. END. x NUMBER. Specify this value as a whole NUMBER. Specifies the name that you gave the window when defining it. Specifies the y coordinate of the window. SHOW_WINDOW is executed as a GO_ITEM call to the first navigable item in the modal window. NUMBER).SHOW_WINDOW built-in
Description Displays the indicated window at either the optionally included X. Syntax SHOW_WINDOW (window_id Window). SHOW_WINDOW (window_id Window.5).
440
. y Built-in Type unrestricted procedure Enter Query Mode yes Parameters window_id Specifies the unique ID that Form Builder assigns the window when created. or at the window’s current X. The data type of the name is VARCHAR2.20.

Process_Element(j).
SYNCHRONIZE examples
/* ** Built-in: SYNCHRONIZE ** Example: Achieve an odometer effect by updating the ** screen as an items value changes quickly.
441
. SYNCHRONIZE updates the screen display to reflect the information that Form Builder has in its internal representation of the screen. END LOOP.. Syntax SYNCHRONIZE.SYNCHRONIZE built-in
Description Synchronizes the terminal screen with the internal state of the form. SYSTEM.. That is.e. SYNCHRONIZE. Built-in Type unrestricted procedure Enter Query Mode yes Parameters none
SYNCHRONIZE restrictions
SYNCHRONIZE only updates the screen display if both of the following conditions are true: • • Form Builder is at the item level in the forms hierarchy (i.1000 LOOP :control.CURRENT_ITEM is not NULL). the screen is typically ** only updated when Form Builder completes all trigger ** execution and comes back for user input. ** Without synchronize. */ BEGIN FOR j IN 1. END.units_processed := j.

Built-in Type unrestricted function Returns the newly-created OLE variant.. For the table version. This is an optional parameter. FUNCTION TO_VARIANT (source_table. persistence BOOLEAN) RETURN newvar OLEVAR.or.or. For the VARCHAR2 version. vtype VT_TYPE persistence BOOLEAN) RETURN newvar OLEVAR. If not specified. A boolean value of TRUE establishes the variant as persistent. .. the default is the type of the source variant. Syntax FUNCTION TO_VARIANT (newval NUMBER. The OLE VT_TYPE to be given to the newly-created variant.. . Parameters newval vtype The value to be given to the newly-created OLE variant. the default value for the NUMBER version of the function is VT_R8. the default is VT_BSTR.. a value of FALSE establishes the variant as non-persistent. vtype VT_TYPE arrspec VARCHAR2.. the default is determined from the PL/SQL types of the table For the OLEVAR version. . There are four versions of the function.. FUNCTION TO_VARIANT (newval VARCHAR2..TO_VARIANT built-in
Description Creates an OLE variant and assigns it a value..or. persistence Controls the persistence of the variant after its creation.. FUNCTION TO_VARIANT (var OLEVAR.. vtype VT_TYPE persistence BOOLEAN) RETURN newvar OLEVAR. persistence BOOLEAN) RETURN newvar OLEVAR.
443
... vtype VT_TYPE arrspec VARCHAR2.

This is an optional parameter. the default value is non-persistent. If not specified.)
arrspec
Usage Notes
•
This function first creates an empty variant and then gives it a value. Indicates which selected element or elements of a source table are to be used in the creation of the new variant. (This source variant may be a table. The source table can be of any type. This TO_VARIANT function can also be thought of as the inverse version of the VAR_TO_* function. For more information. var An existing OLE variant whose value is to be given to the new variant. VARCHAR2. It offers a combined version of the CREATE_VAR and SET_VAR operations. source_table An existing PL/SQL table that is used to establish the bounds and values of the newly-created variant table.
•
•
444
. If not specified. This is an optional parameter. see Specifiers for OLE Arrays. and table versions in that it uses an existing OLE variant as the source. The lower bound always starts at 1. rather than a PL/SQL equivalent value. Note that the OLEVAR version of this function differs from the NUMBER. the entire source table or source variant is used.

*/ PROCEDURE Clear_Even_Rows ( rg_id RecordGroup ) IS BEGIN FOR j IN 1. END LOOP.2)=0 THEN Unset_Group_Selection( rg_id. j ). The data type of the ID is RecordGroup. for example. those rows are considered by Form Builder to be selections 1. and 12. If you select rows 3. row_number Built-in Type unrestricted procedure Enter Query Mode yes Description Unmarks the specified row in the indicated record group. and 3. You can undo any row selections for the entire group by calling the RESET_GROUP_SELECTION built-in. Use the FIND_GROUP built-in to return the ID to a variable. Rows are numbered sequentially starting at 1.Get_Group_Row_Count(rg_id) LOOP IF MOD(j. END IF. 2. NUMBER).UNSET_GROUP_SELECTION built-in
Syntax UNSET_GROUP_SELECTION (recordgroup_id RecordGroup. 8. The data type of the name is VARCHAR2.
445
. row_number UNSET_GROUP_SELECTION (recordgroup_name VARCHAR2.
recordgroup_name row_number
UNSET_GROUP_SELECTION examples
/* ** Built-in: UNSET_GROUP_SELECTION ** Example: Clear all of the even rows as selected in the ** record group whose id is passed-in as a ** parameter. Specifies the number of the record group row that you want to select.. NUMBER). The value you specify is a NUMBER. Parameters recordgroup_id Specifies the unique ID that Form Builder assigns to the record group when created. Use the procedure to unmark rows that have been programmatically selected by a previous call to SET_GROUP_SELECTION. END. Specifies the name of the record group that you gave to the group when creating it.

Syntax UP.UP built-in
Description Navigates to the instance of the current item in the record with the next lowest sequence number. Built-in Type restricted procedure Enter Query Mode no Parameters none
446
.

ITEM ). PROCEDURE UPDATE_CHART (chart_name VARCHAR2. PROCEDURE UPDATE_CHART (chart_id FORMS4C. By default.PARAMLIST ). PROCEDURE UPDATE_CHART (chart_id FORMS4C. param_list_id TOOLS. Built-in Type unrestricted procedure Enter Query Mode yes Parameters chart_id chart_name param_list_id param_list_name Specifies the unique ID of the chart. For example.UPDATE_CHART built-in
Description A data block is updated whenever it is queried or when changes to it are committed. param_list_id TOOLS.ITEM . param_list_name VARCHAR2 ). PROCEDURE UPDATE_CHART (chart_id FORMS4C. you may want update the chart to reflect uncommitted changes in the data block. Syntax PROCEDURE UPDATE_CHART (chart_name VARCHAR2.PARAMLIST ). Specifies the unique name of the chart parameter list. even if the data block on which it is based has not been updated.
447
.ITEM . Specifies the unique name of the chart. You can use the UPDATE_CHART built-in to explicitly cause a chart item to be updated. param_list_name VARCHAR2 ). PROCEDURE UPDATE_CHART (chart_name VARCHAR2 ). any charts based on the data block are automatically updated. when the block is updated. Specifies the unique ID of the chart parameter list.

448
. Syntax UPDATE RECORD. This built-in is included primarily for applications that run against a non-ORACLE data source. Built-in Type restricted procedure
Enter Query Mode no Parameters none
UPDATE_RECORD restrictions
Valid only in an On-Update trigger. initiates the default Form Builder processing for updating a record in the database during the Post and Commit Transaction process.UPDATE_RECORD built-in
Description When called from an On-Update trigger.

including any parameters. VARCHAR2. The user exit subprogram must parse ** the string argument it is passed to decide what ** functionality to perform. Specifies a user-defined error message that Form Builder should display if the user exit fails. END IF. /* ** Pass the string argument as a command to the robot */ User_Exit(’RobotLnk SEND Unit=6. RAISE Form_trigger_Failure. END IF.USER_EXIT built-in
Description Calls the user exit named in the user_exit_string. Syntax USER_EXIT (user_exit_string USER_EXIT (user_exit_string error_string
VARCHAR2). */ User_Exit(’RobotLnk INITIALIZE Unit=6. RAISE Form_trigger_Failure. */ PROCEDURE Command_Robotic_Arm( cmd_string VARCHAR2 ) IS BEGIN /* ** Call a C function ’RobotLnk’ to initialize the ** communication card before sending the robot a message.
Built-in Type unrestricted procedure Enter Query Mode yes Parameters user_exit_string error_string Specifies the name of the user exit you want to call. /* ** Close the robot’s communication channel */
449
.Msg=’||cmd_string ).CmdToFollow=1’). IF NOT Form_Success THEN Message(’Failed to initialize Robot 6’). VARCHAR2).
USER_EXIT examples
/* ** Built-in: USER_EXIT ** Example: Invoke a 3GL program by name which has been ** properly linked into your current Form Builder ** executable. IF NOT Form_Success THEN Message(’Command not understood by Robot 6’).

Note: If you change the scope via SET_FORM_PROPERTY(VALIDATION UNIT) and then call VALIDATE(DEFAULT_SCOPE). ITEM_SCOPE Perform normal validation for the current item. into a global variable.VALIDATE built-in
Description VALIDATE forces Form Builder to immediately execute validation processing for the indicated validation scope. the cursor does not move to that field. Instead. Validate(block_scope). Note on runtime behavior If an invalid field is detected when validation is performed. determined by the runtime platform. Form Builder will not validate at the default scope but at the scope defined by SET_FORM_PROPERTY.
NUMBER).Empno IS NOT NULL THEN :Global.Empno. RECORD_SCOPE Perform normal validation for the current record. BLOCK_SCOPE Perform normal validation for the current block. which the user ** has typed. In this case. you will override the default scope as defined in the form module.
VALIDATE examples
/* ** Built-in: VALIDATE ** Example: Deposits the primary key value.
451
. and then ** validates the current block. the cursor remains in its previous position. Syntax VALIDATE (validation_scope Built-in Type: unrestricted procedure Enter Query Mode yes Parameters validation scope Specify one of the following scopes: DEFAULT_SCOPE Perform normal validation for the default scope. FORM_SCOPE Perform normal validation for the current form.Employee_Id := :Emp. ** trigger: When-New-Item-Instance */ BEGIN IF :Emp.

IF NOT Form_Success THEN RAISE Form_trigger_Failure. END IF. END IF. Execute_Query. END.
452
.

•
453
. the variant is assumed to hold an address to the type specified in the vtype.VARPTR_TO_VAR built-in
Description Changes a variant pointer into a simple variant. Usage Notes
• •
This function removes VT_BYREF typing from the variant. the default value is VT_VARIANT. If not specified. and is de-referenced accordingly. Syntax FUNCTION VARPTR_TO_VAR (variant OLEVAR. vtype VT_TYPE) RETURN changed OLEVAR. then VT_EMPTY is returned. If the variant’s type was not VT_BYREF. This is an optional parameter. The OLE VT_TYPE to be given to the transformed variant. Built-in Type unrestricted function Returns the transformed variant. If the pointer was NULL or the variant was of type VT_NULL. Parameters variant vtype The OLE variant pointer to be changed into a variant.

This is an optional parameter. The PL/SQL table to be populated.VAR_TO_TABLE built-in
Description Reads an OLE array variant and populates a PL/SQL table from it. See Specifiers for OLE Arrays for more information. arrspec VARCHAR2). or elements of the source array are to be used. Built-in Type unrestricted procedure Parameters var target_table arrspec The OLE variant that is the source array. target_table.
454
. Syntax PROCEDURE VAR_TO_TABLE (var OLEVAR. use the function VAR_TO_type . Indicates which rows. If not specified. Usage Notes For similar operations on other data types. columns. all elements in the source array are used.

In the VAR_TO_OBJ version of this function. It indicates which element of the array is to be read and returned. and OBJ... . arrspec VARCHAR2) RETURN retval VARCHAR2. FUNCTION VAR_TO_NUMBER (var OLEVAR.or... This parameter is used only if the OLE variant is an array. See Specifiers for OLE Arrays for more information.. There are three versions of the function (denoted by the value in type). FUNCTION VAR_TO_OBJ (var OLEVAR. Built-in Type unrestricted function Returns The variant with its value changed into an equivalent PL/SQL-type. use the procedure VAR_TO_TABLE . Note that the type of the return depends on the version of the function chosen. arrspec VARCHAR2) RETURN retval OLEOBJ. Parameters var arrspec The OLE variant to be read.VAR_TO_<type> built-in
Description Reads an OLE variant and transforms its value into an equivalent PL/SQL type. one for each for of the types CHAR. arrspec VARCHAR2) RETURN retval NUMBER.
Syntax FUNCTION VAR_TO_CHAR (var OLEVAR.
455
. . Usage Notes
• •
To return a table..or. NUMBER. the returned object is local (non-persistent)...

or defaults to VT_BYREF. If the vtype does not have a VT_BYREF in it. the default value is VT_BYREF. and it will point to the content within the variant. and VT_NULL. Syntax FUNCTION VAR_TO_VARPTR (variant OLEVAR. This is an optional parameter. regardless of the vtype specification in the function. Usage Notes
•
If the variant to be pointed to is of type VT_EMPTY. vtype VT_TYPE) RETURN newpointer OLEVAR.VAR_TO_VARPTR built-in
Description Creates an OLE variant that points to an existing variant. then the created pointer will be of type VT_BYREF plus the source variant’s type. VT_PTR.
•
•
456
. If not specified. The type to be assigned to the created OLE variant. then the created pointer will be of type VT_NULL. Permissible types are VT_BYREF. Built-in Type unrestricted function Returns the created variant Parameters variant vtype The existing OLE variant to be pointed to. then the created pointer will be of type VT_PTR. If vtype is specified as VT_BYREF.

The data type of the name is VARCHAR2 string. VBX. VBX. Specifies the unique ID Form Builder assigns when a parameter list is created.
VBX.VBX.FIRE_EVENT The VBX. paramlist_name VARCHAR2). paramlist_name VARCHAR2). (item_name event_name VARCHAR2.FIRE_EVENT ITEM. event_name VARCHAR2.FIRE_EVENT built-in
Description Raises an event for the VBX control. VARCHAR2. The name you give the parameter list object when it is defined. event_name paramlist_id PARAMLIST).FIRE_EVENT built-in triggers a SpinDown
457
. The data type of the ID is ITEM. Syntax VBX. paramlist_id PARAMLIST).FIRE_EVENT examples
/* ** Built-in: ** Example: VBX.
item_name event_name paramlist_id paramlist_name
VBX.FIRE_EVENT VARCHAR2. VBX. Built-in Type unrestricted procedure Enter Query Mode yes Parameters item_id Specifies the unique ID that Form Builder assigns to the item when created.FIRE_EVENT restrictions
Valid only on Microsoft Windows. Specifies the name of the object created at design time.FIRE_EVENT (item_id ITEM. The data type of the ID is PARAMLIST. The data type of the name is VARCHAR2 string. Use the FIND_ITEM built-in to return the ID to an appropriately typed variable. The data type of the name is VARCHAR2 string. (item_id event_name VARCHAR2. Specifies the name of a VBX event sent to the VBX control.FIRE_EVENT (item_name VARCHAR2.

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

z ).INVOKE_METHOD built-in
Syntax VBX. x. x.INVOKE_METHOD( item_name. x. Specifies optional arguments that might be required for VBX controls. y.
462
. ** The position where the entry appears is the second ** optional argument. they should be specified. Built-in Type: unrestricted procedure Enter Query Mode yes Description Invokes the specified method on the item. The data type of the ID is ITEM. Use the FIND_ITEM built-in to return the ID to an appropriately typed variable. Parameters item_id Specifies the unique ID that Form Builder assigns to the item when created. z ).VBX. The data type of the arguments is VARCHAR2 string. w. z
VBX. Specifies the name of the method to invoke.INVOKE_METHOD examples
/* ** Built-in: VBX. w. method_name. The data type of the name is VARCHAR2 string. Specifies the name of the object created at design time. The methods that are valid for VBX controls and a listing of the arguments they expect can be found in the moduleation that accompanies the VBX control. BEGIN VBX.
item_name method_name w. The arguments should be provided in the order that the VBX control expects them.’blue’. END. The data type of the name is VARCHAR2 string.
VBX. y. */ DECLARE ItemName VARCHAR2(40) := ’COMBOBOX’.INVOKE_METHOD( item_id.’ADDITEM’. If the method takes arguments.Invoke_Method(ItemName. method_name. The entry to ** add to the combobox is first optional argument. VBX.INVOKE_METHOD_PROPERTY ** Example: Adds an entry to a combobox. y.’2’).INVOKE_METHOD restrictions
Valid only on Microsoft Windows.

SET_PROPERTY restrictions
Valid only on Microsoft Windows. Specifies the value to be applied to the VBX property. VBX_VAL_PROP VARCHAR2(40). ** trigger: When-Button-Pressed */ DECLARE ItemName VARCHAR2(40) := ’SPINBUTTON’.SET_PROPERTY ** Example: Uses the VBX. Specifies a property or an element of a property array for a VBX control. The data type of the ID is ITEM.SET_PROPERTY (item_name VARCHAR2. Height. and FontSize.SET_PROPERTY examples
/* ** Built-in: VBX.
item_name property
value
VBX.VBX. The data type of property is a VARCHAR2 string.SET_PROPERTY built-in to set the Index ** property of the SpinButton VBX control.SET_PROPERTY built-in
Description Sets the specified property for a VBX control. The data type of the name is VARCHAR2 string. value Built-in Type: unrestricted procedure Enter Query Mode yes Parameters item_id Specifies the unique ID that Form Builder assigns to the item when created.SET_PROPERTY (item_id ITEM.
VBX. Syntax VBX. A set of VBX properties exists for any given VBX control.
463
. property VARCHAR2. VARCHAR2). Use the FIND_ITEM built-in to return the ID to an appropriately typed variable. value VARCHAR2). Specifies the name of the object created at design time. Examples of VBX properties are Width. property VARCHAR2. The data type of value is a VARCHAR2 string. VBX.

BEGIN IF :System. The data type of the name is VARCHAR2 string. Syntax VBX.
VBX. property VARCHAR2). Examples of VBX properties are Width. END. A set of VBX properties exists for any given VBX control.SET_VALUE_PROPERTY examples
/* ** Built-in: VBX.SET_VALUE_PROPERTY built-in to set the ** VBX Control Value property.Custom_Item_Event = ’SpinDown’ THEN VBX_VAL_PROP := ’Index’. Height.SET_VALUE_PROPERTY (item_id ITEM.SET_VALUE_PROPERTY ** Example: Uses VBX.SET_VALUE_PROPERTY built-in
Description Sets the VBX Control Value Property of a VBX control.
item_name property
VBX. and FontSize. Specifies the name of the object created at design time. The data type of property is a VARCHAR2 string.VBX_VAL_PROP).SET_VALUE_PROPERTY (item_name VARCHAR2. Specifies a property for the Form Builder VBX Control Value Property. VARCHAR2). The data type of the ID is ITEM.VBX. VBX.SET_VALUE_PROPERTY restrictions
Valid only on Microsoft Windows.Set_Value_Property(ItemName.
465
. VBX_VAL_PROP VARCHAR2(40). Use the FIND_ITEM built-in to return the ID to an appropriately typed variable. END IF. property Built-in Type unrestricted procedure Enter Query Mode yes Parameters item_id Specifies the unique ID that Form Builder assigns to the item when created. */ DECLARE ItemName VARCHAR2(40) := ’SPINBUTTON’. VBX.

*/ BEGIN Web. it is equivalent to the target _self. Specifies one of the following targets: _SELF Causes the document to load into the same frame or window as the source document. END. _PARENT Causes the target document to load into the parent window or frameset containing the hypertext reference.Show_Document(‘http://www. Built-in Type: unrestricted procedure Enter Query Mode: yes Description: Specifies the URL and target window of a Web application. Specifies the Uniform Resource Locator of the document to be loaded.WEB.SHOW_DOCUMENT built-in
Syntax: SHOW_DOCUMENT (url. Restrictions: Can only be used from within a form run from the Web. _BLANK Causes the document to load into a new.com’. replacing any frames currently displayed in the window. _TOP Causes the document to load into the window containing the hypertext link.SHOW_DOCUMENT ** Example: Display the specified URL in the target window. Datatype is VARCHAR2. target). unnamed top-level window. Example: /* ** Built-in: WEB. ‘_self’). Parameters: url target Datatype is VARCHAR2.
466
.abc. If the reference is in a window or top-level frame.

In a full-screen menu.WHERE_DISPLAY built-in
Description Toggles the Where menu navigation option on and off.
467
. Built-in Type: unrestricted procedure Enter Query Mode yes Parameters none
WHERE_DISPLAY restrictions
WHERE_DISPLAY is valid only in a full-screen menu. the Where option displays information about the operator’s current location in the menu hierarchy. Syntax WHERE_DISPLAY.

NUMBER). CALS. The file name must adhere to your operating system requirements. or TPIC. Datatype is ITEM. VARCHAR2 . NUMBER. VARCHAR2. LUT (Lookup Table). you overwrite the contents of that file
468
. MAXIMIZE_COMPRESSION The degree of depth Form Builder will apply to the image when it stores it to the file (optional). The name you gave the image item when you defined it. Valid values are:NO_COMPRESSION. Use the FIND_ITEM built-in to return the ID to an appropriately typed variable. As with any file. Datatype is VARCHAR2. Datatype is VARCHAR2. LOW_COMPRESSION. if you write the image to an existing file. VARCHAR2. TIFF. The file type of the image: BMP. GIF. The degree of compression Form Builder will apply to the image when it stores it to the file (optional). Valid values are:ORIGINAL_DEPTH. Datatype is VARCHAR2.
item_name compression_quality
image_depth
WRITE_IMAGE_FILE restrictions
• • The indicated file type must be compatible with the actual file type of the image. RGB (Red. JPEG. VARCHAR2. The parameter takes a VARCHAR2 argument. RAS. Green. GRAYSCALE. HIGH_COMPRESSION. PICT. MONOCHROME. MEDIUM_COMPRESSION. NUMBER.WRITE_IMAGE_FILE built-in
Description Writes the image from a Form Builder image item into the specified file. Syntax WRITE_IMAGE_FILE (file_name file_type item_id compression_quality image_depth WRITE_IMAGE_FILE (file_name file_type item_name compression_quality image_depth Built-in Type unrestricted procedure Enter Query Mode yes Parameters file_name file_type item_id The name of the file where the image is stored. JFIF. ITEM. MINIMIZE_COMPRESSION. NUMBER). Blue)
VARCHAR2 . The unique ID Form Builder assigned to the image item when you created it.

469
.
•
WRITE_IMAGE_FILE examples
/* Built-in: WRITE_IMAGE_FILE ** ** Save the contents of an image item out to a file ** on the filesystem in a supported image format. original_depth). ’emp. • Though you can read PCD and PCX files from the filesystem or the database.with the contents of the image item. ’TIFF’. maximize_compression.) Writing a JPEG file from a Form Builder image item will result in loss of resolution. END.tif’. you cannot write image files to the filesystem in PCD or PCX format (using WRITE_IMAGE_FILE).photo_image_data’. */ BEGIN WRITE_IMAGE_FILE(’output. (If you use a restricted file type when writing images to the filesystem. Form Builder defaults the image file to TIFF format.

The unique ID Form Builder gave the sound item when you created it. compression NUMBER. and ORIGINAL_SETTING (retain the default channel
channels
470
.WRITE_SOUND_FILE built-in
Description Writes sound data from the specified sound item to the specified file. If omitted. Valid values are: AU. The name you gave the sound item when you created it. LOWEST_SOUND_QUALITY. Whether Form Builder should write the sound data to the file as monophonic or stereophonic. is ORIGINAL_SETTING. and WAVE. Syntax WRITE_SOUND_FILE( file_name VARCHAR2. channels NUMBER). sound_quality The quality of data sampling rate and depth for the sound data. Sound quality is optional: the default value. STEREOPHONIC. Possible values are: HIGHEST_SOUND_QUALITY. compression NUMBER. AIFF-C (Macintosh). item_name VARCHAR2. channels NUMBER). Built-in Type unrestricted Enter Query Mode Yes Parameters: file_name file_type The fully-qualified file name of the file to which you wish to write sound data. HIGH_SOUND_QUALITY. MEDIUM_SOUND_QUALITY. file_type VARCHAR2. Form Builder applies a default file type: WAVE (Microsoft Windows). Possible values are COMPRESSION_ON. Note: File type is optional. Valid values are MONOPHONIC. is ORIGINAL_QUALITY.
item_id item_name
compressioWhether the sound data should be compressed before Form Builder writes the data to the file. WRITE_SOUND_FILE( file_name file_type VARCHAR2. Compression is optional: the default value. item_id ITEM. VARCHAR2. but should be specified if known for increased performance. if omitted. if omitted. LOW_SOUND_QUALITY. AIFF-C. sound_quality NUMBER. COMPRESSION_OFF. The file type for the sound data file. and ORIGINAL_SETTING (retain the default compression setting of the data). or AU (all others). sound_quality NUMBER. and ORIGINAL_QUALITY. AIFF.

Therefore. Channels is optional: the default value. it cannot be assigned to a null canvas or have its Displayed property set to No. you must "hide" the sound item behind another object on the canvas so users will not see the control at runtime. is ORIGINAL_SETTING. place focus in the "hidden" sound item by including a call to the built-in procedure GO_ITEM in the trigger code prior to calling READ_SOUND_FILE and PLAY_SOUND.setting of the data). the control will not function for end users at runtime.
471
. if omitted. READ_SOUND_FILE and WRITE_SOUND_FILE built-ins to play and/or record sound data in a file.
WRITE_SOUND_FILE restrictions
• To use the PLAY_SOUND. (To place focus in an item. to call the READ_SOUND_FILE and PLAY_SOUND built-ins from a When-Button-Pressed trigger. you must create a sound item and place focus in that item before the call to the built-ins are executed. Although the sound item will be represented by the sound item control at design-time.) For example.

SQL*Forms. Form operators use Forms Runtime to run the completed application. Delete module definitions from the database. you can create three types of modules: forms. and executes the form. Application developers use the Web Previewer to test forms locally as though they were being run from Forms Server in a browser or in the Appletviewer. or components. you can: Convert files between binary. Upgrade applications created with previous versions of Form Builder. and executes the form. Using Form Builder.
Forms Runtime
Web Previewer
Form Compiler
472
.Options
About Form Builder Components
Form Builder consists of the following programs. Using Form Compiler. Forms Runtime reads the machine-readable file created by the Form Compiler. which you can execute independently from the command line or by clicking on an icon: Form Builder Form Builder is the design component you use to create. you can also use Forms Runtime to test and debug forms during the design stage. compile. and SQL*Menu. Like Forms Runtime. As an application designer. Recompile application modules when porting to different platforms. menus. text. Insert module definitions into database tables. Form Compiler also allows you to convert various representations of a form. and database module storage formats. you use the Form Compiler to create a machinereadable file that Forms Runtime can execute. and run Form Builder applications. and libraries. the Web Previewer reads the machine-readable file created by the Form Compiler. Most often.

or Forms Runtime components in one of two ways.
473
. When you start a component by entering a command on the command line. double-click it. To launch a component. you can indicate the options you want to use for this session by entering keyword parameters on the command line. depending on your computer platform: icon You will see a different icon for each component: Form Builder. Web Previewer. You can start the Form Builder. Form Compiler. and Forms Compiler. and some support command lines.
command line
For more information on starting Form Builder components. Forms Runtime. refer to the Form Builder documentation for your operating system.Starting Form Builder Components
Some platforms support icons.

. are unique because you can use either positional or keyword notation to enter them. with no calls to the user exit interface. enter this statement at the system prompt: component_name [module_name] [userid/password] [parameters] where: component_name Specifies the Form Builder component you want to use: • • • • Form Builder .ifweb60 Form Compiler . ifrun60 custform scott/tiger statistics=yes Note: The examples assume that you’re running Form Builder on Microsoft Windows. or library name. userid/password Specifies your ORACLE username and password. menu. To indicate that foreign functions accessible through the user exit interface have been linked into the executable. so the Forms Runtime component name is shown as "ifrun60. module_name Specifies the module you want to load: a form. MODULE and USERID.Starting Form Builder Components from the Command Line
To start any Form Builder component from the command line. on the command
474
. add an x to component_name . Use keyword notation to enter optional parameters.ifcmp60
Starting Form Builder Components examples
ifrun60 Starts the Forms Runtime component on Microsoft Windows. If you omit the module name. Optional parameters are entered in this format:keyword1=value1 keyword2=value2.. Form Builder displays a dialog allowing you to choose the module to open. refer to the Form Builder documentation for your operating system.ifbld60 Forms Runtime . Keyword Usage There are three categories of parameters in Form Builder: • • • MODULE and USERID options (command line parameters for setting options) form parameters
The first two parameters." You should substitute the correct value of component_name for your platform and application. For more information on valid component names.ifrun60 Web Previewer . parameters Specifies any optional command line parameters you want to activate for this session. with no calls to the user exit interface.

475
. Options Use keyword notation for setting options on the command line. Form Builder will prompt you for module name and username/password.) Form parameters are optional input variables that are defined at design time for a specific form. MODULE and USERID. To use positional notation instead of keywords would require inserting the value of the MODULE parameter immediately after the component name. Separate arguments with one or more spaces. you may omit the keywords and enter only values. Valid Examples: ifrun60 module=custform userid=scott/tiger ifrun60 userid=scott/tiger ifrun60 If you indicate only the module name. so it must be preceded by the USERID keyword. MODULE and USERID If you enter the first two parameters.line. as in the previous example. in the specified order. (Many optional parameters can also be set using dialogs. Form parameters provide a simple mechanism for defining and setting the value of inputs that are required by a form at startup. For information on options. as shown in the following example: ifrun60 custform scott/tiger Invalid Example: ifrun60 scott/tiger This sequence is invalid because the value for username/password is out of sequence. Operators can specify values for form parameters by entering them on the command line using standard command line syntax. including options and form parameters: • • No spaces should be placed before or after the equal sign of an argument.
Invalid Example: ifrun60 custform scott/tiger statistics = yes ifrun60 custform scott/tiger statistics=yes. see: • • • Setting Forms Runtime Options Setting Form Compiler Options Setting Form Builder Options
The following syntax rules apply to all keyword parameters.debug=yes Valid Examples: ifrun60 custform scott/tiger statistics=yes ifrun60 custform scott/tiger statistics=yes debug=yes Form Parameters Form parameters are variables that you define at design time. do not use commas to separate arguments.

myname_param is a user-defined form parameter that was defined in Form Builder. Note: If a form parameter value includes a space or punctuation. The operator can override the default value when starting Forms Runtime by specifying a new value for the form parameter on the command line. type the component name followed by "help=yes" at the system prompt.The default value for a form parameter is taken from the Default Value field of the Properties window. Example ifrun60 empform scott/tiger myname_param="Msr. In the following example. enclose the value in double quotes. Example ifrun60 help=yes
476
. Dubois" Displaying Hint Text on Command Line Options To receive help on syntax and parameters.

Forms will offer you an opportunity to enter a new password when you log on. in Form Builder. use one of the following forms: username/password username/password@node Expired password The Oracle8 database server offers a password expiration feature that database administrators can employ to force users to update their password on a regular basis. If your password has expired. choose File->Connect. use the USERID command line keyword or. see your Database Administrator. (You can also use the Forms startup dialog box to change your password before it expires. The maximum length for the connect string is 255 characters. USERID USERID is your ORACLE username and password with an optional SQL*Net connect string. For help with your ORACLE username.
477
.Logging on to the Database
To explicitly log on to the database.)
Logging on to the Database examples
You might specify the following command to run the ORDER_ENTRY form on the default database of the LONDON node: ifrun60 order_entry scott/tiger@D:london For information on SQL*Net. To log on. refer to the SQL*Net User’s Guide.

Options may also be set for the Web Previewer in the serverargs parameter of a base HTML file. choose Tools Preferences. in any order: ifrun60 module=myform userid=scott/tiger debug=YES statistics=YES
Option Name Oracle terminal resource file Run in debug mode Debug messages Write input keystrokes to file Read input keystrokes from file Write output to file Write output to display Array processing Buffer records to temporary file Display screen to specify logon Display block menu on startup Optimize V2-style trigger step SQL processing Optimize transaction mode processing
Keyword Parameter Term Debug Debug_Messages * Keyout Keyin Output_File Interactive Array Buffer_Records Logon_Screen Block_Menu OptimizeSQL OptimizeTP
Default
No No
Yes Yes No No No Yes Yes
478
. You can set Forms Runtime options in two ways: • • Set options in the Forms Runtime Options dialog box.Forms Runtime Options
Forms Runtime options specify Form Builder default behavior during a Forms Runtime session. The following chart lists the Forms Runtime options from the Options window and their corresponding keyword parameters. you can enter more than one at a time. You can specify this HTML filename in the Runtime tab of the Preferences dialog box. Pass parameters to Form Builder on the command line when you invoke Forms Runtime. If you enter these keyword parameters as command line options. or on the command line. To display the Preferences dialog box.
In addition. you can set Forms Runtime options to specify the defaults for forms you run from Form Builder in the Preferences dialog box. Note: Forms Runtime preferences set in Form Builder apply only to forms run from within Form Builder.

479
. not available from the Forms Runtime Options dialog box.Run in quiet mode Show statistics Run in query only mode Show help information Window state Collect PECS data? Options screen Use SDI mode Path for HTML file (Web Runtime only)
Quiet Statistics Query_Only Help Window_State PECS Options_Screen * USESDI HTML
No No No No NORMAL OFF No No
* Use from command line only.

or DELETE when array processing is suppressed.Array (Forms Runtime)
Description Use array processing during a Forms Runtime session. However. When you suppress array processing. Forms requests that the database only returns a single row of query results at a time from server to client. Similarly. Option Name Array Processing Default YES
Array (Forms Runtime) examples
ifrun60 module=myform userid=scott/tiger array=NO
480
. UPDATE. the total time required to fetch and display a number of records is shorter with array processing because network overhead can be reduced. Suppressing array processing usually results in the first retrieved record displaying faster than it would if you fetched a number of records with array processing. Forms requests that the database only send a single row at a time from the client to the server for an INSERT.

Buffer_Records (Forms Runtime)
Description Sets the number of records buffered in memory to the minimum allowable number of rows displayed plus 3 (for each block). If a block retrieves any records by a query beyond this minimum. Form Builder buffers these additional records to a temporary file on disk. Option Name Buffer Records to Temporary File Default NO
Buffer_Records (Forms Runtime) examples
ifrun60 module=myform userid=scott/tiger buffer_records=YES
482
. but may slow down processing because of disk I/O. Setting this option saves Forms Runtime memory. Buffer_Records=NO tells Form Builder to set the minimum to the number specified using the Buffered property from each block.

To invoke debug mode on non-Windows platforms. Debug mode invokes break processing if the BREAK built-in is used in any trigger or if you use the Help->Debug command from the Form Builder menu.Debug (Forms Runtime)
Description Invokes the debug mode for the Forms Runtime session. you must use the debug runform executable: ifdbg60 module=myform userid=scott/tiger debug=YES Option Name Run in Debug Mode Default NO
Debug (Forms Runtime) examples
ifdbg60 module=myform userid=scott/tiger debug=YES
483
.

Help (Forms Runtime)
Description Invokes the Form Builder help screen. Option Name Show Help Information Default NO
Help (Forms Runtime) examples
ifrun60 help=YES
485
.

or keyscript. run interactively) as well as print the output to a file. The Keyin file specifies the input. file.. Note: You must use the Keyin and Output_File parameters whenever you use Interactive.Interactive (Forms Runtime)
Description Interactive specifies that.e. Option Name Write Output to Display Default YES
Interactive (Forms Runtime) examples
ifrun60 module=myform userid=scott/tiger keyin=myfile. Form Builder will display the output on the terminal screen (i. Output_File specifies the output. when you are using a keyscript file as input. or display log.key output_file=mydisplay. Use Interactive=NO to suppress screen output when running forms in batch mode.out interactive=NO
486
. This parameter applies to character-mode terminals only. file.

The keyscript file starts. file. executes. specify Interactive=NO and use Output_File to specify the output file.Keyin (Forms Runtime)
Description Allows you to read a keyscript file into a form as input. This parameter applies to character-mode terminals only. or keyscript. Option Name Read Input Keystrokes from File
Keyin (Forms Runtime) examples
ifrun60 module=myform userid=scott/tiger keyin=myfile.key
487
. If you want to suppress screen output. Form Builder performs all actions on the terminal screen. The file name specified is the input. By default. and ends the Forms Runtime session.

Logon_Screen (Forms Runtime)
Description Forces the logon screen to display if you have not entered the password. Do not specify a username and password when you use Logon_Screen (Form Builder will ignore it if you do). Use Logon_Screen when you do not want to type your password on the command line (where it is visible). Option Name Display Screen to Specify Logon Default NO

Optimize SQL Processing (Forms Runtime)
Description Specifies that Form Builder is to optimize SQL statement processing in V2-style triggers by sharing database cursors. By default, Form Builder assigns a separate database cursor for each SQL statement that a form executes explicitly in a V2 trigger. This behavior enhances processing because the statements in each cursor need to be parsed only the first time they are executed in a Forms Runtime session¾not every time. When you specify OptimizeSQL=NO, Form Builder assigns a single cursor for all SQL statements in V2 triggers. These statements share, or reuse, that cursor. This behavior saves memory, but slows processing because the SQL statements must be parsed every time they are executed. You can fine-tune this behavior through the New Cursor Area trigger step characteristic. If a trigger step that contains a SQL statement has this characteristic turned on, Form Builder assigns a separate cursor to the statement, in effect overriding the OptimizeSQL parameter for that statement. Note: OptimizeSQL has no effect on statements in PL/SQL triggers. Option Name Optimize V2-Style trigger Step SQL Processing optimizesql Default YES

Optimize Transaction Mode Processing (Forms Runtime)
Description Optimizes transaction mode processing. By default, Form Builder assigns a separate database cursor for each SQL statement that a form executes implicitly as part of posting or querying data. This behavior enhances processing because the statements in each cursor are parsed only the first time they are executed in a Forms Runtime session, not every time. Note that the cursors that are assigned to query SELECT statements must be parsed every time they are executed. This exception exists because queries can vary from execution to execution. When you specify OptimizeTP=NO, Form Builder assigns a separate cursor only for each query SELECT statement. All other implicit SQL statements share, or reuse, cursors. This behavior saves memory but slows processing because all INSERT, UPDATE, DELETE, and SELECT FOR UPDATE statements must be parsed every time they are executed. Option Name Optimize Transaction Mode Processing optimizetp Default YES

Optimize Transaction Mode Processing (Forms Runtime) restrictions
The OptimizeTP parameter has no effect if you replace standard Form Builder processing with OnInsert, On-Update, and On-Delete triggers because these triggers replace the implicit issuance of INSERT, UPDATE, and DELETE statements.

Output_File (Forms Runtime)
Description Captures the terminal output for a form in a display log file, as well as displaying it on the screen. If you want to suppress screen output, use Interactive=NO and then specify an Output_File. This parameter applies to character-mode terminals only. Note: You must use the Keyin parameter whenever you use Output_File. The Keyin file specifies the input, or keyscript, file; Output_File specifies the output, or display log, file. Option Name Write Output to File

PECS (Forms Runtime)
Description Runs a form with Performance Event Collection Services (PECS) enabled. PECS is a performance measurement tool you can use to perform the following tasks: • • • • Measure resource usage (CPU time per event or transactions processed per hour) of Form Builder or application-specific events Locate performance problems (elapsed time per event) Measure object coverage (whether a specific object, such as a trigger, alert, or window, is visited during test execution) Measure line-by-line coverage (for PL/SQL code in triggers and procedures)

The PECS option can be set to ON, OFF, or FULL: For object coverage, set PECS=ON • For object coverage and line coverage: Compile with Debug=ON Run with PECS=FULL The default is PECS=OFF

To use PECS on non-Windows platforms, you must use the debug runform executable: ifdbg60 module=myform userid=scott/tiger PECS=ON Default: OFF

Query_Only (Forms Runtime)
Description Invokes the form in query-only mode. Setting this option to On is equivalent to using the CALL_FORM(query_only) built-in. Preference Name Query Only Mode Default NO

Quiet (Forms Runtime)
Description Invokes the quiet mode for the Forms Runtime session. In quiet mode, messages do not produce an audible beep. You can explicitly ring the bell from a trigger by way of a call to the BELL built-in. The default of quiet=NO means that the bell rings. To turn off the bell, set quiet=YES. Option Name Run in Quiet Mode Default NO

Statistics (Forms Runtime)
Description Displays a message at the end of the session that states the maximum number of simultaneous cursors that were used during the session. This message appears on the terminal screen, not on the message line. This option also issues the following command to the database: ALTER SESSION SET SQL_TRACE TRUE This command enables the SQL trace facility for the current session, displaying the trace file directory on the server. For more information on this facility¾which gathers database performance information¾refer to the Oracle RDBMS Performance Tuning Guide . If you are running a form within Form Builder and you want to use this feature, activate the Statistics Forms Runtime option. Option Name Show Statistics Default NO

Term (Forms Runtime)
Description Specifies a mapping other than the default mapping for the current device and product: resfile The file name specified is the name of your Oracle Terminal resource file. If you do not specify resfile, Form Builder defaults to a file name that is platform-specific, but begins with "FMR" on most platforms. For example, the Microsoft Windows default file is FMRUSW. resfile The file name specified is the name of your Oracle Terminal resource file. If you do not specify resfile, Form Builder defaults to a file name that is platform-specific, but begins with “FMR” on most platforms. For example, the Microsoft Windows default file is FMRUSW. The mapping name specified is the mapping you want to use for this Form Builder session.

mymapping

Note: You or the DBA define mappings with Oracle Terminal. For more information on resource files, refer to the Form Builder documentation for your operating system. When running forms on the web use only the resfile argument to specify the full path of the resource file to be used. Option Name Oracle Terminal Resource File

Term (Forms Runtime) examples
ifrun60 module=myform userid=scott/tiger@<alias> term=resfile:mymapping When running a form on the web use: serverargs="myform.fmx scott/tiger@<alias> term=c:\formdir\resfile.res"

498

Window_State (Forms Runtime)
Description Sets the size of the MDI application window at the beginning of Forms Runtime. When set to MAXIMIZE, the MDI application window is maximized at the beginning of a Forms Runtime session. When set to MINIMIZE, the MDI application window is minimized at the beginning of a Forms Runtime session. The NORMAL setting starts up an MDI application window that is normal size. Option Name Window State Default NORMAL

Window_State (Forms Runtime) restrictions
Valid only on Microsoft Windows. Not supported for forms running from the web.

Setting Form Compiler Options
Form Compiler options specify Form Builder default behavior during a Form Compiler session. Some of these options apply to file generation during development, for running and testing forms; other options apply only when you are converting files from earlier versions to Version 6.0. You can set Form Compiler options in two ways: • • Set options in the "Form Compiler Options" dialog box. Pass parameters to Form Builder on the command line when you invoke Form Compiler.

The following chart lists the Form Compiler options from the "Form Compiler Options" window and their corresponding keyword parameters. For information on a specific Form Compiler option, see the corresponding parameter in the alphabetical list that follows the chart. In the alphabetical list of Form Compiler parameters, the following information is shown for each parameter: • • • • example, showing the parameter set to a value other than its default relevant module type: Form, Menu, Library, or All description default

If you enter these keyword parameters as command line options, you can enter more than one at a time, in any order: ifcmp60 module=myform userid=scott/tiger batch=YES statistics=YES

Upgrade 3.0 Form or 5.0 Menu to 4.5 Module Upgrade SQL*Menu 5.0 table privileges Version to upgrade CRT file to use when upgrading Compile a runform/runmenu file when upgrading Add key-up and down triggers when upgrading Add NOFAIL to exemacro steps when upgrading Show help information Options_Screen Batch

Compile_All (Form Compiler)
Description Compiles the program units within the specified module. Note: The output file will be placed in the current directory unless you specify a different location using Output_File. Module: Form, Menu, Library Default NO

Debug (Form Compiler)
Description Creates a debug-capable form. The debug Form Compiler option creates entries in your .FMX file used by the runtime source-level debugger, so set debug=yes for Form Compiler whenever you plan to set debug=yes for runtime. Option Name Compile in Debug Mode Default NO

Help (Form Compiler)
Description Invokes the Form Builder help screen. Module: All Default NO

Help (Form Compiler) examples
ifcmp60 help=YES

510

Insert (Form Compiler)
Description Inserts a module directly into the database from the Form Compiler command line. Module: All Default NO Usage Notes The Insert option does not work in combination with the Upgrade option.

Logon (Form Compiler)
Description Specifies whether Form Compiler should log on to the database. If the module contains any PL/SQL code with table references, a connection will be required for generation. Module: Form Default YES

When used with upgrade=yes.PLL file)
Note: To specify the name of the generated library file.fmb
517
. output_file specifies: • the complete name of the upgraded binary design module(. Module: All
Output_File (Form Compiler) examples
ifcmp60 module=myform userid=scott/tiger upgrade=yes output_file=myform. you must use Strip_Source in conjunction with Output_File.MMB.. the file extension is ignored. or .MMX file)
When used with upgrade=yes and build=no.FMB. • the root name (without extension) of the upgraded Forms Runtime executable module (.Output_File (Form Compiler)
Description Specifies the file name for the generated file.FMX or .

FMB. This operation can also be done from within Form Builder by using the Convert command. .PLL).MMT.Parse (Form Compiler)
Description Converts the text file format of a module (. . . .MMB.PLD) to a binary format (.FMT. Module: All Default NO
Parse (Form Compiler) examples
ifcmp60 module=myform parse=YES
518
.

or .MMB.FMT.PLD).PLL) to a text format (. or .Script (Form Compiler)
Description Converts a binary file format (.MMT. This operation can also be done within Form Builder by using the Convert command. . Module: All Default NO
Script (Form Compiler) examples
ifcmp60 module=myform script=YES
519
. .FMB.

lists of values. radio groups.
Module: Form Default NO
Statistics (Form Compiler) examples
ifcmp60 module=myform userid=scott/tiger statistics=YES
520
. text items. trigger Statistics: The number of form triggers. and total number of items. item triggers. the average array fetch size. Block Statistics: The number of blocks with Array Fetch ON. record groups. display items. image items. and total number of triggers. canvases.Statistics (Form Compiler)
Description Displays a message at the end of the session listing the number of various objects in the compiled form: • • • • Object Statistics: The number of alerts. windows. and total number of objects. Item Statistics: The number of buttons. editors. and the total number of blocks. procedures. check boxes. visual attributes. block triggers. list items. user areas.

Module: Library Default NO
Strip_Source (Form Compiler) examples
ifcmp60 module=old_lib.pll
521
.Strip_Source (Form Compiler)
Description Removes the source code from the library file and generates a library file that only contains pcode. When you use Strip_Source. The resulting file can be used for final deployment.pll userid=scott/tiger strip_source=YES output_file=new_lib. you must specify an output file by using the Output_File (Forms Runtime) parameter. but cannot be subsequently edited in Form Builder.

0.0.0 to an Form Builder 4.0 to Form Builder 4. or from SQL*Menu 5.5.3. To upgrade from SQL*Forms 2.Upgrade (Form Compiler)
Description Upgrades modules from SQL*Forms 2.
Upgrade (Form Compiler) examples
ifcmp60 module=myform userid=scott/tiger upgrade=YES
522
.5 menu module: To upgrade from SQL*Forms 3.5. specify upgrade=yes and omit version.0 to Form Builder 4.3. To upgrade from SQL*Forms 2.0 or SQL*Menu 5. specify upgrade=yes and version=23. Menu Default NO Usage Notes The Upgrade option does not work in combination with the Insert option. or 3. 2. Module: Form. specify upgrade=yes and version=20.

Version (Form Compiler)
Description Indicates version from which to upgrade.0 (version=20). Use in conjunction with upgrade=yes to upgrade from version 2. specify upgrade=yes and omit the version parameter.3 (version=23) or version 2. Module: Form Default version=30
Version (Form Compiler) examples
ifcmp60 module=myform userid=scott/tiger upgrade=yes version=23
524
. To upgrade from version 3.0.

When upgrading to Version 4. This option is most useful for upgrading Form Builder 3. If two fields are currently flush against each other.Widen_Fields (Form Compiler)
Description Use the Widen_Fields option in conjunction with Upgrade.0 character-mode applications with a large number of 1-6 character fields. the Widen_Fields option will cause the fields to overlap. The effects of the Widen_Fields option will depend on your interface design. Effects can include: • • Text items may overlap boilerplate text if space between fields is limited. Note: This has no effect on the maximum allowable data length. and should be tested carefully. the bevels on each field can cause the loss of up to one character per field.
Module: Form Default NO
Widen_Fields (Form Compiler) examples
ifcmp60 module=myform userid=scott/tiger upgrade=yes widen_fields=YES
525
.5. Specify this option when upgrading to automatically add one character to the Display Width of each field.

Database. All) Printer Color Palette Color Mode
For information on a specific design option.Setting Form Builder Preferences
Form Builder preferences specify Form Builder session default behavior. The Preferences dialog box includes both Form Builder and Forms Runtime preferences. To set options. Choose Tools Preferences in Form Builder to invoke the Preferences dialog box. Form Builder Preferences You can set the following design options to specify the defaults for the current Form Builder session: • • • • • • • • • • Save Before Building Build Before Running Suppress Hints Run Module Asynchronously Use System Editor Module Access (File. click on the check boxes or fill in file names for the options you choose. File/Database) Module Filter (Forms. see the alphabetical list that follows. Menus. Libraries. Runtime Options You can set the following Runtime options to specify the defaults for forms that you run from Form Builder: • • • • • • • • • Buffer Records in File Debug Mode Array Processing Optimize SQL Processing Optimize Transaction Mode Processing Statistics Display Block Menu Query Only Mode Quiet Mode
Runtime options are listed earlier in this chapter. Keyword Parameters
526
.

you can set these keyword parameters on the Form Builder command line: • • • Module_Type Module_Access Help
Setting Form Builder Options examples
ifbld60 module=orders userid=scott/tiger module_type=menu
527
.In addition to the options listed in the Options dialog.

Use Formet -> Layout Options -> Color Palette to make changes to the color palette (only when the Layout Editor is open). For this reason. and is not relevant for Form Builder.Shared will help you avoid the color flicker that can result when you switch between Form Builder color palettes and is the recommended setting for Color Mode unless you are modifying the palette. Default Read Only . In Form Builder. open. Form Builder loads the Form Builder color palette into your current system color table.Color Mode
Determines how an Form Builder color palette will be loaded on your system. General tab. Once you have changed the color palette. General tab.Shared mode. Color Mode).Shared and save your options. Read Only . Use File -> Export -> Color Palette to save the Form Builder color palette to a file (only when the Layout Editor is open).
Read Only-Private
This option is provided for consistency with Graphics Builder. and if there is no more room in the table. return to Read Only Shared mode. To change the Form Builder color palette: • • • • • • • Read Only-Shared Change Color Mode to Editable and save your options (Tools -> Preferences. Change your options to use the new color file (Tools -> Preferences. Restart Form Builder. Color Mode options: Editable Select Editable mode only when you want to change the Form Builder color palette. it maps to Read Only Shared. Color Palette). each color has its own unique entry in the current system color table.Shared option except when you are actively modifying the Form Builder color palette. use the Read Only . Form Builder maps duplicate colors to the same entry in the current system color table before appending new entries from your Form Builder color palette. or create a form. Change Color Mode back to Read Only . the color palette may refuse to load. In Editable mode. Form Builder may not be able to accurately modify multiple forms simultaneously if they use different color palettes. Restart Form Builder. Because this system color table can handle only a limited number of colors at once.Shared
528
. Each time you load.
In Read Only .

529
. refer to About Color Palettes. the Form Builder default color palette is loaded. If this field is left blank. For more information about color palettes.Color Palette
Description Specifies the name of the Form Builder color palette that is automatically loaded when you create a new form.

this option does not save the module. You must issue the File Save command to save the module. or library module to create an executable runfile having the same name as the module runs the . When Build Before Running is checked.
This option lets you avoid issuing separate Compile and Run commands each time you modify and then run a form. or check the Save Before Building preference.FMX file (form runfile) you specify in the Run dialog box. Form Builder does not automatically compile any menu or library modules attached to that form. However. Form Builder does the following when you issue the Program>Run Form command to run a specified form: • builds the active form. Default: Off
530
. when the Build Before Running option is checked.Build Before Running
Description Determines whether Form Builder automatically compiles the active module before running a form. Also. menu. You must compile menu and library modules separately before running a form that references them.

When you preview a form in the Web Previewer. Enter the path and filename of a custom HTML file to supersede the one Form Builder creates. This file is sent to the Web Previewer to execute your form.HTML File Name
Description Specifies the HTML file to be used to run the form using the Web Previewer. a container HTML file is created dynamically with the runtime options specified by preferences or by default.
532
.

The command line parameter establishes access on a one-time basis for the current Form Builder session. Modules are loaded from and saved to the database. In the Module Access option. use the Access preference (Tools->Preferences Access tab) to change your Preferences file. Modules can be loaded from and saved to either the file system or the database. This option can be set on the command line using the Module_Access parameter or within the Form Builder Access tab of the Preferences dialog box. the Module_Access option can be set to file or database. On the command line. Form Builder will prompt for the location of the file each time you perform these operations.
Module: All Default FILE
Access preference (Form Builder) examples
ifbld60 module=myform userid=scott/tiger module_access=database
533
.Access preference (Form Builder)
Description Specifies whether to open and save modules to the file system or to the database. you can specify one of the following storage preferences for opening and saving modules: File Database Ask Modules are loaded from and saved to the file system. To set this option for future Form Builder sessions.

menu and library modules with the same name.Module_Type (Form Builder)
Description Specifies module type for current module. you can have form. Module: All Default FORM
Module_Type (Form Builder) examples
ifbld60 module=orders userid=scott/tiger module_type=menu
534
. By specifying Module_Type.

refer to the Form Builder documentation for your operating system.Printer
The name of the default printer.
535
. This name is operating-system dependent. For more information about printers.

forms you run from Form Builder are asynchronous. so you can move back and forth between Form Builder and Forms Runtime. and Forms Runtime startup errors are not reported in Form Builder. forms you run from Form Builder are synchronous.
When you run a form synchronously. no such communication between Forms Runtime and Form Builder occurs. Default Off
536
. When you run a form asynchronously. Form Builder notifies you of any Forms Runtime startup errors that occur by displaying an alert in Form Builder. When Run Modules Asynchronously is On. That is. you cannot work in Form Builder until you exit the form.Run Modules Asynchronously
Determines whether forms that you run from Form Builder are executed synchronously or asynchronously with respect to Form Builder itself: • • When Run Modules Asynchronously is Off.

Save Before Building
Determines whether Form Builder saves the current module automatically before it is built either when you choose File->Administration->Compile File or when the form is built before running when the Build Before Running preference is checked. Default Off
537
.

Specify one of the following preferences for saving the path of original objects with subclassed objects: Remove Keep Ask Default ASK Notes A subclassed object inherits property values from the original object and references the original object by the file name of the form in which it is saved. The full path name of the form may be saved with the subclassed object or only the filename. When the form containing the subclassed object is opened. Form Builder looks in the current directory in which Form Builder was started.
538
.Subclassing Path
Description Specifies whether to save the path of an original object with the subclassed object. The path will be removed from the filename of the original object referenced in the subclassed object. The subclassed object will reference the original object according to the full path. Form Builder looks for the file specified for the subclassed object. If the filename is specified without the path. Each time you subclass an object Form Builder will display a dialog box prompting whether to remove or keep the path.

Default Off
539
.Suppress Hints
Determines whether hints are suppressed from the message line as you work in Form Builder.

refer to the Form Builder documentation for your operating system. Form Builder defaults to a file name that is platform-specific. the Microsoft Windows default file is FMRUSW.Term (Form Builder)
Description Specifies a mapping other than the default mapping for the current device and product: resfile The file name specified is the name of your Oracle Terminal resource file.
mymapping
For more information on resource files. but begins with "FMR" on most platforms.
Term (Form Builder) examples
ifbld60 module=myform userid=scott/tiger term=resfile:mymapping
540
. The mapping name specified is the mapping you want to use for this Form Builder session. For example. Note: You or the DBA define mappings with Oracle Terminal. If you do not specify resfile.

USESDI (Forms Runtime and Web Forms Runtime)
Description Use single document interface (SDI) system of window management during a Forms Runtime or Web Forms Runtime session. MDI toolbars exist in parent windows and menus will be attached to each window. such as Alt-TAB on Microsoft Windows. There is no multiple document interface (MDI) root window.
USESDI (Forms Runtime) examples
ifrun60 module=myform userid=scott/tiger usesdi=YES
541
. Option Name None Default YES Usage Notes: SDI Forms are not native windows and you cannot navigate to the SDI window by using certain native OS methods to access windows. Calls to the FORMS_MDI_WINDOW constant returns NULL as the MDI window handle when usesdi=YES.

For more information about defining the default system editors. you must save the document as ASCII text (with line breaks). When Use System Editor is unchecked. Form Builder displays the default editor. Note: If Use System Editor is checked and you are using an editor with a native document format. When Use System Editor is checked. instead of saving the document in that editor’s format. Form Builder displays the default system editor defined on your system.Use System Editor
Determines which editor Form Builder uses when you invoke an editor from a multi-line text item. refer to the Form Builder documentation for your operating system. Default Off
542
.

You can use any of the Form Builder or Forms Runtime keyword parameters listed in this chapter in a user preference file. just as you would on the command line. For example. you would include the following line in the user preference file: FORMS. Form Builder ignores that line when it reads the file.QUIET=ON The preference file also allows you to preset a mapping for Form Builder. Use the following syntax:
KEYWORD = {ON | OFF | STRING}
For a list of keywords and appropriate values. then examine the current contents of your PREFS. the preference file must be named PREFS. Form Builder reads the updated preference file when you start Form Builder. to ensure that any form that you run from Form Builder runs in quiet mode.ORA and must reside in the login directory.ORA file. If you start Form Builder with a command line parameter that specifies a preference setting or mapping. The preference file that enforces Form Builder options is automatically updated every time you change your preferences. Syntax for Options To preset a Form Builder or Forms Runtime option.
543
. include the appropriate keyword and setting in the preference file. Also.User Preference File
Although the Preferences dialog box is the most convenient way to set preferences. On most platforms.ORA). This file contains keywords and settings that allow you to preset each of the Form Builder and Forms Runtime options. you can also set them directly in the preference file (usually called PREFS. if a line in the preference file contains an error. the command line parameter overrides the setting in the preference file. save your preferences.

the welcome screen will be displayed when Form Builder is started. Default ON
544
. When checked. blank module called module1.Welcome Dialog
Description Determines whether the welcome screen is displayed when Form Builder is started. Form Builder starts with a new. When unchecked.

the welcome page will be displayed when the wizard is started. When checked. the wizard does not display the welcome page.Welcome Pages
Description Determines whether the welcome page for a specific wizard is displayed when the wizard is invoked. Applies to Data Block Wizard LOV Wizard Layout Wizard Chart Wizard Default
ON
545
. When unchecked.

.Properties
What are properties?
Each object in a Form Builder application possesses characteristics known as properties. or both. An object’s properties determine its appearance and functionality. GET_ITEM_PROPERTY).g. programmatically at runtime.
546
.
About setting and modifying properties
Each property description includes a Set heading that describes how you can set the property. Setting Properties Programmatically To dynamically modify object properties programmatically. either declaratively in Form Builder (using the Property Palette). use the following Form Builder built-ins subprograms: • • • • • • • • • • • • • • • • SET_APPLICATION_PROPERTY SET_BLOCK_PROPERTY SET_CANVAS_PROPERTY SET_FORM_PROPERTY SET_ITEM_PROPERTY SET_ITEM_INSTANCE_PROPERTY SET_LOV_PROPERTY SET_MENU_ITEM_PROPERTY SET_PARAMETER_ATTR SET_RADIO_BUTTON_PROPERTY SET_RECORD_PROPERTY SET_RELATION_PROPERTY SET_REPORT_OBJECT_PROPERTY SET_TAB_PAGE_PROPERTY SET_VIEW_PROPERTY SET_WINDOW_PROPERTY
You can programmatically determine the settings of most properties by using the set of corresponding built-ins to get properties (e.

Built-in(s) you can use to set the property.
Heading Applies to Set
Description The object class or classes for which this property is meaningful.Reading property descriptions
Description The property descriptions follow a general pattern. The default value of the property. Any particular usage considerations you should keep in mind when using the property. or both. Any restrictions potentially affecting usage of the property. The property name is printed in a bold typeface and is followed by a brief description. The headings in the following table are included for those properties to which they apply. Where you can set the property: in Form Builder (using the Property Palette). if you can set the property programmatically. Whether the property is required or optional. programmatically at runtime.
Refer to Built-in Default Required/Optional Restrictions: Usage Notes
547
.

Applies to ActiveX items Set Form Builder Required/Optional optional
548
.About Control property
Description For ActiveX (OCX) control items in the layout editor. Provides a link to an about screen describing the current OCX control.

The access key character is displayed with an underscore in the item label. allowing the operator to select or execute an item by pressing a key combination. For example. When the operator presses the access key.
549
. the When-Button-Pressed trigger fires for Push_Button1. For example. When the operator presses Alt-C (on Microsoft Windows).Access Key property
Description Specifies the character that will be used as the access key. Applies to button. Assume also that there is a When-Button-Pressed trigger associated with Push_Button1. Form Builder executes the "Commit" command. any triggers associated with the action fire. such as Alt-C. assume that Push_Button1’s label is "Commit" and the access key is defined as "c". assume that Push_Button1 has an access key assigned to it. and check box Set Form Builder Default No Required/Optional Optional Usage Notes • When the operator initiates an action via an access key.
Access Key restrictions
• Buttons with the Iconic property set to Yes cannot have an access key. radio button.

the alert style determines which bitmap icon is displayed in the alert.Alert Style property
Description Specifies the alert style: caution. or informational. Applies to alert Set Form Builder Default warning
550
. warning. On GUI platforms.

and must qualify the column name by using that alias as a prefix. the alias is E. If the alias for this EMP table were E. E.
551
. In this case. then a SELECT statement would need to be qualified as follows: SELECT EMPNO. requires no such qualification. You only need to concern yourself with this alias naming if you are doing such things as coding a block WHERE clause.Alias property
Description Establishes an alias for the table that the data block is associated with. It will establish an alias name at design-time.CITY is qualified with that alias.CITY FROM EMP E. which is a normal relational column.) In most situations. STATE VARCHAR2(2)). Form Builder will handle this alias naming for you. Applies to table/columns associated with a data block Set Form Builder Default The Data Block wizard sets the Alias property to the first letter of the table name. The column object ADDRESS. CITY VARCHAR2(30). SELECT statements that include column objects or REF columns must identify both the table name and its alias. CREATE TABLE EMP (EMPNO NUMBER. For example: CREATE TYPE ADDRESS_TYPE AS OBJECT (STREET VARCHAR2(30).) Required/Optional required for Oracle8 tables that contain column objects or REFs Usage Notes For Oracle8 tables.ADDRESS. and the alias is also given after the table name. (The column EMPNO. and then automatically use the qualified name at runtime when it fetches the data from the Oracle8 Server. ADDRESS ADDRESS_TYPE). a table named DEPT would have a default alias of D. (For example.

Applies to frame Set Form Builder Default Yes Required/Optional required
552
.Allow Expansion property
Description Specifies whether Form Builder can automatically expand a frame when the contents of the frame extend beyond the frame’s borders.

If set to FALSE. an empty branch will be displayed as a collapsed node. If set to TRUE.Allow Empty Branches property
Description Specifies whether branch nodes may exist with no children. programmatically Default False Required/Optional required
553
. branch nodes with no children will be converted to leaf nodes. Applies to hierarchical tree Set Form Builder.

Allow Multi-Line Prompts property
Description Specifies whether Form Builder can conserve space within a frame by splitting a prompt into multiple lines. Applies to frame Set Form Builder Default Yes Required/Optional required
554
. Prompts can only span two lines.

Applies to frame Set Form Builder Default No Required/Optional required
555
. and prompts are attached to the item’s top edge. By default.Allow Start-Attached Prompts property
Description Specifies whether space usage can be optimized when arranging items in tablular-style frames. Setting Allow Start-Attached Prompts to Yes allows you to attach prompts to the item’s start edge if there is enough space. this property is set to No.

Setting Allow Top-Attached Prompts to Yes allows you to attach prompts to the item’s top edge if there is enough space. and prompts are attached to the item’s start edge. By default. this property is set to No.Allow Top-Attached Prompts property
Description Specifies whether space usage can be optimized when arranging items in form-style frames. Applies to frame Set Form Builder Default No Required/Optional required
556
.

Applies to form. this pointer value must be converted with TO_PLS_INTEGER.Application Instance property
Description Specifies a reference to an instance of an application on the Microsoft Windows platform.
Application Instance restrictions
Valid only on Microsoft Windows (Returns NULL on other platforms). To use the instance handle when calling the Windows API. Other platforms always return the NULL value. block.
557
. or item Refer to Built-in GET_APPLICATION_PROPERTY Default NULL Usage Notes Specify the APPLICATION_INSTANCE property in GET_APPLICATION_PROPERTY to obtain the pointer value of an instance handle.

or Middle to End. Middle to Start. Start. End. Both ends. Applies to graphic line Set Form Builder Default None Required/Optional required
558
.Arrow Style property
Description Specifies the arrow style of the line as None.

Form Builder prompts the operator to enter a value in the Enter Parameter Values dialog box.Associated Menus property
Description Indicates the name of the individual menu in the module with which the parameter is associated. When the operator navigates to a menu that has an associated parameter.
559
. Applies to menu parameter Set Form Builder Required/Optional optional
Associated Menus restrictions
Applies only to full-screen menus.

Mono.Audio Channels property
Description Specifies the number of channels with which the sound item will be stored in the database: either Automatic. When you use the or WRITE_SOUND_FILE built-in subprogram to write sound data to the filesystem. programmatically Refer to Built-in • WRITE_SOUND_FILE
Default Automatic Required/Optional required
560
. Applies to sound item Set Form Builder. or Stereo. use the channels parameter to control the number of channels with which the sound data will be written to the filesystem.

the width of each column is set automatically to the greater of the two following settings: the width specified by the Display Width property or the width necessary to display the column’s title as specified in the Column Title property. the width of each column is set to the value specified by the Display Width property.
•
Applies to LOV Set Form Builder Default No
561
. When Automatic Column Width is set to No.Automatic Column Width property
Description Specifies whether LOV column width is set automatically. • When Automatic Column Width is set to Yes.

Automatic Display property
Description Specifies whether Form Builder displays the LOV automatically when the operator or the application navigates into a text item to which the LOV is attached. Applies to LOV Set Form Builder Default No
562
.

Automatic Position property
Description Specifies whether Form Builder automatically positions the LOV near the field from which it was invoked. Applies to LOV Set Form Builder Default No
563
.

564
.Automatic Query property
Description See Coordination.

Form Builder does not re-execute the query. Form Builder executes the query to populate an LOV’s underlying record group whenever the LOV is invoked. it is usually appropriate to use the same Automatic Refresh setting for each one. a strict requirement. you can explicitly replace the records in an LOV’s underlying record group by calling the POPULATE_GROUP built-in. By default. • When Automatic Refresh is set to Yes (the default). however. that is. For example.
565
. Form Builder executes the query each time the LOV is invoked. or whenever Form Builder validates a text item that has the Use LOV for Validation property set to Yes. Other record group built-ins allow you to get and set the values of cells in a record group. the following scenario describes refresh behavior when one LOV has Automatic Refresh set to Yes and another has Automatic Refresh set to No. When Automatic Refresh is set to No.
•
The Automatic Refresh property also determines how long records retrieved by the query remain stored in the underlying record group: • When Automatic Refresh is set to Yes. but instead displays the LOV using the records currently stored in the record group. or validation is completed. This behavior ensures that the LOV’s underlying record group contains the most recent database values. Once the operator dismisses the LOV. programmatically Refer to Built-in • • GET_LOV_PROPERTY SET_LOV_PROPERTY
Default Yes Usage Notes • When multiple LOVs are based on the same record group. whenever the LOV is displayed. You can manipulate these records programmatically. records from the initial query remain stored in the LOV’s underlying record group until they are removed or replaced.
•
Applies to LOV Set Form Builder.) If the LOV’s underlying record group has already been populated as a result of an LOV displaying. the record cache is destroyed. When Automatic Refresh is set to No. (Remember that more than one LOV can be based on the same record group.Automatic Refresh property
Description Determines whether Form Builder re-executes the query to populate an LOV that is based on a query record group. Form Builder executes the query only if the LOV’s underlying record group is not flagged as having been populated by a query that occurred because this or any other LOV was invoked. This is not. records returned by the query are stored in the underlying record group only as long as the LOV is needed.

Form Builder does not consider it to have been queried by an LOV invocation. even though LOV2 has Automatic Refresh set to No. both LOV1 and LOV2 had Automatic Refresh set to No. • When Automatic Refresh is set to No. When LOV1 is invoked. When LOV2 is subsequently invoked. Form Builder would execute the query when LOV1 was invoked. and so re-executes the query. LOV1 has Automatic Refresh set to Yes. Form Builder destroys the record cache. If. Form Builder again executes the query to populate the record group. (Form Builder looks only at the internal flag that indicates whether a query has occurred. This is true even if the initial query returned no rows.
566
. Form Builder ignores this operation when deciding whether to re-execute the query. When the operator dismisses LOV1. not at the actual rows returned by that query. but would not re-execute the query for LOV2. on the other hand. LOV2 has Automatic Refresh set to No. Because LOV2’s underlying record group was cleared when LOV1 was dismissed. rather than a static or non-query record group. Form Builder executes the query to populate the underlying record group. and clears the record group.)
Automatic Refresh restrictions
Valid only for an LOV based on a query record group. you can programmatically replace the rows that were returned by the initial query with POPULATE_GROUP.LOV1 and LOV2 are based on the same record group.

Automatic Select property
Description Specifies what happens when an LOV has been invoked and the user reduces the list to a single choice when using auto-reduction or searching: • • When Automatic Confirm is set to Yes.
Applies to LOV Set Form Builder Default No
567
. the LOV remains displayed. When Automatic Confirm is set to No. the LOV is dismissed automatically and column values from the single row are assigned to their corresponding return items. giving the operator the option to explicitly select the remaining choice or dismiss the LOV.

Applies to text item Set Form Builder. This behavior is consistent with the fact that the operator did not press [Next Item]. programmatically Refer to Built-in • • GET_ITEM_PROPERTY SET_ITEM_PROPERTY
Default No Usage Notes Combine the Automatic Skip property with the Fixed Length property to move the cursor to the next applicable text item when an operator enters the last required character.
568
.
Automatic Skip (Item) restrictions
• • Valid only for single-line text items.Automatic Skip (Item) property
Description Moves the cursor to the next navigable item when adding or changing data in the last character of the current item. The Key-NXT-ITEM trigger does not fire when the cursor moves as a result of this property. The last character is defined by the Maximum Length property.

569
. the focus remains in the text item after the operator makes a selection from the LOV.Automatic Skip (LOV) property
Description Moves the cursor to the next navigable item when the operator makes a selection from an LOV to a text item. programmatically Refer to Built-in SET_ITEM_PROPERTY Default No
Automatic Skip (LOV) restrictions
• The Key-NXT-ITEM trigger does not fire when the cursor moves as a result of this property. Applies to LOV Set Form Builder. When Automatic Skip is set to No. This behavior is consistent with the fact that the operator did not press [Next Item].

programmatically [BORDER_BEVEL] Refer to Built-in • • • • GET_ITEM_INSTANCE_PROPERTY GET_ITEM_PROPERTY SET_ITEM_INSTANCE_PROPERTY SET_ITEM_PROPERTY
Default LOWERED Usage Notes • To create a scrolling window. you cannot set BORDER_BEVEL programmatically. custom item. If the item’s Bevel property is set to None in Form Builder. the border bevel is determined by the item-level value specified at design-time or by SET_ITEM_PROPERTY at runtime. INSET.
571
. and simply specify that the item should have a border. LOWERED. OUTSET. Applies to chart item. the Bevel property should be set to RAISED or LOWERED. text items (Microsoft Windows only) Set Form Builder. the RAISED. image item. You cannot programmatically set BORDER_BEVEL to NONE. LOWERED. stacked canvases. either RAISED. That is. Can also be set programmatically at the item instance level to indicate the property is unspecified at this level.Bevel property
Description Specifies the appearance of the object border. or NONE.
Bevel restrictions
• • • On window managers that do not support beveling. if you set this property programmatically at the item instance level using SET_ITEM_INSTANCE_PROPERTY. and NONE options are equivalent.

) Object types are determined as shown in the following table: Date object Item of datatype DATETIME Item of datatype DATE: …having a format mask that contains yyyy. for a new application. (Note that DATE4 DATE2 DATE4 DATE2 DATE2 Type DATETIME
DATE2
575
. YYYY. However. Applies to application (global value) Set programmatically Refer to Built-in • • GET_APPLICATION_PROPERTY built-in SET_APPLICATION_PROPERTY built-in
Required/Optional optional. it is strongly recommended that you explicitly set this value for a new application. (These default masks are used for compatibility with prior releases. However. you set this property to a format mask containing full century and time information. (Note that there are no DATETIME parameters. and its length (Maximum Length) is 10 or more …not having a format mask. This format mask is most commonly used when executing a built-in subprogram. and its length (Maximum Length) is 9 or less Parameter (as in :PARAMETER.myparam) of datatype DATE. or DATETIME object. rrrr. It is also recommended that this format mask be the same as the one specified in the PLSQL_DATE_FORMAT property . or RRRR …not having a format mask. Forms first determines whether the item is a DATE2. it is STRONGLY RECOMMENDED that. DATE4. YYYY. or RRRR …having a format mask that does not contain yyyy. if you do not.) LOV column of datatype DATE. and then tries a series of format masks accordingly. and that a parameter's Maximum Length property applies only to CHAR parameters. the default value used will depend on the context. Default As noted above. rrrr.Builtin_Date_Format property
Description This property establishes the format mask used in converting a date value to or from a string that is not potentially visible to the end user.

only the first (primary) format mask is used.) Internal value of system variables CURRENT_DATETIME and EFFECTIVE_DATE DATETIME
After determining the object type of the item to be converted. Forms uses one of the masks listed below.there are no DATETIME LOV columns. and another set for RR operations. Form Builder first tries the first/primary format mask. it tries the other (secondary) masks. If that conversion is unsuccessful. in the order shown For YY:
Object Type DATE2
Format Masks Used DD-MON-YY DD-MM-SYYYY HH24:MI:SS
DATE4
DD-MON-YYYY DD-MM-SYYYY HH24:MI:SS
DATETIME
DD-MON-YYYY HH24:MI:SS DD-MON-YYYY HH24:MI DD-MM-SYYYY HH24:MI:SS
For RR:
Object Type DATE2
Format Masks Used DD-MON-RR DD-MM-SYYYY HH24:MI:SS
DATE4
DD-MON-RRRR DD-MM-SYYYY HH24:MI:SS
DATETIME
DD-MON-RRRR HH24:MI:SS DD-MON-RRRR HH24:MI DD-MM-SYYYY HH24:MI:SS
576
.one set for YY operations. There are two sets of masks -. For a string-to-date operation. For a date-to-string operation.

Indicates the item’s value will be calculated as the result of a user-written formula. The expression can compute a value.Calculation Mode property
Description Specifies the method of computing the value of a calculated item. Valid values are: None Formula The default. You must enter a single PL/SQL expression for an item’s formula. Indicates the item’s value will be calculated as the result of a summary operation on a single form item. You must specify the summary type. Indicates the item is not a calculated item. and also can call a Form Builder or user-written subprogram.
Summary
Applies to item Set Form Builder Required/Optional optional Default None
578
. and the item to be summarized.

579
. as indicated by the form module Name property. that is. a form that was invoked from a calling form by the execution of the CALL_FORM built-in procedure. Applies to application Set not settable Refer to Built-in GET_APPLICATION_PROPERTY Default NULL Usage Notes Only valid in a called form.Calling_Form property
Description Specifies the name of the calling form.

the item is a NULL-canvas item. that is.Canvas property
Description Specifies the canvas on which you want the item to be displayed. Form Builder automatically updates the Canvas property for all items assigned to that canvas.
580
.
Canvas restrictions
The canvas specified must already exist in the form. Applies to item Set Form Builder Default The item’s current canvas assignment. an item that is not assigned to any canvas and so cannot be displayed in the Form Editor or at runtime. Required/Optional optional Usage Notes • • • Items are assigned to a specific canvas. If you leave the Canvas property blank. If you change the name of a canvas in the Form Builder. which in turn is assigned to a specific window.

You can define iconic buttons. Specifies that the canvas should be displayed as a horizontal toolbar at the left side of the window to which it is assigned. or Horizontal Toolbar Canvas. pop-lists. Most canvases are content canvases. Stacked views are usually displayed programmatically and overlay some portion of the content view displayed in the same window.
Vertical Toolbar Canvas
Horizontal Toolbar Canvas Applies to canvas Set Form Builder Default Content Usage Notes
In the Property Palette. Specifies that the canvas should occupy the entire content area of the window to which it is assigned. Stacked.
581
. and determines which properties make sense for the canvas. Specifies that the canvas should be displayed in its window at the same time as the window’s content canvas. Vertical Toolbar Canvas. the properties listed under the Stacked View heading are valid only for a canvas with the Canvas Type property set to Stacked. The type determines how the canvas is displayed in the window to which it is assigned. Specifies that the canvas should be displayed as a vertical toolbar under the menu bar of the window. and other items on the toolbar as desired.Canvas Type property
Description Specifies the type of canvas. either Content. Content Stacked The default.

For example. and makes the exact match. making use of the index. it checks the UPPER(ENAME) = ’BLAKE’ part of the statement. Execute the query. queries may take longer to execute. Applies to text item Set Form Builder. The last part of the WHERE clause is performed first. enter the name ’BLAKE’ into :ENAME. programmatically Refer to Built-in • • GET_ITEM_PROPERTY SET_ITEM_PROPERTY
Default No Usage Notes Case-insensitive queries are optimized to take advantage of an index.Case Insensitive Query property
Description Determines whether the operator can perform case-insensitive queries on the text item. In Enter Query mode.
Form Builder constructs the following statement: SELECT * FROM EMP WHERE UPPER(ENAME) = ’BLAKE’ AND (ENAME LIKE ’Bl%’ OR ENAME LIKE ’bL%’ OR ENAME LIKE ’BL%’ OR ENAME LIKE ’bl%’).
583
. assume you perform the following steps: • • • • Create an index on the EMP table.
Case Insensitive Query restrictions
If you set this property to Yes. Set the Case Insensitive Query property on ENAME to Yes. Once the database finds an entry that begins with bl.

the form will display it in UPPER. If the data is subsequently modified in that field and the change is committed. whether they are entered by an operator or assigned programmatically. Lower case text converted to upper case as it is typed. If you programmatically assign string values that conflict with the setting for Case Restriction. the value of the data will change to upper case. because Case Restriction serves as both an input and output format mask enforced by the user interface.
584
. Case Restriction governs the display of all strings. The allowable values for this property are as follows:
Value MIXED UPPER LOWER
Result Text appears as typed. programmatically Refer to Built-in • • GET_ITEM_PROPERTY SET_ITEM _PROPERTY
Case Restriction restrictions
• • Values assigned to the text item through triggers are not effected. then what the end user sees on the screen may differ from the internal value of that text item. However. menu substitution parameters Set Form Builder.Case Restriction property
Description Specifies the case for text entered in the text item or menu substitution parameter. but the actual value of the data will remain mixed case. Upper case text converted to lower case as it is typed. you will not see the effect in the text item because its display will be forced to conform to the current setting of Case Restriction. For example. if Case Restriction is set to UPPER and the data retrieved from the data source is in mixed case. This also means that if data that violates the Case Restriction setting is queried into or programmatically assigned to an item.
Applies to text item.

585
.Character Cell WD/HT properties
Description Specifies the width and height of a character cell when the Coordinate System property is set to Real. or points) indicated by the Real Unit property setting. inches. rather than Character. The width and height are expressed in the current real units (centimeters. Applies to form module Set Form Builder Required/Optional optional Usage Notes The character cell size is specified in the Coordinate System dialog in pixels but displayed in the Layout Editor in points.

Chart Subtype property
Description Specifies a variation of the chart type. Each variation is based on the specified chart type. with various properties set to achieve a different look. Applies to chart item Set Form Builder Default Column
587
.

Applies to check box Set Form Builder Default NOT ALLOWED Usage Notes The following settings are valid for this property:
Setting Not Allowed
Description Any queried record that contains a value other than the userdefined checked and unchecked values is rejected and no error is raised.Check Box Mapping of Other Values property
Description Specifies how any fetched or assigned value that is not one of the pre-defined "checked" or "unchecked" values should be interpreted. Any value other than the user-defined checked value is interpreted as the unchecked state. Any value other than the user-defined unchecked value is interpreted as the checked state. Any attempt to assign an other value is disallowed.
Checked Unchecked
588
.

Checked property
Description Specifies the state of a check box.
589
. either CHECKED or UNCHECKED.or radio-style menu item. Applies to menu item Set programmatically Refer to Built-in • • GET_MENU_ITEM_PROPERTY SET_MENU_ITEM_PROPERTY
Default NULL Required/Optional optional
Checked restrictions
Valid only for a menu item with the Menu Item Type property set to Check or Radio.

If you specify a value less than the original image height. Applies to graphic image Set Form Builder Default original image height Required/Optional required
590
. the image clips from the bottom.Clip Height property
Description Specifies the height of a clipped (cropped) image in layout units.

the image clips from the right. If you specify a value less than the original image’s width.Clip Width property
Description Specifies the width of a clipped (cropped) image in layout units. Applies to graphic image Set Form Builder Default original image width Required/Optional required
591
.

Applies to graphic image Set Form Builder Default 0 Required/Optional required
592
.Clip X Position property
Description Specifies how much (in layout units) to clip off the left side of the image.

Applies to graphic image Set Form Builder Default 0 Required/Optional required
593
.Clip Y Position property
Description Specifies how much (in layout units) to clip off the top of the image.

to actually close the window in response to this event. You can close a window programmatically by calling HIDE_WINDOW.
•
Close Allowed restrictions
Cannot be set for a root window.
594
. or EXIT_FORM. or by doubleclicking the close box in the upper-left corner of the window. the Close command is available on the window’s system menu. On GUI window managers. Applies to window Set Form Builder Default Yes Usage Notes • Setting Close Allowed to Yes enables the Close command so that the Close Window event can be sent to Form Builder when the operator issues the Close command.Close Allowed property
Description Specifies whether the window manager-specific Close command is enabled or disabled for a window. SET_WINDOW_PROPERTY. A root window is always closeable. if the operator closes the MDI parent window. On Microsoft Windows. However. you must write a When-Window-Closed trigger that explicitly closes the window. Form Builder executes DO_KEY(’Exit_Form’) by default.

Return Item Specifies the name of the form item or variable to which Form Builder should assign the column’s value whenever the operator selects an LOV record. Column Title. pixels. you cannot increase the width between a NUMBER column and a non-NUMBER column by increasing the display width for the NUMBER column because LOVs display numbers right-justified. just as you would for a displayed column. set the Display Width wider than the column’s default width. Usage Notes The column names must adhere to object naming standards. centimeters. To avoid this situation. however. inches. assume that your LOV contains 3 columns: column 1 and 3 are type CHAR and column 2 is type NUMBER. Note. Column value truncation may occur if the Display Width is smaller than the width of the column value. To increase the width between each column. (You can specify a return item for a hidden column. Column Title Specifies the title that displays above the column currently selected in the column name list. Required/Optional At least one column must be defined.
•
596
. Applies to LOV Set Form Builder Column Name Specifies the names of the columns in an LOV. set Display Width to 0. For example.) To add extra space between columns in the LOV window.Column Mapping Properties property
Description The Column Mapping Properties group includes Column Name. increase the Display Width for columns 1 and 3. Default The names of the columns in the underlying record group. Display Width Specifies the width for the column currently selected in the Column Name list. Display Width. and Return Item.
To make the column a hidden column. Required/Optional optional Usage Notes • Set the Display Width property to the width in appropriate units (points. or characters as specified by the form’s Coordinate System property) that you want Form Builder to reserve for the column in the LOV window. that as an exception to this rule. increase the Display Width for the column.

Default NULL Required/Optional optional Usage Notes The Return Item can be any of the following entries: • • • form item (block_name.
597
.my_parameter) global parameter (GLOBAL.item_name) form parameter (PARAMETER.my_global)
Do not put a colon in front of the object name.

chart.dname. If we then selected dname to become an item in the data block. dname.x). and we had a column object called dept based on dept_type.AttributeName .Column Name property
Description Establishes that an item corresponds to a column in the table associated with the data block. assume dept_type were an object type having attributes of dnum. Form Builder creates a compound name for it using dot notation: ObjectColumnName. For example. and dloc. its column name property would become dept. Applies to any item except button.
598
. VBX (on 16-bit Microsoft Windows 3. or ActiveX (on 32bit Windows) controls Set Form Builder Refer to Built-in GET_ITEM_PROPERTY Default Yes Required/Optional optional Usage notes When a selected item is from a column object or REF column in a table.

Column Value. Column Value For a static record group. There can be up to 255 columns in a record group. Default NULL Data Type Specifies the data type for a given record group column. Applies to record group Set Form Builder Column Name Specifies the names of the columns in a record group. Length Specifies the length.Column Specifications property
Description The Column Specifications group of properties include Column Name. Data Type. Restrictions The data type of a record group column can only be CHAR. Default Names of the columns in the underlying record group. Usage Notes The column names must adhere to object naming standards. in characters. NUMBER. except when you define a query record group. of the record group column currently selected in the Column Name list. Required/Optional At least one column must be defined. Default
599
. specifies the row values for the column currently selected in the Column Name list. Length. in which case. the data type of each column defaults to the data type of the corresponding database column. Default CHAR. or DATE.

the default is 30. For a static record group. The data type of the value must correspond to the data type of its associated column. Required/Optional required
Column Specifications restrictions
• • You cannot reference an uninitialized variable or an item for this property.
600
. the default is the width specified for the column in the database.For a query record group. as indicated in the Column Name property. as that action constitutes a forward reference that Form Builder is unable to validate at design time.

valid command text is any valid PL/SQL statements.
Command Text restrictions
The value can be up to 240 characters in length.Command Text property
Description Specifies menu item command text for the current menu item. when the command type is MENU. When the command type is PL/SQL. For instance. valid command text is the name of a submenu in the menu module. Valid values depend on the current setting of the menu item Command Type property. Applies to menu item Set Form Builder Required/Optional Required for all command types except NULL.
603
.

use the PL/SQL command type. use the built-ins NAME_IN and COPY to indirectly reference such values.Command Type property
Description Specifies the nature of the menu item command. or parameters in a form module. This property determines how Form Builder interprets the text in the Command Text property. Instead. The default command type. and execute the HOST built-in to launch SQL*Plus. use the PL/SQL command type. Avoid. To invoke SQL*Plus. including calls to built-in and user-named subprograms. variables. Note: PL/SQL in a menu module cannot refer directly to the values of items. Valid command text is the name of the submenu to be invoked.
Menu PL/SQL
Plus*
Current Forms*
Macro* *This command type is included for compatibility with previous versions. Avoid. Valid command text is PL/SQL statements.) Avoid. Do not use this command type in new applications. To invoke Form Builder. use plus80. Executes a PL/SQL command.
604
. Applies to menu item Set Form Builder Default NULL Required/Optional required
Command Type Null
Description Specifies that the menu item does not issue a command. (On Windows platforms.exe as the executable name. Executes a SQL*Menu macro. Invokes a submenu. and execute the HOST or RUN_PRODUCT built-ins to execute a valid Form Builder login. The NULL command is required for separator menu items and optional for all other types of items.

605
.

Applies to all objects Set Form Builder Required/Optional optional
606
. maintain. and debug your applications. Use comments to record information that will be useful to you or to other designers who develop.Comments property
Description The Comments property specifies general information about any Form Builder object that you create.

such as when updating a chart item. specifies the communication mode to be used as either Synchronous or Asynchronous. Applies to chart items Set Form Builder Default Synchronous Required/Optional required
607
. Synchronous specifies that control returns to the calling application only after the called product has finished.Communication Mode (Chart) property
Description When calling Graphics Builder from Form Builder to create a chart. even if the called application has not completed its display. The end user cannot work in the form while the called product is running. Asynchronous specifies that control returns to the calling application immediately. When data is returned from the called product. communication mode must be synchronous.

Communication Mode (Report) property
Description For report/form integration. Synchronous specifies that control returns to the calling application only after the called product has finished. Applies to report integration Set Form Builder Default Synchronous Required/Optional required
608
. specifies communication mode between the form and the report as either Synchronous or Asynchronous. When data is returned from the called product. communication mode must be synchronous. Asynchronous specifies that control returns to the calling application immediately. even if the called application has not completed its display. The end user cannot work in the form while the called product is running.

programmatically Refer to Built-in • WRITE_SOUND_FILE
Default Automatic (uses the compression setting of the sound data.Compress property
Description Specifies whether a sound object being read into a form from a file should be compressed when converting to the Oracle internal format. if any).
609
. Applies to sound item Set Form Builder.

Compression Quality property
Description Specifies whether an image object being read into a form from a file. or written to a file (with the WRITE_IMAGE_FILE built-in) should be compressed. and if so. to what degree. programmatically Refer to Built-in • • GET_ITEM_PROPERTY SET_ITEM_PROPERTY
Default None
610
. Valid values are: • • • • • • None Minimum Low Medium High Maximum
Applies to image item Set Form Builder.

programmatically Refer to Built-in • • GET_ITEM_PROPERTY SET_ITEM_PROPERTY Disables the echoing back of data entered by the operator. Enables echoing of data entered by the operator.Conceal Data property
Description Hides characters that the operator types into the text item.
Default No
Conceal Data restrictions
Valid only for single-line text items. This setting is typically used for password protection.
611
. The following list describes the allowable values for this property: Yes No Applies to text item Set Form Builder.

Applies to application Refer to Built-in GET_APPLICATION_PROPERTY
612
. If the current operator does not have a SQL*NET connect string.Connect_String property
Description The Connect String property specifies the form operator’s SQL*NET connect string. Form Builder returns NULL.

The console includes the status line and message line. If you do not want a form to have a console. Applies to form Set Form Builder Default WINDOW1 Required/Optional optional
613
. On Microsoft Windows. however. rather than on any particular window in the form.Console Window property
Description Specifies the name of the window that should display the Form Builder console. set this property to <Null>. the console is always displayed on the MDI application window. and is displayed at the bottom of the window. you must still set this property to the name of a form window to indicate that you want the console to be displayed.

Provides a link to the OCX help documentation about the current OCX control..Control Help property
Description For ActiveX (OCX) control items in the layout editor.. Required/Optional optional
614
. Applies to ActiveX control Set Form Builder Default More.

The control must be visible in the Layout Editor in order to view its property sheet. Applies to OLE/ ActiveX control Set Form Builder
615
.Control Properties property
Description Activates the control-specific property sheet for the currently-selected OLE or ActiveX control.

.. but lets you line up character cell boundaries exactly. Loss of precision can occur when you convert to less precise units. but sets a coarse grid that reduces the ability to fine-tune the layout. choose the Character setting. the decision about which coordinate system to use depends on which interface style you want to optimize. Real: inches. If you want to optimize for GUIs. pixels. the Real setting provides maximum flexibility for proportional fonts. inches. When you convert from one coordinate system to another. Sets the coordinate system to the unit of measure specified by the Real Unit property (centimeters. This setting provides less flexibility for the proportional fonts used on GUIs.
For this type of application. For example. but may require some fine-tuning to avoid overlapping fields on the character-mode side. setting the Coordinate System to Character provides the most portable unit across platforms. GUI only Character-mode only Mixed character-mode and GUI:
Set Coordinate System to. Applies to form Set Form Builder Default Centimeter Usage Notes The coordinate system you select is enforced at design time and at runtime. if you programmatically move a window with SET_WINDOW_PROPERTY. or as real units (centimeters. the position coordinates you pass to the built-in are interpreted in the current form coordinate units. The actual size and position of objects will depend on the size of a default character on your particular platform. Form Builder automatically converts object size and position values that were specified declaratively at design time. pixels. or points Character
616
. or points. or points). The following settings are valid for this property: Character Sets the coordinate system to a character cell-based measurement. If you want to optimize for character-mode. centimeters..Coordinate System property
Description Specifies whether object size and position values should be interpreted as character cell values. but does not change the grid spacing and snap-points settings.)
Real
Changing the coordinate system for the form changes the ruler units displayed on Form Editor rulers. If portability is a concern. inches.. If your application runs in both character-mode and GUI.

Optimize for GUI Optimize for character-mode
Real Character
617
.

Form Builder defers fetching the associated detail records until the operator navigates to the detail block and explicitly executes a query.Coordination property
Description Specifies how and when the population phase of block coordination should occur. Form Builder defers fetching the associated detail records until the operator navigates to the detail block. When a coordination-causing event occurs in the master block. When you set these properties at design time.
Deferred=No.Automatic Query ignored Deferred=Yes. Automatic Query No) Usage Notes Whenever the current record in the master block changes at runtime (a coordination-causing event). the detail records are fetched immediately. When a coordination-causing event occurs. Automatic Query=No
The default setting. You can specify exactly how and when that population should occur by setting this property to one of three valid settings:
Deferred=No. When a coordination-causing event occurs. programmatically Refer to Built-in • • GET_RELATION_PROPERTY SET_RELATION_PROPERTY
Default Immediate coordination (Deferred No. Form Builder needs to populate the detail block with a new set of records. Automatic Query=Yes Deferred=Yes.Automatic Query=Yes
618
. Not a valid setting. Form Builder creates or modifies the appropriate master-detail triggers to enforce the coordination setting you choose. Specify the coordination desired by setting the Deferred and Automatic Query properties. Applies to: relation Set: Form Builder.

and setting the coordination properties at runtime has no effect on the default trigger text. Form Builder generates the appropriate triggers to enforce coordination.Coordination restrictions
The ability to set and get these properties programmatically is included only for applications that require a custom master-detail scheme. For a default master-detail relation created at design time.
619
.

Applies to relation Set programmatically Refer to Built-in • • GET_BLOCK_PROPERTY SET_BLOCK_PROPERTY
Usage Notes This property is included for designers who are programmatically enforcing a custom master-detail block coordination scheme.
620
. Its use is not required when you are using Form Builder declarative master-detail coordination. the status of a detail block is COORDINATED. This property is set to the value COORDINATED when the block is coordinated with all of its master blocks. the status of the detail block again becomes NON_COORDINATED. When a different record becomes the current record in the master block.Coordination_Status property
Description For a block that is a detail block in a master-detail block relation. this property specifies the current coordination status of the block with respect to its master block(s). When the block is not coordinated with all of its master blocks. Immediately after records are fetched to the detail block. Coordination_Status is set to NON_COORDINATED.

When you define a masterdetail relation. In such cases. set the Enabled property to No for the foreign key items. the Copy Value from Item property names the primary key item in the master block whose value gets copied to the foreign key item in the detail block whenever a detail record is created or queried. To get the Copy Value from Item property programmatically with GET_ITEM_PROPERTY. use the constant ENFORCE_KEY. Setting the Copy Value from Item property does not affect record status at runtime. because the copying occurs during default record processing. and image items Set Form Builder Refer to Built-in GET_ITEM_PROPERTY Required/Optional optional Usage Notes • • • • Specify this property in the form <block_name>. Form Builder sets this property automatically on the foreign key item(s) in the detail block. Applies to all items except buttons.
621
.<block_item_name>.Copy Value from Item property
Description Specifies the source of the value that Form Builder uses to populate the item. chart items. To prevent operators from de-enforcing the foreign key relationship.

the EmpNo item in the current record would display as green. or item level. but you cannot dynamically highlight the current item. If you specify named visual attributes at each level. Note that if you define a form-level Current Record Visual Attribute. the current record will display as blue.Current Record Visual Attribute Group property
Description Specifies the named visual attribute used when an item is part of the current record. you can set the block-level Current Record Visual Attribute for the toolbar to something acceptable. block. For example. the item-level attribute overrides all others. any toolbars in the form will be displayed using that Current Record Visual Attribute. EmpNo would still be green and EmpName would not change. block. as the input focus changes. You can avoid this by defining block-level Current Record Visual Attributes for the blocks that need them instead of defining them at the form level. item Set Form Builder. because it contains the item that is part of the current record. if you define Vis_Att_Blue for the Emp block which displays four detail records. Applies to form. If you define an item-level Current Record Visual Attribute. or at any combination of levels.
622
. if you set the Current Record Visual Attribute for EmpNo to Vis_Att_Green. When the input focus moved to EmpName. For example. If you wish to retain the form-level Current Record Visual Attribute. and the block-level overrides the form-level. Current Record Visual Attribute is frequently used at the block level to display the current row in a multi-record block in a special color. you can display a pre-determined item in a special color when it is part of the current record. programmatically Refer to Built-in • • • • • • GET_FORM_PROPERTY SET_FORM_PROPERTY GET_BLOCK_PROPERTY SET_BLOCK_PROPERTY GET_ITEM_PROPERTY SET_ITEM_PROPERTY
Required/Optional optional Usage Notes This property can be set at the form.

Current_Form property
Description Specifies the name of the . File_Name is gettable with GET_FORM_PROPERTY.FMX file of the form currently being executed.
623
. Current_Form at the application level corresponds to File_Name at the form level. Applies to application Set not settable Refer to Built-in GET_APPLICATION_PROPERTY Usage Notes Get the value of this property to determine the name of the file the current form came from in an application that has multiple called forms.

Form_Name is gettable with GET_FORM_PROPERTY. Applies to application Set not settable Refer to Built-in GET_APPLICATION_PROPERTY Usage Notes Get the value of this property to determine the name of the current form in an application that has multiple called forms.
624
. as indicated by the form module Name property. Current_Form_Name at the application level corresponds to Form_Name at the form level.Current_Form_Name property
Description Specifies the name of the current form.

Current_Record property
Description Specifies the number of the current record in the block’s list of records. Applies to block Set not settable Refer to Built-in GET_BLOCK_PROPERTY
625
.

form Set Programmatically Default Unspecified Refer to Built-in • • • • • • GET_ITEM_PROPERTY SET_ITEM_PROPERTY GET_BLOCK_PROPERTY SET_BLOCK_PROPERTY GET_FORM_PROPERTY SET_FORM_PROPERTY
627
. Applies to item. Patterns are rendered in the two colors specified by Background_Color and Foreground_Color.Current_Row_Fill_Pattern property
Description Specifies the pattern to be used for the object’s fill region. block.

or typeface.Current_Row_Font_Name property
Description Specifies the font family. to be used for text in the object. Applies to item. The list of fonts available is system-dependent. form Set Programmatically Default NULL Refer to Built-in • • • • • • GET_ITEM_PROPERTY SET_ITEM_PROPERTY GET_BLOCK_PROPERTY SET_BLOCK_PROPERTY GET_FORM_PROPERTY SET_FORM_PROPERTY
628
. block.

Form Builder allows cursors to remain open across COMMIT operations. Specifies that cursors should be closed when a commit is issued.0 and later. In particular. and should not be used. cursor mode should never be set to Close. This reduces overhead for subsequent execution of the same SQL statement because the cursor does not need to be re-opened and the SQL statement does not always need to be re-parsed. The cursor refers to the memory work area in which SQL statements are executed. Closing cursors at commit time and re-opening them at execute time can degrade performance in
•
•
635
. Description Defines the cursor state across transactions. For more information on cursors. Some non-ORACLE databases do not allow database state to be maintained across transactions. refer to the ORACLE RDBMS Database Administrator’s Guide. you can specify the CLOSE_AT_COMMIT parameter of the Cursor_Mode option to satisfy those requirements. Therefore. The following information is provided only for historical and maintenance purposes. This property is now obsolete.Cursor Mode property
Note: In Release 5. The following settings are valid for the Cursor_Mode property:
Setting Open (the default) Close
Description Specifies that cursors should remain open across transactions.
Applies to form Set programmatically Refer to Built-in • • GET_FORM_PROPERTY SET_FORM_PROPERTY
Default OPEN_AT_COMMIT Usage Notes • Because ORACLE allows the database state to be maintained across transactions. cursor mode is handled automatically by Form Builder. This property is useful for applications running against a non-ORACLE data source.

you might want to close any open queries on the block whenever you perform a commit. the designer. Form Builder expects ORACLE or the connect to return an end-of-fetch error when trying to fetch from an implicitly closed cursor. for the following reasons: Form Builder does not attempt to handle read consistency issues. then commit. it checks the transaction ID. Form Builder increments the transaction ID each time it opens a cursor. This setting is primarily a hint to Form Builder that the cursor state can be undefined after a commit. must manage your cursors. then Form Builder opens. change data. For example. • When using this property in conjunction with transactional triggers. When Form Builder attempts to re-execute a cursor. Only the last transaction ID is maintained. For instance. • • • If you query. or performs a rollback. and executes a new cursor. nor does it handle re-positioning in the cursor. Subsequent fetches do not re-open and execute the cursor.three areas: • • • • during the COMMIT operation during future execution of other SQL statements against the same records during execution of queries Form Builder does not explicitly close cursors following commit processing if you set the property to CLOSE_AT_COMMIT. parses. performs a commit.
636
. you. Form Builder increments the transaction ID. If it is not the current transaction ID. On a subsequent execution of the query. Form Builder maintains a transaction ID during all types of transaction processing. Form Builder opens a new cursor.

INSERTIODisplays a GUI-specific insertion symbol. Note. the BUSY cursor reverts to the HELP cursor. Use this property to dynamically change the shape of the cursor.
637
. it displays the "Working" message and replaces any cursor style specified with the BUSY cursor. if you set the cursor style to "HELP" and the operator executes a large query. the cursor style changes immediately rather than waiting for Form Builder to complete the operation before changing cursor styles. Displays a GUI-specific crosshair symbol. For example. Applies to application Set Programmatically Refer to Built-in • • GET_APPLICATION_PROPERTY SET_APPLICATION_PROPERTY
Default Arrow symbol Usage Notes When Form Builder is performing a long operation. Displays a GUI-specific help symbol. however. if you change the cursor style while Form Builder is displaying the BUSY cursor. The following settings are valid for the Cursor Style property: Setting BUSY CROSSHAIR DEFAULT HELP Description Displays a GUI-specific busy symbol.Cursor_Style property
Description Specifies the mouse cursor style. the HELP cursor is replaced by the BUSY cursor while the query is being executed. After Form Builder executes the query. Displays a GUI-specific arrow symbol.

specifies the data block to be used as the source of a chart item.Data Source Data Block (Chart) property
Description When running Graphics Builder from Form Builder to create a chart. Applies to chart item Set Form Builder Default Null Required/Optional optional
642
.

Data Source Data Block (Report) property
Description For report/form integration. Applies to report integration Set Form Builder Default Null Required/Optional optional
643
. specifies the data block to be used as the source of the report as either Null or a block name.

Applies to chart item Set Form Builder
644
.Data Source X Axis property
Description Specifies the data block column to be used as the basis of the X axis of a chart item.

Data Source Y Axis property
Description Specifies the data block column to be used as the basis of the Y axis of a chart item. Applies to chart item Set Form Builder
645
.

Default Example Null "Employee". and NUMBER only) Note: All data types do not apply to each item type. Do not create items that correspond to database CHAR columns if those items will be used in queries or as the join condition for a master-detail relation. and are included primarily for compatibility with previous versions. Set Form Builder Usage Notes • In Form Builder 6. use VARCHAR2 database columns instead. The data type of a base table item must be compatible with the data type of the corresponding database column. or RNUMBER (unless the item’s format mask permits leading zeros) The form parameter Data Type property supports the data types CHAR. and NUMBER for data. You can achieve the same formatting characteristics by using a standard data type with an appropriate format mask. DATE. DATETIME. list item. and form parameter (form parameter supports CHAR. These data types are based on native ORACLE data types. The other data types are valid only for text items. Form Builder will perform the following actions on items. RMONEY. Applies to check box. DATE. and offer better performance and application portability. and NUMBER. MONEY. as appropriate: remove any trailing blanks change the item to NULL if it consists of all blanks remove leading zeros if the data type is NUMBER. "SMITH"
CHAR Supports VARCHAR2 up to 2000 characters. DATETIME. radio group.
•
•
•
•
ALPHA Contains any combination of letters (upper and/or lower case). Contains any combination of the following characters: • • • Letters (upper and/or lower case) Digits Blank spaces
646
. custom item. RINT.Data Type property
Description Specifies what kinds of values Form Builder allows as input and how Form Builder displays those values. it is recommended that you use only the standard data types CHAR. text item.0 and later. Use the CHAR data type for items that correspond to ORACLE VARCHAR2 database columns. display item. INT. DATE.

not a character string.•
Special characters ($. Default Restrictions DD-MON-YY Refers to a DATE column in the database and is processed as a true date. Instead. Example 31-DEC-88 23:59:59
EDATE Contains a valid European date. not a character string. Example 23/10/92 (October 23. "CHAR_EXAMPLE_2"
Default Example
DATE Contains a valid date. Must refer to a NUMBER column in the database. Included for backward compatibility. Apply a format mask to produce the European date format. Reference a DATE column in the database. You can display a DATE item in any other valid format by changing the item’s format mask. Example 01-JAN-92
DATETIME Contains a valid date and time. 1992) 01/06/93 (June 1. 1993) INT
647
. The DATETIME data type contains a four digit year. and _) Null "100 Main Street". the year is interpreted as 00YY. rather than a NUMBER column. #. follow these recommendations: Use the DATE data type. @. Default Restrictions DD-MON-YY HH24:MI[:SS] Refers to a DATE column in the database and is processed as a true date. If the year input to a DATETIME data type is two digits. The DATE data type is not intended to store a time component. Default Restrictions DD/MM/YY V3 data type.

Reference a DATE column in the database. Instead. rather than a NUMBER column. -1000
JDATE Contains a valid Julian date. use a format mask with a number to produce the same result.
MONEY Contains a signed or unsigned number to represent a sum of money. 1993)
LONG Contains any combination of characters. PL/SQL has a maximum of 32. Default Restrictions Null Not allowed as a reference in the WHERE or ORDER BY clauses of any SELECT statement. Forms allows a LONG field to be up to 65. 0.47
NUMBER
648
. Instead.760 byte limit.Contains any integer (signed or unsigned whole number). Example 10/23/92 (October 23. it cannot exceed that 32. Example 10.95. Restrictions V3 data type Included for backward compatibility. Default Example 0 1. Default Restrictions MM/DD/YY V3 data type. 1992) 06/01/93 (June 1. 100.760 bytes.99. However. If a LONG variable is to be used as a bind variable in a PL/SQL statement.534 bytes. LONG items are not queryable in Enter Query mode. Stored in ORACLE as variable-length character strings. -15. Included for backward compatibility. follow these recommendations: Use the DATE data type. Apply a format mask to produce the Julian date format. Must refer to a NUMBER column in the database.

1.0x10-129 to 9.
RNUMBER Displays NUMBER values as right-justified. and Form Builder processes their values as true numbers (not character strings).. Use a format mask instead. Restrictions V3 data type Included for backward compatibility. in the range of 1. Instead. Restrictions V3 data type Included for backward compatibility. follow these recommendations: Use the NUMBER data type. with one or more of the following characteristics: • • • • • • signed unsigned containing a decimal point in regular notation in scientific notation up to 38 digits of precision
NUMBER items refer to NUMBER or FLOAT columns in the database. 99. follow these recommendations: Use the NUMBER data type. follow these recommendations: Use the NUMBER data type Apply a format mask such as $999.g. 1.85E3
RINT Displays integer values as right-justified. 10. Instead. Restrictions V3 data type Included for backward compatibility.
RMONEY Displays MONEY values as right-justified.001. Apply a format mask such as 999 to produce a right-justified number. -1. Instead.99x10124.999).
649
.01. 1. Default Restrictions Example 0 Commas cannot be entered into a number item (e.Contains fixed or floating point numbers.99 to produce a right-justified number.

follow these recommendations: Use the DATETIME data type.999 to produce a right-justified number.
TIME Contains numbers and colons that refer to NUMBER columns in the database. Default Restrictions HH24:MI[:SS] V3 data type Included for backward compatibility. Apply a format mask to produce only the time.Apply a format mask such as 999. Not allowed as a reference to DATE columns in the database. Example :10:23:05 21:07:13
650
. Instead.

Database Block property
Description Specifies that the block is based on any of the following block data source types: table. Applies to block Set Form Builder Default Yes Required/Optional required
652
. object tables. form builder grays-out and ignores the datasource properties for the block. and relational tables containing column objects or REFs. or sub-query. (Table source includes relational tables. procedure. When the Database Block property is set to No.) Also specifies that the block is not a control block. transactional trigger.

When a fetched value has been updated and then subsequently committed.Database_Value property
Description For a base table item that is part of a database record whose status is QUERY or UPDATE. Note: You can examine the Database_Value property to determine what the value of an item in a database record was before it was modified by the end user. Database_Value returns the value that was originally fetched from the database. Database_Value returns the committed value. Database_Value returns the value that was originally assigned to the item when the record was fetched from the database. Applies to: all items except buttons. chart items. Note: You can examine the SYSTEM.RECORD_STATUS system variable or use the GET_RECORD_PROPERTY built-in to determine if a record has been queried from the database. For a control item that is part of a database record. For any item that is part of a non-database record whose status is NEW or INSERT. Database_Value returns the current value of the item. and image items Set not settable Refer to Built-in: GET_ITEM_PROPERTY
653
.

not for connections established by On-Logon triggers. The following settings are valid for this property: • • • • • • • • • ORACLE DB2 NULL (Unspecified database. Applies to application Set not settable Refer to Built-in GET_APPLICATION_PROPERTY Default ORACLE Usage Notes This property is used in connection with non-Oracle data sources. or not logged on) NONSTOP TERADATA NCR/3600 NCR/3700 SQLSERVER
654
.Datasource property
Description Specifies the name of the database currently in use. It returns the name of the database for connections established by Form Builder.

•
655
.0 chooses the types of conversions done in Release 5.0. The conversion operations and masks affected by this choice are noted in About format masks for dates Applies to application Set settable from within Form Builder.5 and earlier.0 and later.0 value will override the Date_Format_Compatibility_Mode setting. A setting of 4. the 5.Date_Format_Compatibility_Mode property
Description Establishes what date format masks will be used in certain conversion operations.5 chooses the types of conversions done in Release 4.5 but the Runtime_Compatibility_Mode property is set to 5.0 Required/Optional required Usage Notes If this Date_Format_Compatibility_Mode property is set to 4. A setting of 5. Refer to Built-in GET_APPLICATION_PROPERTY SET_APPLICATION_PROPERTY Default 5.

Applies to alert Set Form Builder Default Button 1 Required/Optional optional
656
. The default alert button is normally bordered uniquely or highlighted in some specific manner to visually distinguish it from other buttons.Default Alert Button property
Description Specifies which of three possible alert buttons is to be the default alert button.

Default Button property
Description Specifies that the button should be identified as the default button. On some window managers. the default button is bordered or highlighted in a unique fashion to distinguish it from other buttons in the interface. At runtime. the end user can invoke the default button by pressing [Select] if focus is within the window that contains the default button. Applies to button Set Form Builder Default No Required/Optional optional
657
.

Applies to form module Set Form Builder Default Yes
Default Font Scaling restrictions
Valid only when the Coordinate System property is set to Character Cell.
658
.Default Font Scaling property
Description Specifies that the font indicated for use in a form defaults to the relative character scale of the display device in use.

Deferred property
Description See Coordination.
659
.

a Defer Required Enforcement setting of No is ignored and item-level validation does not take place. Form Builder will issue an error at that time. If the trigger ends normally.Defer Required Enforcement property
Description For an item that has the Required property set to true. it specifies whether Form Builder should defer enforcement of the Required item attribute until the record is validated. the item is considered to have failed validation and Form Builder will issue an error. and the item’s Item Is Valid property is unchanged. That is. for example.)
660
. If the item value is still null when record-level validation occurs later. even if they are null. and the item’s Item Is Valid property is unchanged. Form Builder will not allow navigation out of the item until a valid value is entered. programmatically Refer to Built-in • • GET_FORM_PROPERTY SET_FORM_PROPERTY
Default No Usage Notes This property applies only when item-level validation is in effect. Applies to form Set Form Builder. update the values of other items. 4. null-valued Required items are not validated when navigated out of. If it fails (raises Form_trigger_Failure). However.5 mode. Setting a value of 4. postponing enforcement of the Required attribute until validation occurs at the record level.5 for Defer Required Enforcement allows you to code logic in a WHENVALIDATE-ITEM trigger that will be executed immediately whenever the end-user changes the item’s value (even to null) and then navigates out. the WHEN-VALIDATE-ITEM trigger always fired during item-level validation. and No. Such logic might. you allow the end user to move freely among the items in the record. This behavior will be in effect if you set Defer Required Enforcement to No. There are three settings for this property: Yes. (The name 4. null-valued Required items are not validated when navigated out of. in this unusual case. If the item value is still null when record-level validation occurs later. the WHEN-VALIDATEITEM trigger (if any) does fire. (An exception is made when the item instance does not allow end-user update.5. and subsequent releases running in 4. the WHEN-VALIDATE-ITEM trigger (if any) does not fire.5.) If you set Defer Required Enforcement to Yes (PROPERTY_TRUE for runtime) or to 4. By default. when an item has Required set to true. When Defer Required Enforcement is set to Yes.5 (PROPERTY_4_5 for runtime). When Defer Required Enforcement is set to 4. Form Builder will issue an error. processing continues normally.5.5 for this setting reflects the fact that in Release 4.

datatypes.Delete Procedure Arguments property
Description Specifies the names. Applies to block Set Form Builder Default NULL Required/Optional optional
662
. The Delete Procedure Arguments property is valid only when the DML Data Target Type property is set to Procedure. and values of the arguments that are to be passed to the procedure for deleting data.

Applies to block Set Form Builder Default NULL Required/Optional optional
663
.Delete Procedure Name property
Description Specifies the name of the procedure to be used for deleting data. The Delete Procedure Name property is valid only when the DML Data Target Type property is set to Procedure.

Applies to block Set Form Builder Default NULL Required/Optional optional
664
. The Delete Procedure Result Set Columns property is valid only when the DML Data Target Type property is set to Procedure.Delete Procedure Result Set Columns property
Description Specifies the names and the datatypes of the result set columns associated with the procedure for deleting data.

665
. and changing the Delete Record Behavior property at runtime does not alter the default trigger text. Allows the master record to be deleted and automatically deletes any associated detail records in the detail block’s base table at commit time. Form Builder creates the appropriate triggers to enforce the relation. In a master-detail-detail relation. programmatically Refer to Built-in • • GET_RELATION_PROPERTY SET_RELATION_PROPERTY
Default Non-Isolated
Delete Record Behavior restrictions
• Setting this property at runtime has no effect for a default master-detail relation. only records in the immediate detail block are deleted (deletions do not cascade to multiple levels of a relation chain automatically).) Specifies how the deletion of a record in the master block should affect records in the detail block:
Setting Non-Isolated Isolated Cascading
Description The default setting.Delete Record Behavior property
Description (Note : this property was formerly called the Master Deletes property. where relations are nested. Prevents the deletion of a master record when associated detail records exist in the database. At design time. Allows the master record to be deleted and does not affect associated detail records in the database.
Applies to relation Set Form Builder. The ability to set and get this property programmatically is included only for designers who are coding custom master-detail coordination.

Applies to relation Set Form Builder Refer to Built-in GET_RELATION_PROPERTY (Detail_Name) Default: NULL Required/Optional required
Detail Block restrictions
The block specified must exist in the active form.Detail Block property
Description Specifies the name of the detail block in a master-detail block relation.
666
.

This property applies only when the Relation Type property is set to REF. Applies to Relation Set Form Builder Refer to Built-in • • GET_ITEM_PROPERTY SET_ITEM_PROPERTY
Default Null Usage Notes This property applies only when the Relation type property is set to REF
667
.Detail Reference Item property
Description Identifies the REF item in the relation’s detail data block that forms the link to the master data block.

For all objects except text items and display items. you can get and set the Direction property only for all items.
Default Setting Derives Value From This Object Form All objects. such as Alert. Radio Group. and Canvas All items. and List Item NLS environment variable Form
Canvas
This table summarizes the functions controlled by the Direction property for each object type. and Initial Keyboard Direction properties for these items. (Text items and display items do not have a Direction property. however. Display Item. and Roman refers to languages displayed Left-To-Right. the NLS language environment variable layout direction will ripple down to each subsequent level. This chart summarizes inheritance for the Direction property. instead. have both a Direction property and an Initial Keyboard Direction property. Specifies the layout direction for bidirectional objects. programmatically. However. Button. You only need to specify the bidirectional properties when you want to override the inherited default values. leaving all the other Direction properties set to Default will provide the desired functionality--that is. assume that Local refers to languages displayed Right-To-Left. (List items. Window.) The form-level Direction property is the highest level setting of the property.Direction property
Description Note: This property is specific to bidirectional National Language Support (NLS) applications. and its setting controls the other aspects of bidirectional function. Block. the layout direction for the form is inherited from the natural writing direction specified by the NLS language environment variable. including text items and display items. For the purposes of this property. Direction is an umbrella property that provides as much functionality for each object as possible. In most cases. you can specifically set Justification. the Direction property is the only bidirectional property.)
Layout Direction
Text Reading
Text Alignment
Scrollbar Position
Initial Keyboard
668
. When you accept the Default setting for the form-level Direction property. such as Text Item. in the Form Builder. LOV. Reading Order. Check Box.

• • •
SET_WINDOW_PROPERTY SET_VIEW_PROPERTY SET_ITEM_PROPERTY
General Usage Notes: • If you want all items on your form to default to the natural writing direction specified by the language environment variable. you may want to override the default by setting the Direction property for a specific object that needs to be displayed differently from the higher-level Direction property. point of origin is top right corner. choose the Left-To-Right value. Direction (Button) Specifies the reading order of button text and the initial keyboard state when the button receives input focus. the Default setting will provide the functionality you need. Follow these guidelines when choosing a Direction property value: If you are developing a bilingual application and want to display a Local object in Right-To-Left mode and a Roman object in Left-To-Right. set Language Direction at the Form level to Default. point of origin is top left corner) display of rulers and scrollbars reading order of boilerplate text
Canvas Usage Notes: • • • Refer to the Usage Notes for the form-level Direction property to determine which value to choose. and allow all other Direction properties to be Default. you might set the Direction property to override the default. In most cases. but in the case of a specific text item. including: • • • • layout direction used in the Layout Editor point of origin (for Right-to-Left. If you are developing a bilingual application and need to display both Local and Roman menus. If the object is normally composed of Roman text.
•
•
• • • •
Direction (Alert) Specifies the layout direction of the alert interface items. however. Direction (Canvas) Specifies the layout direction of the canvas. create a trigger to display the correct version of the menu based on the USER_NLS_LANG property of the GET_APPLICATION_PROPERTY built-in. use the Default value. This will provide: automatic layout of blocks in the canvas Direction property
670
. Occasionally. choose the Right-To-Left value. including the reading order of the text displayed within the alert window. If the object is normally composed of Local text. for Left-to-Right. For example. place each block on a different canvas. you may want to have most items on a canvas inherit their Direction from the canvas Direction property. To develop an application with blocks laid out in different directions. as well.

keep the canvas Direction property the same for all canvases. return the setting to Default. choose the corresponding value. Before generating the final executable. if you change the canvas Direction property while the Layout Editor is open. In the Form Builder. to test your form in Local or Roman direction. the change will not take place until you reopen the Layout Editor. set Direction to either Right-To-Left or Left-To-Right. including: • • reading order of text initial keyboard state when the radio group gains input focus
Direction (Windows) Specifies layout direction of the window object. If your application must run in one direction only.
Direction (List Item) Specifies the layout direction of the list items in both popup lists and combo boxes. the window title)
671
. unless you intend to have part of the block displayed with a different Direction.• • •
boilerplate text reading order will default to the canvas Direction property If a block spans multiple canvases. use the Default value. Form Usage Notes: • • • If you are developing a bilingual application that must run in both Right-To-Left and Left-To-Right directions. During testing. including: • • • the position of the box relative to the text reading order of check box label initial keyboard state when the check box receives input focus
Direction (Form) Specifies the layout direction of a form.
Direction (Check Box) Specifies the layout direction of a check box. Setting the form-level Direction property to Default lets the form inherit layout direction from the natural writing direction of the language specified in the NLS environment variable. including: • • • • position of the scroll bar alignment of list text reading order of list text initial keyboard state when the list item gains input focus
Direction (Radio Group) Specifies layout direction of the radio buttons of a group (position of the circle relative to the text). including: • • layout direction of the menu reading order of any text displayed within the window area that is not part of an object that has its own Direction property (for example.

display item. and custom item Set Form Builder. Hint. but only for the target item.Display Hint Automatically property
Description Determines when the help text specified by the item property.
672
. Set Display Hint Automatically to No to have Form Builder display the hint text only when the input focus is in the item and the end user presses [Help] or selects the Help command on the default menu. the help text does not display for the traversed items.
Display Hint Automatically restrictions
Not applicable when the Hint property is NULL. is displayed: • • Set Display Hint Automatically to Yes to have Form Builder display the hint text whenever the input focus enters the item. programmatically Refer to Built-in • • GET_ITEM_PROPERTY SET_ITEM_PROPERTY
Default No Usage Notes If a trigger causes Form Builder to navigate through several items before stopping at the target item.
Applies to all items except chart item.

for example. set the Display Keyboard Help property to Yes.Display in ’Keyboard Help’/’Keyboard Text’ property
Description Specifies whether a key trigger description is displayed in the runtime Keys help screen. If you want to replace the default key description. This is the default setting. set the Display Keyboard Help property to No.
673
. If you want the name of the key that corresponds to the trigger and its default description to be displayed in the Keys window. Ctrl-S.
•
Display in Keyboard Help restrictions
Valid only for key triggers. An entry in the Keys screen includes a text description for the key name and the physical keystroke associated with it. set the Display Keyboard Help property to Yes and leave the Keyboard Help Text blank. Applies to trigger Set Form Builder Default No Usage Notes • • If you do not want the name or the description to appear in the Show Keys window. then enter the desired description in the Keyboard Help Text property.

which requires more resources. The following settings are valid for this property: High Medium Low Applies to image item Set Form Builder Default High Displays the image with high quality. Displays the image with medium quality. Displays the image with low quality. allowing you to control the tradeoff between image quality and memory/performance. which requires fewer resources.
Display Quality restrictions
none
674
.Display Quality property
Description Determines the level of quality used to display an image item.

Form Builder does not display the item if the end user does not have access to it. For more information on establishing the roles list and assigning a role access to menu items.Display without Privilege property
Description Determines whether the current menu item is displayed when the current form end user is not a member of a security role that has access privileges to the item: • • When Display without Privilege is No. When Display without Privilege is Yes. The end user can see the item on the menu. Menu Module Roles. but cannot execute the command associated with the item. To add a database role to this list. Form Builder displays the item as a disabled (grayed) menu item. Applies to menu item Set Form Builder Default No
Display without Privilege restrictions
Valid only when the name of at least one database role has been specified in the roles list.
You can only grant access to members of those roles displayed in the roles list.
676
. set the menu module property. see the Form Builder online help system.

in the units specified by the current setting of the Coordinate Units form property. Applies to application Set not settable Refer to Built-in GET_APPLICATION_PROPERTY
677
.Display_Height property
Description Specifies the height of the display device. Use this property to dynamically calculate the optimum display position for windows on the screen.

Use this property to dynamically calculate the optimum display position for windows on the screen. in the units specified by the current setting of the Coordinate Units form property.Display_Width property
Description Specifies the width of the display device. Applies to application Set not settable Refer to Built-in GET_APPLICATION_PROPERTY
678
.

Setting a selected item’s Diaplayed property to false will generate an error: FRM-41016. When an itme is disabled and hidden it is not navigable. Refer to Built-in GET_ITEM_PROPERTY SET_ITEM_PROPERTY
Displayed property restrictions
You cannot set the Displayed property of an item that is selected or has focus.Displayed property
Descriptiuon Enables/unhides or deisbles/hides an item. Values: TRUE/FALSE Applies to: item Set: programmatically Usage notes You should make sure an item is not selected before setting the Displayed property to FALSE. or updateable.
679
. queryable.

Applies to item Set Form Builder Default 0 Required/Optional optional Usage Notes If you are working in character cell ruler units. to increase the amount of space between item instances in a 5 record item. A multi-record block is a block that has the Number of Records Displayed property set to greater than 1. For example. you must set the Distance Between Records property to at least 4.
680
. one cell for each space between item instances. the amount of space between item instances must be at least as large as the height of a single cell.Distance Between Records property
Description Specifies the amount of space between instances of items in a multi-record block.

Applies to graphic image Set Form Builder Default No Required/Optional required
681
.Dither property
Description Specifies the whether the image is dithered when it is displayed.

Applies to block Set form builder Default 1 Usage Notes A larger size reduces transaction processing time by reducing network traffic to the database. even if Update Changed Columns Only is Yes in the form builder. With single record processing. • When the DML Array Size is greater than 1 and Insert Allowed is Yes. During array processing.
DML Array Size restrictions
Minimium number of records is 1. When DML Array Size is greater than 1. The primary key is used to specify the row to lock. there is no maximum. The optimal size is the number of records a user modifies in one transaction. Update Changed Columns Only specifies that only columns whose values are actually changed should be included in the UPDATE statement during a COMMIT. and deleting records in the database at one time. but requires more memory. you must specify one or more items as a primary key.
•
•
682
. the DML Array Size is always set to 1 at runtime. and the ROWID is used for updating and deleting. ROWID is the default construct ORACLE uses to identify each record. the ROWID of a record is obtained for future reference (update or delete). Update Changed Columns Only is always set to No at runtime. updating. sound or OLE item) appears in the block. You should specify one or more items in the block as the primary key even if the Key Mode value is Unique (the default). because you cannot get the ROWID of the records. resulting in the need to designate one or more primary key items in the block. BLOCK. the ROWID of each record in the array is not returned.DML Array Size property
Description Specifies the maximum array size for inserting. If a long raw item (such as an image.ROWID is not available until the record is locked.

Applies to block Set Form Builder.
683
.DML Data Target Name property
Description Specifies the name of the block’s DML data target. programmatically Refer to Built-in • • GET_BLOCK_PROPERTY SET_ITEM_PROPERTY
Default NULL Required/Optional optional
DML Data Target Name restrictions
Prior to setting the DML Data Target Name property you must perform a COMMIT_FORM or a CLEAR_FORM. The DML Data Target Name property is valid only when the DML Data Target Type property is set to Table.

and the user will not need to re-query the database to obtain the changed values. When this property is set to No.
685
. the user receives a warning message and is asked to re-query to obtain the latest values. but (currently) not with Delete statements. A No setting selects old behavior (behavior of Release 5 and earlier). This property is ignored when using a non-Oracle8 server. This No setting is available as a compatibility option. when using an Oracle8 database server.DML Returning Value property
Description Specifies whether Forms should use new or old behavior when updating client-side data with changed values after a database update or insert. which in turn is affected by the setting of the DML Array Size property. The updating of unchanged columns is controlled by the setting of the Update Changed Columns Only property. Forms does not use the Returning clause when processing LONGs. (This is its pre-Release 6 behavior. A Yes setting for this property selects new behavior (new as of Release 6). In Release 6. if the user subsequently tries to update a row whose values were altered on the server side. A database update or insert action may initiate server-side triggers that cause alterations or additional changes in the data. Forms will automatically update the client-side version of the data. Forms uses the Returning clause with Insert and Update statements. Applies to block Set Form Builder Valid values Yes/No Default No Required/Optional required Restrictions • • • • Forms uses the DML Returning clause only with an Oracle8 database server.) In this case. Forms uses the DML Returning clause to immediately bring back any such changes. Forms will not automatically update the client-side version of the data. When this property is set to Yes.

Enter the value SYSTEM_EDITOR in the Editor Name field.
689
.
Editor restrictions
The editor specified must exist in the active form.Editor property
Description Specifies that one of the following editors should be used as the default editor for this text item: • • a user-named editor that you defined in the form or a system editor outside of Form Builder that you specified by setting the SYSTEM_EDITOR environment variable
Applies to text item Set Form Builder Refer to Built-in GET_ITEM_PROPERTY Default blank. indicating the default Form Builder editor Required/Optional optional Usage Notes To specify a system editor: • • Define the system editor by setting the FORMS60_EDITOR environment variable.

indicating that Form Builder should use the default editor display coordinates. Applies to text item Set Form Builder Refer to Built-in GET_ITEM_PROPERTY Default 0. Editor Y Position properties
Description Specifies the horizontal (x) and vertical (y) coordinates of the upper left corner of the editor relative to the upper left corner of the window’s content canvas. 0. as specified by the editor Position property. Required/Optional optional
690
.Editor X Position. you can set the Editor position properties to override the default display coordinates specified for the editor. When you set the Editor property.

Elements in List property
Description The Elements in List property group includes the List Item and List Item Value properties.
Elements in List restrictions
• Must be unique among values associated with element values. Applies to list item Set Form Builder List Item Specifies the text label for each element in a list item. the value associated with the element is NULL. Required/Optional required List Item Value Specifies the value associated with a specific element in a list item.
691
. Default NULL Required/Optional required Usage Notes When you leave the List Item Value field blank.

Applies to all items except buttons. the Keyboard_Navigable property is also set to PROPERTY_FALSE. when the Enabled property is set to PROPERTY_FALSE. programmatically Refer to Built-in • • • • GET_ITEM_PROPERTY SET_ITEM_PROPERTY GET_RADIO_BUTTON_PROPERTY SET_RADIO_BUTTON_PROPERTY
Default Yes Usage Notes When Enabled is set to Yes. On most window managers. Enabled set to No grays out the item. At runtime. Enabled set to No grays out the item. an item is always non-Keyboard Navigable. If you want the item to appear normally so the user can inspect it but without being able to change it.Enabled (Item) property
Description Determines whether end users can use the mouse to manipulate an item. chart items. and display items Set Form Builder. Keyboard Navigable can be set to Yes or No. set the following properties: Insert Allowed (Item) to No Update Allowed (Item) to No Enabled to Yes
692
. When Enabled is No.

The current end user is not a member of a role that has access to the menu item.Enabled (Menu Item) property
Description Specifies whether the menu item should be displayed as an enabled (normal) item or disabled (grayed) item. programmatically Refer to Built-in • • Default Yes GET_MENU_ITEM_PROPERTY
Enabled (Menu Item) restrictions
You cannot programmatically enable or disable a menu item that is hidden as a result of the following conditions: • • • The menu module Use Security property is Yes. Applies to menu item Set Form Builder. The menu item Display without Privilege property is set to No.
693
.

using the horizontal axis as an origin.End Angle property
Description Specifies the ending angle of the arc. Applies to graphic arc Set Form Builder Default 180 Required/Optional required
695
.

Form Builder does not enforce the defined update privileges.Enforce Column Security property
Description Specifies when Form Builder should enforce update privileges on a column-by-column basis for the block’s base table. If an end user does not have update privileges on a particular column in the base table. by turning off the Update Allowed item property at form startup. The following table describes the effects of the allowable values for this property:
State Yes No
Effect Form Builder enforces the update privileges that are defined in the database for the current end user. Form Builder makes the corresponding item non-updateable for this end user only.
Applies to block Set Form Builder Refer to Built-in GET_BLOCK_PROPERTY Default No
696
.

Enforce Primary Key (Block) property
Description Indicates that any record inserted or updated in the block must have a unique key in order to avoid committing duplicate rows to the block’s base table.
697
. Applies to block Set Form Builder. programmatically Refer to Built-in • • GET_BLOCK_PROPERTY SET_BLOCK_PROPERTY
Default No
Enforce Primary Key (Block) restrictions
• The Primary Key item property must be set to Yes for one or more items in the block.

Applies to block Set not settable Refer to Built-in GET_BLOCK_PROPERTY Usage Notes • A block is enterable when its current record contains an item instance whose Keyboard Navigable property has an effective value of true. See the Keyboard Navigable property and SET_ITEM_INSTANCE_PROPERTY built-in for information about effective Keyboard Navigable values.
•
698
.Enterable property
Description Specifies whether the block is enterable.

Error_Date/Datetime_Format property
Description Holds the current error date or datetime format mask established by the environment variable FORMSnn_ERROR_DATE_FORMAT or FORMSnn_ERROR_DATETIME_FORMAT. There are two separate properties: Error_Date_Format and Error_Datetime_Format. Refer to Built-in GET_APPLICATION_PROPERTY
699
. Forms uses these format masks as defaults in its runtime error processing. Applies to application Set Not settable from within Form Builder.

this property specifies the execution mode to be used as either Batch or Runtime. Batch mode executes the report or graphic without user interaction.Execution Mode (Chart) property
Description When running Graphics Builder from Form Builder to create a chart. Runtime mode enables user interaction during the execution. Applies to chart items Set Form Builder Default Batch Required/Optional required
701
.

Runtime mode enables user interaction during the execution. Batch mode executes the report or graphic without user interaction. Applies to report Developer integration Set Form Builder Default Batch Required/Optional required
702
. this property specifies the execution mode of the report as either Batch or Runtime.Execution Mode (Report) property
Description For report integration with a form.

The following settings are valid for this property: Override Before After Applies to trigger Set Form Builder Default Override Specifies that the current trigger fire instead of any trigger by the same name at any higher scope. This is known as "override parent" behavior. This is known as "fire after parent" behavior. Specifies that the current trigger fire before firing the same trigger at the next-higher scope.Execution Hierarchy property
Description Specifies how the current trigger code should execute if there is a trigger with the same name defined at a higher level in the object hierarchy. Specifies that the current trigger fire after firing the same trigger at the next-higher scope.
703
. This is known as "fire before parent" behavior.

Applies to form.
Filename property restrictions
If two or more forms share the same name. Filename supplies the name of the file where the most recently-accessed form is stored. report Set not settable Refer to Built-in GET_FORM_PROPERTY Required/Optional optional Usage Notes Filename at the form level corresponds to Current_Form at the application level. Current_Form is gettable with GET_APPLICATION_PROPERTY.
704
.Filename property
Description Specifies the name of the file where the named object is stored.

Pie renders the arc from the center point of the circle described by the arc.Fill property
Description Specifies the fill shape of the arc as either Pie or Chord. Chord renders the arc from a line segment between the arc’s two end points. Applies to graphic arc Set Form Builder Default Pie Required/Optional required
705
.

and BAZ. For example.
•
707
. Applies to LOV Set Form Builder Default No
Filter Before Display restrictions
• If the SELECT statement for the LOV's underlying record group joins tables. if the end user enters 7. When a long-list LOV is used for item validation. If the end user enters the value F or F% in the query criteria dialog. the resulting LOV contains only the values FOO and FAR. Form Builder displays a query criteria dialog before displaying the LOV. If it is not. the DEPTNO column would not be unique because it occurs in both tables. the name of the first column displayed in the LOV must be unique among all columns in all joined tables. the WHERE clause reads LIKE ’7%’ and would return 7. the query criteria dialog is not displayed so that LOV validation is transparent to the forms end user. FAR.Filter Before Display property
Description When Filter Before Display is set to Yes. Instead. An alternative is to create a view in the database. an error occurs when the end user attempts to use the Filter Before Display feature. and assign a unique name to the column you want end users to reference in the query criteria dialog. when joining the EMP and DEPT tables. the LOV effectively contains only those rows that correspond to both the the default SELECT statement and the WHERE clause created by the value in the query criteria dialog. The value is applied to the first column displayed in the LOV. If the user then enters the value B% in the LOV’s selection field. For example. nothing will be returned because BAZ has already been selected against in the query criteria dialog. End users can enter a value in the query criteria dialog to further restrict the rows that are returned by the default SELECT statement that populates the LOV’s underlying record group. A hidden LOV column is not displayed. 712. The WHERE clause constructed by Form Builder appends the wildcard symbol to the value entered by the end user. Keep in mind that once the end user enters a value in the query criteria dialog and the LOV is displayed. Form Builder uses the value entered in the query criteria dialog to construct a WHERE clause for the SELECT statement. and 7290. For example. consider an LOV whose default SELECT statement returns the values FOO. Form Builder uses the current value of the text item to construct the WHERE clause used to reduce the size of the list by applying the wildcard criteria to the first visible column in the LOV.

Applies to trigger Set Form Builder Default no Usage Notes Only applicable to the following triggers: • • • • • • • • • • • • Key On-Error On-Message When. except: When-Database-Record When-Image-Activated When-New-Block-Instance When-New-Form-Instance When-Create-Record When-Remove-Record When-Validate-Record When-Validate-Item
708
.Fire in Enter-Query Mode property
Description Specifies that the trigger should fire when the form is in Enter-Query mode.triggers. as well as in Normal mode.

before Form Builder navigates internally to the first block in the form. the First_Navigation_Block is the first block in the form’s commit sequence.First Navigation Block property
Description Specifies the name of the block to which Form Builder should navigate at form startup and after a CLEAR_FORM operation. Applies to form module Set Form Builder. that is. programmatic Refer to Built-in • • GET_FORM_PROPERTY SET_FORM_PROPERTY
Default The first block in the form. the block that is listed first in the Object Navigator. which fires at form startup. By default. Required/Optional optional Usage Notes You can set this property from a When-New-Form-Instance trigger. as indicated by the sequence of blocks in the Object Navigator.
709
. You can set the First_Navigation_Block property programmatically to specify a different block as the first navigation block.

At startup.First_Block property
Description Specifies the block that is the first block in the form. as indicated by the sequence of blocks in the Object Navigator. Form Builder navigates to the first item in the first block. Applies to form Set not settable Refer to Built-in GET_FORM_PROPERTY
710
.

It can be used in conjunction with the Next_Master_Relation and Next_Detail_Relation properties to traverse a list of relations. Applies to block Set not settable Refer to Built-in GET_BLOCK_PROPERTY Usage Notes This property is useful when you are writing your own master-detail coordination scheme.First_Detail_Relation property
Description Specifies the name of the first master-detail block relation in which the given block is the detail block.
711
.

as indicated by the sequence of items in the Object Navigator. Form Builder navigates to the first item in the first block. Applies to block Set not settable Refer to Built-in GET_BLOCK_PROPERTY
712
. At startup.First_Item property
Description Specifies the item that is the first item in the block.

It can be used in conjunction with the Next_Master_Relation and Next_Detail_Relation properties to traverse a list of relations.First_Master_Relation property
Description Specifies the name of the first master-detail block relation in which the given block is the master block. Applies to block Set not settable Refer to Built-in GET_BLOCK_PROPERTY Usage Notes This property is useful when you are writing your own master-detail coordination scheme.
713
.

Fixed Bounding Box property
Description Specifies whether the text object’s bounding box should remain a fixed size. the values of the Width and Height properties determine the size of the bounding box. If this property is set to Yes. Applies to graphic text Set Form Builder Default No Required/Optional required
714
.

A text item value of the NUMBER data type cannot contain leading zeroes."
715
. programmatically Refer to Built-in • • GET_ITEM_PROPERTY SET_ITEM_PROPERTY
Default No
Fixed Length (Item) restrictions
• • The Visible and Enabled properties must be set to Yes. The maximum number of characters allowed is determined by the Maximum Length property setting.Fixed Length (Item) property
Description When set to Yes. Form Builder automatically removes leading zeroes and interprets the text item as "not filled. Fixed Length specifies that the item should be considered valid only when it contains the maximum number of characters allowed. Applies to text item Set Form Builder.

The maximum number of characters allowed is determined by the Maximum Length property setting. Fixed Length specifies that the parameter should be considered valid only when it contains the maximum number of characters allowed.Fixed Length (Menu Substitution Parameter) property
Description When set to Yes. Applies to menu substitution parameter Set Form Builder Default No
716
.

When item-level validation is performed. This means that the end user is not allowed to leave the current validation unit (as specified by the current form’s Validation Unit property). No error or warning message is displayed. it is possible for an end user to type more bytes into an item than the item’s Maximum Length property specifies.
717
. it will fail (with an error message indicating that truncation would be necessary). Applies to application Set programmatically Default Property_False (‘FALSE’) Refer to Built-in GET_APPLICATION_PROPERTY SET_APPLICATION_PROPERTY Usage Notes In a 3-tier. non-UTF8 multi-byte character set environment. When the Flag User Value Too Long property has been set to TRUE and this situation arises. then the user’s typed-in value is not truncated.Flag User Value Too Long property
Description Specifies how Forms should handle a user-entered value that exceeds the item’s Maximum Length property. then the end user is allowed to navigate out of the item. the truncated value is validated. If validation (and any navigational triggers) succeeds. then the user’s typed-in value is truncated (on a character boundary) so that its size in bytes does not exceed the item’s Maximum Length. When the Flag User Value Too Long property has been set or defaulted to FALSE and this situation arises. This property applies only in a 3-tier environment in which the middle tier (the Forms server) specifies a multi-byte character set other than UTF8. When item-level validation is performed.

the Form Horizontal Toolbar Canvas property is ignored and the canvas is mapped to the window indicated by its Window property setting.
724
. On other platforms. Applies to form Set Form Builder Default Null Required/Optional optional
Form Horizontal Toolbar Canvas restrictions
Valid only on Microsoft Windows.Form Horizontal Toolbar Canvas property
Description On Microsoft Windows. The canvas specified must have the Canvas Type property set to Horizontal Toolbar. specifies the canvas that should be displayed as a horizontal toolbar on the MDI application window.

On other platforms. the Form Vertical Toolbar Canvas property is ignored and the toolbar canvas is mapped to the window indicated by its Window property setting.
725
. specifies the toolbar canvas that should be displayed as a vertical toolbar on the MDI application window. The canvas specified must have the Canvas Type property set to Vertical Toolbar. Applies to form Set Form Builder Default Null Required/Optional optional
Form Vertical Toolbar Canvas restrictions
Valid only on Microsoft Windows.Form Vertical Toolbar Canvas property
Description On Microsoft Windows.

please indicate the part number. • • • • • Did you find any errors? Is the information clearly presented? Do you need more information? If so. If you have any problems with the software.com.oracle.
xi
.Send Us Your Comments
Oracle Forms Developer: Form Builder Reference. Your input is an important part of the information used for revision. where? Are the examples correct? Do you need more examples? What features did you like most about this manual?
If you find any errors or have any other suggestions for improvement. You can send comments to us by electronic mail to oddoc@us. Release 6 i Volume 2 Part No: A73074-01
Oracle Corporation welcomes your comments and suggestions on the quality and usefulness of this publication. section. chapter. and page number (if available). please contact your local Oracle World Wide Support Center.

xii
.

please see the preface in Volume 1.
xiii
.Preface
This book is Volume 2 of the Oracle Forms Develop:r Form Builder Reference . For more information about the book.

xiv
.

do not right justify. numeric. End user input string must be exact length specified by format mask. Any alphabetic.
Element FM
Example FMXX99
Description Fill mode: accept string as typed. Numeric characters only. End user input string must be exact length specified by format mask. Character Strings The following table describes valid format masks for character strings. Alphabetic characters only. End user input string must be exact length specified by format mask. or special character. programmatically Refer to Built-in • • GET_ITEM_PROPERTY SET_ITEM_PROPERTY
Required/Optional optional Usage Notes Valid format masks for character strings. Applies to text item Set Form Builder.
X
XXXX
9 A
9999 AAAA
Character String Examples Format Mask Description
1
. numbers and dates are described in the following tables.Properties (continued)
Format Mask property
Description Specifies the display format and input accepted for data in text items. Allows end user input string to be shorter than the format mask.

).99
E FM
9. ab11.)
FMXX99
• •
To embed additional characters such as a hyphen (-) or a comma (. 11ab. (To produce the Form Builder Version 3. Display a negative value in <angle brackets>.999
Description Number of nines determines display width. Display a decimal point in this position.
period
99.XXAA XXXX
Will accept: --ab. do not right justify. --11.0 Alpha datatype. Will accept 1234 or abcd. Display a comma in this position. Form Builder adds a space in front of the number to accommodate the plus (+) or minus (-) sign. substitute D to return the appropriate decimal separator. since the plus sign is not displayed. ab followed by two spaces. surround the character with double-quotes ("). ab1. use FMXXXX. Any leading zeros will be displayed as blanks. Display leading zeros. For correct behavior in multilingual applications. substitute G to return the appropriate group (thousands) separator. numeric. or ab--. or special characters: --ab.
Element 9 0 0 $ B MI PR comma
Example 9999 0999 9990 $9999 B9999 9999MI 9999PR 9. not "0". Embedded characters are separate from text item values and are not collated along with text item values.999EEEE FM999
•
When you mask a number with nines (9). use FMAAAAAA. Display "-" after a negative value. will not accept 123 or abc. even when the end user enters them. 11ab. not blank. Display in scientific notation (format must contain exactly four "E"s). Fill mode: accept string as typed. Prefix value with dollar sign. will not accept 12ab or abcd. ab11. it
2
. Display zero value as zero. (To accept input string shorter than mask. abcd. will not accept: --11. Display zero value as blank. Will accept any combination of alphabetic. For correct behavior in multilingual applications.) Will accept ab12. However. abcd.
NUMBERS The following table describes valid format masks for numbers. or ab--(must use XX to accept hyphens and other special characters).

0 21. to fit the mask. the value displayed to the user would be 2. with a format mask of 099"-"99"-"9999.9 99. the value will be rejected.01 21.
NUMBER Examples
Format Mask FM099"-"99"-"9999
Description Displays the social security number as formatted.00E+20.
3
. the value is displayed.9 User enters 321. Accepts -678.0666. For example: Format Mask 99.To create a Social Security column. but truncated. Displays as 1.appears as if Form Builder adds a space in front of the number. if the database held the value 2. create an 11character column. including hyphens.) For example. Accepts -123. accepting 012-34-5678 or 012345678 (both stored as 012345678). surround the character with double-quotes (").1.0666. and the format mask was 99. reformats as 678-.1 01. set to fixed length. However. if a numeric value fetched from the database exceeds the format mask specification for its display field. even if end user enters only nine digits.1 1. (The minus sign is displayed. This mask will accommodate Social Security numbers that begin with zero. Dates The following table describes valid format masks for dates. the value of the item within the form would be the full 2. reformats as <123>.1
In contrast. with rounding.). even when the end user enters them.) • • To embed additional characters such as a hyphen (-) or a comma (. Embedded characters are separate from text item values and are not collated along with text item values.9 99.
99999PR 999MI 9.9 99.999EEEE
How Forms handles length mismatches If a runtime user enters a numeric string that exceeds the format mask specification. "S" prefixes "BC" date with "-". (The item itself within the Forms application retains its full value.1 Result Invalid Invalid 21.9.
Element YYYY or SYYYY
Description 4-digit year.

Name of month.M. 2. 3-letter abbreviation. BC/AD indicator. Meridian indicator. Seconds past midnight (0-86399). Julian day. Day of week (1-7. including delimiters. RR
Last 3.YYY or YY or Y Y. Punctuation is reproduced in the result. Year with comma in this position.YYY BC or AD B. HH or HH12 HH24 MI SS SSSSS /. padded with blanks to length of 9 characters. Day of year (1-366). Deduces the century from a date entered by comparing the 2 digit year entered with the year and century to which the computer’s internal clock is set.) All date literals must match the format mask exactly. padded with blanks to length of 9 characters. Hour of day (0-23). Years 00-49 will be given the 21st century (the year 2000). JAN = 01). 4712 BC. Fill mode: assumes implied characters such as O or space. Hour of day (1-12). displays significant characters left justified." FM
FX
4
. Day of month (1-31). and years from 50-99 will be given the 20th century (the year 1900). Sunday=1). Month (01-12. Defaults to correct century. 3-letter abbreviation. Quoted string is reproduced in the result.. Second (0-59).M. ..D. . Minute (0-59). Name of month. Allows end user input to be shorter than the format mask. Meridian indicator with periods.C. or 1 digits of year.
MM MONTH MON DDD DD D DAY DY J AM or PM A. or A. (Use in conjunction with FX to require specific delimiters. ". Name of day. or P. Name of day. the number of days since January 1. BD/AD indicator with periods.

such as this example or DY-DD-MMYY. Displays as WED-012-1994.JAN. Will also accept the entry of other delimiters. "YYYY
Description Displays the text item data in the specified date format: JANUARY 12. including the appropriate blank spaces and comma. however. because "AN" is not a valid month name. Form Builder stores full precision. Will accept 12. Will accept 12-JAN94. In other words.94 or 12/JAN/94 because the delimiters do not match the mask. However. will not accept 01JAN94. but if delimiters are omitted by the end user.•
When you prefix a date mask with FX. converting it to 01-JAN-94. for example 01/JAN/94 and 01 JAN 94. Embedded characters are separate from text item values and are not collated along with text item values. be sure that the data includes day of the week information. even when the end user enters them.
Format Mask FMMONTH" "DD".
FMDD-MONTH-YYYY DY-DDD-YYYY
•
When you use day of the week formats.). Will accept 01-JAN-94.
FMDD-MON-YY
DD-MON-YY
• • •
Use of a format mask only affects how the data looks. the end user must enter the date exactly as you define the mask. 12/JAN/94 or 12-JAN-94. including the specified delimiters:
Date Examples
Format Mask FXDD-MON-YY
Description Will accept 12-JAN-94. a mask that allows specific determination of the day is required. Displays as 12-JANUARY-1994. display also either the day of the year (1-366) or the month in some
5
. Will accept 1-JAN-94. but will not accept 12JAN94. Note: for input validation including day of the week. To embed additional characters such as a hyphen (-) or a comma (. 1994. but will not accept 12.JAN. that double-quotes themselves cannot be used as a character. regardless of how the data is presented. Note.94. Will not accept 12JAN94 because there are no delimiters. trying to achieve output of DD"MM by specifying a mask of DD"""MM would not work. this mask will interpret date characters as a delimiters. (but will erroneously interpret as 12-JAN-04). Will accept 01-JAN-94 but will not accept 1-JAN-94. Note: Any delimiter characters will be accepted. surround the character with double-quotes ("). To avoid illogical masks.

this item displays as Kr. Displays the appropriate international currency symbol: if NLS_LANG=American. this item displays as $1. if NLS_LANG=French.00. Avoid masks such as DY-DD-YY. Be sure to include month. if NLS_LANG=Norwegian.600. and decimal separators: if NLS_LANG=American.999 9. Displays a decimal point in this position. include space for any embedded characters inserted by the format mask you specify.
NLS Format Masks The following table describes valid National Language Support (NLS) format masks.999
Description Returns the international currency symbol. which could generate an error. this item displays as FRF1.00.00. Displays a decimal point in this position. Returns the local currency symbol.
Format Mask DD-MONTH-YYYY DY-DDD-YYYY DY-DD-MON-YY
Description Displays as 12-JANUARY-1994.00.1.
NLS Format Mask Examples
Format Mask L99G999D99
Description Displays the local currency symbol. Returns the decimal separator.
6
. Returns the group (thousands) separator.600. Displays as WED-012-1994. Displays as WED-12-JAN-94.format.600.600. Displays a comma in this position.
C99G999D99
Format Mask restrictions
• When setting the Maximum Length property for a text item. group. this item displays as USD1.
Element C L D G comma period
Example C999 L9999 99D99 9G999 9.

such as WW. are not supported.
7
.• •
Format masks can contain a maximum of 30 characters. Form Builder supports only ORACLE format masks that are used for both input and output. Output-only format masks.

Form_Name property
Description Specifies the name of the form. Applies to form Set not settable Refer to Built-in GET_FORM_PROPERTY Usage Notes Form_Name at the form level corresponds to Current_Form_Name at the application level.
8
. Current_Form_Name is gettable with GET_APPLICATION_PROPERTY.

accordingly.. For example.sal + :emp_comm). instead of coding an entire assignment statement. Applies to item Set Form Builder Refer to Built-in RECALCULATE Usage Notes You cannot enter an entire PL/SQL statement as your formula. The expression can reference built-in or user-written subprograms.gross_comp := (:emp. Required/Optional required if Calculation Mode property is set to Formula
9
. :emp.g.comm Form Builder will internally convert this into a complete statement.sal + :emp. do not terminate your calculation expression with a semicolon. e. Form Builder adds the actual assignment code to the formula internally do not code it yourself.Formula property
Description Specifies a single PL/SQL expression that determines the value for a formula calculated item. code just the expression :emp.

This property is valid when the Layout Style property is set to Form. Fill. Applies to frame Set Form Builder Default Fill Required/Optional required
10
. or Column. Center.Frame Alignment property
Description Specifies how objects should be aligned within the width of the frame. End. either Start.

Frame Title Alignment property
Description Specifies the title alignment for a frame. Note: Title alignment is relative to the Direction of the canvas on which the canvas appears. Applies to frame Set Form Builder Default Start Required/Optional required
12
. End. either Start. or Center.

Applies to frame Set Form Builder Default Defaults to the standard operating system font color (usually white).Frame Title Background Color property
Description Specifies the color to apply to the frame title background. Required/Optional required
13
.

Frame Title Font Name property
Description Specifies the name of the font (typeface) to apply to the frame title. Applies to frame Set Form Builder Default Defaults to the standard operating system font Required/Optional required
14
.

Applies to frame Set Form Builder Default Defaults to the standard operating system font size Required/Optional required
15
.Frame Title Font Size property
Description Specifies the size of the font (typeface) to apply to the frame title.

Frame Title Font Spacing property
Description Specifies the spacing to apply to the frame title text. Applies to frame Set Form Builder Default Defaults to the standard operating system font spacing Required/Optional required
16
.

Applies to frame Set Form Builder Default Defaults to the standard operating system font style Required/Optional required
17
.Frame Title Font Style property
Description Specifies the typographic style (for example. Italic) to apply to the frame title text.

Applies to frame Set Form Builder Default Defaults to the standard operating system font weight.Frame Title Font Weight property
Description Specifies the typographic weight (for example. Bold) to apply to the frame title text. Required/Optional required
18
.

Frame Title Foreground Color property
Description Specifies the color to apply to the frame title text. Required/Optional required
19
. Applies to frame Set Form Builder Default Defaults to the standard operating system font color (usually black).

Applies to frame Set Form Builder Default 2 char cells (or the equivalent depending on the form coordinate system) Required/Optional required
20
.Frame Title Offset property
Description Specifies the distance between the frame and its title.

either Default. Applies to frame Set Form Builder Default Default Required/Optional required
21
.Frame Title Reading Order property
Description Specifies the reading order for frame titles. Left-to-Right. or Right-to-Left.

Applies to frame Set Form Builder Default 1 char cell (or the equivalent depending on the form coordinate system) Required/Optional required
22
.Frame Title Spacing property
Description Specifies the amount of space reserved on either side of the frame’s title.

The actual settings are determined by a combination of factors. the resource file in use.Frame Title Visual Attribute Group property
Description Specifies how the frame title’s individual attribute settings (Font Name. Named visual attributes are separate objects that you create in the Object Navigator and then apply to interface objects.
Applies to frame title Set Form Builder Default Default Usage Notes • Default and named visual attributes can include the following individual attributes. the poplist for this property will show Default. etc. When Visual Attribute Group is set to a named visual attribute. Fill Pattern. Background Color. and font settings. Font Weight The weight of the font. Font Style The style of the font. or typeface. the amount of space between characters (kerning). When Visual Attribute Group is set to Default. The following settings are valid for this property:
Default
Specifies that the object should be displayed with default color.) are derived. that is. pattern. The list of fonts available is system-dependent.
Named visual attribute
Specifies a named visual attribute that should be applied to the object. Font Size The size of the font. and the platform. that should be used for text in the object.
23
. Foreground Color The color of the object’s foreground region. much like styles in a word processing program. including the type of object. the individual attribute settings reflect the attribute settings defined for the named visual attribute object. listed in the order they appear in the Property Palette: Font Name The font family. Font Spacing The width of the font. the individual attribute settings reflect the current system defaults. specified in points. the Foreground Color attribute defines the color of text displayed in the item. For items. When the current form does not contain any named visual attributes.

For example. On Microsoft Windows. For example.Background Color The color of the object’s background region. White on Black Specifies that the object is to appear on a monochrome bitmap display device as white text on a black background. setting font attributes for a window object has no effect. items are rendered with shading that provides a sculpted. An item that has Visual Attribute Group set to Default. or that has individual attribute settings left unspecified. The default font specified determines the font used for new boilerplate text generated by the New Block window. and patterns.INI file. You can apply property classes to objects to specify visual attribute settings. Character Mode Logical Attribute Specifies the name of a character mode logical attribute defined in an Oracle Terminal resource file that is to be used as the basis of device attributes for a character mode version of your application. Override the default font for new items and boilerplate by setting the optional FORMS60_DEFAULTFONT environment variable. and for any items that have Visual Attribute Group set to Default. inherits those settings from the canvas to which it is assigned. its initial visual attribute settings are determined by the current Layout Editor settings for fonts. The default settings are defined internally. if you set a window’s Background Color to CYAN. at runtime. Logical attribute definitions defined in the resource file take precedence over visual attributes specified in the Form Builder. the colors of buttons. window title bars. that canvas will inherit the CYAN background from its window. or one or more of the individual attribute properties. and window borders are controlled by the Windows Control Panel color settings specified for these elements. not at design time. For example. inherits those settings from the window in which it is displayed. Visual attribute settings derived through window canvas or canvas item inheritance are apparent only at runtime. as indicated by the Font dialog and Color and Pattern palettes. colors. use the Oracle Terminal utility. Not all attributes are valid for each object type. A side effect of setting this property is that any canvases that have Visual Attribute Group set to Default derive their color setting from the Windows Control Panel (gray for most color schemes). the named visual attribute settings take precedence. and the property class visual attribute settings are ignored. (The font used in a window’s title bar is derived from the system. a canvas that has Visual Attribute Group set to Default. When the Use 3D Controls form property is set to Yes on Microsoft Windows (the default). On Microsoft Windows. local environment variable definitions.10". You can override this setting by explicitly applying named visual attributes to the canvas. set this variable in the ORACLE. Similarly. and default Form Builder attributes. (If a property class contains both Visual Attribute Group and individual attributes. To edit the resource file.
24
. or that has individual attribute settings left unspecified. When you create an item in the Layout Editor. the Visual Attribute Group property takes precedence. A property class can contain either the Visual Attribute Group property. three-dimensional look. You cannot override these colors in Form Builder. as follows: FORMS60_DEFAULTFONT="COURIER. Patterns are rendered in the two colors specified by Background Color and Foreground Color. Fill Pattern The pattern to be used for the object’s fill region.) A new object in a new form has Default visual attributes. and then leave Background Color unspecified for the canvas assigned to the window.) If you apply both a named visual attribute and a property class that contains visual attribute settings to the same object.

The column names and types in the new record group must match the column names and types in the record group you are replacing.Group_Name property
Description Specifies the name of the record group on which an LOV is based.
26
. Applies to LOV Set programmatically Refer to Built-in • • GET_LOV_PROPERTY SET_LOV_PROPERTY
Default Name of the underlying record group. Usage Notes Set Group_Name to replace the LOV’s current record group with another record group at runtime.

Help property
Description On character mode platform specifies help text for the menu item.
27
. Help text is displayed in a window when the end user presses [Help] while the menu item is selected. Applies to menu item Set Form Builder Required/Optional optional
Help restrictions
Applies to character mode applications only.

Hide on Exit property
Description For a modeless window. programmatically Refer to Built-in • • GET_WINDOW_PROPERTY SET_WINDOW_PROPERTY
Default No
Hide on Exit restrictions
• Cannot be set for a root window: a root window always remains visible when the end user navigates to an item in another window. determines whether Form Builder hides the window automatically when the end user navigates to an item in another window.
28
. Applies to window Set Form Builder.

my_global) form parameter (:PARAMETER. you can enter dates in either: the default format for your NLS_LANG setting or the format you specified as a format mask For compatibility with prior releases.)
29
. specify two of them (that is. To specify a raw value that begins with a leading ampersand (‘&’) or a leading colon (‘:’).Highest Allowed Value/Lowest Allowed Value property
Description Determines the maximum value or minimum value. ‘&&’ or ‘::’). beginning with Release 6.item_name) global variable (:GLOBAL.my_param) Form Builder evaluates the values in items by data type. inclusive. Applies to text item Set Form Builder Refer to Built-in GET_ITEM_PROPERTY Required/Optional optional Usage Notes • The following values are valid for range settings: any valid constant form item (:block_name. that Form Builder allows in the text item. a reference to a form item or to a sequence may be specified with a leading ampersand (&) instead of a leading colon (:).5. as follows:
•
ALPHA alphabetical according to your system’s collating sequence CHAR alphabetical according to your system’s collating sequence DATE chronological DATETIME INT chronological
numerical ascending numerical ascending
NUMBER •
For all items. (This is a change in Forms behavior.

and custom items Set Form Builder Refer to Built-in • GET_ITEM_PROPERTY (HINT_TEXT)
Default "Enter value for: <item name>" NULL Required/Optional optional Usage Notes Leave the Hint property NULL if you do not want the item to have hint text. For an item that was created by using the Data Block Wizard For all other items
30
. Hint text is available when the input focus is in the item. Applies to all items except chart items. display items.Hint (Item) property
Description Specifies item-specific help text that can be displayed on the message line of the root window at runtime.

is displayed as the item descriptor. In full-screen display style. (When no hint text is specified.) Applies to menu item Set Form Builder Required/Optional optional
Hint (Menu Item) restrictions
• Applies to character mode applications only.Hint (Menu Item) property
Description For a character mode application. hint text. In pull-down and bar menu display styles. if specified. Form Builder displays the item name as the descriptor.
31
. specifies hint text for a menu item. and the menu item name is ignored. hint text is displayed on the message line when the input focus is in the menu item.

Hint (Menu Substitution Parameter) property
Description Specifies a description or instruction to appear on the message line when the end user enters a value for the menu substitution parameter. Applies to menu substitution parameter Set Form Builder Required/Optional optional
32
.

Applies to frame Set Form Builder Default 1 char cell (or the equivalent depending on the form coordinate system) Required/Optional required
34
.Horizontal Margin property
Description Specifies the distance between the frame’s borders (left and right) and the objects within the frame.

Horizontal Object Offset property
Description Specifies the horizontal distance between the objects within a frame. Applies to frame Set Form Builder Default 2 char cells (or the equivalent depending on the form coordinate system) Required/Optional required
35
.

or Center. Right.Horizontal Origin property
Description Specifies the horizontal position of the text object relative to its origin point as either Left. Applies to graphic text Set Form Builder Default Left Required/Optional required
36
.

Horizontal Toolbar Canvas property
Description Specifies the canvas that should be displayed as a horizontal toolbar on the window. Applies to window Set Form Builder Default Null Required/Optional required if you are creating a horizontal toolbar Usage Notes • • In the Properties window. the specified horizontal toolbar canvas will not be displayed on the window if you have specified that it should be displayed on the MDI application window by setting the Form Horizontal Toolbar Canvas form property. On Microsoft Windows. the poplist for this property shows only canvases that have the Canvas Type property set to Horizontal Toolbar. At runtime. The canvas specified must be a horizontal toolbar canvas (Canvas Type property set to Horizontal Toolbar) and must be assigned to the current window by setting the Window property. Form Builder attempts to display the specified horizontal toolbar on the window.
•
37
. Form Builder may display a different toolbar in response to navigation events or programmatic control. However. if more than one toolbar of the same type has been assigned to the same window (by setting the canvas Window property to point to the specified window).

menu item.)
Icon Filename restrictions
• • For a window.).ico. (Neither uppercase nor lower-case are allowed.Icon Filename property
Description Specifies the name of the icon resource that you want to represent the iconic button. Icon resources must exist in the runtime operating system. menu item. and are not incorporated in the form definition. icon resource files are not portable across platforms. not my_icon. For this reason. enter my_icon.
The icon filename should not end in any of the following five letters: A. the Microsoft Windows name for this variable is UI60_ICON. window Set Form Builder. and X. do not include the icon file extension (.ico. (For more information on this variable name.
38
. programmatically Refer to Built-in • • • • • • GET_ITEM_PROPERTY SET_ITEM_PROPERTY GET_MENU_ITEM_PROPERTY SET_MENU_ITEM_PROPERTY GET_WINDOW_PROPERTY SET_WINDOW_PROPERTY
Default NULL Required/Optional optional Usage Notes When defining the Icon Filename property. .
Use the platform-specific environment variable to indicate the directory where icon resources are located. etc. For example. S. or window.) These are reserved letters used internally for icon sizing. L. Applies to button. refer to the Form Builder documentation for your operating system. M. For example. it is only valid when Minimize Allowed property set to Yes. Unexpected icon placement results may occur if your icon filename ends in any of these letters.xpm.

the Icon Filename property specifies the icon that will be displayed.Icon in Menu property
Description Specifies whether an icon should be displayed in the menu beside the menu item. Applies to menu item Set Form Builder Default No Required/Optional optional
39
. If Yes.

40
.Iconic property
Description Specifies that a button is to be an iconic button.
Iconic restrictions
A valid icon resource file name must be supplied. the button’s Icon Filename property specifies the icon resource that Form Builder should display for the button. Applies to button Set Form Builder Refer to Built-in GET_ITEM_PROPERTY Default No Required/Optional optional Usage Notes When Iconic is Yes.

Valid values are: • • • • • • • • BMP CALS GIF JFIF PICT RAS TIFF TPIC
Applies to image item Set Form Builder Refer to Built-in • • GET_ITEM_PROPERTY WRITE_IMAGE_FILE
Default TIFF Required/Optional required Usage Notes • • The default Oracle image storage format no longer is valid. and a TIFF image is pasted into the image item at runtime.
42
. The value you set for this property will override the original format of an image when the record containing the image item is stored in the database. if an image item’s Image Format property is set to GIF. the pasted image will be stored in GIF format when the record is saved to the database. For example.Image Format property
Description Specifies the format in which an image item will be stored in the database.

or of a custom implementation for a control item type when you want to supply an alternate to the standard Form Builder control. not for all control item types.) Also required for any other control item type listed above if the form is to use a customized. This property identifies the class name of the container of the JavaBean you are adding to the application. the form’s end user will see an empty square. Applies to The following control item types: Bean Area Check Box List Item Push Button Radio Group Text Item Set Form Builder Default None. This identifies the class name of the alternate control you are supplying. Required/Optional Always required for Bean Area. Set at Runtime No.Implementation Class property
Description Identifies the class name of a container of a JavaBean. Usage Notes
•
The Implementation Class property is only available for those control item types listed above.
43
. usersupplied implementation of that control. (If this property is not supplied.

This is how Form Builder coordinates the master-detail relationship at runtime. the wizard sets the Copy_Value_From_Item property in the detail block to access this new REF. Required/Optional Required for a master block in a master-detail relationship based on a REF pointer. The Data Block wizard sets this property to Yes and creates this REF item when you build a masterdetail relationship based on a REF pointer. The OID is a unique identifier for that row. It is not visible to the end user. In a REF pointer relationship between two tables. In addition. Each row in an object table is identified by a unique object id (OID). when creating a relationship based on a REF pointer. Set Form Builder Default Default is No. However. This item also can be used programmatically to access the object Id (OID) of a row in an object table. and is in the master block.Include REF Item property
Description Creates a hidden item called REF for this block. master-detail REF links. in particular.
44
. Form Builder sets this property to Yes. The item is named REF. These OIDs form an implicit column in an object table. the REF column in the pointing table holds copies of the OID values (addresses) of the pointed-to table. Applies to Blocks based on object tables. Usage Notes This REF item is used to obtain the object-ids (OIDs) of the rows in an object table. This forms the link between the two tables. This item is used internally to coordinate master-detail relationships built on a REF link.

Applies to window Set Form Builder Default Yes Required/Optional optional
Inherit Menu restrictions
• Not valid on Microsoft Windows.
45
.Inherit Menu property
Description Specifies whether the window should display the current form menu on window managers that support this feature.

so the end user can begin to type immediately. text item Set Form Builder Usage Notes • • Most of the time.
Value Default Local Roman
Description Initial keyboard state is based on the value of the Reading Order property. Initial keyboard state is Roman (Left To Right language).Initial Keyboard State property
Description Note: This property is specific to bidirectional National Language Support (NLS) applications. Initial keyboard state is Local (Right To Left language). you will use this property only for text items.
Applies to display item.
46
. Initial Keyboard State sets the keyboard to generate either Local or Roman characters when the item receives input focus. without switching the keyboard state. The end user can override the setting for Initial Keyboard State by pressing the keyboard state toggle key.

The Initial Menu property allows you to override the Main Menu property. Main Menu. By default. menu for this invocation. the starting menu is the menu named in the menu module property. End users cannot navigate above the menu specified as the starting menu. Applies to form module Set Form Builder Default blank (Form Builder uses the default main menu as the starting menu) Required/Optional optional
Initial Menu restrictions
• The menu specified must exist in the menu module.
47
.Initial Menu property
Description Specifies the name of the individual menu in the menu module that Form Builder should use as the main. or top-level.

the value associated with one of the radio buttons in the group is NULL. radio groups. Form Builder ignores them and issues a warning. T-list. and user areas Set Form Builder Default Null Required/Optional Optional for all items except radio groups. check boxes.
Usage Notes When using the default value to initialize the state of items such as check boxes. radio groups. keep in mind that the default value does not get assigned until Form Builder creates a record in the block. or list items.
For a check box.
For a list item. the value associated with one of the list elements is NULL.my_seq. a valid Initial Value is required unless
a) b)
the radio group specifies Mapping of Other Values or. or check box •
48
. a valid Initial Value is required unless
a) b)
the list item specifies Mapping of Other Values or. radio group. For a radio group. ’TOKYO’) form item (:block_name. the value associated with Checked or Unchecked is NULL. and list items.my_global) form parameter (:PARAMETER. The default value can be one of the following: • • • • • raw value (216. If the subordinate mirror item specifies Initial Value and ON-SEQUENCE-NUMBER. the initial value set by this property will be ignored if all of the following are true for the item (or an item that mirrors it): the item is a poplist.my_param) a sequence (:SEQUENCE. text items. display items.item_name) global variable (:GLOBAL.NEXTVAL)
Applies to check boxes. At runtime. a valid Initial Value is required unless
a) b)
the check box specifies Mapping of Other Values or. list items. The ONSEQUENCE-NUMBER trigger is also taken from the master item.Initial Value (Item) property
Description Specifies the default value that Form Builder should assign to the item whenever a record is created. Subordinate mirror items are initialized from the master mirror item’s Initial Value property.

Form Builder checks first for a radio button name.
•
49
. or the value associated with one of the list elements.5. the default value must be either the name (not the label) of one of the radio buttons. To specify a raw value that begins with a leading ampersand (‘&’) or a leading colon (‘:’). (This is a change in Forms behavior. For a radio group. Form Builder checks first for a list element name. the value cannot be outside the range defined by the Lowest Allowed Value and Highest Allowed Value properties. specify two of them (that is.)
Initial Value (Item) property restrictions
• • For a text item. or the value associated with one of the radio buttons. the default value must be either the name of one of the list elements. For a list item. ‘&&’ or ‘::’). a reference to a form item or to a sequence may be specified with a leading ampersand (&) instead of a leading colon (:). beginning with Release 6.there is no element corresponding to the initial value the item does not allow other values For compatibility with prior releases.

Applies to text item. custom items Set Form Builder. radio button. but not at the item or block levels. If Enabled or Visible is set to No (or PROPERTY_FALSE for runtime). in combination with Update Allowed. For example. Set the Enabled property to No if you want to prevent an item from responding to mouse events. setting Insert Allowed to No lets you create a display-only item without disabling it. check box. For items in non-database blocks. For example. which applies to records with a Record_Status of QUERY or CHANGED. you might set Insert Allowed to No to prevent modification of the key while still displaying it normally (not grayed out). or select a radio button.
Insert Allowed (Item) restrictions
• If you are using SET_ITEM_PROPERTY to set Insert Allowed to true. your user cannot type data into an item instance if INSERT_ALLOWED is true at the instance level. Disabled items are grayed out to emphasize the fact that they are not currently applicable.e.Insert Allowed (Item) property
Description Determines whether an end user can modify the value of an item in a new record (i. • Setting INSERT_ALLOWED to Yes (or PROPERTY_TRUE for runtime) has no effect at the item instance level unless it is set consistently at the block and item levels. Insert Allowed resembles Update Allowed. For items in database blocks. image item. but not to modify the item’s value.. for a system-generated key field. then you must set item
51
. when the Record_Status is NEW or INSERT). programmatically Refer to Built-in • • • • GET_ITEM_INSTANCE_PROPERTY GET_ITEM_PROPERTY SET_ITEM_INSTANCE_PROPERTY SET_ITEM_PROPERTY
Default Yes Usage Notes Set Insert Allowed to No when you want the user to be able to inspect an item without being able to modify it. lets you control whether the end user can enter or change the value displayed by an item. For example. Insert Allowed. list item. while enabled items with Insert Allowed set to No allow the user to browse an item’s value with the mouse or keyboard. check a check box. If you set Insert Allowed to No for an item. the user will not be able to type into a text item. the user will not be able to manipulate the item in a new record. then the items’ or item instance’s Insert Allowed property is effectively false.

This means that setting INSERT_ALLOWED to Yes (PROPERTY_TRUE for runtime) has no effect at the item instance level unless it is set consistently at the block and item levels. the values are ANDed together. For example. but not at the item or block levels. item.properties as follows: Enabled to Yes (PROPERTY_TRUE for runtime) Visible to Yes (PROPERTY_TRUE for runtime) When Insert Allowed is specified at multiple levels (item instance. and block).
52
. your user cannot type data into an item instance if INSERT_ALLOWED is true at the instance level.

Insert Procedure Arguments property
Description Specifies the names. Applies to block Set Form Builder Default NULL Required/Optional optional
53
. and values of the arguments to pass to the procedure for inserting data into the data block. The Insert Procedure Arguments property is valid only when the DML Data Target Type property is set to Procedure. datatypes.

Insert Procedure Name property
Description Specifies the name of the procedure to be used for inserting data into the data block. Applies to block Set Form Builder Default NULL Required/Optional optional
54
. The Insert Procedure Name property is valid only when the DML Data Target Type property is set to Procedure.

Applies to block Set Form Builder Default NULL Required/Optional optional
55
.Insert Procedure Result Set Columns property
Description Specifies the names and datatypes of the result set columns associated with the procedure for inserting data into the data block. The Insert Procedure Result Set Columns property is valid only when the DML Data Target Type property is set to Procedure.

Non-blocking interaction mode is useful if you expect the query will be time-consuming and you want the user to be able to interrupt or cancel the query. If set to Non-Blocking. the Forms runtime will display a dialog that allows the user to cancel the query. If Interaction Mode is set to Blocking. then end users can interact with the form while records are being fetched. Applies to form module Set Form Builder Refer to Built-in • GET_FORM_PROPERTY
Default Blocking Required/Optional required
56
. however. then users are prevented from resizing or otherwise interacting with the form until the records for a query are fetched from the database. In this mode. you can obtain the interaction mode programmatically using the GET_FORM_PROPERTY built-in.Interaction Mode property
Description Specifies the interaction mode for the form module. You cannot set the interaction mode programmatically. Interaction mode dictates how a user can interact with a form during a query.

regardless of updates committed by other users from other sessions. Applies to form module Set Form Builder Usage Notes Serializable mode is best suited for an implementation where few users are performing a limited number of transactions against a large database. leave Isolation Mode set to Read Committed (the default).). If Isolation Mode has the value Serializable. and a second user updates and commits the same row from another session. Serializable mode is best used in conjunction with the block-level property Locking Mode set to Delayed.Isolation Mode property
Description Specifies whether or not transactions in a session will be serializable. and where long-running transactions are queries. the end user sees a consistent view of the database for the entire length of the transaction. If the end user queries and changes a row. in other words. Default Read Committed Required/Optional required
57
. For transaction-intensive implementations. the first user sees Oracle error (ORA-08177: Cannot serialize access. an implementation where there is a low chance that two concurrent transactions will modify the same row.

Item Roles restrictions
Valid only when the name of at least one role has been specified in the menu module roles list. set the menu module property Module Roles. To add a role to this list.
58
. Applies to menu item Set Form Builder Required/Optional optional Usage Notes You can only grant access to members of those roles displayed in the roles list.Item Roles property
Description Specifies which menu roles have access to a menu item.

60
.Item_Is_Valid property
Description Specifies whether an item is marked internally as valid. Set Item_Is_Valid to No to instruct Form Builder to treat any current data in a text item as invalid and subject it to subsequent validation. Set Item_Is_Valid to Yes to instruct Form Builder to treat any current data in an item as valid and skip any subsequent validation. Applies to item Set programmatically Refer to Built-in • • GET_ITEM_PROPERTY SET_ITEM_PROPERTY
Default item in a new record: No. item in a queried record: Yes Usage Notes • • Use Item_Is_Valid to check whether the current status of a text item is valid.

where one item exists in the master block and the other item exists in the detail block a combination of item names and equating conditions
Join Condition restrictions
• Maximum length for a join condition is 255 characters.item1 = block2.item_3) an equating condition of two item names.
62
. define the join condition as follows: block1.item1 AND block1. define the following join condition: ORDID To link the detail block to its master block through a number of text items.
Join Condition examples
Examples: To link a detail block to its master block through the ORDID text item that is common to both blocks.item2 Keep in mind that the join condition specifies the relationship between the items in each block. the items specified must actually exist in the form for the join condition to be valid. Thus.item2 = block2. not between the columns in the tables on which those blocks are based. Applies to relation Set Form Builder Required/Optional required for a relation object Usage Notes You can specify a join condition with the following entries: • • • an item name that exists in both the master block and the detail block (block_2.Join Condition property
Description Defines the relationship that links a record in the detail block with a record in the master block.

regardless of Reading Order property. Centered. regardless of Reading Order property. End is evaluated as Left alignment when the reading order is Right To Left.
• •
64
. The starting edge depends on the value of the item’s Reading Order property. and as Right alignment when the reading order is Left to Right. text item Set Form Builder. Start is evaluated as Right alignment when the reading order is Right To Left.
End
Applies to display item. accept the default. choose Start (the default). For unidirectional applications. Start.Justification property
Description Specifies the text justification within the item. Item text is aligned with the starting edge of the item bounding box. Right-justified. The allowable values for this property are as follows:
Value Left Center Right Start
Description Left-justified. and as Left alignment when the reading order is Left to Right. Start gives exactly the same results as Left and End gives the same results as Right. in most cases. In bidirectional applications: If your data must be aligned with the item’s Reading Order. programmatically Refer to Built-in • • GET_ITEM_PROPERTY SET_ITEM_PROPERTY
Default Start Usage Notes • In unidirectional applications (reading order Left to Right). Item text is aligned with the ending edge of the item bounding box. regardless of Reading Order property. The ending edge depends on the value of the item’s Reading Order property.

65
. Unsupported by some window managers. choose End.• •
If your data must be aligned opposite to the item’s Reading Order.

programmatically Refer to Built-in • • GET_ITEM_PROPERTY SET_ITEM_PROPERTY
Default No Usage Notes Use this property if you want to give the end user the flexibility to move the cursor to an item.
Keep Cursor Position restrictions
Unsupported on some window managers. and have the cursor reposition itself to the end of the partial text.Keep Cursor Position property
Description Specifies that the cursor position be the same upon re-entering the text item as when last exited.
66
. then back to the partially filled item. Applies to text item Set Form Builder.

By default. For applications that will run against ORACLE. programmatically Refer to Built-in • • GET_BLOCK_PROPERTY SET_BLOCK_PROPERTY
Default Unique Usage Notes
67
.
Non-Updateable
Unique Updateable
Applies to block Set Form Builder. Instructs Form Builder to use ROWID constructs to identify unique rows in an ORACLE database. Use this setting if your database allows primary key columns to be updated and you intend for the application to update primary key values. but instead rely solely on unique primary key values to identify unique rows. Non-ORACLE databases do not include the ROWID construct. Specifies that Form Builder should not include primary key columns in any UPDATE statements. you must use primary keys. the ORACLE database uses unique ROWID values to identify each row. Use this setting if your database does not allow primary key values to be updated. use the default setting.Key Mode property
Description Specifies how Form Builder uniquely identifies rows in the database. Specifies that Form Builder should issue UPDATE statements that include primary key values. and set the Key Mode block property accordingly. If you are creating a form to run against a non-ORACLE data source. This property is included for applications that will run against non-ORACLE data sources.
Value Automatic (default)
Description Specifies that Form Builder should use ROWID constructs to identify unique rows in the datasource but only if the datasource supports ROWID.

When the Key Mode property is set to one of the primary key modes.
68
. you must identify the primary key items in your form by setting the Enforce Primary Key block property to Yes for the block. and the Primary Key item property to Yes for at least one item in the block.

Accelerator keys are named ACCELERATOR1. When running with bar-style menus. and so on. You can also create additional accelerator keys in Oracle Terminal (ACCELERATOR6. You must edit the resource file in Oracle Terminal to change the key mappings. through ACCELERATOR5. and so on). which you can then associate with menu items in a menu module. accelerator keys can be used only for items on the menu that is currently displayed. Key mappings must not interfere with standard Form Builder key mappings.
69
. End users can select the menu item by pressing the key or key combination that is mapped to the logical accelerator key.
Keyboard Accelerator restrictions
• • • Not valid for separator menu items.Keyboard Accelerator property
Description Specifies a logical function key to be associated with a menu item. Applies to menu item Set Form Builder Required/Optional optional Usage Notes The mappings of logical accelerator keys to physical device keys is defined in the runtime resource file. ACCELERATOR2. ACCELERATOR7.

then enter the desired description in the Keyboard Help Description field. This is the default setting. If you want the name of the key that corresponds to the trigger and its default description to be displayed in the Keys window. set the Display Keyboard Help property to Yes and leave the Keyboard Help Description blank.
70
. Applies to trigger Set Form Builder Default blank Usage Notes • • If you do not want the name or the description to appear in the Keys window. for example. If you want to replace the default key description.Keyboard Help Description property
Description Specifies the key trigger description that is displayed in the runtime Keys help screen if the Display in Keyboard Help property is set to Yes.
•
Keyboard Help Description restrictions
Valid only for key triggers. set the Display Keyboard Help property to Yes. An entry in the Keys screen includes a text description for the key name and the physical keystroke associated with it. Ctrl-S. set the Display Keyboard Help property to No.

then you must set item properties as follows: Enabled to Yes (PROPERTY_TRUE for runtime) Visible to Yes (PROPERTY_TRUE for runtime)
71
. and block). the keyboard Navigable property is NOT set to PROPERTY_TRUE. the values are ANDed together. the item is navigable. but not at the item level. However. The default navigation sequence for items is defined by the order of items in the Object Navigator. the Keyboard_Navigable property is also set to PROPERTY_FALSE. your user cannot navigate to an item instance if Keyboard Navigable is true at the instance level.
•
Keyboard Navigable restrictions
• If you are using SET_ITEM_PROPERTY to set NAVIGABLE to true. This means that setting Keyboard Navigable to Yes (or NAVIGABLE to PROPERTY_TRUE for runtime) has no effect at the item instance level unless it is set consistently at the item level. when the Enabled property is set to PROPERTY_FALSE. item. if the Enabled property is subsequently set back to PROPERTY_TRUE. You can use the GO_ITEM built-in procedure to navigate to an item that has its Keyboard Navigable property set to No (PROPERTY_FALSE) for runtime. Form Builder skips over the item and enters the next navigable item in the default navigation sequence. For example. Applies to all items except chart items and display items Set Form Builder. then the items’ or item instance’s Keyboard navigable property is effectively false. When set to No. • When Keyboard Navigable is specified at multiple levels (item instance. and must be changed explicitly. At runtime. When set to Yes for an item.Keyboard Navigable property
Description Determines whether the end user or the application can place the input focus in the item during default navigation. programmatically [NAVIGABLE] Refer to Built-in • • • • GET_ITEM_INSTANCE_PROPERTY GET_ITEM_PROPERTY SET_ITEM_INSTANCE_PROPERTY SET_ITEM_PROPERTY
Default Yes Usage Notes If Enabled or Visible is set to No (PROPERTY_FALSE for runtime).

Applies to item international Set Form Builder Default Any Required/Optional required
72
. or Local Only.Keyboard State property
Description Specifies supported international keyboard states as Any. Roman Only.

the label can include multiple words and punctuation.Label (Menu Item) property
Description Specifies the text label for each menu item. programmatically Refer to Built-in • • GET_MENU_ITEM_PROPERTY SET_MENU_ITEM_PROPERTY
Required/Optional optional Usage Notes Each menu item has both a name and a label. used only in the runtime GUI. For example." the menu item name remains ITEM2 until you change it in either the Object Navigator or the Properties Palette. which must follow PL/SQL naming conventions. making it. Unlike the name.. and a default label. Form Builder gives it a default name. for instance.
74
. When you create a new menu item in the Menu editor. The label. may differ from the name. <New Item>. which can be used programmatically. When you edit the item label in the Menu editor. "Show Keys. is an acceptable label. like ITEM2. Applies to menu item Set Form Builder. while the corresponding name would be more_info..More Info.

Last_Block property
Description Specifies the name of the block with the highest sequence number in the form. Applies to form module Set not settable Refer to Built-in GET_FORM_PROPERTY
77
. as indicated by the sequence of blocks listed in the Object Navigator.

Last_Item property
Description Specifies the name of the item with the highest sequence number in the indicated block. as indicated by the sequence of items listed in the Object Navigator. Applies to block Set not settable Refer to Built-in GET_BLOCK_PROPERTY
78
.

Last_Query property
Description Specifies the SQL statement for the last query of the specified block. Applies to block Set not settable Refer to Built-in GET_BLOCK_PROPERTY
79
.

You cannot arrange a block’s items within multiple frames.Layout Data Block property
Description Specifies the name of the data block which the frame is associated with. A block can only be associated with one frame. the items within this block are arranged within the frame. Applies to frame Set Form Builder Default NULL Required/Optional required
80
.

Layout Style property
Description Specifies the layout style for the items within the frame.
Tabular
Applies to frame Set Form Builder Default Form Required/Optional required
81
. with graphic text prompts positioned to the left of each item. When Frame Style is set is to Form. Form The default frame style. Form Builder arranges the items in a two-column format. with graphic text prompts above each item. When Frame Style is set to Tabular. Form Builder arranges the items next to each other across a single row.

If Custom is selected.Line Spacing property
Description Specifies the line spacing of the text objext as Single. One-and-a-half. Custom. Applies to graphic text Set Form Builder Default Single Required/Optional required
83
. Double. the Custom Spacing property determines the line spacing.

Applies to radio button Set Form Builder Default NULL Required/Optional required Usage Notes When you leave the List Item Value field blank.List Item Value property
Description Specifies the value associated with a specific radio.
85
. the value associated with the radio button is NULL.
List Item Value restrictions
• Must be unique among values associated with radio button.

When an LOV is attached to a text item. end users can navigate to the item and press [List of Values] to invoke the LOV.
86
.List of Values property
Description Specifies the list of values (LOV) to attach to the text item. To alert end users that an LOV is available. Applies to text item Set Form Builder Refer to Built-in GET_ITEM_PROPERTY Required/Optional optional
List of Values restrictions
The LOV must exist in the active form module. Form Builder displays the LOV list lamp on the message line when the input focus is in a text item that has an attached LOV.

Applies to list item Set Form Builder Default Poplist Usage Notes The display style you select for the list item has no effect on the data structure of the list item." and end users can see more than one value at a time if the list is large enough to display multiple values. either poplist.List Style property
Description Specifies the display style for the list item. The poplist and combo box styles take up less space than a Tlist. A Tlist remains "open. or Tlist. but end users must open the poplist or combo box to see list elements. combo box.
87
.

When you select this option.
Old
List Type restrictions
none
88
. you must choose the record group in the Record Group property drop-down list. Applies to: List of Values (LOV) Set Form Builder Default Query Required/Optional required Usage Notes The following settings are valid for this property: Record Group Indicates that you intend to base the LOV on an existing record group.List Type property
Description Specifies how you intend to reference the record group object on which the LOV will be based. This option is included for compatibility with previous versions of Form Builder. Every LOV has an associated record group from which it derives its values at runtime. It cannot be used in new applications. and must already exist in the active form. The record group you specify can be either a static record group or a query record group .

Form Builder displays the LOV at the display coordinates you specified when you created the LOV. you can also set the List X Position and List Y Position properties to override the default display coordinates specified for the LOV. Required/Optional required Usage Notes • If you leave the List X Position property set to 0 and the List Y Position property set to 0. When you attach an LOV to a text item by setting the List of Values property. The List of Values property must be specified. If you specify position coordinates. as specified by the List X Position property. the coordinates you specify override the LOV’s default position coordinates.
•
89
. indicating that Form Builder should use the default LOV display horizontal (X) coordinate.List X Position property
Description Specifies the horizontal (X) coordinate of the upper left corner of the LOV relative to the screen. Applies to text item Set Form Builder Refer to Built-in GET_ITEM_PROPERTY Default 0.

the coordinates you specify override the LOV’s default position coordinates. you can also set the List Y Position and List X Position properties to override the default display coordinates specified for the LOV. as specified by the List Y Position property. indicating that Form Builder should use the default LOV display vertical (Y) coordinate. When you attach an LOV to a text item by setting the List of Values property. If you specify position coordinates.
•
90
. Applies to text item Set Form Builder Refer to Built-in GET_ITEM_PROPERTY Default 0. Required/Optional required Usage Notes • If you leave the List X Position property set to 0 and the List Y Position property set to 0.List Y Position property
Description Specifies the vertical (Y) coordinate of the upper left corner of the LOV relative to the screen. The List of Values property must be specified. Form Builder displays the LOV at the display coordinates you specified when you created the LOV.

if so.Listed in Data Block Menu/Data Block Description
Specifies whether the block should be listed in the block menu and. For an existing block. Applies to block Set Form Builder Default Yes. Form Builder navigates to the first enterable item in the block. Form Builder has a built-in block menu that allows end users to invoke a list of blocks in the current form by pressing [Block Menu]. the description that should be used for the block. the block name at the time the block was created. Required/Optional optional
Listed in Block Menu/Block Description restrictions
The block does not appear in the Block Menu if you set the Listed in Block Menu property to Yes but leave the Block Description property blank. Block Description: For a new block. NULL.
91
. When the end user selects a block from the list.

The Lock Procedure Arguments property is valid only when the DML Data Target Type property is set to Procedure. and values of the arguments that are to be passed to the procedure for locking data. datatypes.Lock Procedure Arguments property
Description Specifies the names. Applies to block Set Form Builder Default NULL Required/Optional optional
92
.

The Lock Procedure Name property is valid only when the DML Data Target Type property is set to Procedure. Applies to block Set Form Builder Default NULL Required/Optional optional
93
.Lock Procedure Name property
Description Specifies the name of the procedure to be used for locking data.

Lock Procedure Result Set Columns property
Description Specifies the names and datatypes of the result set columns associated with the procedure for locking data. The Lock Procedure Result Set Columns property is valid only when the DML Data Target Type property is set to Procedure. Applies to block Set Form Builder Default NULL Required/Optional optional
94
.

To set the Lock Record property with SET_ITEM_PROPERTY. but you still want Form Builder to lock the row in the database that corresponds to the current record in the block.
95
.Lock Record property
Description Specifies that Form Builder should attempt to lock the row in the database that corresponds to the current record in the block whenever the text item’s value is modified. Useful for lookup text items where locking underlying record is required.
• •
Lock Record restrictions
Valid only when the item is a control item (Base Table Item property set to No) in a data block. Applies to text item Set Form Builder. programmatically Refer to Built-in • • GET_ITEM_PROPERTY SET_ITEM_PROPERTY
Default No Usage Notes • Set this property to Yes when the text item is a control item (an item not associated with a base table column). either by the end user or programmatically. use the constant LOCK_RECORD_ON_CHANGE.

96
. For other datasources. The following table describes the allowed settings for the Locking Mode property: Value Automatic (default) Immediate Delayed Description Identical to Immediate if the datasource is an Oracle database. Form Builder locks the row only while it posts the transaction to the database. The Delayed setting is useful for applications that must minimize the number of locks or the amount of time that rows remain locked.
Applies to block Set Form Builder. Use delayed locking if the form’sIsolation Mode property has the value Serializable.Locking Mode property
Description Specifies when Form Builder tries to obtain database locks on rows that correspond to queried records in the form. The main drawbacks of delayed locking are • • The changes an end user makes to a block may need to be redone at commit time. not while the end user is editing the record. Use Automatic instead. Form Builder prevents the commit action from processing if values of the fields in the block have changed when the user causes a commit action. Form Builder determines the available locking facilities and behaves as much like Immediate as possible. Another user’s lock can force the first end user to choose between waiting indefinitely or abandoning the changes. The Immediate setting remains for compatibility with existing applications. Form Builder locks the corresponding row as soon as the end user presses a key to enter or edit the value in a text item. programmatically Refer to Built-in • • GET_BLOCK_PROPERTY SET_BLOCK_PROPERTY
Default Automatic Usage Notes For most applications use the default setting of Automatic. but there is no reason to use it in new applications.

About. Cut. Copy. Clear. Paste. or Window. Copy. so the designer may not assign a command to this item.
Help Quit Window
97
. so the designer may not enter a command for these items. Help. The Window magic menu item presents a submenu of all open windows.Magic Item property
Description Specifies one of the the following predefined menu items for custom menus: Cut. The designer provides the functionality of items on this submenu. Window. About
Description These items perform the usual text-manipulation operations. except Menu. Clear. Copy. and Quit have built-in functionality supplied by Form Builder. The command for the Help menu item must be Menu. so the designer must enter a command for these items. Quit also has built-in functionality. Clear Undo. in an order determined by Form Builder. Paste. Paste. Applies to menu item Set Form Builder Default Cut Required/Optional optional Usage Notes The following settings are valid for this property:
Setting Cut. allowing the user to activate any of them. If the Window magic menu item has a command that invokes a submenu. The command type for a magic Window item is Null or Menu. Magic menu items are automatically displayed in the native style for the platform on which the form is being executed. These items have no native functionality. Form Builder supplies their functionality. while the other magic menu items can have commands associated with them. with the appropriate accelerator key assigned. that submenu will contain both the list of open widows and the user-defined submenu items. Quit. Undo. Any type of command can be used for these items.

and Hint properties blank. For example.Magic Item restrictions
• Any given magic menu item may appear only once in the entire menu hierarchy for a given menu module. Keyboard Accelerator. a menu containing the magic menu item Cut cannot be a submenu of two different options in the menu module. Leave the magic menu item’s Icon.
•
98
.

and updated thereafter if you change the name of that menu. The Main Menu property is used mostly with full-screen menus.
99
. End users cannot navigate to any menu that is above the main menu in the menu module hierarchy. you can specify a different menu in the document to be the main menu by setting the Initial Menu property. you will not need to change this property: it is automatically set to the name of the first menu you create. If you are creating a pulldown menu.Main Menu property
Description Specifies the name of the individual menu in the document that is to be the main or starting menu at runtime. to limit the menus to which end users have access. Applies to menu module Set Form Builder Default blank Required/Optional required Usage Notes When you attach the menu module to a form by setting the appropriate properties in the Form Module property sheet.

radio group Set Form Builder Default blank Required/Optional optional Usage Notes • Leave this property blank to indicate that other values are not allowed for this item or radio group. Applies to list item. Any attempt to assign an other value is disallowed. Any value you specify must evaluate to one of the following references: the value associated with one of the list elements or radio groups the name (not the label) of one of the list elements
• • •
100
. Any queried record that contains a value other than the user-defined element value is silently rejected.Mapping of Other Values property
Description Specifies how any fetched or assigned value that is not one of the pre-defined values associated with a specific list element or radio button should be interpreted.

Maximize Allowed property
Description Specifies that end users can resize the window by using the zooming capabilities provided by the runtime window manager. Applies to window Set Form Builder Default Yes
Maximize Allowed restrictions
• Only valid when Resize Allowed is set to No
101
.

•
Note: Bear these considerations in mind if you are writing applications for a multi-byte character set: • • Form Builder allows end users to enter the full number of single-byte characters. and chart items Set Form Builder Refer to Built-in GET_ITEM_PROPERTY Default • For a database item. to allow for the possible use of a minus sign (for negative values) and a decimal separator.Maximum Length property
Description Specifies the maximum length of the data value that can be stored in the item. (If Maximum Length exceeds the display width of the item. consider raising the Maximum Length for the item. For a LONG item. up to the Maximum Length specified. image items.)
102
.
• •
Required/Optional required Usage Notes • At runtime. the Maximum Length is 2000 characters. 30. To avoid this situation. Forms will increase the value of the Maximum Length property if the item’s format mask requires a longer length. the length of the corresponding column in the database table. For a control item. If the end user enters a combination of single-byte and multi-byte characters that produce a string whose total length in bytes exceeds the item's Maximum Length. or one of the implicit masks used by Forms in its internal conversion operations. Applies to all items except buttons. Note: If the item’s data type is NUMBER. the string will be truncated to the nearest whole character and a warning will be displayed. 240 bytes. Form Builder will automatically allow the end user to scroll the contents of the item. (The format mask may be either an explicit mask specified by the form’s designer for this item.) For CHAR values. the maximum length will be set to the defined column length plus two.

of a form parameter of type CHAR.
103
. 30 Required/Optional required
Maximum Length (Form Parameter) restrictions
• Maximum length of a CHAR parameter is 2000 bytes. Applies to form parameter Set Form Builder Default For a parameter of type CHAR. in characters.Maximum Length (Form Parameter) property
Description Specifies the maximum length.

Applies to frame Set Form Builder Default 0 Required/Optional required
105
.Maximum Objects Per Line property
Description Specifies the maximum number of objects that can appear on each line within a frame. there is no maximum--Form Builder arranges the maximum number of objects per line within a frame. This property is valid when the Frame Style property is set to Form and the Vertical Fill property is set to No. When the Maximum Number of Frame Objects is set to 0 (the default).

106
. Programmatically Refer to Built-in • • GET_FORM_PROPERTY GET_BLOCK_PROPERTY
Required/Optional optional Usage Notes This property is only useful when the Query All Records property is set to Yes. Applies to form.Maximum Query Time property
Description Provides the option to abort a query when the elapsed time of the query exceeds the value of this property. block Set Form Builder.

block Set Form Builder.Maximum Records Fetched property
Description Specifies the number of records fetched when running a query before the query is aborted. Applies to form. Set the Maximum Records Fetched property to limit the records returned by a user’s query. Programmatically Refer to Built-in • • GET_FORM_PROPERTY GET_BLOCK_PROPERTY
Required/Optional optional Usage Notes Maximum Records Fetched is only useful when the properties Query Allowed and Query All Records are set to Yes.
107
.

In fullscreen display style. Applies to menu module Set Form Builder Default The default document name Required/Optional optional
Menu Description restrictions
• Applicable for character mode applications only.
108
.Menu Description property
Description For applications running on character mode in the pull-down and bar menu display styles. this property specifies the string that identifies the menu module. this property specifies the string that displays on the message line when the end user navigates to the menu.

This property is applicable only when you want Form Builder to locate the menu . rather than direct reference. The Menu Directory and Menu Filename menu module properties specify the path where Form Builder should look for the . At runtime.
109
.MMX runtime menu file. Form Builder queries the menu module definition stored in the database to find out the directory and filename of the menu . then searches any predefined search paths. Form Builder first searches the default directory for the file. Applies to menu module Set Form Builder Default blank Required/Optional optional Usage Notes If you leave the directory path unspecified. For more information on search paths.MMX menu file.MMX runfile.Menu Directory property
Description Specifies the directory in which Form Builder should look for the .
Menu Directory restrictions
Not valid when using direct reference to specify the location of the menu . When using database lookup. refer to the Form Builder documentation for your platform. the menu module must be stored in the database.MMX runfile. You use direct reference when you attach a menu to a form by setting the Menu Source form module property to Yes.MMX runfile through database lookup.

This property is applicable only when you want Form Builder to locate the menu runfile through database lookup. refer to the Form Builder documentation for your platform.MMX runfile. rather than direct reference. To use database lookup. the menu module must be stored in the database.
Menu Filename restrictions
• The . Form Builder queries the menu module definition stored in the database to find out the directory and filename of the menu .MMX runtime menu file that Form Builder should look for at form startup. At runtime.
110
.MMX file extension is not required. For more information on search paths. The Menu Directory and Menu Filename menu module properties specify the path where Form Builder should look for the .Menu Filename property
Description Specifies the name of the .MMX menu file. Form Builder first searches the default directory for the file. then searches any predefined search paths. Applies to menu module Set Form Builder Default Module Name property Required/Optional required Usage Notes If you leave the directory unspecified.

Menu Item Radio Group property
Description Specifies the name of the radio group to which the current radio menu item belongs.
Menu Item Radio Group restrictions
• • Radio items must be adjacent to each other on the same menu. Applies to menu item Set Form Builder Required/Optional required Usage Notes Specify the same Radio Group for all radio items that belong to the same logical set.
112
. Only one radio group per individual menu is allowed.

Windows. Indicates a Boolean menu item that is either Yes or No. Copy. and Window. Applies to: menu items Set Form Builder Default Plain Usage Notes The following menu item types are available: • PlaiDefault. Standard text menu item. The type determines how the item is displayed and whether the item can have an associated command. Form Builder toggles the selection state of the item and executes its command. When the end user selects a Radio menu item.Menu Item Type property
Description Specifies the type of menu item: Plain. Magic menu items Cut. Radio. Clear. Whenever the end user selects a Check menu item Form Builder toggles the state of that item and executes the command associated with that menu item. Cut. Enter a radio group name in the Radio Group property field. while the other magic menu items require that commands be associated with them. checked or unchecked. Clear. with the appropriate accelerator key assigned. Magic. You specify a Separator menu item for the purpose of separating other menu items on the menu. Help. and Quit have built-in functionality supplied by Form Builder. A Separator menu item cannot be selected and therefore it cannot have a command associated with it. Undo. Copy. Copy. and Paste are automatically enabled and disabled by Form
113
. if there is one. About. Paste. Separator A line or other cosmetic item. Check. or Separator. Quit. Paste. Indicates a BOOLEAN menu item that is part of a radio group. Magic menu items are automatically displayed in the native style of the platform on which the form is executed. if there is one.
Check
Radio
• •
You can use GET_MENU_ITEM_PROPERTY and SET_MENU_ITEM_PROPERTY to get and set the state of check and radio menu items. in the position determined by the platform’s conventions. Clear. Magic Indicates one of the the following predefined menu items: Cut. One and only one Radio menu item in a group is selected at any given time.

Menu Item Type restrictions
The top-level menu should only have plain or magic menu items. You can also use GET_MENU_ITEM_PROPERTY and SET_MENU_ITEM_PROPERTY to get and set the state of magic menu items programmatically.Builder. depending on the behavior of the native platform.
114
. but the result of disabling magic menu items will vary.

MMX file to use with this form.
Applies to form module Set Form Builder Default Default. When left NULL. Required/Optional optional
115
. the Menu Module property specifies the name of the menu . indicating that Form Builder should run the form with the default form menu. the Menu Source property determines how the Menu Module property setting is interpreted: • • When the Menu Source property is Yes. When this property is set to Default.Menu Module property
Description Specifies the name of the menu to use with this form. When the Menu Source property is No.MMX runfile that Form Builder should use with this form. Form Builder runs the form with the default menu that is built in to every form. When any value other than Default or Null is specified. Form Builder runs the form without any menu. it specifies the name of the menu module in the database that Form Builder should query at form startup to find out the name of the menu .

and then running the menu under that role. the Menu Role property allowed designers to test a menu by creating a master role that had access to all of the items in the menu. In previous versions of Form Builder.
116
. all end users have access to all menu items. You can obtain the same result by setting the menu module property Use Security to No. When the Menu Role property is specified. When Use Security is No. Applies to form module Set Form Builder Required/Optional optional Usage Notes The Menu Role property is included for backward compatibility only.Menu Role property
Description Specifies the security role that Form Builder should use to run the menu. Form Builder runs the indicated menu as if the current end user were a member of the security role specified. Its use is not recommended in current applications. and you do not have to be a member of any particular role to test your application.

MMX file in the Menu Module field. Applies to form module Set Form Builder Default Yes Required/Optional optional Usage Notes Setting the Menu Source property allows you to specify the location of the menu .MMX runfile it needs. Database lookup is included for backward compatibility.MMX runfile when you attach a custom menu to a form module.
The following table compares the property settings and database conditions required when attaching a menu to a form through direct reference to those required for database lookup.MMX file defined by the menu module Menu Filename and Menu Directory properties.MMX file in file system
117
.Menu Source property
Description Menu Source allows you to specify the location of the . then enter the path/filename of the . To refer to the menu by way of database lookup.MMX file by querying the database to look up the pointer to the .MMX runfile n/a Database Lookup No Name of . Form Builder loads the .MMX file. then enter the name of the menu module stored in the database. In most cases.MMX file at form startup. set the Menu Source property to Yes.MMX runfile through either direct reference or through database lookup. you will want to use direct reference to the file system. At form startup. Condition or Property Form Module Property: "Menu Source" Form Module Property: "Menu Module" Menu Module Property: "Menu Directory/Menu Direct Reference Yes Name of . (The Menu Module Menu Filename and Menu Directory define the path to the . Form Builder locates the .) When the form is loaded at runtime.MMX file in the file system. Form Builder queries the menu module definition to look up the name of the .MMB menu design document in database Path/filename of .
Direct Reference Database Lookup
To refer directly to the . set the Menu Source property to No.

MMB at Load Time Not required n/a Required at form startup Must be stored in database
The following diagrams compare using direct reference and database lookup when attaching a custom menu to a form.Filename" Database Connection Location of Menu .
118
.

(The default menu runs only in pulldown display style.Menu Style property
Description Specifies the menu display style Form Builder should use to run the custom menu specified by the Menu Module property. Applies to form module Set Form Builder Default Pull-down Required/Optional optional
Menu Style restrictions
Not valid when the Menu Module property is set to DEFAULT.)
119
. Display style options are pull-down or bar.

Note. however. programmatically Refer to Built-in SET_ALERT_PROPERTY Required/Optional optional
Message restrictions
Maximum of 200 characters. including the font chosen and the limitations of the runtime window manager.Message property
Description Specifies the message that is to be displayed in an alert. that several factors affect the maximum number of characters displayed.
120
. Applies to alert Set Form Builder.

121
.Minimize Allowed property
Description Specifies that a window can be iconified on window managers that support this feature. Applies to window Set Form Builder Default Yes Required/Optional optional
Minimize Allowed restrictions
Cannot be set for a root window: a root window is always iconifiable.

Applies to window Set Form Builder Default No Required/Optional optional
Minimized Title restrictions
Only applicable when the Minimize Allowed property is set to Yes.
122
.Minimized Title property
Description Specifies the text string that should appear below an iconified window.

the following window properties are ignored:
•
Close Allowed
•
Resize Allowed
•
Icon Filename
•
Minimized Title
•
Minimize Allowed
•
Inherit Menu
•
Move Allowed
•
Maximize Allowed
•
Show Vertical/Horizontal Scroll Bar
123
. Applies to window Set Form Builder Default No
Modal restrictions
• When Modal is set to Yes. Modal windows require an end user to dismiss the window before any other user interaction can continue.Modal property
Description Specifies whether a window is to be modal.

Module_NLS_Lang property
Description Specifies the complete current value of the NLS_LANG environment variable defined for the form. for national language support.WE8ISO8859P1.
124
." but all the defaults can be port-specific. MODULE_NLS_LANG is the equivalent of concatenating the following properties: • • • MODULE_NLS_LANGUAGE (language only) MODULE_NLS_TERRITORY (territory only) MODULE_NLS_CHARACTER_SET (character set only)
Applies to form Set Not settable from within Form Builder. Refer to Built-in GET_FORM_PROPERTY Default Default is usually "America_American. Set at your operating system level.

125
. Applies to menu module Set Form Builder Required/Optional optional Usage Notes Use Menu Module Roles to construct the entire list of roles with access to this menu module. then use Menu Item Roles to specify which of these roles should have access to a specific menu item.Module Roles property
Description Specifies which database roles are available for items in this menu module.

Mouse Navigate property
Description Specifies whether Form Builder should perform navigation to the item when the end user activates the item with a mouse. Applies to button, check box, list item, radio group Set Form Builder Refer to Built-in • • GET_ITEM_PROPERTY SET_ITEM_PROPERTY

Default Yes Usage Notes When Mouse Navigate is No, Form Builder does not perform navigation to the item when the end user activates it with the mouse. For example, a mouse click in a button or check box is not treated as a navigational event. Form Builder fires any triggers defined for the button or check box (such as WhenButton-Pressed), but the input focus remains in the current item. When Mouse Navigate is Yes, Form Builder navigates to the item, firing any appropriate navigation and validation triggers on the way.

Mouse Navigation Limit property
Description Determines how far outside the current item an end user can navigate with the mouse. Mouse Navigation Limit can be set to the following settings: Form Block Record Item Applies to form Set Form Builder Default Form (The default.) Allows end users to navigate to any item in the current form. Allows end users to navigate only to items that are within the current block. Allows end users to navigate only to items that are within the current record. Prevents end users from navigating out of the current item. This setting prevents end users from navigating with the mouse at all.

127

Move Allowed property
Description Specifies whether or not the window can be moved . Windows can be moved from one location to another on the screen by the end user or programmatically by way of the appropriate built-in subprogram. Applies to window Set Form Builder Default Yes Required/Optional optional Usage Notes In general, it is recommended that windows always be movable.

Move Allowed restrictions
Cannot be set to NO for a window with the name of ROOT_WINDOW. Such a window is always movable.

128

Multi-Line property
Description Determines whether the text item is a single-line or multi-line editing region. Applies to text item Set Form Builder Refer to Built-in GET_ITEM_PROPERTY Default No Usage Notes Setting the Multi-line property Yes allows a text item to store multiple lines of text, but it does not automatically make the item large enough to display multiple lines. It is up to you to set the Width, Height, Font Size, and Maximum Length properties to ensure that the desired number of lines and characters are displayed. Single-line Multi-line Pressing the carriage return key while the input focus is in a single-line text item initiates a [Next Item] function. Pressing the carriage return key while the input focus is in a multi-line text item starts a new line in the item.

Multi-Selection property
Description Indicates whether multiple nodes may be selected at one time. If set to FALSE, attempting to select a second node will deselect the first node, leaving only the second node selected. Applies to hierarchical tree Set Form Builder Default False Required/Optional required

130

Name property
Description Specifies the internal name of the object. Every object must have a valid name that conforms to Oracle naming conventions. Applies to all objects Set Form Builder Default OBJECT_CLASS_N, where OBJECT_CLASS is the type of object, and N is the next available number in the document; for example, BLOCK5 or EDITOR3. Required/Optional required Usage Notes • • • • For menu items and radio buttons, the Name property has unique characteristics: The Name property specifies an internal handle that does not display at runtime. The Name property is used to refer to the menu item or radio button in PL/SQL code. The Label property specifies the text label that displays for the menu item or current radio button.

For menu substitution parameters, the following restrictions apply: • • • • • Restricted to a two-character identifier for the substitution parameter. Must be alphanumeric. Must start with an alphabetic character. When referencing the parameter in a menu command line, the parameter must be preceded by an ampersand (&RN) In a PL/SQL reference, the parameter must be preceded by a colon (:SS).

Name restrictions
• • • • • • • • Can be up to 30 characters long Must begin with a letter Can contain letters, numbers, and the special characters $, #, @ and _ (underscore) Are not case sensitive Must uniquely identify the object: Item names must be unique among item names in the same block Relation names must be unique among relations that have the same master block Cannot be set for the root window

131

Name examples
Example ENAME, ADDRESS1, PHONE_NO1

132

Navigation Style property
Description Determines how a Next Item or Previous Item operation is processed when the input focus is in the last navigable item or first navigable item in the block, respectively. Applies to block Set Form Builder, programmatically Refer to Built-in • • GET_BLOCK_PROPERTY SET_BLOCK_PROPERTY

Default Same Record Usage Notes The following settings are valid for this property: Same Record The default navigation style. A Next Item operation from the block’s last navigable item moves the input focus to the first navigable item in the block, in that same record . A Next Item operation from the block’s last navigable item moves the input focus to the first navigable item in the block, in the next record . If the current record is the last record in the block and there is no open query, Form Builder creates a new record. If there is an open query in the block (the block contains queried records), Form Builder retrieves additional records as needed. A Next Item operation from the block’s last navigable item moves the input focus to the first navigable item in the first record of the next block. Similarly, a Previous Item operation from the first navigable item in the block moves the input focus to the last item in the current record of the previous block. The Next Navigation Block and Previous Navigation Block properties can be set to redefine a block’s "next" or "previous" navigation block.

Change Record

Change Block

133

Next Navigation Block property
Description Specifies the name of the block that is defined as the"next navigation block" with respect to this block. By default, this is the block with the next higher sequence number in the form, as indicated by the order of blocks listed in the Object Navigator. However, you can set this property to redefine a block’s "next" block for navigation purposes. Applies to block Set Form Builder, programmatically Refer to Built-in • • GET_BLOCK_PROPERTY SET_BLOCK_PROPERTY

Default The name of the block with the next higher sequence number, as indicated by the order of blocks listed in the Object Navigator. Required/Optional optional Usage Notes Setting this property does not change the value of the NextBlock property.

134

Next Navigation Item property
Description Specifies the name of the item that is defined as the "next navigation item" with respect to this current item. By default, the next navigation item is the item with the next higher sequence as indicated by the order of items in the Object Navigator. However, you can set this property to redefine the "next item" for navigation purposes. Applies to item Set Form Builder, programmatically Refer to Built-in • • GET_ITEM_PROPERTY SET_ITEM_PROPERTY

Default NULL. NULL indicates the default sequence, which is the name of the item with the next higher sequence number.

Next Navigation Item restrictions
The item specified as Next Navigation Item must be in the same block as the current item.

135

NextBlock property
Description Specifies the name of the block with the next higher sequence number in the form, as indicated by the order of blocks listed in the Object Navigator. Applies to block Set not settable Refer to Built-in GET_BLOCK_PROPERTY Usage Notes • • • You can programmatically visit all of the blocks in a form by using GET_BLOCK_PROPERTY to determine the First_Block and NextBlock values. The value of NextBlock is NULL when there is no block with a higher sequence number than the current block. Setting the Next Navigation Block property has no effect on the value of NextBlock.

136

NextItem property
Description Specifies the name of the item with the next higher sequence number in the block, as indicated by the order of items listed in the Object Navigator. Applies to item Set not settable Refer to Built-in GET_ITEM_PROPERTY

137

Next_Detail_Relation property
Description Returns the name of the relation that has the same detail block as the specified relation. If no such relation exists, returns NULL. Applies to relation Set not settable Refer to Built-in GET_RELATION_PROPERTY Usage Notes Use this property with the FIRST_DETAIL_RELATION property to traverse a list of relations for a given master block.

138

Next_Master_Relation property
Description Returns the name of the next relation that has the same master block as the specified relation. If no such relation exists, returns NULL. Applies to relation Set not settable Refer to Built-in GET_RELATION_PROPERTY Usage Notes Use this property with the FIRST_MASTER_RELATION property to traverse a list of relations for a given master block.

139

Number of Items Displayed property
Description Specifies the number of item instances displayed for the item when the item is in a multi-record block. Setting Number of Items Displayed > 0 overrides the Number of Records Displayed block property. Applies to item Set Form Builder Default Zero. Zero indicates that the item should display the number of instances specified by the Number of Records Displayed block property. Required/Optional optional Usage: Use Number of Items Displayed to create a single button, chart, OLE item, image, VBX control (in 16bit Microsoft Windows), or ActiveX control (in 32-bit Windows) as part of a multi-record block. For instance, if Number of Records Displayed is set to 5 to create a multi-record block and you create a button, by default you will get 5 buttons, one per record. To get only one button, set Number of Items Displayed to 1.

Number of Items Displayed restrictions
Number of Items Displayed must be <= Number of Records Displayed block property setting.

140

Number of Records Buffered property
Description Specifies the minimum number of records buffered in memory during a query in the block. Applies to block Set Form Builder Default NULL; which indicates the minimum setting allowed (the value set for the Number of Records Displayed property plus a constant of 3). Required/Optional optional Usage Notes • • • • Form Builder buffers any additional records beyond the maximum to a temporary file on disk. Improve processing speed by increasing the number of records buffered. Save memory by decreasing the number of records buffered. This can, however, result in slower disk I/O. If you anticipate that the block may contain a large number of records either as the result of a query or of heavy data entry, consider raising the Number of Records Buffered property to increase performance. Consider lowering the Number of Records Buffered property if you anticipate retrieving large items, such as image items, because of the amount of memory each item buffered may require.

•

Number of Records Buffered restrictions
• If you specify a number lower than the minimum, Form Builder returns an error when you attempt to accept the value.

141

Number of Records Displayed property
Description Specifies the maximum number of records that the block can display at one time. The default is 1 record. Setting Number of Records Displayed greater than 1 creates a multi-record block. Applies to block Set Form Builder Refer to Built-in GET_BLOCK_PROPERTY Default 1 Required/Optional required

142

OLE Activation Style property
Description Specifies the event that will activate the OLE containing item. Applies to OLE Container Set Form Builder Default Double Click Usage Notes The following settings are valid for this property: Double Click • Focus-i The default OLE activation style. An OLE object becomes active by double-clicking anywhere on the OLE object. Navigating to the OLE object causes the OLE object to become active. An OLE object becomes active by selecting Edit or Open from the Object submenu of the OLE popup menu. The Show OLE Popup Menu property must be set to YES and the Object menu item must be set to displayed and enabled. The OLE popup menu is accessible when the mouse cursor is on the OLE object and the right mouse button is pressed.

Manual

If the Show OLE Popup Menu property is YES and the Object menu item is displayed and enabled, it is also possible to manually activate the OLE object through the OLE popup menu when the OLE Activation Style is Double Click or Focus-in.

OLE Class property
Description Determines what class of OLE objects can reside in an OLE container. The following settings are valid for this property: NULL other than NULL The default OLE class. You can insert any kind of OLE object class specified in the registration database in an OLE container. Only OLE objects from the specified class can be inserted in an OLE container at runtime. The OLE object classes that are available for selection depend on information contained in the registration database. The content of the registration database is determined by the OLE server applications installed on your computer.

Applies to OLE Container Set Form Builder Default NULL Usage Notes You select a specific class if you want to create an application that allows end users to change the current OLE object in the OLE container, but want to restrict the end users to creating OLE objects from a particular class.

OLE Class restrictions
Valid only on Microsoft Windows and Macintosh.

144

OLE In-place Activation property
Description Specifies if OLE in-place activation is used for editing embedded OLE objects. The following settings are valid for this property: YES Turns on OLE in-place activation. OLE in-place activation is used for editing embedded OLE objects; linked objects are activated with external activation. Turns off OLE in-place activation and turns on external activation. External Activation is used for editing embedded or linked OLE objects.

OLE Inside-Out Support property
Description Specifies if the OLE server of the embedded object allows inside-out object support during in-place activation. Inside-out activation allows for more than one embedded object to have an active editing window within an OLE container. The following settings are valid for this property: YES NO Applies to OLE Container Set Form Builder Default YES Turns on inside-out object support for embedded objects that have the OLE In-place Activation property set to Yes. Turns off inside-out object support for embedded objects that have the OLE in-place Activation property set to Yes.

OLE Inside-Out Support restrictions
• Valid only on Microsoft Windows and Macintosh.

146

OLE Popup Menu Items property
Description Determines which OLE popup menu commands are displayed and enabled when the mouse cursor is on the OLE object and and the right mouse button is pressed. The OLE popup menu commands manipulate OLE objects. OLE popup menu commands and their actions include:

OLE Popup Menu Command CUT COPY PASTE PASTE SPECIAL

Action Cuts an OLE object and places the content on the clipboard. Copies an OLE object and places the content on the clipboard. Pastes the content from the clipboard to an OLE container. Pastes an OLE object from the clipboard to an OLE container in a format other than the original format. Inserts an OLE object in an OLE container. Deletes an OLE object from an OLE container. Invokes a dialog that has settings to determine how links are updated, edit linked source files, and change links from one source file to another source file. Depending on the OLE server, it is possible to perform various operations on an OLE object. Some examples include opening an OLE object, editing an OLE object, and converting an OLE object from one format to another.

Default Display On and Enable On for all menu commands Required/Optional required

147

Usage Notes • In the Form Builder, you can set each OLE popup menu command to exhibit the following characteristics by selecting the appropriate check box: Specifies whether the selected menu command is displayed. Specifies whether a menu command that has Display On is enabled or disabled. A disabled item appears dimmed or grayed.

Display Enable •

In addition to setting OLE popup menu command properties in the Form Builder, you can set and get OLE popup menu command properties programmatically. To set or get the OLE popup menu commands programmatically, use a programmatic property name that corresponds to a menu command. The following list includes each of the OLE popup menu commands and a corresponding programmatic property name:

You can programmatically set the OLE popup menu command properties to any of the following values: Specifies that an OLE popup menu command is displayed and enabled. Specifies that an OLE popup menu command is displayed and disabled. A disabled item appears dimmed or grayed.

DISPLAYED ENABLED •

HIDDESpecifies that an OLE popup menu command is not displayed on the OLE popup menu. A command that is not displayed is not enabled. In addition to the values that you can set programmatically, you can programmatically get the following values from each of the OLE popup menu commands: Return value when an OLE popup menu command is displayed and enabled. Return value when an OLE popup menu command is displayed and disabled. A disabled item appears dimmed or grayed. HIDDEReturn value when an OLE popup menu command is not displayed on the OLE popup menu. A command that is not displayed is not enabled. Return value when the OLE popup menu is not supported. This is the return value for every platform except Microsoft Windows.

DISPLAYED ENABLED • UNSUPPORTED

148

OLE Popup Menu Items restrictions
Valid only on Microsoft Windows.

149

OLE Resize Style property
Description Determines how an OLE object is displayed in an OLE container. The following settings are valid for this property: CLIP SCALE INITIAL DYNAMIC Applies to OLE Container Set Form Builder Required/Optional required Default CLIP The default OLE resize style. An OLE object is cropped to fit into an OLE container. An OLE object is scaled to fit into an OLE container. An OLE container is resized to fit an OLE object at creation time only. An OLE container is resized to fit an OLE object whenever the OLE object size changes.

OLE Tenant Aspect property
Description Determines how an OLE object appears in an OLE container. Applies to OLE Container Set Form Builder Default CONTENT Usage Notes The following settings are valid for this property: CONTENT The default OLE tenant aspect. The content of an OLE object is displayed in an OLE container. The content of the OLE object depends on the value of the OLE Resize Style property and can either be clipped, scaled, or full size. An icon of an OLE object is displayed in an OLE container. The default icon is one that represents the OLE server application that created the OLE object. You can choose which icon to use from the insert object dialog.

ICO

THUMBNAIL A reduced view of the OLE object is displayed in an OLE container. An OLE object type is saved to the database in a LONG RAW column. When the OLE object is queried from the database, make sure that it has the same OLE Tenant Aspect property setting as that of the OLE object saved to the database. If the OLE Tenant Aspect property of the saved OLE object is different from that of the queried OLE object, the record containing the object is automatically LOCKED.

OLE Tenant Aspect restrictions
Valid only on Microsoft Windows.

151

OLE Tenant Types property
Description Specifies the type of OLE objects that can be tenants of the OLE container. The following settings are valid for this property: ANY NONE STATIC The default OLE tenant type. Any OLE object can be a tenant of the OLE container. No object can reside in the OLE container. Only static OLE objects can be a tenant of the OLE container. A static OLE object is a snapshot image of a linked OLE object that has a broken link to its source. A static OLE object cannot be modified. Only an embedded OLE object can be a tenant of the OLE container. Only a linked OLE object can be a tenant of the OLE container.

Operating_System property
Description Specifies the name of the current operating system, such as Microsoft WINDOWS, WIN32COMMON, UNIX, Sun OS, MACINTOSH, VMS, and HP-UX. Applies to application Set not settable Refer to Built-in GET_APPLICATION_PROPERTY Usage Notes Because the value returned by this property is platform-specific, refer to the Form Builder documentation for your operating system if the platform you are using is not listed above.

153

Optimizer Hint property
Description Specifies a hint string that Form Builder passes on to the RDBMS optimizer when constructing queries. Using the optimizer can improve the performance of database transactions. Applies to block Set Designer, programmatically Refer to Built-in • • GET_BLOCK_PROPERTY SET_BLOCK_PROPERTY

Restrictions: Valid only for applications running against the Oracle7 Server or Oracle8 Server. Usage Notes Consider a form that contains a block named DeptBlock based on the DEPT table. If the end user enters a criteria of " > 25 " for the DEPTNO column and executes the query, the default SELECT statement that Form Builder generates to query the appropriate rows from the database is as follows: SELECT DEPTNO,DNAME,LOC,ROWID FROM DEPT WHERE (DEPTNO > 25) The designer can use SET_BLOCK_PROPERTY to set the Optimizer Hint property to request that the Oracle7 Server attempt to optimize the SQL statement for best response time: Set_Block_Property(’DeptBlock’,OPTIMIZER_HINT,’FIRST_ROWS’); SELECT /*+ FIRST_ROWS */ DEPTNO,DNAME,LOC,ROWID FROM DEPT WHERE (DEPTNO > 25) For more information on how to use this feature with Oracle7, refer to the following sources: • • Oracle7 Server Application Developer’s Guide, Chapter 5, "Tuning SQL Statements" Oracle7 Server Concepts Manual , Chapter 13, "The Optimizer"

154

Order By property
Description See WHERE CLAUSE/ORDER BY CLAUSE.

155

Other Reports Parameters property
Description A <keyword>=<value> list of parameters to include in the running of the report. For a list of valid parameters, see the keyword list in the Report Builder online help. Applies to Report Builder reports Set Form Builder Default blank Required/Optional optional Usage Notes: When passing multi-word parameter values in the where-clause, the entire where-clause should be enclosed in single quotes. When a name appears in such a multi-word parameter, then two single quotes should also be used to begin and to end that name. For example, in order to pass the parameter value where ename = ’MILLER’ it is necessary to code this as: ‘where ename = ‘‘MILLER’’’

156

Output_Date/Datetime_Format property
Description Holds the current output date or datetime format mask established by the environment variable FORMSnn_OUTPUT_DATE_FORMAT or FORMSnn_OUTPUT_DATETIME_FORMAT. Forms uses these format masks as defaults in its runtime output processing. There are two separate properties: Output_Date_Format and Output_Datetime_Format. Applies to application Set Not settable from within Form Builder. Refer to Built-in GET_APPLICATION_PROPERTY

157

Parameter Data Type property
Description Specifies what kinds of values Form Builder allows as input and how Form Builder displays those values. Applies to check box, display item, list item, radio group, text item, custom item, form parameter Note: All data types do not apply to each item type. Set Form Builder Usage Notes • It is recommended that you use only the standard data types CHAR, DATE, LONG, and NUMBER. These data types are based on native ORACLE data types, and offer better performance and application portability. The other data types are valid only for text items, and are included primarily for compatibility with previous versions. You can achieve the same formatting characteristics by using a standard data type with an appropriate format mask. The data type of a base table item must be compatible with the data type of the corresponding database column. Use the CHAR data type for items that correspond to ORACLE VARCHAR2 database columns. Do not create items that correspond to database CHAR columns if those items will be used in queries or as the join condition for a master-detail relation; use VARCHAR2 database columns instead. Form Builder will perform the following actions on items, as appropriate: remove any trailing blanks change the item to NULL if it consists of all blanks remove leading zeros if the data type is NUMBER, INT, MONEY, RINT, RMONEY, or RNUMBER (unless the item’s format mask permits leading zeros) The form parameter Parameter Data Type property supports the data types CHAR, DATE, and NUMBER.

Contains a valid date. You can display a DATE item in any other valid format by changing the item’s format mask. Default Restrictions The DATE data type contains a ZERO time component Example DATETIME Contains a valid date and time. Default Restrictions DD-MON-YY HH24:MI[:SS] Refers to a DATE column in the database and is processed as a true date, not a character string. The DATETIME data type contains a four digit year. If the year input to a DATETIME data type is two digits, the year is interpreted as 00YY. Example EDATE Contains a valid European date. Default Restrictions DD/MM/YY V3 data type. Must refer to a NUMBER column in the database. Included for backward compatibility. Instead, follow these recommendations: Use the DATE data type. Apply a format mask to produce the European date format. Reference a DATE column in the database, rather than a NUMBER column. Example 23/10/92 (October 23, 1992) 01/06/93 (June 1, 1993) INT Contains any integer (signed or unsigned whole number). 31-DEC-88 23:59:59 DD-MON-YY Refers to a DATE column in the database and is processed as a true date, not a character string. .

01-JAN-92

159

Default Example JDATE

0 1, 100, -1000

Contains a valid Julian date. Default Restrictions MM/DD/YY V3 data type. Must refer to a NUMBER column in the database. Included for backward compatibility. Instead, follow these recommendations: Use the DATE data type. Apply a format mask to produce the Julian date format. Reference a DATE column in the database, rather than a NUMBER column. Example 10/23/92 (October 23, 1992) 06/01/93 (June 1, 1993) LONG Contains any combination of up to 65,534 characters. Stored in ORACLE as variable-length character strings. Default Restrictions Blanks Not allowed as a reference in the WHERE or ORDER BY clauses of any SELECT statement. LONG items are not queryable in Enter Query mode. MONEY Contains a signed or unsigned number to represent a sum of money. Restrictions V3 data type Included for backward compatibility. Instead, use a format mask with a number to produce the same result. Example NUMBER Contains fixed or floating point numbers, in the range of 1.0x10-129 to 9.99x10124, with one or more of the following characteristics: • • • • • signed unsigned containing a decimal point in regular notation in scientific notation 10.95, 0.99, -15.47

160

•

up to 38 digits of precision

NUMBER items refer to NUMBER columns in the database and Form Builder processes their values as true numbers (not character strings). Default Restrictions Example RINT Displays integer values as right-justified. Restrictions V3 data type Included for backward compatibility. Instead, follow these recommendations: Use the NUMBER data type. Apply a format mask such as 999 to produce a right-justified number. RMONEY Displays MONEY values as right-justified. Restrictions V3 data type Included for backward compatibility. Instead, follow these recommendations: Use the NUMBER data type Apply a format mask such as $999.99 to produce a right-justified number. RNUMBER Displays NUMBER values as right-justified. Restrictions V3 data type Included for backward compatibility. Instead, follow these recommendations: Use the NUMBER data type. Apply a format mask such as 999.999 to produce a right-justified number. TIME Contains numbers and colons that refer to NUMBER columns in the database. Default Restrictions HH24:MI[:SS] V3 data type Included for backward compatibility. Instead, follow these recommendations: Use the DATETIME data type. Apply a format mask to produce only the time. Not allowed as a reference to DATE columns in the database. 0 Commas cannot be entered into a number item (e.g., 99,999). Use a format mask instead. -1, 1, 1.01, 10.001, 1.85E3

161

Example

:10:23:05 21:07:13

162

Parameter Initial Value (Form Parameter) property
Description Specifies the value that Form Builder assigns the parameter at form startup. Applies to Form Parameter Set Form Builder Default NULL Required/Optional optional Usage Notes Any valid constant is a valid value for this property.

163

Menu Parameter Initial Value (Menu Substitution Parameter) property
Description Specifies the value that Form Builder assigns the parameter at form startup. Set Form Builder Required/Optional required

164

Password property
Description Specifies the password of the current end user. Applies to application Set not settable Refer to Built-in GET_APPLICATION_PROPERTY Usage Notes The Password property returns only the password. If you want a connect string as well, examine the Connect_String property.

165

PLSQL_Date_Format property
Description This property establishes the format mask used in converting date values when executing PL/SQL (for a trigger or called function or procedure) within Forms, in the following cases:
• •

evaluating TO_DATE (char_value) or TO_DATE (date_value) with no explicit format mask assigning a CHAR value to a date variable, or vice versa.

Required/Optional optional. However, it is STRONGLY RECOMMENDED that, for a new application, you set this property to a format mask containing full century and time information. It is also recommended that this format mask be the same as the one specified in the Builtin_Date_Format property. Default As noted above, it is strongly recommended that you explicitly set this value for a new application. If you do not, the default value will be DD-MON-YY. (This value is used for compatibility with Release 4.5 and earlier.) Compatibility with other Oracle products In Oracle products other than Form Builder, PL/SQL version 2 does not necessarily use a default date format mask of DD-MON-YY. Instead, it typically uses a format mask derived from the current NLS environment. If for some reason you want your Forms application to exhibit the same behavior, you can use the USER_NLS_DATE_FORMAT application property to get the current NLS date format mask, and then assign it to the application’s PLSQL_DATE_FORMAT property.

166

This property is displayed only for your information. You cannot set or change it through the property palette. If you requested that the directory path be retained. Default none
167
. This property is set when you attach a PL/SQL library to a Forms module. this property will be the full pathname of the library. this property will be just the library name.PL/SQL Library Location property
Description Shows the location of the attached PL/SQL library. Applies to PL/SQL libraries Set Form Builder Required/Optional display only. If you requested that the directory path be removed.

PL/SQL Library Source property
Description This property is set when you attach a PL/SQL library to a Forms module. You cannot set or change it through the property palette. It shows the source of this PL/SQL library – either File or Database. This property is displayed only for your information. Applies to PL/SQL libraries Set Form Builder Required/Optional display only Default File
168
.

Applies to canvases and items Set not settable Required/Optional Optional Default NULL Refer to Built-in GET_MENU_ITEM_PROPERTY • SET__MENU_ITEM_PROPERTY
Note: ENABLED. but you can assign a popup menu to a radio group.
Popup Menu restrictions
The popup menu must be defined within the current form module.
169
. and LABEL are the only properties valid for popup menus. DISABLED. • You cannot attach a popup menu to individual radio buttons.Popup Menu property
Description Specifies the popup menu to display for the canvas or item.

Default No Usage Notes When an end user executes a query in a block with Precompute Summaries set to Yes.Precompute Summaries property
Description Specifies that the value of any summarized item in a data block is computed before the normal query is issued on the block.3 database. or (4) the block contains a checkbox item. and (2) the form-level Isolation Mode property is set to Serializable.) over all the records. (3) the block’s Query Data Source is a stored procedure or transactional triggers (must be a table or sub-query). and again just before executing the normal query. Form Builder fires the Pre-Query trigger (if any) once before it executes the special query. Form Builder fires the PreSelect trigger (if any) twice: once just before executing the special query. (2) a minimize or maximize operation is performed on a summarized item in the block..
Precompute Summaries restrictions
You cannot set Precompute Summaries to Yes if any of the following are true: (1) the block contains a summarized control item. • Read consistency cannot be guaranteed unless (1) the form is running against an Oracle7. Applies to block Set Form Builder Required/Optional Required if the block contains summarized items and the block’s Query All Records property is set to No. or radio group with an empty Other Values property. count. Form Builder issues a special query that selects all records (in the database) of the summarized item and performs the summary operation (sum. etc.
170
. list item.

Applies to relation Set Form Builder. Form Builder displays an appropriate message when end users attempt to insert or query a record: FRM-41105: Cannot create records without a parent record. FRM-41106: Cannot query records without a parent record. programmatically Refer to Built-in • • GET_RELATION_PROPERTY SET_RELATION_PROPERTY
Default No
171
.Prevent Masterless Operations property
Description Specifies whether end users should be allowed to query or insert records in a block that is a detail block in a master-detail relation. When Prevent Masterless Operation is Yes. Form Builder does not allow records to be inserted in the detail block when there is no master record in the master block. When set to Yes. and does not allow querying in the detail block when there is no master record that came from the database.

Applies to block Set Form Builder. Required/Optional optional Usage Notes Setting this property has no effect on the value of the PreviousBlock property.Previous Navigation Block property
Description Specifies the name of the block that is defined as the "previous navigation block" with respect to this block. programmatically Refer to Built-in • • GET_BLOCK_PROPERTY SET_BLOCK_PROPERTY
Default The name of the block with the next lower sequence in the form. as indicated by the order of blocks in the Object Navigator. you can set this property to redefine a block’s "previous" block for navigation purposes.
172
. By default. However. this is the block with the next lower sequence in the form.

programmatically Refer to Built-in • • GET_ITEM_PROPERTY SET_ITEM_PROPERTY
Default NULL. you can set this property to redefine the "previous item" for navigation purposes.Previous Navigation Item property
Description Specifies the name of the item that is defined as the"previous navigation item" with respect to the current item. However. Required/Optional optional
Previous Navigation Item restrictions
The item specified as Previous Navigation Item must be in the same block as the current item.
173
. which is the name of the item with the next lower sequence in the form. as indicated by the order of items in the Object Navigator. Applies to item Set Form Builder. NULL indicates the default. By default. this is the item with the next lower sequence in the form.

The value of PreviousBlock is NULL when there is no block with a lower sequence number than the current block. Setting the Previous Navigation Block property has no effect on the value of PreviousBlock. Applies to block Set not settable Refer to Built-in GET_BLOCK_PROPERTY Required/Optional optional Usage Notes • • • You may use this property with the First_Block or Last_Block form properties to traverse a list of blocks. as indicated by the order of blocks in the Object Navigator.PreviousBlock property
Description Specifies the name of the block with the next lower sequence in the form.
174
.

as indicated by the order of items in the Object Navigator. Applies to item Set not settable Refer to Built-in GET_ITEM_PROPERTY Required/Optional optional
175
.PreviousItem property
Description Spec