SAP ABAP Interface I_OI_FORM (Form Interface)

Hierarchy

☛ SAP_BASIS (Software Component) SAP Basis Component
   ⤷ BC-FES-OFF (Application Component) SAP Desktop Office Integration
     ⤷ SOFFICEINTEGRATION (Package) Platform- and application-indep. Office integration

Properties

Interface	I_OI_FORM
Short Description	Form Interface

General Data

Package	SOFFICEINTEGRATION	Platform- and application-indep. Office integration
Created	19981202	SAP
Last changed	19991216	SAP
Unicode checks active	☑

Forward declarations

#	Type group / Object type	Type	Type Description
1	SOI	Type group use (TYPE-POOLS tp)	Type group use (TYPE-POOLS tp)

Interfaces

Interface I_OI_FORM has no interface.

Friends

Interface I_OI_FORM has no friend.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	FORM_CHECKBOX	Constant	Public	☐	Type reference (TYPE)	SOI_BOOLEAN	'C'	Checkbox ID	19990121
2	FORM_COMBOBOX	Constant	Public	☐	Type reference (TYPE)	SOI_BOOLEAN	'L'	Combobox ID	19990121
3	FORM_DELETE	Constant	Public	☐	Type reference (TYPE)	SOI_BOOLEAN	'2'	Delete List	19990121
4	FORM_NOTHING	Constant	Public	☐	Type reference (TYPE)	SOI_BOOLEAN	'0'	No Effect	19990121
5	FORM_PROPERTY	Constant	Public	☐	Type reference (TYPE)	SOI_BOOLEAN	'P'	ID of a Property	19990121
6	FORM_PROTECT	Constant	Public	☐	Type reference (TYPE)	SOI_BOOLEAN	'3'	Protect Field	19990121
7	FORM_RANGE	Constant	Public	☐	Type reference (TYPE)	SOI_BOOLEAN	'R'	ID of a Range	19990121
8	FORM_SELECT	Constant	Public	☐	Type reference (TYPE)	SOI_BOOLEAN	'1'	Select Entry	19990121
9	FORM_TEXTBOX	Constant	Public	☐	Type reference (TYPE)	SOI_BOOLEAN	'T'	ID of a Text Box	19990121

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	ADD_FIELD	Instance method	Public	Method	Adds a Field in the Document	19981202
2	DELETE_FIELDS	Instance method	Public	Method	Deletes Fields in the Document	19981202
3	DISCONNECT_FIELDS	Instance method	Public	Method	Disconnects Fields from ABAP	19981202
4	GET_DATA	Instance method	Public	Method	Gets Data from Application	19981202
5	GET_FORM_FIELDS	Instance method	Public	Method	Gets Field Names	19981202
6	LOAD_LIB	Instance method	Public	Method	Load DLL	19991103
7	PROTECT	Instance method	Public	Method	Switches Between Protected and Unprotected	19981202
8	SET_DATA	Instance method	Public	Method	Sets the Data in the Application	19981202
9	SET_MODUS	Instance method	Public	Method	Switches Between Designe and View Mode	19981202
10	SYNCHRONIZE_FIELDS	Instance method	Public	Method	Synchronizes the Document Properties and the Fields	19990920

Events

Interface I_OI_FORM has no event.

Types

Interface I_OI_FORM has no local type.

Method Signatures

Method ADD_FIELD Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ERROR	Call by reference	☐	Object reference (TYPE REF TO)	I_OI_ERROR		errors?	19981202
2	Importing	FIELD	Call by reference	☐	Type reference (TYPE)	SOI_FORM_ITEM		new field	19981202
3	Importing	NO_FLUSH	Call by reference	☐	Type reference (TYPE)	C	' '	flush?	19981202
4	Exporting	RETCODE	Call by reference	☐	Type reference (TYPE)	SOI_RET_STRING		text of the error	19981202

Method ADD_FIELD on Interface I_OI_FORM has no exception.

Method DELETE_FIELDS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ERROR	Call by reference	☐	Object reference (TYPE REF TO)	I_OI_ERROR		errors?	19981202
2	Importing	FIELDS	Call by reference	☐	Type reference (TYPE)	SOI_FORM_LIST		the list of the fields that should be deleted	19981202
3	Importing	NO_FLUSH	Call by reference	☐	Type reference (TYPE)	C	' '	flush?	19981202
4	Exporting	RETCODE	Call by reference	☐	Type reference (TYPE)	SOI_RET_STRING		text of the error	19981202

Method DELETE_FIELDS on Interface I_OI_FORM has no exception.

Method DISCONNECT_FIELDS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ERROR	Call by reference	☐	Object reference (TYPE REF TO)	I_OI_ERROR		errors?	19981202
2	Importing	FIELDS	Call by reference	☐	Type reference (TYPE)	SOI_FORM_LIST		the fields that should be disconnected	19981202
3	Importing	NO_FLUSH	Call by reference	☐	Type reference (TYPE)	C	' '	flush?	19981202
4	Exporting	RETCODE	Call by reference	☐	Type reference (TYPE)	SOI_RET_STRING		text of the error	19981202

Method DISCONNECT_FIELDS on Interface I_OI_FORM has no exception.

Method GET_DATA Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	ALL	Call by reference	☐	Type reference (TYPE)	C	' '	all datas	19981202
2	Exporting	ERROR	Call by reference	☐	Object reference (TYPE REF TO)	I_OI_ERROR		errors?	19981202
3	Exporting	FIELDS	Call by reference	☐	Type reference (TYPE)	SOI_FORM_LIST		the table of the fieldnames	19981202
4	Importing	NO_FLUSH	Call by reference	☐	Type reference (TYPE)	C	' '	flush?	19981202
5	Exporting	RETCODE	Call by reference	☐	Type reference (TYPE)	SOI_RET_STRING		text of the error	19981202

Method GET_DATA on Interface I_OI_FORM has no exception.

Method GET_FORM_FIELDS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ERROR	Call by reference	☐	Object reference (TYPE REF TO)	I_OI_ERROR		errors?	19981202
2	Exporting	FIELDS	Call by reference	☐	Type reference (TYPE)	SOI_FORM_LIST		the fields in the document	19981202
3	Importing	NO_FLUSH	Call by reference	☐	Type reference (TYPE)	C	' '	flush?	19981202
4	Exporting	RETCODE	Call by reference	☐	Type reference (TYPE)	SOI_RET_STRING		text of the error	19981202

Method GET_FORM_FIELDS on Interface I_OI_FORM has no exception.

Method LOAD_LIB Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ERROR	Call by reference	☐	Object reference (TYPE REF TO)	I_OI_ERROR		error	19991103
2	Importing	NO_FLUSH	Call by reference	☐	Type reference (TYPE)	C	''	flush?	19991103
3	Exporting	RETCODE	Call by reference	☐	Type reference (TYPE)	SOI_RET_STRING		text of error	19991103

Method LOAD_LIB on Interface I_OI_FORM has no exception.

Method PROTECT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ERROR	Call by reference	☐	Object reference (TYPE REF TO)	I_OI_ERROR		errors?	19981202
2	Importing	NO_FLUSH	Call by reference	☐	Type reference (TYPE)	C	' '	flush?	19981202
3	Importing	PROTECT	Call by reference	☐	Type reference (TYPE)	C	' '	protect?	19981202
4	Exporting	RETCODE	Call by reference	☐	Type reference (TYPE)	SOI_RET_STRING		text of the error	19981202

Method PROTECT on Interface I_OI_FORM has no exception.

Method SET_DATA Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	CLEAR	Call by reference	☐	Type reference (TYPE)	C	'X'	Clear all fields	19981202
2	Exporting	ERROR	Call by reference	☐	Object reference (TYPE REF TO)	I_OI_ERROR		errors?	19981202
3	Importing	FIELDS	Call by reference	☐	Type reference (TYPE)	SOI_FORM_LIST		the contents of the fields	19981202
4	Importing	NO_FLUSH	Call by reference	☐	Type reference (TYPE)	C	' '	flush?	19981202
5	Exporting	RETCODE	Call by reference	☐	Type reference (TYPE)	SOI_RET_STRING		text of the error	19981202

Method SET_DATA on Interface I_OI_FORM has no exception.

Method SET_MODUS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ERROR	Call by reference	☐	Object reference (TYPE REF TO)	I_OI_ERROR		errors?	19981202
2	Importing	MODUS	Call by reference	☐	Type reference (TYPE)	C	' '	design or view?	19981202
3	Importing	NO_FLUSH	Call by reference	☐	Type reference (TYPE)	C	' '	flush?	19981202
4	Exporting	RETCODE	Call by reference	☐	Type reference (TYPE)	SOI_RET_STRING		text of the error	19981202

Method SET_MODUS on Interface I_OI_FORM has no exception.

Method SYNCHRONIZE_FIELDS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ERROR	Call by reference	☐	Object reference (TYPE REF TO)	I_OI_ERROR		error?	19990920
2	Importing	NO_FLUSH	Call by reference	☐	Type reference (TYPE)	C	''	flush?	19990920
3	Exporting	RETCODE	Call by reference	☐	Type reference (TYPE)	SOI_RET_STRING		text of error	19990920

Method SYNCHRONIZE_FIELDS on Interface I_OI_FORM has no exception.

History

Last changed by/on	SAP	19991216
SAP Release Created in