Page 555
Oracle Forms 4.5 contains a large variety of built-in subprograms that PL/SQL scripts use in objects such as triggers and user-defined subprograms. Developers use these subprograms to perform various functions, such as dinging a bell, executing a query, navigating to the next record, or inserting records into the database. Table A.1 defines the built-in subprograms available to you.
The first column contains the name of the built-in subprogram and lists any parameters that may be needed. The second column determines whether the subprogram is restricted.You cannot use restricted subprograms in all triggers because they affect form navigation and cannot be used from a trigger that is causing navigation to occur in the form. Examples of triggers that cannot contain restricted subprograms are the Pre_text_item and Post_change_item triggers. They fire on moving the cursor into and out of an item, respectively. These triggers that cannot contain "Restricted" subprograms because they are fired during a navigation procedure. Subprograms with a Yes in the Restricted column are restricted.
Some of the subprograms cannot be fired in the Enter Query mode. This mode occurs when the form is prompting the user to enter a query value. Each subprogram in the table is marked with a Yes in the Enter Query column if is used in the Enter Query mode.n
Page 556
Table A.1Built-In Subprograms
Built-In Name/ Parameter Syntax | Restricted | Enter Query | Description |
abort_query; | No | Yes | Stops the execution of a query. |
add_group_column (record group id or name, group column name, column type, column width); | No | Yes | Adds a column to a record group. Record group id is the unique name Oracle assigns the group. Record group name is the user-defined name of the group. Group column name is the name of the column. Column type indicates the data type. The allowable column types are: char_column, date_column, long_column, and number_column. |
add_group_row (record group id or name, row number); | No | Yes | Adds a row to the record group. Record group id is the unique name Oracle assigns the group. Record group name is the user-defined name of the group. Row number specifies the row in the group. |
add_list_element (list name or list id, list index, list label, list value); | No | Yes | Adds an item to a pick list. List id is the unique Oracle id for the list. List name is the user-defined name of the list. List index indicates the list position of the element. List label specifies the string value to place in the list. List value contains the list label's corresponding database value. |
add_parameter (list or name, parameter, parameter type, value); | No | Yes | Adds a parameter to a parameter list. A parameter list is a list of variables that will be passed to another object. List or name specifies the identifier of the list. Parameter type holds two acceptable values: Text_type, which is a string literal; and data_parameter, which is a string specifying a record group defined in the form. Value is the actual value passed to the called module. |
Page 557
Built-In Name/ Parameter Syntax | Restricted | Enter Query | Description |
application_parameter; | No | Yes | Causes Oracle to display the Enter Parameter Values dialog box. The parameters associated to the current menu form are displayed along with their values. |
background_menu (1 .... 10); | No | Yes | Displays a menu item from a background menu. |
bell; | No | Yes | Causes the terminal bell to sound. |
block_menu; | Yes | Yes | Displays a list of values that contains the valid block names and their sequence number. |
break; | No | Yes | Stops the execution of the form and displays the Debugger. This occurs only when the form is running in Debug mode. |
call_form (form name, how to display, switch menu, query mode, parameter list, or to parameter name); | No | Yes | Executes the called form while keeping the current form in the background. Form name is the name of the form. The how display parameter has two values: hide or no_hide. Hide causes Oracle to clear the calling screen and no_hide does not clear the screen. Switch menu has two settings: no_replace, which causes the called form to keep the default menu of the calling form active; and do_replace, which replaces the default menu. Placing a value of query_only in the Query mode parameter causes the called application to be run in Query mode only. Placing the no_query_only value in this parameter enables the user to insert, update, and delete records on the form. Parameter list id or name is the unique ID Forms Designer assigns a parameter list. Parameter list name is the user- defined name for a parameter list object. |
continues
Page 558
Table A.1Continued
Built-In Name/ Parameter Syntax | Restricted | Enter Query | Description |
call_input; | Yes | No |
Accepts and processes function key input. |
checkbox_checked; | Yes | No | Returns a true or false value indicating the state of the checkbox. |
check_record Â_uniqueness; | No | Yes | Initiates the Forms processing for checking primary key uniqueness when called from an On-Check- Unique trigger. |
clear_block; | Yes | No | Clears the records from the current block. |
clear_eol; | Yes | No | Clears a text item's value from the current cursor position to the end of the line. |
clear_form (commit mode, rollback mode); | Yes | No | Clears the form of all records. The commit mode parameter has several parameters: Ask_commit, which prompts the operator to commit the records; Do_commit, which performs the commit; No_commit, which clears the form and does not commit the data; and No_validate, which commits the data without validating. |
clear_item; | Yes | Yes | Changes the current text item to null. |
clear_list (list id or name); | No | Yes | Clears the values in a pick list. List id is the list's Oracle ID. List name is your name for the list. |
clear_message; | Yes | Yes | Clears the message area of any existing message. |
clear_record; | Yes | Yes | Removes all values in the current record. |
close_form (form name or id); | Yes | No | Shuts the current form. A different form may be closed by specifying the form name or id. |
Page 559
Built-In Name/ Parameter Syntax | Restricted | Enter Query | Description |
commit_form; | Yes | No | Modifies the database tables with the values on the form. |
convert_other_value (list name or id); | Yes | Yes | Changes the value of a pick list, radio group, or check box to the value associated with the current state of the item. |
copy (variable 1, variable 2); | No | Yes | Copies the value from variable 1 to variable 2. |
copy_region; | Yes | Yes | Copies text from the current screen and saves it in the clipboard buffer for later use. |
count_query; | Yes | Yes | Identifies the number of records a query retrieves when used in an On- count trigger. |
create_group (record group name); | No | Yes | Creates a static or nonquery record group. Records are added to the group using the populate_group _with_query, add_group_column, and add_group_row subprograms. |
create_group_ from_query (record group name, select statement,); | No | Yes | Creates a record group based on the specified select statement |
create_parameter_list (list name); | No | Yes | Creates a parameter list. Parameters can be added by using the add_parameter subprogram. Parameter lists are often passed as arguments to the run_product, call_form, and new_form subprograms. |
create_queried Â_record; | Yes | No | Creates a record in a block's record buffer when used in an On-Fetch trigger. The buffer contains records that have been retrieved but not displayed. |
create_record; | Yes | No | Places the current block into the input record mode. |
continues
Page 560
Table A.1 Continued
Built-In Name/ Parameter Syntax | Restricted | Enter Query | Description |
create_timer (timer name, milliseconds, iterate); | No | Yes | Creates a timer. Milliseconds determines the allotted time of each cycle. The iterate parameter has two options: repeat, the default setting that tells the timer to repeat on completion; and no_repeat, which tells the timer to stop on completion. |
cut_region; | Yes | No | Cuts the selected text and stores it in the clipboard buffer. |
dbms_error_code; | No | Yes | Traps and displays the last database error code. |
dms_error_text; | No | Yes | Displays the database error message type and text. |
debug_mode; | No | Yes | Turns the Debug mode on and off. This mode applies only to menu modules. |
default_value (literal, variable); | No | Yes | Places the string literal into the variable if its current value is null. |
delete_group (record group id or name); | No | Yes | Deletes a record group created by a program. |
delete_group_row (record group id or name, row number); | No | Yes | Removes the indicated row from the record group. Record group id is the unique name Oracle assigns the group. Record group name is the user-defined name of the group. Row number specifies the row in the group. |
delete_list_element (list name or list id, list index); | No | Yes | Removes the indicated pick list item. List name is the user-defined name of the list. List index indicates the list position of the element. |
delete_parameter (list or name, parameter); | No | Yes | Removes the specified parameter from the parameter list. List and name refer to the name of the parameter list. Parameter refers the deleted parameter. |
delete_record; | Yes | No | Deletes the current record on the form. |
Page 561
Built-In Name/ Parameter Syntax | Restricted | Enter Query | Description |
delete_timer (timer id or time name); | No | Yes | Eliminates the specified timer. Timer id or time name contain the name of the timer. |
destroy_parameter Â_list (list or name); | No | Yes |
Removes a programmatically called
parameter list. List or name refer to the name of the list. |
display_error; | No | Yes | Activates the Display Error screen if an error has been logged. |
display_item (item name or id, attribute); | No | Yes | Alters an item's appearance by assigning it a different attribute. Item name or id refers to the name of the displayed item. Attribute refers to the attribute that is to be changed. |
down; | Yes | No | Displays or navigates to the next record in the record buffer. |
do_key (built-in subprogram name); | Yes | Yes | Simulates the pressing of the function key defined with the name of the subprogram. (See Appendix B for a list of function key trigger names). |
duplicate_item; | Yes | No | Copies the value of the same item from the previous record into the current item. |
duplicate_record; | Yes | No | Copies the values from each item on the previous record into the corresponding items on the current record. |
edit_text_item (x, y, width, height ); | Yes | Yes | Causes the form to display the Runform text editor for the current item. The x parameter specifies the horizontal position of the editor. The y parameter specifies the vertical position. The built-in subprogram also has provisions for specifying height and width. |
enforce_column Â_security; | No | Yes | Causes the application to check column security. |
enter; | Yes | No | Performs validation checks on the current item. |
continues
Page 562
Table A.1 Continued
Built-In Name/ Parameter Syntax | Restricted | Enter Query | Description |
enter_query ; | Yes | Yes | Changes the form mode to Enter Query. |
erase (global variable name); | No | Yes |
Eliminates the specified global variable from memory. |
error_code; | No | Yes | Traps and displays the number of the Oracle Forms error. |
error_text; | No | Yes | Displays message text explaining the Forms error. |
error_type; | No | Yes | Displays the type of error.FRM indicates it is a Forms error. ORA indicates it is a database error. |
execute_query; | Yes | Yes | Causes Oracle to fetch records to the form, and to place the form into the Update mode. |
execute_trigger (trigger name); | Yes | Yes | Performs the specified trigger. |
exit_form (commit mode, roll_back mode); | Yes | Yes | Changes the mode to the Input mode when the form is in the Enter Query mode. It closes the form in all other modes. The Commit mode parameter has several parameters: Ask_commit, which prompts the operator to commit the records; Do_commit, which performs the commit; No_commit, which clears the form and does not commit the data; and No_validate, which commits the data without validating. The rollback mode tells Oracle the point to rollback the changes. The settings are: To_savepoint, Full_rollback, and No_rollback. |
fetch_records; | No | No | Initiates the fetching of records to the form. |
find_alert (alert name); | No | Yes | Identifies the ID of the alert. The ID must be returned to a defined variable. |
Page 563
Built-In Name/ Parameter Syntax | Restricted | Enter Query | Description |
find_block (block name); | No | Yes | Identifies the ID of the block. The ID must be returned to a defined variable. |
find_canvas (canvas name); | No | Yes | Identifies the ID of the canvas. The ID must be returned to a defined variable. |
find_column (record group, group column name); | No | Yes | Identifies the ID of the record group column. The ID must be returned to a defined variable. |
find_editor (editor name); | No | Yes | Identifies the ID of the editor. The ID the editor. The ID must be returned to a defined variable. |
find_form (form name); | No | Yes | Identifies the ID of the form. The ID must be returned to a defined variable. |
find_group, (record group name); | No | Yes | Identifies the ID of the record group. The ID must be returned to a defined variable. |
find_item (block_name, item_name); | No | Yes | Identifies the ID of the item. The ID must be returned to a defined variable. |
find_lov (list of values name); | No | Yes | Identifies the ID of the list of values. The ID must be returned to a defined variable. |
find_menu_item (menu_name, item _name); | No | Yes | Identifies the ID of the menu item. The ID must be returned to a defined variable. |
find_relation (relation name); | No | Yes | Identifies the ID of the relation. The ID must be returned to a defined variable. |
find_timer (timer name); | No | Yes | Identifies the ID of the timer. The ID must be returned to a defined variable. |
find_view (canvas-view name); | No | Yes | Identifies the ID of the canvas-view. The ID must be returned to a defined variable. |
find_window (window name); | No | Yes | Identifies the ID of the window. The ID must be returned to a defined variable. |
continues
Page 564
Table A.1 Continued
Built-In Name/ Parameter Syntax | Restricted | Enter Query | Description |
first_record; | Yes | No | Displays the first record in the set of records fetched to the form. |
form_failure | No | Yes | Returns a Boolean value indicating the outcome of the last form action. |
form_fatal; | No | Yes | Returns a Boolean expression indicating the result of the last action performed. Outcomes that were successful or failed return a value of false. Fatal errors return a value of true. |
form_successs; | No | Yes | Returns a Boolean expression indicating the result of the last action performed. Outcomes that fail or are fatal errors return a value of false. Success returns a value of true. |
forms_ddl (statement); | No | Yes | Issues SQL commands while operating the form. The statements may be a literal, dml, or ddl state- ment or an expression representing a block of PL/SQL code. |
forms_ole. activate_server (item id or item name); | No | No | Initiates an OLE server and prepares it to receive OLE automation events. |
forms_ole. close_server (item id or name) | No | No | Shuts down the OLE server and breaks the connection between the server and the container. |
forms_ole.exec_verb (item id or name, verb index or verb name); | No | No | Tells the OLE server to perform the command identified by the verb id or name. |
forms_ole.find_ole_verb (item id or item, verb name); | No | No | Returns the index value of an OLE verb. |
forms_ole.get_interface _pointer (item id or name); | No | No | Identifies the handle of an OLE2 automation object. |
Page 565
Built-In Name/ Parameter Syntax | Restricted | Enter Query | Description |
forms_ole.get_verb _count (item id or name); | No | No | Identifies the quantity of commands the OLE server recognizes. |
forms_ole.get_verb _name (item id or name, verb index number); | No | No | Captures and returns the name of the verb associated to the verb index number. |
forms_ole.initialize_ container (item id or name, file name); | No | No | Adds an OLE object into an OLE container when it is server compatible. |
forms_ole.server _active (item id or item name; | No | No | Returns a Boolean value indicating the server associated with the container is running. True indicates it is running, and false indicates it is not. |
generate_ sequence_number; | No | Yes | Initiates the generation of a sequence number when a sequence is defined as the default value in an item property. |
get_application_property (property name) | No | Yes | Identifies property values for the current form. |
get_block_property (block id or block name, property); | No | Yes | Returns the value of various block properties. |
get_canvas_property (canvas name or id, property). | No | Yes | Returns the value of the specified canvas property. The properties are: height, width, and visual_attribute. |
get_form_property (form id or property); | No | Yes | Returns the value of the specified form property. name, |
get_group_char_cell (group column id or name, row number); | No | Yes | Identifies the character or long value of a record group cell. A cell is a row/column intersection. |
get_group_date_cell (group column id or name, row number); | No | Yes | Identifies the date value of a record group cell. A cell is a row/column intersection. |
get_group_number_cell (group column id or name, row number); | No | Yes | Identifies the numeric value of a record group cell. A cell is a row/column intersection. |
continues
Page 566
Table A.1 Continued
Built-In Name/ Parameter Syntax | Restricted | Enter Query | Description |
get_group_row_count (record group id, or name); | No | Yes | Identifies the number of rows in a specified record group. |
get_group_selection (record group id or name, selection number); | No | Yes | Identifies the numeric position of the selected row in a record group. |
get_group_selection _count (record group id or name); | No | Yes | Identifies the total number of rows programmatically marked as selected. |
get_item_property (item id or name, property); | No | Yes | Identifies the value of the specified item property setting. |
get_list_element_count (list id or); | No | Yes | Identifies the total number of values in a pick list. |
get_list_element_label (list id or name, list_index); | No | Yes | Identifies the list label name value of the specified pick list item. |
get_list_element_value (list id or name, list index); | No | Yes | Identifies the actual value of the specified pick list item. |
get_lov_property (list of values id or name, property); | No | Yes | Identifies various list of values property settings. The properties are: auto_refresh, group_name, height, width, x_pos, and y_pos. |
get_menu_item_ property (menu item id or name, property) | No | Yes | Identifies the state of the specified menu item. The properties are: checked, enabled, and labeled. |
get_message; | No | Yes | Displays the current message. |
get_parameter_attr (list or name, parameter name, parameter type, value); | No | Yes | Identifies the type and value of the specified parameter in a parameter list. The parameter types are: data_parameter, which indicates the value is the name of the group; and text_parameter, which indicates the parameter value is an actual data value. |
Page 567
Built-In Name/ Parameter Syntax | Restricted | Enter Query | Description |
get_parameter_list (list name); | No | Yes | Identifies the parameter list ID for the specified list. |
get_radio_button_ property (item name or id, button name, property); | No | Yes | Identifies the value of the specified radio button property. The prop- erties are: displayed,enabled, height, label,visual_attribute, width, window_handle,x_pos, and y_pos. |
get_record_property (record number, block name, property); | No | Yes | Identifies the status of the specified record. The property that issup- ported is status. The various status values are: new,changed, query, and insert. |
get_relation_property (relation id or name, property); | No | Yes | Identifies the state of the specified property. The properties are: autoquery, deferred_ coordination, detail_name, master_deletes, master_name, next_detail_relation, next_master_relation, and prevent_masterless_operation. |
get_view_property (view id or name, property); | No | Yes | Identifies the value of the specified view property. The properties are: display_x_pos, display_y_pos, height, visible, width, window_ name, x_pos_on_canvas, and y_pos_on_canvas. |
get_window_property (window id or name, property); | No | Yes | Identifies the value of the specified window property. The properties are: height,remove_on_exit, title, visible, width, window_ handle, window_size, window_ state, and x_pos. |
go_block (block name); | Yes | No | Navigates to the specified block. |
go_form (form id or name); | Yes | No | Navigates to the specified form in a multiform application. |
go_item (item name or id); | Yes | Yes | Navigates to the specified item. |
continues
Page 568
Table A.1 Continued
Built-In Name/ Parameter Syntax | Restricted | Enter Query | Description |
go_record (record number); | Yes | No | Navigates to the specified record. |
help; | Yes | Yes | Shows the current item's hint message. |
hide_menu; | No | Yes | Causes the current menu to disappear when operating on Character mode platforms. |
hide_view (view name or id); | No | Yes | Causes the specified view to disappear. |
hide_window (window name or id); | No | Yes | Causes the specified window to disappear. |
host (system command, screen action); | No | Yes | Performs the specified operating system command. |
id_null (object id); | No | Yes | Returns true if the specified object is available and false if not. |
image_zoom (image_id or name, zoom type, zoom factor ); | No | Yes | Changes the amount of the image seen by zooming in or out. Zoom types consist of:adjust_to_fit, selection_rectangle, zoom_in_ factor, and zoom_percent. The zoom factor is a percentage. |
insert_record; | Yes | No | Adds the current record to the database. |
issue_rollback (savepoint name); | No | No | Issues the Rollback command. The savepoint name refers to the last time the data was committed. |
issue_savepoint (savepoint name); | No | No | Issues a savepoint. |
item_enabled (menu name, item name); | No | Yes | Returns a value of true when the menu item is enabled, and false when not. |
last_record; | Yes | No | Displays the last record in the record buffer. |
Page 569
Built-In Name/ Parameter Syntax | Restricted | Enter Query | Description |
list_value (parameter value); | Yes | No | Displays the list of values for the current item. The parameter values are: no_restrict, which tells Forms not to use the automatic search and complete feature; and restrict, which does the opposite. |
lock_record; | No | No | Causes Forms Runtime to lock the corresponding row in the database. |
logon (user name, password, display logon screen on error ); | No | Yes | Causes the form to connect to the Oracle database. Specifying true in the display logon screen para- meter causes Oracle to show the logon screen when the subprogram fails to connect with the database. |
logon_screen; | No | Yes | Displays the database logon screen. |
logout; | No | Yes | Logs off the database. |
main_menu; | Yes | Yes | Displays the application's main menu. |
menu_clear_field; | No | Yes | Removes characters in the current field to the right of the cursor position. |
menu_next_field; | Yes | Yes | Moves the cursor to the next field in an Enter Parameter Values dialog box. |
menu_parameter; | No | Yes | Shows all the current menu's parameters in the Enter Parameter Values dialog box along with their values. |
menu_previous_field; | No | Yes | Moves the cursor to the previous field in the Enter Parameter Values dialog box. |
menu_redisplay; | No | Yes | Redraws the screen in a menu. |
menu_show_keys; | No | Yes | Displays the Function Keys dialog box. |
continues
Page 570
Table A.1 Continued
Built-In Name/ Parameter Syntax | Restricted | Enter Query | Description |
message ( message literal, response ); | No | Yes | Places the specified message on the message line. The response parameter has two values: acknowledge, which displays a modal alert the operator must dismiss; or no_acknowledge, which tells Oracle that no response is necessary when two messages are issued. |
message_code; | No | Yes | Identifies the number of the most recently generated message. |
message_text; | No | Yes | Returns the text for the most recently generated message. |
message_type; | No | Yes | Identifies the type of message. Valid types are: Ora, Oracle database message; FRM, Forms error; or Null, no message was issued. |
move_window (window id or name, x, y); | No | Yes | Changes the location of the window. The x parameter is the horizontal setting and y the vertical setting. |
name_in (variable); | No | Yes | Identifies the value of the specified variable. |
new_form (form name, rollback mode, query mode, parameter list id or parameter list name ); | Yes | No | Closes the existing form and initiates ato_savepoint, all the current form's changes are rolled back to the last savepoint;no_ rollback, no rollback occurs on the current form; and full_rollback, all uncommitted changes are rolled back. Form name refers to the name of the form. The Query mode setting determines whether the form is executed in query only mode. The parameter list name identifies the list of parameters passed to the new application. |
Page 571
Built-In Name/ Parameter Syntax | Restricted | Enter Query | Description |
next_block; | Yes | No | Moves the cursor to the next block. This block is determined by the sequence setting. |
next_form; | Yes | No | Navigates to the next form in a multiform application. |
next_item; | Yes | Yes | Moves the cursor to the next item as determined by the item sequence. |
next_key; | Yes | Yes | Moves the cursor to the next item that is a primary key item. The primary key must be enabled and navigable. |
next_menu_item; | Yes | Yes | Moves the cursor to the next menu item. |
next_record; | Yes | No | Displays the next record in the record buffer. |
next_set; | Yes | No | Retrieves the next set of records from the database and moves the cursor to the first record. |
open_form (form name, activate, session, parameter id or parameter list ); | Yes | No | Opens the specified form. The activate parameter settings are: activate, makes the opened form the current form; no_activate, leaves the current form the focus. The session parameters are: no_session, tells Oracle the opened form will use the same database as the other forms; session, tells Oracle a new database session needs to be created. |
paste_region; | Yes | Yes | Pastes the contents of the clipboard buffer at the cursor location. |
pause; | No | Yes | Halts form processing until the user presses a function key. |
populate_group (group name or id); | No | Yes | Runs the record group query, returning a number indicating success (0) or failure (not 0). |
continues
Page 572
Table A.1 Continued
Built-In Name/ Parameter Syntax | Restricted | Enter Query | Description |
populate_group _with_query (record group id or name, query); | No | Yes | Replaces the rows of a record group with the results of the query. |
populate_list (list id or name, record group id or name); | No | Yes | Replaces the contents of a picklist with the values from the specified record group. |
post; | Yes | No | Sends the data from the form to the database without committing it. |
previous_block; | Yes | No | Moves the cursor to the previous block. This block is determined by the sequence setting. |
previous_form; | Yes | No | Navigates to the previous form in a multiple form application. |
previous_item; | Yes | Yes | Moves the cursor to the previous item as determined by the item sequence.|
previous_menu; | Yes | Yes | Moves the cursor to the previously active menu. |
previous_menu _item; | Yes | Yes | Moves the cursor to the previous menu item. |
previous_record; | Yes | No | Displays the previously displayed record in the record buffer. |
print; | No | Yes | Performs a screen print of the current window. |
query_parameter (parameter literal); | No | Yes | Shows the Query Parameter dialog box, which shows the values of the specified parameters. |
read_image_file (file name, file type, item name or id); | No | Yes | Displays an image from the specified file in a Forms image item. |
redisplay; | No | Yes | Clears existing messages and reinitiates the screen. |
Page 573
Built-In Name/ Parameter Syntax | Restricted | Enter Query | Description |
replace_content view (window name or,view name or id); | No | Yes | Changes the content canvas_view in the current window. |
replace_menu (menu file name, menu type, initial menu name, group name, use_file ; | No | Yes | Substitutes the new menu for the current menu. |
reset_group_ selection (record group id or record group name); | Yes | No | Unselects rows currently selected in a group. |
resize_window (window id or name, width, height); | No | Yes | Changes the size of the window to the specified dimensions. |
retrieve_list (list id or name, record group id or name); | No | Yes | Places the current list into the specified record group. |
run_product (Oracle product, file, communications style, execution style, location, list or name, display); | No | Yes | Starts the specified Oracle product and executes the file. The com- munications settings are: synchron- ous, which tells Oracle to return control to Forms after the new product has closed; and asynchron- ous, which tells Oracle to return control immediately. The execution settings are: batch or runtime. The location setting determines where the file the product will execute is located. The list or name variable specifies the parameter list to be passed to the product. The display variable specifies the name of the Forms chart item that will display the chart generated by Graphics. |
scroll_down; | Yes | No | Displays the next set of records from the record buffer. |
continues
Page 574
Table A.1 Continued
Built-In Name/ Parameter Syntax | Restricted | Enter Query | Description |
scroll_up; | Yes | No | Displays the previously displayed set of records from the record buffer. |
scroll_view (view name or id, x, y); | No | Yes | Repositions the view by changing the horizontal (x) and vertical (y) canvas property settings. |
select_all; | Yes | Yes | Grabs or selects the text in the current item. |
select_records; | Yes | No | Starts the Forms select processing. |
set_alert_property (alert id or name, alert_message_text, message); | No | Yes | Changes the message text displayed in the alert. The alert message property (second parameter) is alert_message _text. |
set_application _property (property, setting); | No | Yes | Changes a property of the current application. The property used is cursor_style. The values for this property are: busy, crosshair, default, help, and insertion. |
set_block_property (block name or id, property, value); | No | Yes | Changes a block property setting. |
set_canvas_property (canvas id or name, property, value or [x, y]); | No | Yes | Changes the value of a canvas property. The properties are: height, width, andvisual_ attribute. |
set_form_property (form name or form id, property, value); | No | Yes | Changes a form property. |
set_group_char_cell (group column name or id, row number, value); | No | Yes | Changes the value of a character group cell. |
set_group_date_cell (group column name or id, row number, value); | No | Yes | Changes the value of a date group cell. |
Page 575
Built-In Name/ Parameter Syntax | Restricted | Enter Query | Description |
set_group_number _cell (group column name or id, row number, value); | No | Yes | Changes the value of a numeric group cell. |
set_group_ selection (record group name or id, row number); | No | Yes | Selects or tags the specified row of a record group. |
set_input_focus (menu); | No | Yes | Changes the input focus to the current form's menu. |
set_item_property (item id or name, property, value or [x, y]); | No | Yes | Changes an item's property setting. |
set_lov_property (list-of-values id or name, property, value or [x, y]); | No | Yes | Changes the specified list-of- values property. |
set_menu_item _property (menu item id, property, value); | No | Yes | Changes the value of a menu property. The properties are: checked,displayed, enabled, and label. The value parameters consist of: property_true and property_false. |
set_parameter attr (list or _ name, parameter name, parameter type, value); | No | Yes | Changes the type and value of the specified parameter in a parameter list. |
set_radio_button _property (item id or name, button name, property, value or [x, y]); | No | Yes |
The properties are:displayed,
enabled, height,label, visual_
attribute, width,window_handle,
x_pos, and y_pos. |
set_record_ property (record number, block name, property, value) | No | Yes | Changes the specified record status property. The values are:changed_ status,insert_status, ;new_status, and query_status. |
continues
Page 576
Table A.1 Continued
Built-In Name/ Parameter Syntax | Restricted | Enter Query | Description |
set_relation_property (relation id or name, property, value); | No | Yes | Changes the specified relation property. |
set_timer (timer id or name, milliseconds, iterate); | No | Yes | Modifies the setting of a timer. The millisecond parameter can be set between 1 to2147483648. The no_change value keeps the current setting. The iterate values are: repeat, no_repeat, and no_change. |
set_view_property (view id or name, property, value or [x, y]; | No | Yes | Changes acanvas-view property. |
set_window_property (window id or name, property, value or [x, y]); | No | Yes | Changes a window property setting |
show_alert (alert id or name); | No | Yes | Initiates the specified alert, and returns a value that corresponds to the chosen button. |
show_background _menu; | No | Yes | Exhibits the background menu. |
show_editor (editor id or name, text in, [x, y] optional, text out, result); | No | Yes | Initiates the editor at the specified location. It passes a text string in and out of the editor. |
show_keys; | No | Yes | Exhibits the Forms function key dialog. |
show_lov (list-of-values id or name, [x, y]); | Yes | Yes | Exhibits the specified list of values. This built-in subprogram returns a Boolean value. It should be included as part of an equality expression (such as a = show_lov (lov name); |
show_menu; | No | Yes | Activates and exhibits the current menu. |
Page 577
Built-In Name/ Parameter Syntax | Restricted | Enter Query | Description |
show_view (view id or name); | No | Yes | Exhibits the specified canvas-view.> |
show_window (window id or name, [x, y] ); | No | Yes | Exhibits the specified window at the x, y coordinates. |
synchronize; | No | Yes | Allows Oracle to update the display only if two conditions are met: Navigation to a new canvas-view has occurred and Forms is at the item level. |
terminate; | Yes | No | Stops entry of values into the form or dialog box. |
unset_group_selection (record group id or name, row number); | No | Yes | Unselects rows that were marked by theset_group_selection. |
up; | Yes | No | Displays the previous record from the record buffer. |
update_record; | Yes | No | Causes Forms to update the database with the form modifications. |
user_exit (expression, error text ); | No | Yes | Initiates the user exit contained in the expression parameter. |
validate (parameter); | No | Yes | Causes Forms to execute validation> processing based on the scope of the parameter value. The values are: default_scope, form_scope, record_scope, and item_scope. |
vbx.fire_event (item id or name, event, parameter list id or name); | No | Yes | Initiates an event for a VBX control. |
vbx.get_property (item id or name, property); | No | Yes | Identifies the value of a VBX control property. |
vbx.get_value_property (item id or name); | No | Yes | Obtains the VBX control value property of a VBX control. |
continues
Page 578
Table A.1 Continued
Built-In Name/ Parameter Syntax | Restricted | Enter Query | Description |
vbx.invoke_method (item id or name, method name, w, x, y, z); | No | Yes | Performs the argument contained in the method name on the item. |
vbx.set_property (item id or name, property, value); | No | Yes | Changes the specified VBX control property. |
vbx.set_value_ property (item id or name,property); | No | Yes | Changes the specified VBX control value property. |
where_display; | No | Yes | Changes the value of the Where menu navigation option. The values are on or off. |
write_image_file (image file, file type, item id or name); | No | Yes | Places the image from an Oracle Forms image item into a file. |