SAP ABAP Interface I_OI_CONTAINER_CONTROL (Document Container Control 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
SAP_BASIS (Software Component) SAP Basis Component⤷
BC-FES-OFF (Application Component) SAP Desktop Office Integration⤷
SOFFICEINTEGRATION (Package) Platform- and application-indep. Office integration
Meta Relationship - Used By
| # | Relationship type | Used by | Short Description | Created on |
|---|---|---|---|---|
| 1 | Interface composition (i COMPRISING i_ref) | I_OI_OLE_CONTAINER_CONTROL | Document Container Control Interface (Obsolete) | 19981120 |
Properties
| Interface | I_OI_CONTAINER_CONTROL | |
| Short Description | Document Container Control Interface |
General Data
| Package | SOFFICEINTEGRATION | Platform- and application-indep. Office integration |
| Created | 19981120 | SAP |
| Last changed | 19981120 | SAP |
| Unicode checks active |
Forward declarations
| # | Type group / Object type | Type | Type Description |
|---|---|---|---|
| 1 | CL_GUI_CFW | Forward declaration class (CLASS c DEFINITION DEFERRED) | Forward declaration class (CLASS c DEFINITION DEFERRED) |
| 2 | CNTL | Type group use (TYPE-POOLS tp) | Type group use (TYPE-POOLS tp) |
| 3 | SOI | Type group use (TYPE-POOLS tp) | Type group use (TYPE-POOLS tp) |
Interfaces
Interface I_OI_CONTAINER_CONTROL has no interface.
Friends
Interface I_OI_CONTAINER_CONTROL has no friend.
Attributes
| # | Attribute | Level | Visibility | Read only | Typing | Associated Type | Initial Value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | DOCUMENT_FORMAT_COMPOUND | Constant | Public | Type reference (TYPE) | CHAR3 | 'OLE' | Compound Document Format | 19981120 | |
| 2 | DOCUMENT_FORMAT_NATIVE | Constant | Public | Type reference (TYPE) | CHAR6 | 'NATIVE' | Application-Specific Format | 19981120 | |
| 3 | DOCUMENT_FORMAT_RTF | Constant | Public | Type reference (TYPE) | CHAR3 | 'RTF' | Rich Text Format | 19981120 | |
| 4 | DOCUMENT_FORMAT_TEXT | Constant | Public | Type reference (TYPE) | CHAR4 | 'TEXT' | Text Format | 19981120 | |
| 5 | INPLACE_MODE_ENABLED | Constant | Public | Type reference (TYPE) | I | 1 | 19981120 | ||
| 6 | INPLACE_MODE_NOTOOLS | Constant | Public | Type reference (TYPE) | I | 2 | 19981120 | ||
| 7 | INPLACE_MODE_RESIZE | Constant | Public | Type reference (TYPE) | I | 4 | 19981120 | ||
| 8 | INPLACE_MODE_SCROLL | Constant | Public | Type reference (TYPE) | I | 8 | 19981120 |
Methods
| # | Method | Level | Visibility | Method type | Description | Created on |
|---|---|---|---|---|---|---|
| 1 | CHECK_REGISTERED_DOC_TYPES |
Instance method | Public | Method | Checks Whether the Required Applications Exist | 19981120 |
| 2 | DESTROY_CONTROL |
Instance method | Public | Method | Destroys Control | 19981120 |
| 3 | GET_CONTROL_HANDLE |
Instance method | Public | Method | Obsolete: Use GET_CONTROL_OBJECT Instead | 19981120 |
| 4 | GET_CONTROL_OBJECT |
Instance method | Public | Method | Returns a Reference to the Control Object | 19981124 |
| 5 | GET_DOCUMENT_PROXY |
Instance method | Public | Method | Creates an Instance for Document Management | 19981120 |
| 6 | GET_EXTENSIONS |
Instance method | Public | Method | Get Extensions for ProgID from Registry | 19991015 |
| 7 | GET_LINK_SERVER |
Instance method | Public | Method | Creates an Instance for the Link Server | 19981120 |
| 8 | GET_REGISTERED_DOC_TYPES |
Instance method | Public | Method | Returns a List of All Existing Applications | 19981120 |
| 9 | GET_TABLE_COLLECTION |
Instance method | Public | Method | Returns an Instance for Managing the Table Collection | 19981120 |
| 10 | INIT_CONTROL |
Instance method | Public | Method | Creates and Initializes the Control | 19981120 |
| 11 | LINK_CONTROL |
Instance method | Public | Method | Obsolete: Link Using Container Objects | 19981120 |
| 12 | RELEASE_ALL_DOCUMENTS |
Instance method | Public | Method | Releases all Frontend Resources for All Documents | 19981120 |
| 13 | SET_FOCUS |
Instance method | Public | Method | Sets Focus to the Control | 19981120 |
| 14 | SET_INPLACE_BORDER_SPACE |
Instance method | Public | Method | Obsolete | 19981120 |
| 15 | SET_WINDOW_PROPERTIES |
Instance method | Public | Method | Obsolete: Use Container Methods Instead | 19981120 |
Events
Interface I_OI_CONTAINER_CONTROL has no event.
Types
Interface I_OI_CONTAINER_CONTROL has no local type.
Method Signatures
Method CHECK_REGISTERED_DOC_TYPES Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 |  Changing |
DESCR_LIST | Call by reference | Type reference (TYPE) | SOI_DOCUMENT_TYPE_DESCR_LIST | 19981120 | |||
| 2 |  Exporting |
ERROR | Call by reference | Object reference (TYPE REF TO) | I_OI_ERROR | 19981120 | |||
| 3 |  Importing |
NO_FLUSH | Value transfer | Type reference (TYPE) | C | ' ' | 19981120 | ||
| 4 | Changing |
RETCODE | Call by reference | Type reference (TYPE) | SOI_RET_STRING | 19981120 |
Method CHECK_REGISTERED_DOC_TYPES on Interface I_OI_CONTAINER_CONTROL has no exception.
Method DESTROY_CONTROL 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 | 19981120 | |||
| 2 | Importing |
NO_FLUSH | Value transfer | Type reference (TYPE) | C | ' ' | 19981120 | ||
| 3 | Exporting |
RETCODE | Call by reference | Type reference (TYPE) | SOI_RET_STRING | 19981120 |
Method DESTROY_CONTROL on Interface I_OI_CONTAINER_CONTROL has no exception.
Method GET_CONTROL_HANDLE 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 | 19981120 | |||
| 2 | Exporting |
HANDLE | Call by reference | Type reference (TYPE) | CNTL_HANDLE | Control-Handle | 19981124 | ||
| 3 | Importing |
NO_FLUSH | Value transfer | Type reference (TYPE) | C | ' ' | 19981120 | ||
| 4 | Exporting |
RETCODE | Call by reference | Type reference (TYPE) | SOI_RET_STRING | 19981120 |
Method GET_CONTROL_HANDLE on Interface I_OI_CONTAINER_CONTROL has no exception.
Method GET_CONTROL_OBJECT Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Exporting |
CONTROL | Call by reference | Object reference (TYPE REF TO) | CL_GUI_CONTROL | Referenz auf das Control | 19981124 | ||
| 2 | Exporting |
ERROR | Call by reference | Object reference (TYPE REF TO) | I_OI_ERROR | 19981124 | |||
| 3 | Importing |
NO_FLUSH | Value transfer | Type reference (TYPE) | C | ' ' | 19981124 | ||
| 4 | Exporting |
RETCODE | Call by reference | Type reference (TYPE) | SOI_RET_STRING | 19981124 |
Method GET_CONTROL_OBJECT on Interface I_OI_CONTAINER_CONTROL has no exception.
Method GET_DOCUMENT_PROXY Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
DOCUMENT_FORMAT | Call by reference | Type reference (TYPE) | C | 'NATIVE' | 19981120 | ||
| 2 | Exporting |
DOCUMENT_PROXY | Call by reference | Object reference (TYPE REF TO) | I_OI_DOCUMENT_PROXY | 19981120 | |||
| 3 | Importing |
DOCUMENT_TYPE | Call by reference | Type reference (TYPE) | C | 19981120 | |||
| 4 | Exporting |
ERROR | Call by reference | Object reference (TYPE REF TO) | I_OI_ERROR | 19981120 | |||
| 5 | Importing |
NO_FLUSH | Value transfer | Type reference (TYPE) | C | ' ' | 19981120 | ||
| 6 | Importing |
REGISTER_CONTAINER | Call by reference | Type reference (TYPE) | C | ' ' | 19981120 | ||
| 7 | Exporting |
RETCODE | Call by reference | Type reference (TYPE) | SOI_RET_STRING | 19981120 |
Method GET_DOCUMENT_PROXY on Interface I_OI_CONTAINER_CONTROL has no exception.
Method GET_EXTENSIONS Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
DOCUMENT_TYPE | Call by reference | Type reference (TYPE) | SOI_DOCUMENT_TYPE | ProgID | 19991015 | ||
| 2 | Exporting |
ERROR | Call by reference | Object reference (TYPE REF TO) | I_OI_ERROR | Fehlerobjekt | 19991015 | ||
| 3 | Changing |
EXTENSIONS | Call by reference | Type reference (TYPE) | SOI_COLNAMES_TABLE | Tabelle mit Extensions | 19991015 | ||
| 4 | Importing |
NO_FLUSH | Value transfer | Type reference (TYPE) | C | ' ' | Flushverhalten | 19991015 | |
| 5 | Exporting |
RETCODE | Call by reference | Type reference (TYPE) | SOI_RET_STRING | Returncode | 19991015 |
Method GET_EXTENSIONS on Interface I_OI_CONTAINER_CONTROL has no exception.
Method GET_LINK_SERVER 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 | 19981120 | |||
| 2 | Exporting |
LINK_SERVER | Call by reference | Object reference (TYPE REF TO) | I_OI_LINK_SERVER | 19981120 | |||
| 3 | Importing |
NO_FLUSH | Value transfer | Type reference (TYPE) | C | ' ' | 19981120 | ||
| 4 | Exporting |
RETCODE | Call by reference | Type reference (TYPE) | SOI_RET_STRING | 19981120 | |||
| 5 | Importing |
SERVER_TYPE | Call by reference | Type reference (TYPE) | C | ' ' | 19981120 |
Method GET_LINK_SERVER on Interface I_OI_CONTAINER_CONTROL has no exception.
Method GET_REGISTERED_DOC_TYPES Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Exporting |
DESCR_LIST | Call by reference | Type reference (TYPE) | SOI_DOCUMENT_TYPE_DESCR_LIST | 19981120 | |||
| 2 | Exporting |
ERROR | Call by reference | Object reference (TYPE REF TO) | I_OI_ERROR | 19981120 | |||
| 3 | Importing |
INTERFACE_TYPE | Call by reference | Type reference (TYPE) | C | ' ' | 19981120 | ||
| 4 | Importing |
NO_FLUSH | Value transfer | Type reference (TYPE) | C | ' ' | 19981120 | ||
| 5 | Exporting |
RETCODE | Call by reference | Type reference (TYPE) | SOI_RET_STRING | 19981120 |
Method GET_REGISTERED_DOC_TYPES on Interface I_OI_CONTAINER_CONTROL has no exception.
Method GET_TABLE_COLLECTION 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 | 19981120 | |||
| 2 | Importing |
NO_FLUSH | Value transfer | Type reference (TYPE) | C | ' ' | 19981120 | ||
| 3 | Exporting |
RETCODE | Call by reference | Type reference (TYPE) | SOI_RET_STRING | 19981120 | |||
| 4 | Exporting |
TABLE_COLLECTION | Call by reference | Object reference (TYPE REF TO) | I_OI_TABLE_COLLECTION | 19981120 |
Method GET_TABLE_COLLECTION on Interface I_OI_CONTAINER_CONTROL has no exception.
Method INIT_CONTROL Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
AUTOALIGN | Value transfer | Type reference (TYPE) | C | 'x' | Control soll den Container ausfüllen | 19990126 | |
| 2 | Importing |
DYNPRO_NR | Value transfer | Type reference (TYPE) | SY-DYNNR | SY-DYNNR | Obsolete | 19981120 | |
| 3 | Exporting |
ERROR | Call by reference | Object reference (TYPE REF TO) | I_OI_ERROR | Fehler-Objekt | 19981120 | ||
| 4 | Importing |
GUI_CONTAINER | Call by reference | Type reference (TYPE) | C | ' ' | Obsolete | 19981120 | |
| 5 | Importing |
INPLACE_ENABLED | Call by reference | Type reference (TYPE) | C | ' ' | 19981120 | ||
| 6 | Importing |
INPLACE_MODE | Call by reference | Type reference (TYPE) | I | 0 | Obsolete | 19981120 | |
| 7 | Importing |
INPLACE_RESIZE_DOCUMENTS | Call by reference | Type reference (TYPE) | C | ' ' | 19981120 | ||
| 8 | Importing |
INPLACE_SCROLL_DOCUMENTS | Call by reference | Type reference (TYPE) | C | ' ' | 19981120 | ||
| 9 | Importing |
INPLACE_SHOW_TOOLBARS | Call by reference | Type reference (TYPE) | C | 'X' | 19981120 | ||
| 10 | Importing |
NAME | Call by reference | Type reference (TYPE) | STRING | Name der Anwendung | 20000207 | ||
| 11 | Importing |
NO_FLUSH | Value transfer | Type reference (TYPE) | C | ' ' | 19981120 | ||
| 12 | Importing |
PARENT | Call by reference | Object reference (TYPE REF TO) | CL_GUI_CONTAINER | Parent-Container | 19981214 | ||
| 13 | Importing |
PARENT_ID | Call by reference | Type reference (TYPE) | I | cl_gui_cfw=>dynpro_0 | Obsolete | 19981120 | |
| 14 | Importing |
R3_APPLICATION_NAME | Call by reference | Type reference (TYPE) | C | Anwendungsname | 19981120 | ||
| 15 | Importing |
REGISTER_ON_CLOSE_EVENT | Call by reference | Type reference (TYPE) | C | ' ' | 19981120 | ||
| 16 | Importing |
REGISTER_ON_CUSTOM_EVENT | Call by reference | Type reference (TYPE) | C | ' ' | 19981120 | ||
| 17 | Importing |
REP_ID | Value transfer | Type reference (TYPE) | SY-REPID | SY-REPID | Obsolete | 19981120 | |
| 18 | Exporting |
RETCODE | Call by reference | Type reference (TYPE) | SOI_RET_STRING | Fehlerwert, obsolete | 19981120 | ||
| 19 | Importing |
SHELL_STYLE | Call by reference | Type reference (TYPE) | I | 1384185856 | 19981120 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 |  JAVABEANNOTSUPPORTED |
Javabeans werden nicht unterstützt | 20020415 |
Method LINK_CONTROL Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
DYNPRO_NR | Value transfer | Type reference (TYPE) | SY-DYNNR | SY-DYNNR | 19981120 | ||
| 2 | Exporting |
ERROR | Call by reference | Object reference (TYPE REF TO) | I_OI_ERROR | 19981120 | |||
| 3 | Importing |
GUI_CONTAINER | Call by reference | Type reference (TYPE) | C | ' ' | 19981120 | ||
| 4 | Importing |
NO_FLUSH | Value transfer | Type reference (TYPE) | C | ' ' | 19981120 | ||
| 5 | Importing |
REP_ID | Value transfer | Type reference (TYPE) | SY-REPID | SY-REPID | 19981120 | ||
| 6 | Exporting |
RETCODE | Call by reference | Type reference (TYPE) | SOI_RET_STRING | 19981120 |
Method LINK_CONTROL on Interface I_OI_CONTAINER_CONTROL has no exception.
Method RELEASE_ALL_DOCUMENTS 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 | 19981120 | |||
| 2 | Importing |
NO_FLUSH | Value transfer | Type reference (TYPE) | C | ' ' | 19981120 | ||
| 3 | Exporting |
RETCODE | Call by reference | Type reference (TYPE) | SOI_RET_STRING | 19981120 |
Method RELEASE_ALL_DOCUMENTS on Interface I_OI_CONTAINER_CONTROL has no exception.
Method SET_FOCUS 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 | 19981120 | |||
| 2 | Importing |
NO_FLUSH | Value transfer | Type reference (TYPE) | C | ' ' | 19981120 | ||
| 3 | Exporting |
RETCODE | Call by reference | Type reference (TYPE) | SOI_RET_STRING | 19981120 |
Method SET_FOCUS on Interface I_OI_CONTAINER_CONTROL has no exception.
Method SET_INPLACE_BORDER_SPACE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
BOTTOM | Call by reference | Type reference (TYPE) | I | 0 | 19981120 | ||
| 2 | Exporting |
ERROR | Call by reference | Object reference (TYPE REF TO) | I_OI_ERROR | 19981120 | |||
| 3 | Importing |
LEFT | Call by reference | Type reference (TYPE) | I | 0 | 19981120 | ||
| 4 | Importing |
NO_FLUSH | Value transfer | Type reference (TYPE) | C | ' ' | 19981120 | ||
| 5 | Exporting |
RETCODE | Call by reference | Type reference (TYPE) | SOI_RET_STRING | 19981120 | |||
| 6 | Importing |
RIGHT | Call by reference | Type reference (TYPE) | I | 0 | 19981120 | ||
| 7 | Importing |
TOP | Call by reference | Type reference (TYPE) | I | 0 | 19981120 |
Method SET_INPLACE_BORDER_SPACE on Interface I_OI_CONTAINER_CONTROL has no exception.
Method SET_WINDOW_PROPERTIES Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
ALIGN | Call by reference | Type reference (TYPE) | I | 0 | 19981120 | ||
| 2 | Exporting |
ERROR | Call by reference | Object reference (TYPE REF TO) | I_OI_ERROR | 19981120 | |||
| 3 | Importing |
HEIGHT | Call by reference | Type reference (TYPE) | I | 1 | 19981120 | ||
| 4 | Importing |
LEFT | Call by reference | Type reference (TYPE) | I | 0 | 19981120 | ||
| 5 | Importing |
METRIC | Call by reference | Type reference (TYPE) | CNTL_METRIC | CNTL_METRIC_DYNPRO | 19981120 | ||
| 6 | Importing |
NO_FLUSH | Value transfer | Type reference (TYPE) | C | ' ' | 19981120 | ||
| 7 | Exporting |
RETCODE | Call by reference | Type reference (TYPE) | SOI_RET_STRING | 19981120 | |||
| 8 | Importing |
TOP | Call by reference | Type reference (TYPE) | I | 0 | 19981120 | ||
| 9 | Importing |
WIDTH | Call by reference | Type reference (TYPE) | I | 1 | 19981120 |
Method SET_WINDOW_PROPERTIES on Interface I_OI_CONTAINER_CONTROL has no exception.
History
| Last changed by/on | SAP | 19981120 |
| SAP Release Created in |
