Oracle Forms Developer

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, Leanne

Soylemez, Poh Lee Tan, Tony Wolfram

The programs are not intended for use in any nuclear, aviation, mass transit, medical, or other inherently

dangerous applications. It shall be the licensee¡¯s 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 such

purposes, 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 Oracle

Corporation; they are provided under a license agreement containing restrictions on use and disclosure and are

also 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 the

documentation, please report them to us in writing. Oracle Corporation does not warrant that this document is

error free. Except as may be expressly permitted in your license agreement for these programs, no part of these

programs may be reproduced or transmitted in any form or by any means, electronic or mechanical, for any

purpose, 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 of

the U.S. Government, the following notice is applicable:

Restricted Rights Notice Programs delivered subject to the DOD FAR Supplement are "commercial computer

software" and use, duplication, and disclosure of the programs, including documentation, shall be subject to the

licensing restrictions set forth in the applicable Oracle license agreement. Otherwise, programs delivered

subject to the Federal Acquisition Regulations are "restricted computer software" and use, duplication, and

disclosure of the programs shall be subject to the restrictions in FAR 52.227-19, Commercial Computer

Software - 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 are

trademarks or registered trademarks of Oracle Corporation. All other company or product names mentioned are

used for identification purposes only and may be trademarks of their respective owners.

Table of Contents

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

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

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

BUILT-IN SUBPROGRAMS .......................................................................................... 1

Built-ins overview...................................................................................................................................1

Built-in syntax.........................................................................................................................................1

Built-in named parameters ......................................................................................................................2

Built-in code examples............................................................................................................................2

Built-in object IDs...................................................................................................................................2

Built-in form coordinate units .................................................................................................................2

Built-in uppercase return values..............................................................................................................3

Restricted built-in subprograms ..............................................................................................................3

Built-in constants ....................................................................................................................................4

Individual built-in descriptions ...............................................................................................................4

ABORT_QUERY built-in.......................................................................................................................5

ACTIVATE_SERVER built-in...............................................................................................................6

ADD_GROUP_COLUMN built-in.........................................................................................................7

ADD_GROUP_ROW built-in ................................................................................................................9

ADD_LIST_ELEMENT built-in ..........................................................................................................11

ADD_OLEARGS built-in.....................................................................................................................13

ADD_PARAMETER built-in ...............................................................................................................14

ADD_TREE_DATA built-in ................................................................................................................16

ADD_TREE_NODE built-in ................................................................................................................19

APPLICATION_PARAMETER built-in..............................................................................................21

BELL built-in........................................................................................................................................22

BLOCK_MENU built-in.......................................................................................................................23

BREAK built-in ....................................................................................................................................24

CALL_FORM built-in ..........................................................................................................................25

CALL_INPUT built-in..........................................................................................................................28

CALL_OLE ..........................................................................................................................................29

CALL_OLE_ built-in .......................................................................................................30

CANCEL_REPORT_OBJECT built-in ................................................................................................31

CHECKBOX_CHECKED built-in .......................................................................................................32

CHECK_RECORD_UNIQUENESS built-in .......................................................................................34

CLEAR_BLOCK built-in .....................................................................................................................35

CLEAR_EOL built-in ...........................................................................................................................37

CLEAR_FORM built-in........................................................................................................................38

CLEAR_ITEM built-in .........................................................................................................................40

CLEAR_LIST built-in ..........................................................................................................................41

CLEAR_MESSAGE built-in ................................................................................................................43

i

CLEAR_RECORD built-in...................................................................................................................44

CLOSE_FORM built-in ........................................................................................................................45

CLOSE_SERVER built-in ....................................................................................................................46

COMMIT_FORM built-in ....................................................................................................................47

CONVERT_OTHER_VALUE built-in ................................................................................................49

COPY built-in .......................................................................................................................................50

COPY_REGION built-in ......................................................................................................................52

COPY_REPORT_OBJECT_OUTPUT built-in ...................................................................................53

COUNT_QUERY built-in ....................................................................................................................54

CREATE_GROUP built-in...................................................................................................................56

CREATE_GROUP_FROM_QUERY built-in ......................................................................................58

CREATE_OLEOBJ built-in..................................................................................................................60

CREATE_PARAMETER_LIST built-in ..............................................................................................61

CREATE_QUERIED_RECORD built-in .............................................................................................63

CREATE_RECORD built-in ................................................................................................................65

CREATE_TIMER built-in ....................................................................................................................66

CREATE_VAR built-in ........................................................................................................................68

CUT_REGION built-in.........................................................................................................................69

DBMS_ERROR_CODE built-in...........................................................................................................70

DBMS_ERROR_TEXT built-in ...........................................................................................................72

DEBUG_MODE built-in ......................................................................................................................74

DEFAULT_VALUE built-in ................................................................................................................75

DELETE_GROUP built-in ...................................................................................................................76

DELETE_GROUP_ROW built-in ........................................................................................................77

DELETE_LIST_ELEMENT built-in ....................................................................................................79

DELETE_PARAMETER built-in.........................................................................................................81

DELETE_RECORD built-in.................................................................................................................82

DELETE_TIMER built-in ....................................................................................................................84

DELETE_TREE_NODE built-in..........................................................................................................86

DESTROY_PARAMETER_LIST built-in ...........................................................................................88

DESTROY_VARIANT built-in............................................................................................................89

DISPATCH_EVENT built-in ...............................................................................................................90

DISPLAY_ERROR built-in..................................................................................................................91

DISPLAY_ITEM built-in .....................................................................................................................92

DOWN built-in .....................................................................................................................................94

DO_KEY built-in..................................................................................................................................95

DUMMY_REFERENCE built-in .........................................................................................................97

DUPLICATE_ITEM built-in ................................................................................................................98

DUPLICATE_RECORD built-in..........................................................................................................99

EDIT_TEXTITEM built-in.................................................................................................................100

ENFORCE_COLUMN_SECURITY built-in .....................................................................................102

ENTER built-in...................................................................................................................................103

ENTER_QUERY built-in ...................................................................................................................104

ERASE built-in ...................................................................................................................................106

ERROR_CODE built-in......................................................................................................................107

ERROR_TEXT built-in ......................................................................................................................108

ERROR_TYPE built-in.......................................................................................................................109

EXEC_VERB built-in.........................................................................................................................111

EXECUTE_QUERY built-in ..............................................................................................................113

EXECUTE_TRIGGER built-in ..........................................................................................................115

EXIT_FORM built-in .........................................................................................................................117

FETCH_RECORDS built-in...............................................................................................................119

FIND_ALERT built-in........................................................................................................................121

FIND_BLOCK built-in .......................................................................................................................123

FIND_CANVAS built-in ....................................................................................................................124

ii

FIND_COLUMN built-in ...................................................................................................................125

FIND_EDITOR built-in ......................................................................................................................126

FIND_FORM built-in .........................................................................................................................127

FIND_GROUP built-in .......................................................................................................................128

FIND_ITEM built-in...........................................................................................................................129

FIND_LOV built-in ............................................................................................................................130

FIND_MENU_ITEM built-in .............................................................................................................131

FIND_OLE_VERB built-in ................................................................................................................132

FIND_RELATION built-in.................................................................................................................134

FIND_REPORT_OBJECT built-in.....................................................................................................135

FIND_TAB_PAGE built-in ................................................................................................................136

FIND_TIMER built-in ........................................................................................................................137

FIND_TREE_NODE built-in .............................................................................................................138

FIND_VA built-in...............................................................................................................................140

FIND_VIEW built-in ..........................................................................................................................141

FIND_WINDOW built-in ...................................................................................................................142

FIRST_RECORD built-in...................................................................................................................143

FORM_FAILURE built-in..................................................................................................................144

FORM_FATAL built-in......................................................................................................................146

FORM_SUCCESS built-in .................................................................................................................148

FORMS_DDL built-in ........................................................................................................................150

GENERATE_SEQUENCE_NUMBER built-in .................................................................................153

GET_APPLICATION_PROPERTY built-in......................................................................................154

GET_BLOCK_PROPERTY built-in ..................................................................................................158

GET_CANVAS_PROPERTY built-in ...............................................................................................164

GET_CUSTOM_PROPERTY built-in ...............................................................................................166

GET_FILE_NAME built-in ................................................................................................................167

GET_FORM_PROPERTY built-in ....................................................................................................169

GET_GROUP_CHAR_CELL built-in................................................................................................173

GET_GROUP_DATE_CELL built-in ................................................................................................175

GET_GROUP_NUMBER_CELL built-in..........................................................................................177

GET_GROUP_RECORD_NUMBER built-in....................................................................................179

GET_GROUP_ROW_COUNT built-in..............................................................................................181

GET_GROUP_SELECTION built-in .................................................................................................182

GET_GROUP_SELECTION_COUNT built-in .................................................................................184

GET_INTERFACE_POINTER built-in .............................................................................................185

GET_ITEM_INSTANCE_PROPERTY built-in ................................................................................186

GET_ITEM_PROPERTY built-in ......................................................................................................188

GET_LIST_ELEMENT_COUNT built-in .........................................................................................198

GET_LIST_ELEMENT_LABEL built-in ..........................................................................................200

GET_LIST_ELEMENT_VALUE built-in..........................................................................................201

GET_LOV_PROPERTY built-in .......................................................................................................202

GET_MENU_ITEM_PROPERTY built-in ........................................................................................204

GET_MESSAGE built-in ...................................................................................................................206

GET_OLE_ built-in..........................................................................................................207

GET_OLEARG_ built-in.........................................................................................................208

GET_OLE_MEMBERID built-in .......................................................................................................209

GET_PARAMETER_ATTR built-in..................................................................................................210

GET_PARAMETER_LIST built-in....................................................................................................211

GET_RADIO_BUTTON_PROPERTY built-in .................................................................................212

GET_RECORD_PROPERTY built-in................................................................................................215

GET_RELATION_PROPERTY built-in ............................................................................................218

GET_REPORT_OBJECT_PROPERTY built-in ................................................................................220

GET_TAB_PAGE_PROPERTY built-in ...........................................................................................222

GET_TREE_NODE_PARENT built-in..............................................................................................224

iii

 ................
................

In order to avoid copyright disputes, this page is only a partial summary.

Google Online Preview   Download