SAP ABAP Interface I_OI_WORD_PROCESSOR_DOCUMENT (Text Processor 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
Properties
| Interface | I_OI_WORD_PROCESSOR_DOCUMENT | |
| Short Description | Text Processor Interface |
General Data
| Package | SOFFICEINTEGRATION | Platform- and application-indep. Office integration |
| Created | 19981120 | SAP |
| Last changed | 20110908 | SAP |
| Unicode checks active |
Forward declarations
| # | Type group / Object type | Type | Type Description |
|---|---|---|---|
| 1 | CNDP | Type group use (TYPE-POOLS tp) | Type group use (TYPE-POOLS tp) |
| 2 | SOI | Type group use (TYPE-POOLS tp) | Type group use (TYPE-POOLS tp) |
Interfaces
Interface I_OI_WORD_PROCESSOR_DOCUMENT has no interface.
Friends
Interface I_OI_WORD_PROCESSOR_DOCUMENT has no friend.
Attributes
Interface I_OI_WORD_PROCESSOR_DOCUMENT has no attribute.
Methods
| # | Method | Level | Visibility | Method type | Description | Created on |
|---|---|---|---|---|---|---|
| 1 | CLEAR_TABLE |
Instance method | Public | Method | Delete the Contents of a Table in the Document | 19991104 |
| 2 | GET_TABLE_INFO |
Instance method | Public | Method | Get the Number of Rows and Columns in Each Table in Document | 19991105 |
| 3 | GET_TEMPLATE_INFO |
Instance method | Public | Method | Get the Name, Path, and Full Path of the Current Template | 19991108 |
| 4 | GET_VERSION |
Instance method | Public | Method | Get the Version of the Word Processor Application | 19991020 |
| 5 | INSERT_TABLE |
Instance method | Public | Method | Transfer Data from Internal Table to Document TAble | 19990810 |
| 6 | INSERT_TABLE2 |
Instance method | Public | Method | Transfer Data to Document Table using Column Names | 19990928 |
| 7 | INSTALL_TEMPLATE |
Instance method | Public | Method | Installs a Template for the Office Application | 19981120 |
| 8 | REMOVE_TEMPLATE |
Instance method | Public | Method | Removes All Locally-Installed Templates | 19981120 |
| 9 | REPLACE |
Instance method | Public | Method | Replaces a Character String in the Open Document | 19981120 |
| 10 | SEARCH |
Instance method | Public | Method | Finds a Character String in the Open Document | 19981120 |
| 11 | SET_TEMPLATE |
Instance method | Public | Method | Sets Template for the Current Document | 19981120 |
Events
Interface I_OI_WORD_PROCESSOR_DOCUMENT has no event.
Types
Interface I_OI_WORD_PROCESSOR_DOCUMENT has no local type.
Method Signatures
Method CLEAR_TABLE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 |  Importing |
DOCTABLE_NUMBER | Call by reference | Type reference (TYPE) | I | Nummer der Tabelle im Dokument | 19991104 | ||
| 2 |  Exporting |
ERROR | Call by reference | Object reference (TYPE REF TO) | I_OI_ERROR | Fehlerobjekt | 19991104 | ||
| 3 | Importing |
NO_FLUSH | Value transfer | Type reference (TYPE) | C | ' ' | Flushverhalten | 19991104 | |
| 4 | Exporting |
RETCODE | Call by reference | Type reference (TYPE) | SOI_RET_STRING | Fehlercode | 19991104 |
Method CLEAR_TABLE on Interface I_OI_WORD_PROCESSOR_DOCUMENT has no exception.
Method GET_TABLE_INFO 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 | Fehlerobjekt | 19991105 | ||
| 2 | Importing |
NO_FLUSH | Value transfer | Type reference (TYPE) | C | ' ' | Flushverhalten | 19991105 | |
| 3 | Exporting |
RETCODE | Call by reference | Type reference (TYPE) | SOI_RET_STRING | Returncode | 19991105 | ||
| 4 |  Changing |
TABLEINFO | Call by reference | Type reference (TYPE) | SOI_TABLEINFO_TABLE | Tabelle mit Tabelleninfos | 19991105 |
Method GET_TABLE_INFO on Interface I_OI_WORD_PROCESSOR_DOCUMENT has no exception.
Method GET_TEMPLATE_INFO 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 | Fehlerobjekt | 19991108 | ||
| 2 | Importing |
NO_FLUSH | Value transfer | Type reference (TYPE) | C | ' ' | Flushverhalten | 19991108 | |
| 3 | Exporting |
RETCODE | Call by reference | Type reference (TYPE) | SOI_RET_STRING | Returncode | 19991108 | ||
| 4 | Changing |
TEMPLATE_INFO | Call by reference | Type reference (TYPE) | SOI_TEMPLATE_INFO | Tabelle mit Templateinfos (Name, Pfad) | 19991108 |
Method GET_TEMPLATE_INFO on Interface I_OI_WORD_PROCESSOR_DOCUMENT has no exception.
Method GET_VERSION 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 | Fehlerobjekt | 19991020 | ||
| 2 | Importing |
NO_FLUSH | Value transfer | Type reference (TYPE) | C | ' ' | Flushverhalten | 19991020 | |
| 3 | Exporting |
RETCODE | Call by reference | Type reference (TYPE) | SOI_RET_STRING | Returncode | 19991020 | ||
| 4 | Exporting |
VERSION | Call by reference | Type reference (TYPE) | SOI_STRING | Version des Wordprozessors | 19991020 |
Method GET_VERSION on Interface I_OI_WORD_PROCESSOR_DOCUMENT has no exception.
Method INSERT_TABLE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
CLEAROPTION | Call by reference | Type reference (TYPE) | I | Überschreinverhalten hinsichtlich Documenttabelleninhalten | 19990810 | ||
| 2 | Importing |
DATA_TABLE | Call by reference | Type reference (TYPE) | TABLE | Wertetabelle; enthät zu übertragende Daten | 19990810 | ||
| 3 | Importing |
DOCTABLE_NUMBER | Call by reference | Type reference (TYPE) | I | Nummer der zu füllenden Dokumenttabelle | 19990810 | ||
| 4 | Exporting |
ERROR | Call by reference | Object reference (TYPE REF TO) | I_OI_ERROR | Fehlerobjekt | 19990810 | ||
| 5 | Importing |
INFO_TABLE | Call by reference | Type reference (TYPE) | SOI_COLS_TABLE | Infotabelle; Angabe der zu transferierenden Spalten | 19990810 | ||
| 6 | Importing |
LOWERBOUND | Call by reference | Type reference (TYPE) | I | Erste zu übertragenden Zeile aus ITAB | 19990810 | ||
| 7 | Importing |
NO_FLUSH | Value transfer | Type reference (TYPE) | C | ' ' | Flushverhalten | 19990810 | |
| 8 | Exporting |
RETCODE | Call by reference | Type reference (TYPE) | SOI_RET_STRING | Fehlerreturncode | 19990810 | ||
| 9 | Importing |
STARTROW | Call by reference | Type reference (TYPE) | I | Zeile der Dokumenttabelle, ab der Daten eingesetzt werden | 19990810 | ||
| 10 | Importing |
UPPERBOUND | Call by reference | Type reference (TYPE) | I | Letzte zu übertragende Zeile aus ITAB | 19990810 | ||
| 11 | Importing |
VARSIZE | Call by reference | Type reference (TYPE) | C | Anpassung Größe der Dokumenttabelle? | 19990810 | ||
| 12 | Importing |
WHOLETABLE | Call by reference | Type reference (TYPE) | C | ' ' | Option: ganzen ITAB-Inhalt übertragen | 19990810 |
Method INSERT_TABLE on Interface I_OI_WORD_PROCESSOR_DOCUMENT has no exception.
Method INSERT_TABLE2 Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
CLEAROPTION | Call by reference | Type reference (TYPE) | I | Überschreinverhalten hinsichtlich Documenttabelleninhalten | 19990928 | ||
| 2 | Importing |
DATA_TABLE | Call by reference | Type reference (TYPE) | TABLE | Wertetabelle; enthät zu übertragende Daten | 19990928 | ||
| 3 | Importing |
DOCTABLE_NUMBER | Call by reference | Type reference (TYPE) | I | Nummer der zu füllenden Dokumenttabelle | 19990928 | ||
| 4 | Exporting |
ERROR | Call by reference | Object reference (TYPE REF TO) | I_OI_ERROR | Fehlerobjekt | 19990928 | ||
| 5 | Importing |
INFO_COL_TABLE | Call by reference | Type reference (TYPE) | SOI_COLNAMES_TABLE | Infotabelle; Angabe der zu transferierenden Spaltennamen | 19990929 | ||
| 6 | Importing |
LOWERBOUND | Call by reference | Type reference (TYPE) | I | Erste zu übertragenden Zeile aus ITAB | 19990928 | ||
| 7 | Importing |
NO_FLUSH | Value transfer | Type reference (TYPE) | C | ' ' | Flushverhalten | 19990928 | |
| 8 | Exporting |
RETCODE | Call by reference | Type reference (TYPE) | SOI_RET_STRING | Fehlerreturncode | 19990928 | ||
| 9 | Importing |
STARTROW | Call by reference | Type reference (TYPE) | I | Zeile der Dokumenttabelle, ab der Daten eingesetzt werden | 19990928 | ||
| 10 | Importing |
UPPERBOUND | Call by reference | Type reference (TYPE) | I | Letzte zu übertragenden Zeile aus ITAB | 19990928 | ||
| 11 | Importing |
VARSIZE | Call by reference | Type reference (TYPE) | C | Anpassung Größe der Dokumenttabelle? | 19990928 | ||
| 12 | Importing |
WHOLETABLE | Call by reference | Type reference (TYPE) | C | ' ' | Option: ganzen ITAB-Inhalt übertragen | 19990928 |
Method INSERT_TABLE2 on Interface I_OI_WORD_PROCESSOR_DOCUMENT has no exception.
Method INSTALL_TEMPLATE 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 | Fehler-Objekt | 19981120 | ||
| 2 | Importing |
NO_FLUSH | Value transfer | Type reference (TYPE) | C | ' ' | 19981120 | ||
| 3 | Exporting |
RETCODE | Call by reference | Type reference (TYPE) | SOI_RET_STRING | Fehlerwert (obsolete) | 19981120 | ||
| 4 | Importing |
SAVE_READONLY | Call by reference | Type reference (TYPE) | C | ' ' | 20110303 | ||
| 5 | Importing |
TEMPLATE_NAME | Call by reference | Type reference (TYPE) | C | Name der anzulegenden Datei auf dem Präsentationsrechner | 19981120 | ||
| 6 | Importing |
URL | Call by reference | Type reference (TYPE) | C | URL-Adresse des Templates z.B.in der R/3-Dokumentenanblage | 19981120 | ||
| 7 | Importing |
USER_INFO | Call by reference | Type reference (TYPE) | CNDP_USER_INFO | Firewall-Benutzerdaten | 19981120 |
Method INSTALL_TEMPLATE on Interface I_OI_WORD_PROCESSOR_DOCUMENT has no exception.
Method REMOVE_TEMPLATE 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 | Fehler-Objekt | 19981120 | ||
| 2 | Importing |
NO_FLUSH | Value transfer | Type reference (TYPE) | C | ' ' | 19981120 | ||
| 3 | Exporting |
RETCODE | Call by reference | Type reference (TYPE) | SOI_RET_STRING | Fehlerwert (obsolete) | 19981120 | ||
| 4 | Importing |
TEMPLATE_NAME | Call by reference | Type reference (TYPE) | C | Datei-Name des zu löschenden Templates | 19981120 |
Method REMOVE_TEMPLATE on Interface I_OI_WORD_PROCESSOR_DOCUMENT has no exception.
Method REPLACE 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 | Fehler-Objekt | 19981120 | ||
| 2 | Importing |
FLAG | Call by reference | Type reference (TYPE) | C | Suchoption | 19981120 | ||
| 3 | Importing |
NO_FLUSH | Value transfer | Type reference (TYPE) | C | ' ' | 19981120 | ||
| 4 | Importing |
POS | Call by reference | Type reference (TYPE) | C | 19981120 | |||
| 5 | Importing |
REPLACE_STRING | Call by reference | Type reference (TYPE) | C | Zeichenfolge, die eingesezt werden soll | 19981120 | ||
| 6 | Exporting |
RETCODE | Call by reference | Type reference (TYPE) | SOI_RET_STRING | Fehlerwert (obsolete) | 19981120 | ||
| 7 | Importing |
SEARCH_STRING | Call by reference | Type reference (TYPE) | C | Zeichenfolge, nach der gesucht werden soll | 19981120 |
Method REPLACE on Interface I_OI_WORD_PROCESSOR_DOCUMENT has no exception.
Method SEARCH 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 | Fehler-Objekt | 19981120 | ||
| 2 | Importing |
FLAG | Call by reference | Type reference (TYPE) | C | Suchoption | 19981120 | ||
| 3 | Importing |
NO_FLUSH | Value transfer | Type reference (TYPE) | C | ' ' | 19981120 | ||
| 4 | Importing |
POS | Call by reference | Type reference (TYPE) | C | 19981120 | |||
| 5 | Exporting |
RETCODE | Call by reference | Type reference (TYPE) | SOI_RET_STRING | Fehlerwert (obsolete) | 19981120 | ||
| 6 | Importing |
SEARCH_STRING | Call by reference | Type reference (TYPE) | C | Zeichenfolge, nach der gesucht werden soll | 19981120 |
Method SEARCH on Interface I_OI_WORD_PROCESSOR_DOCUMENT has no exception.
Method SET_TEMPLATE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
ATTACH_STYLES | Call by reference | Type reference (TYPE) | C | ' ' | 'X' - die Template-Formatierungen sollen übernommen werden | 19981120 | |
| 2 | Exporting |
ERROR | Call by reference | Object reference (TYPE REF TO) | I_OI_ERROR | Fehler-Objekt | 19981120 | ||
| 3 | Importing |
NO_FLUSH | Value transfer | Type reference (TYPE) | C | ' ' | 19981120 | ||
| 4 | Exporting |
RETCODE | Call by reference | Type reference (TYPE) | SOI_RET_STRING | Fehlerwert (obsolete) | 19981120 | ||
| 5 | Importing |
TEMPLATE_NAME | Call by reference | Type reference (TYPE) | C | Name des einzubindenden Templates | 19981120 |
Method SET_TEMPLATE on Interface I_OI_WORD_PROCESSOR_DOCUMENT has no exception.
History
| Last changed by/on | SAP | 20110908 |
| SAP Release Created in |
