Oracle Forms Developer

Form Builder Reference, Volume 1

Release 6i

January, 2000

Part No: A73074-01

Oracle Forms Developer: Form Builder Reference, Release 6i

Volume 1

Part No: A73074-01

Copyright 1999, Oracle Corporation. All rights reserved.

Contributors: Fred Bethke, Joan Carter, Ken Chu, Kate Dumont, Tom Haunert, Colleen McCann, LeanneSoylemez, Poh Lee Tan, Tony Wolfram

The programs are not intended for use in any nuclear, aviation, mass transit, medical, or other inherentlydangerous applications. It shall be the licensees responsibility to take all appropriate fail-safe, backup,redundancy, and other measures to ensure the safe use of such applications if the programs are used for suchpurposes, and Oracle Corporation disclaims liability for any damages caused by such use of the programs.

The programs (which include both the software and documentation) contain proprietary information of OracleCorporation; they are provided under a license agreement containing restrictions on use and disclosure and arealso protected by copyright, patent, and other intellectual and industrial property laws. Reverse engineering,disassembly, or decompilation of the programs is prohibited.

The information contained in this document is subject to change without notice. If you find any problems in thedocumentation, please report them to us in writing. Oracle Corporation does not warrant that this document iserror free. Except as may be expressly permitted in your license agreement for these programs, no part of theseprograms may be reproduced or transmitted in any form or by any means, electronic or mechanical, for anypurpose, without the express written permission of Oracle Corporation.

If the programs are delivered to the U.S. Government or anyone licensing or using the programs on behalf ofthe U.S. Government, the following notice is applicable:

Restricted Rights Notice Programs delivered subject to the DOD FAR Supplement are "commercial computersoftware" and use, duplication, and disclosure of the programs, including documentation, shall be subject to thelicensing restrictions set forth in the applicable Oracle license agreement. Otherwise, programs deliveredsubject to the Federal Acquisition Regulations are "restricted computer software" and use, duplication, anddisclosure of the programs shall be subject to the restrictions in FAR 52.227-19, Commercial ComputerSoftware - Restricted Rights (June, 1987). Oracle Corporation, 500 Oracle Parkway, Redwood City, CA 94065.

Oracle is a registered trademark, and JDeveloper, JInitiator, Oracle7, Oracle8, Oracle8i, and PL/SQL aretrademarks or registered trademarks of Oracle Corporation. All other company or product names mentioned areused for identification purposes only and may be trademarks of their respective owners.

i

Table of Contents

TABLE OF CONTENTS .................................................................................................. I

SEND US YOUR COMMENTS.................................................................................XIII

PREFACE.......................................................................................................................XV

BUILT-IN SUBPROGRAMS .......................................................................................... 1Built-ins overview...................................................................................................................................1Built-in syntax.........................................................................................................................................1Built-in named parameters ......................................................................................................................2Built-in code examples............................................................................................................................2Built-in object IDs...................................................................................................................................2Built-in form coordinate units .................................................................................................................2Built-in uppercase return values..............................................................................................................3Restricted built-in subprograms ..............................................................................................................3Built-in constants ....................................................................................................................................4Individual built-in descriptions ...............................................................................................................4ABORT_QUERY built-in.......................................................................................................................5ACTIVATE_SERVER built-in...............................................................................................................6ADD_GROUP_COLUMN built-in.........................................................................................................7ADD_GROUP_ROW built-in ................................................................................................................9ADD_LIST_ELEMENT built-in ..........................................................................................................11ADD_OLEARGS built-in.....................................................................................................................13ADD_PARAMETER built-in ...............................................................................................................14ADD_TREE_DATA built-in ................................................................................................................16ADD_TREE_NODE built-in ................................................................................................................19APPLICATION_PARAMETER built-in..............................................................................................21BELL built-in........................................................................................................................................22BLOCK_MENU built-in.......................................................................................................................23BREAK built-in ....................................................................................................................................24CALL_FORM built-in ..........................................................................................................................25CALL_INPUT built-in..........................................................................................................................28CALL_OLE ..........................................................................................................................................29CALL_OLE_ built-in .......................................................................................................30CANCEL_REPORT_OBJECT built-in ................................................................................................31CHECKBOX_CHECKED built-in .......................................................................................................32CHECK_RECORD_UNIQUENESS built-in .......................................................................................34CLEAR_BLOCK built-in ........................................................................................................... ..........35CLEAR_EOL built-in ............................................................................................................. ..............37CLEAR_FORM built-in............................................................................................................ ............38CLEAR_ITEM built-in ............................................................................................................ .............40CLEAR_LIST built-in ............................................................................................................ ..............41CLEAR_MESSAGE built-in ................................................................................................................43

ii

CLEAR_RECORD built-in...................................................................................................................44CLOSE_FORM built-in ........................................................................................................................45CLOSE_SERVER built-in ....................................................................................................................46COMMIT_FORM built-in ....................................................................................................................47CONVERT_OTHER_VALUE built-in ................................................................................................49COPY built-in .......................................................................................................................................50COPY_REGION built-in ......................................................................................................................52COPY_REPORT_OBJECT_OUTPUT built-in ...................................................................................53COUNT_QUERY built-in ....................................................................................................................54CREATE_GROUP built-in...................................................................................................................56CREATE_GROUP_FROM_QUERY built-in ......................................................................................58CREATE_OLEOBJ built-in..................................................................................................................60CREATE_PARAMETER_LIST built-in ..............................................................................................61CREATE_QUERIED_RECORD built-in .............................................................................................63CREATE_RECORD built-in ................................................................................................................65CREATE_TIMER built-in ....................................................................................................................66CREATE_VAR built-in ........................................................................................................................68CUT_REGION built-in.........................................................................................................................69DBMS_ERROR_CODE built-in...........................................................................................................70DBMS_ERROR_TEXT built-in ...........................................................................................................72DEBUG_MODE built-in ......................................................................................................................74DEFAULT_VALUE built-in ................................................................................................................75DELETE_GROUP built-in ...................................................................................................................76DELETE_GROUP_ROW built-in ........................................................................................................77DELETE_LIST_ELEMENT built-in ....................................................................................................79DELETE_PARAMETER built-in.........................................................................................................81DELETE_RECORD built-in.................................................................................................................82DELETE_TIMER built-in ....................................................................................................................84DELETE_TREE_NODE built-in..........................................................................................................86DESTROY_PARAMETER_LIST built-in ...........................................................................................88DESTROY_VARIANT built-in............................................................................................................89DISPATCH_EVENT built-in ...............................................................................................................90DISPLAY_ERROR built-in..................................................................................................................91DISPLAY_ITEM built-in .....................................................................................................................92DOWN built-in .................................................................................................................. ...................94DO_KEY built-in................................................................................................................ ..................95DUMMY_REFERENCE built-in .........................................................................................................97DUPLICATE_ITEM built-in ................................................................................................................98DUPLICATE_RECORD built-in..........................................................................................................99EDIT_TEXTITEM built-in.................................................................................................................100ENFORCE_COLUMN_SECURITY built-in .....................................................................................102ENTER built-in................................................................................................................. ..................103ENTER_QUERY built-in ........................................................................................................... ........104ERASE built-in ................................................................................................................. ..................106ERROR_CODE built-in............................................................................................................ ..........107ERROR_TEXT built-in ............................................................................................................ ..........108ERROR_TYPE built-in............................................................................................................ ...........109EXEC_VERB built-in............................................................................................................. ............111EXECUTE_QUERY built-in ..............................................................................................................113EXECUTE_TRIGGER built-in ..........................................................................................................115EXIT_FORM built-in ............................................................................................................. ............117FETCH_RECORDS built-in...............................................................................................................119FIND_ALERT built-in............................................................................................................ ............121FIND_BLOCK built-in ............................................................................................................ ...........123FIND_CANVAS built-in ........................................................................................................... .........124

iii

FIND_COLUMN built-in ...................................................................................................................125FIND_EDITOR built-in ......................................................................................................................126FIND_FORM built-in .........................................................................................................................127FIND_GROUP built-in .......................................................................................................................128FIND_ITEM built-in...........................................................................................................................129FIND_LOV built-in ............................................................................................................................130FIND_MENU_ITEM built-in .............................................................................................................131FIND_OLE_VERB built-in ................................................................................................................132FIND_RELATION built-in.................................................................................................................134FIND_REPORT_OBJECT built-in.....................................................................................................135FIND_TAB_PAGE built-in ................................................................................................................136FIND_TIMER built-in ............................................................................................................ ............137FIND_TREE_NODE built-in .............................................................................................................138FIND_VA built-in............................................................................................................... ................140FIND_VIEW built-in ............................................................................................................. .............141FIND_WINDOW built-in ........................................................................................................... ........142FIRST_RECORD built-in...................................................................................................................143FORM_FAILURE built-in..................................................................................................................144FORM_FATAL built-in............................................................................................................ ..........146FORM_SUCCESS built-in .................................................................................................................148FORMS_DDL built-in ............................................................................................................. ...........150GENERATE_SEQUENCE_NUMBER built-in .................................................................................153GET_APPLICATION_PROPERTY built-in......................................................................................154GET_BLOCK_PROPERTY built-in ..................................................................................................158GET_CANVAS_PROPERTY built-in ...............................................................................................164GET_CUSTOM_PROPERTY built-in ...............................................................................................166GET_FILE_NAME built-in ................................................................................................................167GET_FORM_PROPERTY built-in ....................................................................................................169GET_GROUP_CHAR_CELL built-in................................................................................................173GET_GROUP_DATE_CELL built-in ................................................................................................175GET_GROUP_NUMBER_CELL built-in..........................................................................................177GET_GROUP_RECORD_NUMBER built-in....................................................................................179GET_GROUP_ROW_COUNT built-in..............................................................................................181GET_GROUP_SELECTION built-in .................................................................................................182GET_GROUP_SELECTION_COUNT built-in .................................................................................184GET_INTERFACE_POINTER built-in .............................................................................................185GET_ITEM_INSTANCE_PROPERTY built-in ................................................................................186GET_ITEM_PROPERTY built-in ......................................................................................................188GET_LIST_ELEMENT_COUNT built-in .........................................................................................198GET_LIST_ELEMENT_LABEL built-in ..........................................................................................200GET_LIST_ELEMENT_VALUE built-in..........................................................................................201GET_LOV_PROPERTY built-in .......................................................................................................202GET_MENU_ITEM_PROPERTY built-in ........................................................................................204GET_MESSAGE built-in ...................................................................................................................206GET_OLE_ built-in..........................................................................................................207GET_OLEARG_ built-in.........................................................................................................208GET_OLE_MEMBERID built-in .......................................................................................................209GET_PARAMETER_ATTR built-in..................................................................................................210GET_PARAMETER_LIST built-in....................................................................................................211GET_RADIO_BUTTON_PROPERTY built-in .................................................................................212GET_RECORD_PROPERTY built-in................................................................................................215GET_RELATION_PROPERTY built-in ............................................................................................218GET_REPORT_OBJECT_PROPERTY built-in ................................................................................220GET_TAB_PAGE_PROPERTY built-in ...........................................................................................222GET_TREE_NODE_PARENT built-in..............................................................................................224

iv

GET_TREE_NODE_PROPERTY built-in .........................................................................................226GET_TREE_PROPERTY built-in......................................................................................................228GET_TREE_SELECTION built-in ....................................................................................................230GET_VA_PROPERTY built-in ..........................................................................................................232GET_VAR_BOUNDS built-in ...........................................................................................................234GET_VAR_DIMS built-in..................................................................................................................235GET_VAR_TYPE built-in..................................................................................................................236GET_VERB_COUNT built-in............................................................................................................237GET_VERB_NAME built-in..............................................................................................................239GET_VIEW_PROPERTY built-in .....................................................................................................240GET_WINDOW_PROPERTY built-in ..............................................................................................242GO_BLOCK built-in.............................................................................................................. .............244GO_FORM built-in............................................................................................................... ..............245GO_ITEM built-in ............................................................................................................... ...............246GO_RECORD built-in............................................................................................................. ...........247HELP built-in.................................................................................................................. ....................248HIDE_MENU built-in............................................................................................................. ............249HIDE_VIEW built-in............................................................................................................. .............250HIDE_WINDOW built-in...................................................................................................................251HOST built-in .................................................................................................................. ...................253ID_NULL built-in ............................................................................................................... ................255IMAGE_SCROLL built-in..................................................................................................................257IMAGE_ZOOM built-in ............................................................................................................ .........258INIT_OLEARGS built-in....................................................................................................................260INITIALIZE_CONTAINER built-in ..................................................................................................261INSERT_RECORD built-in................................................................................................................262ISSUE_ROLLBACK built-in .............................................................................................................263ISSUE_SAVEPOINT built-in.............................................................................................................264ITEM_ENABLED built-in .................................................................................................................266LAST_OLE_ERROR built-in .............................................................................................................267LAST_OLE_EXCEPTION built-in ....................................................................................................268LAST_RECORD built-in....................................................................................................................269LIST_VALUES built-in......................................................................................................................270LOCK_RECORD built-in...................................................................................................................271LOGON built-in..................................................................................................................................272LOGON_SCREEN built-in.................................................................................................................274LOGOUT built-in ...............................................................................................................................276MENU_CLEAR_FIELD built-in........................................................................................................277MENU_NEXT_FIELD built-in ..........................................................................................................278MENU_PARAMETER built-in ..........................................................................................................279MENU_PREVIOUS_FIELD built-in .................................................................................................280MENU_REDISPLAY built-in ............................................................................................................281MENU_SHOW_KEYS built-in ..........................................................................................................282MESSAGE built-in .............................................................................................................................283MESSAGE_CODE built-in ................................................................................................................285MESSAGE_TEXT built-in .................................................................................................................286MESSAGE_TYPE built-in .................................................................................................................287MOVE_WINDOW built-in.................................................................................................................289NAME_IN built-in..............................................................................................................................291NEW_FORM built-in .........................................................................................................................295NEXT_BLOCK built-in......................................................................................................................298NEXT_FORM built-in........................................................................................................................299NEXT_ITEM built-in .........................................................................................................................300NEXT_KEY built-in ...........................................................................................................................301NEXT_MENU_ITEM built-in............................................................................................................302

v

NEXT_RECORD built-in ...................................................................................................................303NEXT_SET built-in ............................................................................................................................304OLEVAR_EMPTY built-in ................................................................................................................305OPEN_FORM built-in ........................................................................................................................306PASTE_REGION built-in...................................................................................................................309PAUSE built-in ...................................................................................................................................310PLAY_SOUND built-in......................................................................................................................311POPULATE_GROUP built-in ............................................................................................................312POPULATE_GROUP_FROM_TREE built-in ...................................................................................313POPULATE_GROUP_WITH_QUERY built-in ................................................................................315POPULATE_LIST built-in .................................................................................................................317POPULATE_TREE built-in ...............................................................................................................319POST built-in ......................................................................................................................................320PREVIOUS_BLOCK built-in .............................................................................................................321PREVIOUS_FORM built-in ...............................................................................................................322PREVIOUS_ITEM built-in.................................................................................................................323PREVIOUS_MENU built-in...............................................................................................................324PREVIOUS_MENU_ITEM built-in ...................................................................................................325PREVIOUS_RECORD built-in ..........................................................................................................326PRINT built-in ................................................................................................................. ...................327PTR_TO_VAR built-in............................................................................................................ ...........328QUERY_PARAMETER built-in ........................................................................................................329READ_IMAGE_FILE built-in............................................................................................................331READ_SOUND_FILE built-in ...........................................................................................................333RECALCULATE built-in ........................................................................................................... ........335REDISPLAY built-in............................................................................................................. .............336RELEASE_OBJ built-in ........................................................................................................... ..........337REPLACE_CONTENT_VIEW built-in .............................................................................................338REPLACE_MENU built-in ................................................................................................................340REPORT_OBJECT_STATUS built-in ...............................................................................................342RESET_GROUP_SELECTION built-in.............................................................................................343RESIZE_WINDOW built-in...............................................................................................................344RETRIEVE_LIST built-in ..................................................................................................................346RUN_PRODUCT built-in........................................................................................................... ........347RUN_REPORT_OBJECT built-in .....................................................................................................350SCROLL_DOWN built-in ..................................................................................................................351SCROLL_UP built-in..........................................................................................................................352SCROLL_VIEW built-in ....................................................................................................................353SELECT_ALL built-in........................................................................................................................355SELECT_RECORDS built-in .............................................................................................................356SERVER_ACTIVE built-in ................................................................................................................357SET_ALERT_BUTTON_PROPERTY built-in .................................................................................358SET_ALERT_PROPERTY built-in....................................................................................................359SET_APPLICATION_PROPERTY built-in ......................................................................................361SET_BLOCK_PROPERTY built-in ...................................................................................................362SET_CANVAS_PROPERTY built-in ................................................................................................367SET_CUSTOM_ITEM_PROPERTY built-in ....................................................................................369SET_CUSTOM_PROPERTY built-in ................................................................................................370SET_FORM_PROPERTY built-in .....................................................................................................372SET_GROUP_CHAR_CELL built-in ................................................................................................376SET_GROUP_DATE_CELL built-in.................................................................................................377SET_GROUP_NUMBER_CELL built-in ..........................................................................................379SET_GROUP_SELECTION built-in..................................................................................................380SET_INPUT_FOCUS built-in ............................................................................................................381SET_ITEM_INSTANCE_PROPERTY built-in .................................................................................382

vi

SET_ITEM_PROPERTY built-in ......................................................................................................385SET_LOV_COLUMN_PROPERTY built-in .....................................................................................397SET_LOV_PROPERTY built-in ........................................................................................................398SET_MENU_ITEM_PROPERTY built-in .........................................................................................400SET_OLE built-in ............................................................................................................... ................402SET_PARAMETER_ATTR built-in ..................................................................................................403SET_RADIO_BUTTON_PROPERTY built-in ..................................................................................404SET_RECORD_PROPERTY built-in ................................................................................................407SET_RELATION_PROPERTY built-in ............................................................................................409SET_REPORT_OBJECT_PROPERTY built-in ................................................................................411SET_TAB_PAGE_PROPERTY built-in ............................................................................................413SET_TIMER built-in ............................................................................................................. .............415SET_TREE_NODE_PROPERTY built-in .........................................................................................417SET_TREE_PROPERTY built-in ......................................................................................................419SET_TREE_SELECTION built-in .....................................................................................................422SET_VA_PROPERTY built-in...........................................................................................................424SET_VAR built-in ............................................................................................................... ...............426SET_VIEW_PROPERTY built-in ......................................................................................................427SET_WINDOW_PROPERTY built-in ...............................................................................................429SHOW_ALERT built-in ............................................................................................................ .........432SHOW_EDITOR built-in ...................................................................................................................433SHOW_KEYS built-in............................................................................................................. ...........435SHOW_LOV built-in.............................................................................................................. ............436SHOW_MENU built-in ............................................................................................................. .........438SHOW_VIEW built-in............................................................................................................. ...........439SHOW_WINDOW built-in.................................................................................................................440SYNCHRONIZE built-in....................................................................................................................441TERMINATE built-in............................................................................................................. ............442TO_VARIANT built-in............................................................................................................ ...........443UNSET_GROUP_SELECTION built-in ............................................................................................445UP built-in.................................................................................................................... .......................446UPDATE_CHART built-in.................................................................................................................447UPDATE_RECORD built-in ..............................................................................................................448USER_EXIT built-in ............................................................................................................. .............449VALIDATE built-in.............................................................................................................. ..............451VARPTR_TO_VAR built-in ..............................................................................................................453VAR_TO_TABLE built-in .................................................................................................................454VAR_TO_ built-in...................................................................................................................455VAR_TO_VARPTR built-in ..............................................................................................................456VBX.FIRE_EVENT built-in...............................................................................................................457VBX.GET_PROPERTY built-in ........................................................................................................459VBX.GET_VALUE_PROPERTY built-in .........................................................................................461VBX.INVOKE_METHOD built-in ....................................................................................................462VBX.SET_PROPERTY built-in .........................................................................................................463VBX.SET_VALUE_PROPERTY built-in..........................................................................................465WEB.SHOW_DOCUMENT built-in..................................................................................................466WHERE_DISPLAY built-in...............................................................................................................467WRITE_IMAGE_FILE built-in..........................................................................................................468WRITE_SOUND_FILE built-in .........................................................................................................470

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

vii

Logging on to the Database.................................................................................................................477Forms Runtime Options ......................................................................................................................478Array (Forms Runtime).......................................................................................................................480Block_Menu (Forms Runtime) ...........................................................................................................481Buffer_Records (Forms Runtime).......................................................................................................482Debug (Forms Runtime)......................................................................................................................483Debug_Messages (Forms Runtime) ....................................................................................................484Help (Forms Runtime) ........................................................................................................... .............485Interactive (Forms Runtime) ...............................................................................................................486Keyin (Forms Runtime) ......................................................................................................................487Keyout (Forms Runtime) ....................................................................................................................488Logon_Screen (Forms Runtime).........................................................................................................489Optimize SQL Processing (Forms Runtime).......................................................................................490Optimize Transaction Mode Processing (Forms Runtime) .................................................................491Options_Screen (Forms Runtime).......................................................................................................492Output_File (Forms Runtime).............................................................................................................493PECS (Forms Runtime)........................................................................................................... ............494Query_Only (Forms Runtime) ............................................................................................................495Quiet (Forms Runtime) .......................................................................................................................496Statistics (Forms Runtime)..................................................................................................................497Term (Forms Runtime) ........................................................................................................... ............498Window_State (Forms Runtime).........................................................................................................499Setting Form Compiler Options ..........................................................................................................500Add_Triggers (Form Compiler) ..........................................................................................................502Batch (Form Compiler) .......................................................................................................................503Build (Form Compiler) .......................................................................................................................504Compile_All (Form Compiler)............................................................................................................505CRT_File (Form Compiler) ................................................................................................................506Debug (Form Compiler)......................................................................................................................507Delete (Form Compiler)......................................................................................................................508Extract (Form Compiler).....................................................................................................................509Help (Form Compiler) ........................................................................................................... .............510Insert (Form Compiler) .......................................................................................................................511Logon (Form Compiler)......................................................................................................................512Module_Access (Form Compiler).......................................................................................................513Module_Type (Form Compiler)..........................................................................................................514Nofail (Form Compiler) ......................................................................................................................515Options_Screen (Form Compiler) .......................................................................................................516Output_File (Form Compiler) .............................................................................................................517Parse (Form Compiler)........................................................................................................................518Script (Form Compiler).......................................................................................................................519Statistics (Form Compiler)..................................................................................................................520Strip_Source (Form Compiler) ...........................................................................................................521Upgrade (Form Compiler) ..................................................................................................................522Upgrade_Roles (Form Compiler) .......................................................................................................523Version (Form Compiler)....................................................................................................................524Widen_Fields (Form Compiler) ..........................................................................................................525Setting Form Builder Preferences .......................................................................................................526Color Mode ..................................................................................................................... ....................528Color Palette .................................................................................................................. .....................529Build Before Running ........................................................................................................... ..............530Help (Form Builder) ............................................................................................................ ...............531HTML File Name ................................................................................................................. ..............532Access preference (Form Builder) ......................................................................................................533Module_Type (Form Builder).............................................................................................................534

viii

Printer .................................................................................................................................................535Run Modules Asynchronously ............................................................................................................536Save Before Building ..........................................................................................................................537Subclassing Path .................................................................................................................................538Suppress Hints ....................................................................................................................................539Term (Form Builder)...........................................................................................................................540USESDI (Forms Runtime and Web Forms Runtime) .........................................................................541Use System Editor...............................................................................................................................542User Preference File............................................................................................................................543Welcome Dialog .................................................................................................................................544Welcome Pages...................................................................................................................................545

PROPERTIES............................................................................................................... 546What are properties? ...........................................................................................................................546About setting and modifying properties..............................................................................................546Reading property descriptions.............................................................................................................547About Control property.......................................................................................................................548Access Key property ...........................................................................................................................549Alert Style property.............................................................................................................................550Alias property......................................................................................................................................551Allow Expansion property ..................................................................................................................552Allow Empty Branches property.........................................................................................................553Allow Multi-Line Prompts property....................................................................................................554Allow Start-Attached Prompts property..............................................................................................555Allow Top-Attached Prompts property...............................................................................................556Application Instance property .............................................................................................................557Arrow Style property...........................................................................................................................558Associated Menus property.................................................................................................................559Audio Channels property ....................................................................................................................560Automatic Column Width property.....................................................................................................561Automatic Display property................................................................................................................562Automatic Position property ...............................................................................................................563Automatic Query property ..................................................................................................................564Automatic Refresh property................................................................................................................565Automatic Select property...................................................................................................................567Automatic Skip (Item) property ..........................................................................................................568Automatic Skip (LOV) property .........................................................................................................569Background_Color property ...............................................................................................................570Bevel property.....................................................................................................................................571Block Description property .................................................................................................................572Bottom Title (Editor) property ............................................................................................................573Bounding Box Scalable property ........................................................................................................574Builtin_Date_Format property ............................................................................................................575Button 1 Label, Button 2 Label, Button 3 Label properties ................................................................577Calculation Mode property .................................................................................................................578Calling_Form property........................................................................................................................579Canvas property ..................................................................................................................................580Canvas Type property .........................................................................................................................581Cap Style property ..............................................................................................................................582Case Insensitive Query property .........................................................................................................583Case Restriction property....................................................................................................................584Character Cell WD/HT properties ......................................................................................................585Chart Type property ............................................................................................................................586Chart Subtype property .......................................................................................................................587

ix

Check Box Mapping of Other Values property...................................................................................588Checked property ................................................................................................................................589Clip Height property ...........................................................................................................................590Clip Width property ............................................................................................................................591Clip X Position property .....................................................................................................................592Clip Y Position property .....................................................................................................................593Close Allowed property ......................................................................................................................594Closed property...................................................................................................................................595Column Mapping Properties property.................................................................................................596Column Name property.......................................................................................................................598Column Specifications property..........................................................................................................599Column Title (LOV) property .............................................................................................................601Column Value (Record Group) property ............................................................................................602Command Text property .....................................................................................................................603Command Type property ....................................................................................................................604Comments property.............................................................................................................................606Communication Mode (Chart) property..............................................................................................607Communication Mode (Report) property............................................................................................608Compress property ..............................................................................................................................609Compression Quality property ............................................................................................................610Conceal Data property ........................................................................................................................611Connect_String property .....................................................................................................................612Console Window property ..................................................................................................................613Control Help property .........................................................................................................................614Control Properties property.................................................................................................................615Coordinate System property................................................................................................................616Coordination property .........................................................................................................................618Coordination_Status property .............................................................................................................620Copy Value from Item property ..........................................................................................................621Current Record Visual Attribute Group property................................................................................622Current_Form property .......................................................................................................................623Current_Form_Name property............................................................................................................624Current_Record property ....................................................................................................................625Current_Row_Background_Color property ........................................................................................626Current_Row_Fill_Pattern property....................................................................................................627Current_Row_Font_Name property....................................................................................................628Current_Row_Font_Size property ......................................................................................................629Current_Row_Font_Spacing property ................................................................................................630Current_Row_Font_Style property .....................................................................................................631Current_Row_Font_Weight property..................................................................................................632Current_Row_Foreground_Color property .........................................................................................633Current_Row_White_On_Black property...........................................................................................634Cursor Mode property.........................................................................................................................635Cursor_Style property .........................................................................................................................637Custom Spacing property....................................................................................................................638Dash Style property.............................................................................................................................639Data Block Description property ........................................................................................................640Data Query property............................................................................................................................641Data Source Data Block (Chart) property ...........................................................................................642Data Source Data Block (Report) property .........................................................................................643Data Source X Axis property ..............................................................................................................644Data Source Y Axis property ..............................................................................................................645Data Type property ............................................................................................................. ................646Data Type (Record Group) property ...................................................................................................651Database Block property .....................................................................................................................652

x

Database_Value property ....................................................................................................................653Datasource property ............................................................................................................ ................654Date_Format_Compatibility_Mode property......................................................................................655Default Alert Button property .............................................................................................................656Default Button property ......................................................................................................................657Default Font Scaling property .............................................................................................................658Deferred property.............................................................................................................. ..................659Defer Required Enforcement property ................................................................................................660Delete Allowed property .....................................................................................................................661Delete Procedure Arguments property ................................................................................................662Delete Procedure Name property ........................................................................................................663Delete Procedure Result Set Columns property ..................................................................................664Delete Record Behavior property .......................................................................................................665Detail Block property..........................................................................................................................666Detail Reference Item property ...........................................................................................................667Direction property ............................................................................................................. ..................668Display Hint Automatically property ..................................................................................................672Display in Keyboard Help/Keyboard Text property.........................................................................673Display Quality property.....................................................................................................................674Display Width (LOV) property ...........................................................................................................675Display without Privilege property .....................................................................................................676Display_Height property.....................................................................................................................677Display_Width property......................................................................................................................678Displayed property..............................................................................................................................679Distance Between Records property ...................................................................................................680Dither property....................................................................................................................................681DML Array Size property ...................................................................................................................682DML Data Target Name property.......................................................................................................683DML Data Target Type property ........................................................................................................684DML Returning Value property..........................................................................................................685Edge Background Color property .......................................................................................................686Edge Foreground Color property ........................................................................................................687Edge Pattern property .........................................................................................................................688Editor property ....................................................................................................................................689Editor X Position, Editor Y Position properties ..................................................................................690Elements in List property ....................................................................................................................691Enabled (Item) property ......................................................................................................................692Enabled (Menu Item) property............................................................................................................693Enabled (Tab Page) property ..............................................................................................................694End Angle property............................................................................................................. ................695Enforce Column Security property......................................................................................................696Enforce Primary Key (Block) property ...............................................................................................697Enterable property............................................................................................................. ..................698Error_Date/Datetime_Format property ...............................................................................................699Execution Mode properties .................................................................................................................700Execution Mode (Chart) property .......................................................................................................701Execution Mode (Report) property .....................................................................................................702Execution Hierarchy property .............................................................................................................703Filename property .............................................................................................................. .................704Fill property .................................................................................................................. ......................705Fill_Pattern property ...........................................................................................................................706Filter Before Display property ............................................................................................................707Fire in Enter-Query Mode property ....................................................................................................708First Navigation Block property..........................................................................................................709First_Block property ...........................................................................................................................710

xi

First_Detail_Relation property............................................................................................................711First_Item property ............................................................................................................ .................712First_Master_Relation property ..........................................................................................................713Fixed Bounding Box property.............................................................................................................714Fixed Length (Item) property..............................................................................................................715Fixed Length (Menu Substitution Parameter) property.......................................................................716Flag User Value Too Long property ...................................................................................................717Font_Name property ............................................................................................................. ..............718Font_Size property............................................................................................................. .................719Font_Spacing property........................................................................................................................720Font_Style property.............................................................................................................................721Font_Weight property .........................................................................................................................722Foreground_Color property ................................................................................................................723Form Horizontal Toolbar Canvas property .........................................................................................724Form Vertical Toolbar Canvas property .............................................................................................725

INDEX............................................................................................................................ 726

xiii

Send Us Your Comments

Forms Developer Form Builder Reference, Release 6i

Volume 1

Part No: A73074-01

Oracle Corporation welcomes your comments and suggestions on the quality and usefulness of thispublication. 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 tooddoc@us.oracle.com.

If you have any problems with the software, please contact your local Oracle World Wide Support Center.

xv

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 Builderand contains detailed information about the following:

Built-in subprograms

Options

Properties

System variables

Triggers

This preface explains how this users guide is organized and introduces other sources of information thatcan help you use Forms Developer Form Builder.

Prerequisites

You should be familiar with your computer and its operating system. For example, you should know thecommands for deleting and copying files and understand the concepts of search paths, subdirectories, andpath names. Refer to your Microsoft Windows 95 or NT and DOS product documentation for moreinformation. You should also understand the fundamentals of Microsoft Windows, such as the elements ofan application window. You should also be familiar with such programs as the Explorer, Taskbar or TaskManager, and Registry.

Notational Conventions

The following typographical conventions are used in this guide:

Convention Meaning

fixed-width font 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 enteredexactly as shown.

lowercase Lowercase characters in a command statement represent a variable. Substituteand appropriate value.

UPPERCASE Uppercase characters within the text represent command names, SQL reservedwords, and keywords.

boldface Boldface is used to indicate user interface items such as menu choices andbuttons.

C> Represents the DOS prompt. Your prompt may differ.

1

Built-in Subprograms

Built-ins overview

Form Builder provides built-in subprograms that you can call from triggers and user-named subprogramsthat you write yourself. Built-ins provide programmatic control over standard application functions,including navigation, interface control, and transaction processing.

This section includes information on the following:

Built-in syntax

Built-in named parameters

Built-in code examples

Built-in object IDs

Restricted built-in subprograms

Built-in constants

Built-in syntax

Named parameters are shown in an italic monospaced font. You can replace any named parameter withthe 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 isa CHAR value. The milliseconds parameter is passed as a number and, as such, does not require singlequotes. The iterate parameter is passed as a constant, and, as such, must be entered exactly as shown inthe parameter description, without single quotes. Capitalization is unimportant.

In those cases where a number of optional elements are available, various alternate syntax statements arepresented. These alternatives are presented to preclude having to decipher various complicatedsyntactical conventions.

Note that you sometimes use variables instead of including a specific object name. In those cases, do notenclose the variable within single quotes. The following example illustrates a When-Timer-Expiredtrigger 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;

2

Built-in named parameters

The named parameter should be followed with the equal/greater than signs (=>), which point to theactual parameter that follows the named parameter. For example, if you intend to change themilliseconds 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 ofthe syntax. Others are more complex illustrations of how to use the Built-in either alone or inconjunction 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 areshown in capital letters for easier readability.

Named parameters, when illustrated, are shown in an italic typeface. If you choose to use namedparameters, enter these parameter names exactly as shown, without quotes and follow them with theequal/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 (_), andsemicolons(;) should be ignored.

Built-in object IDs

Some built-in subprograms accept object IDs as actual parameters. An object ID is an internal, opaquehandle that is assigned to each object when created in the Form Builder. Object IDs are internallymanaged and cannot be externally viewed by the user. The only method you can use to retrieve the ID isto 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 aPL/SQL block, you can use the variable as an object ID while still in that block. The valid PL/SQL typefor each object is included in the syntax descriptions for each parameter. The description for theFIND_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

3

WIDTH

DISPLAY_POSITION

VIEWPORT_X_POS

VIEWPORT_Y_POS

VIEW_SIZE

VIEWPORT_X_POS_ON_CANVAS

VIEWPORT_Y_POS_ON_CANVAS

When you specify coordinates or width and height, you express these measurements in units of thecurrent form coordinate system, set on the Form Module property sheet. The form coordinate systemdefines the units for specifying size and position coordinates of objects in the Form Builder. Use theCoordinate System form module property to set the forms 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 coordinatesare expressed in character cells, so Form Builder accepts only whole numbers for size and positionproperties.

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

Built-in uppercase return values

The GET_X_PROPERTY built-ins, such as GET_FORM_PROPERTY, return CHAR arguments asuppercase 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 internalnavigation. 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 isnavigating from object to another.

Restricted built-ins can be called from the When triggers that are specific to interface items, such asWhen-Button-Pressed or When-Checkbox-Changed. Restricted built-ins can also be called from any ofthe 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.

4

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

Built-in constants

Many of the built-in subprograms take numeric values as arguments. Often, constants have been definedfor these numeric arguments. A constant is a named numeric value. When passing a constant to a built-in 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 arelisted in the descriptions for each parameter.

In the following example, BLOCK_SCOPE is a constant that can be supplied for the parameter constantVALIDATION_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 thefollowing 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 areshown. For example, if the target object of a built-in can be called by name or by object ID, then bothforms 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