SAP ABAP Class CL_RMST_DOI_ENCAPSULATION (RMS-TLS: Object Encapsulation for DOI)

Hierarchy

☛ EA-APPL (Software Component) SAP Enterprise Extension PLM, SCM, Financials
   ⤷ PLM-RM (Application Component) Recipe Management
     ⤷ RMSTLSOUT (Package) RMS-TLS: Output Tool

Properties

Class	CL_RMST_DOI_ENCAPSULATION
Short Description	RMS-TLS: Object Encapsulation for DOI
Super Class
Instantiability of a Class	2	Public
Final	☑

General Data

Message Class
Program status
Category	0
Package	RMSTLSOUT	RMS-TLS: Output Tool
Created	20011120	SAP
Last change	20060703	SAP
Shared Memory-enabled	☐
Fixed point arithmetic	☑
Unicode checks active	☑

Forward declarations

#	Type group / Object type	Type	Type Description
1	C_OI_ERRORS	Forward declaration class (CLASS c DEFINITION DEFERRED)	Forward declaration class (CLASS c DEFINITION DEFERRED)
2	SOI	Type group use (TYPE-POOLS tp)	Type group use (TYPE-POOLS tp)

Interfaces

Class CL_RMST_DOI_ENCAPSULATION has no interface implemented.

Friends

Class CL_RMST_DOI_ENCAPSULATION has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	COL_BACKGROUND	Constant	Public	☐	Type reference (TYPE)	RMSTE_XCL_BACK_COLOR	47	Fill Color of a Cell in Excel	20020122
2	COL_GROUP	Constant	Public	☐	Type reference (TYPE)	RMSTE_XCL_BACK_COLOR	22	Fill Color of a Cell in Excel	20020122
3	CON_1K_SEP_SUBPROP	Instance attribute	Public	☐	Type reference (TYPE)	FIELDNAME	'THOUSANDS_SEPARATOR'	Thousand Separator Property	20031016
4	CON_DEC_SEP_PROP	Constant	Private	☐	Type reference (TYPE)	FIELDNAME	'INTERNATIONAL'	Property: Decimal Separator of the Document (Front End)	20031013
5	CON_DEC_SEP_SUBPROP	Constant	Private	☐	Type reference (TYPE)	FIELDNAME	'DECIMAL_SEPARATOR'	Property: Decimal Separator of the Document (Front End)	20031013
6	CON_EXCEL_FILE_EXTENSION	Constant	Public	☐	Type reference (TYPE)	RMSTE_STRING	',*.XLS.'	String	20011122
7	CON_MESSAGETYPE_I	Constant	Public	☐	Type reference (TYPE)	SY-MSGTY	'I'	Messages, Message Type	20011123
8	CON_METHOD_CANCELLED	Constant	Public	☐	Type reference (TYPE)	SOI_RET_STRING	'METHOD_CANCELLED'	Method Canceled	20011204
9	CON_TRUE	Constant	Public	☐	Type reference (TYPE)	RMSTE_XCL_BOOLE	'X'	RMS-TLS: Truth Value	20011120
10	FRAME_WIDTH1	Constant	Public	☐	Type reference (TYPE)	RMSTE_XCL_FRAME_TYPE	79	Border Style of a Cell in Excel	20020128
11	G_APPLICATION	Instance attribute	Private	☐	Type reference (TYPE)	RMSTE_XCL_APPLICATION		Registry Key of the Office Application	20011120
12	G_FLG_INPLACE	Instance attribute	Private	☐	Type reference (TYPE)	RMSTE_XCL_INPLACE		Inplace Execution of Desktop Office Integration	20011120
13	G_O_CONTAINER_CONTROL	Instance attribute	Private	☐	Object reference (TYPE REF TO)	I_OI_CONTAINER_CONTROL		Document Container Control Interface	20011120
14	G_O_CUSTOM_CONTAINER	Instance attribute	Private	☐	Object reference (TYPE REF TO)	CL_GUI_CUSTOM_CONTAINER		Container for Custom Controls in the Screen Area	20020130
15	G_O_DOCUMENT_PROXY	Instance attribute	Private	☐	Object reference (TYPE REF TO)	I_OI_DOCUMENT_PROXY		General Document Interface	20011120
16	G_O_PARENT	Instance attribute	Private	☐	Object reference (TYPE REF TO)	CL_GUI_CONTAINER		Control Container	20020130
17	G_O_SPREADSHEET	Instance attribute	Private	☐	Object reference (TYPE REF TO)	I_OI_SPREADSHEET		Spreadsheet Interface	20011120
18	G_R3_APPLICATION_NAME	Instance attribute	Private	☐	Type reference (TYPE)	RMSTE_XCL_USEXDES		Name of Excel Output Application	20011120
19	SPREADSHEET_INSERTALL	Constant	Public	☐	Type reference (TYPE)	SOI_BOOLEAN	'3'	Insert all Data	20020111

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	ADD_SHEET	Instance method	Public	Method	Add a Sheet in Excel	20011120
2	CONSTRUCTOR	Instance method	Public	Constructor	Constructor	20011120
3	DEL_SHEET	Instance method	Public	Method	Delete a Sheet in Excel	20011121
4	FLUSH	Instance method	Public	Method	Send Buffered Automation Queue to Front End	20011213
5	FREE	Instance method	Public	Method	Destructor	20011120
6	GET_DECIMAL_SEPARATOR	Instance method	Public	Method	Gets Decimal Separator of the Document (on Front End)	20031013
7	GET_SHEETS	Instance method	Public	Method	Gets a Table with All the Worksheets in the Excel Workbook	20011121
8	INSERT_CELLS	Instance method	Public	Method	Inserts a Set of Cells in Excel (Range-Based)	20011122
9	INSERT_RANGES	Instance method	Public	Method	Inserts a Set of Ranges in Excel	20011122
10	LOAD_LIB	Instance method	Public	Method	Excel Runs "In Process" - Enhances Performance Significantly	20020131
11	ON_CLOSE_EVENT	Instance method	Public	Event handling method	Event Handler for Close Event (Close File in Excel)	20011122
12	RAISE_OI_ERROR	Static method	Private	Method	Triggers Error Message from Office Integration	20011121
13	SAVE_ALIVE	Instance method	Public	Method	Trigger File Save in Excel (File Open)	20011122
14	SAVE_FROM_PROXY	Instance method	Public	Method	Save File from SAP System (File Closed)	20011122
15	SCREEN_UPDATE	Instance method	Public	Method	Display Current Data	20060127
16	SET_ACTIVE_SHEET	Instance method	Public	Method	Set Active Worksheet in Excel	20011121
17	SET_CELL_FORMAT	Instance method	Public	Method	Format a Set of Cells in Excel	20011122
18	SET_RANGES_FORMAT	Instance method	Public	Method	Set the Formats for Several Ranges	20020131

Events

#	Event	Type	Visibility	Description	Created on
1	CLOSE_EVENT	Instance Event (0)	Public (2)	Close the File in Excel	20011122

Types

Class CL_RMST_DOI_ENCAPSULATION has no local type.

Method Signatures

Method ADD_SHEET Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_FLG_NO_FLUSH	Call by reference	☐	Type reference (TYPE)	RMSTE_XCL_FLUSH	' '	Frontend aktualisieren	20011120
2	Importing	I_SHEET_NAME	Call by reference	☐	Type reference (TYPE)	RMSTE_XCL_SHEET_NAME		Name eines Excel-Arbeitsblattes	20011120

#	Exception	Resumable	Description	Created on
1	DOI_ERROR	☐	Fehler in der Desktop Office Integration aufgetreten	20011123
2	INTERNAL_ERROR	☐	programminterner Fehler	20011120
3	NO_SPREADSHEET_INTERFACE	☐	keine gültige Arbeitsmappe vorhanden	20011120
4	PARAMETER_ERROR	☐	Fehlerhafte(r) Parameter	20011120

Method CONSTRUCTOR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_PARENT	Call by reference	☑	Object reference (TYPE REF TO)	CL_GUI_CONTAINER		Container Control Objekt	20020130
2	Importing	I_APPLICATION	Call by reference	☐	Type reference (TYPE)	RMSTE_XCL_APPLICATION	'EXCEL.SHEET'	Registry-Key der Office-Anwendung	20011120
3	Importing	I_CONTAINER_NAME	Call by reference	☑	Type reference (TYPE)	C		Name des Custom Containers für INPLACE-Modus	20011213
4	Importing	I_FLG_INPLACE	Call by reference	☐	Type reference (TYPE)	RMSTE_XCL_INPLACE	' '	Inplace-Ausführung der Desktop Office Integration	20011120
5	Importing	I_R3_APPLICATION_NAME	Call by reference	☐	Type reference (TYPE)	RMSTE_XCL_USEXDES	'Excel Output Function'	Excel-Ausgabe-Anwendung	20011120

Method CONSTRUCTOR on class CL_RMST_DOI_ENCAPSULATION has no exception.

Method DEL_SHEET Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_FLG_NO_FLUSH	Call by reference	☐	Type reference (TYPE)	RMSTE_XCL_FLUSH	' '	Frontend aktualisieren	20011121
2	Importing	I_SHEET_NAME	Call by reference	☐	Type reference (TYPE)	RMSTE_XCL_SHEET_NAME		Name eines Excel-Arbeitsblattes	20011121

#	Exception	Resumable	Description	Created on
1	DOI_ERROR	☐	Fehler in der Desktop Office Integration aufgetreten	20011123
2	INTERNAL_ERROR	☐	programminterner Fehler	20011121
3	NO_SPREADSHEET_INTERFACE	☐	keine gültige Arbeitsmappe vorhanden	20011121
4	PARAMETER_ERROR	☐	Fehlerhafte(r) Parameter	20011121

Method FLUSH Signature

Method FLUSH on class CL_RMST_DOI_ENCAPSULATION has no parameter.
Method FLUSH on class CL_RMST_DOI_ENCAPSULATION has no exception.

Method FREE Signature

Method FREE on class CL_RMST_DOI_ENCAPSULATION has no parameter.
Method FREE on class CL_RMST_DOI_ENCAPSULATION has no exception.

Method GET_DECIMAL_SEPARATOR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	E_DEC_SEP	Call by reference	☐	Type reference (TYPE)	CHAR1		Dezimaltrennzeichen	20031013
2	Exporting	E_DEC_SEP_SAP	Call by reference	☐	Type reference (TYPE)	CHAR1		Einstelliges Kennzeichen	20031013
3	Exporting	E_RC	Call by reference	☐	Type reference (TYPE)	SYSUBRC		Rückgabewert, Rückgabewert nach ABAP-Anweisungen	20031013

Method GET_DECIMAL_SEPARATOR on class CL_RMST_DOI_ENCAPSULATION has no exception.

Method GET_SHEETS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_SHEETS	Call by reference	☐	Type reference (TYPE)	SOI_SHEETS_TABLE		Tabelle der Arbeitsblätter	20011121
2	Importing	I_FLG_NO_FLUSH	Call by reference	☐	Type reference (TYPE)	RMSTE_XCL_FLUSH	' '	Frontend aktualisieren	20011121

#	Exception	Resumable	Description	Created on
1	DOI_ERROR	☐	Fehler in der Desktop Office Integration aufgetreten	20011123
2	INTERNAL_ERROR	☐	programminterner Fehler	20011121
3	NO_SPREADSHEET_INTERFACE	☐	keine gültige Arbeitsmappe vorhanden	20011121
4	PARAMETER_ERROR	☐	Fehlerhafter Parameter	20011121

Method INSERT_CELLS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_CELLS	Call by reference	☐	Type reference (TYPE)	SOI_GENERIC_TABLE		Zellendefinitionen	20011122
2	Importing	IT_RANGES	Call by reference	☐	Type reference (TYPE)	SOI_RANGE_LIST		Bereichstabelle	20011122
3	Importing	I_FLG_NO_FLUSH	Call by reference	☐	Type reference (TYPE)	RMSTE_XCL_FLUSH	' '	Frontend aktualisieren	20011122

#	Exception	Resumable	Description	Created on
1	DOI_ERROR	☐	Fehler in der Desktop Office Integration aufgetreten	20011123
2	INTERNAL_ERROR	☐	programminterner Fehler	20011122
3	NO_SPREADSHEET_INTERFACE	☐	keine gültige Arbeitsmappe vorhanden	20011122
4	PARAMETER_ERROR	☐	Fehlerhafte(r) Parameter	20011122

Method INSERT_RANGES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_RANGES	Call by reference	☐	Type reference (TYPE)	SOI_FULL_RANGE_TABLE			20011122
2	Importing	I_FLG_NO_FLUSH	Call by reference	☐	Type reference (TYPE)	RMSTE_XCL_FLUSH	' '	Frontend aktualisieren	20011122

#	Exception	Resumable	Description	Created on
1	DOI_ERROR	☐	Fehler in der Desktop Office Integration aufgetreten	20011123
2	INTERNAL_ERROR	☐	programminterner Fehler	20011122
3	NO_SPREADSHEET_INTERFACE	☐	keine gültige Arbeitsmappe vorhanden	20011122
4	PARAMETER_ERROR	☐	Fehlerhafte(r) Parameter	20011122

Method LOAD_LIB Signature

Method LOAD_LIB on class CL_RMST_DOI_ENCAPSULATION has no parameter.
Method LOAD_LIB on class CL_RMST_DOI_ENCAPSULATION has no exception.

Method ON_CLOSE_EVENT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	DOCUMENT_PROXY	Call by reference	☐	Attribute reference (LIKE)				20011123

Method ON_CLOSE_EVENT on class CL_RMST_DOI_ENCAPSULATION has no exception.

Method RAISE_OI_ERROR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_OI_ERROR	Call by reference	☐	Object reference (TYPE REF TO)	I_OI_ERROR		Fehler-Objekt	20011121

#	Exception	Resumable	Description	Created on
1	ERROR	☐	programminterner Fehler	20011121

Method SAVE_ALIVE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_FILE_NAME	Call by reference	☑	Type reference (TYPE)	RMSTE_FILE_NAME		Dateiname	20011122
2	Importing	I_FLG_NO_FLUSH	Call by reference	☐	Type reference (TYPE)	RMSTE_XCL_FLUSH	' '	Frontend aktualisieren	20011122
3	Importing	I_FLG_PROMPT_EXCEL	Call by reference	☐	Type reference (TYPE)	RMSTE_XCL_BOOLE	'X'	RMS-TLS: Wahrheitswert	20011204

#	Exception	Resumable	Description	Created on
1	DIALOG_ESCAPE	☐	Benutzer hat Speichern-Dialog abgebrochen	20011204
2	DOI_ERROR	☐	Fehler in der Desktop Office Integration aufgetreten	20011123
3	INTERNAL_ERROR	☐	programminterner Fehler	20011122
4	NO_SPREADSHEET_INTERFACE	☐	keine gültige Arbeitsmappe vorhanden	20011122
5	PARAMETER_ERROR	☐	Fehlerhafte(r) Parameter	20011122

Method SAVE_FROM_PROXY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_FILE_NAME	Call by reference	☑	Type reference (TYPE)	RMSTE_FILE_NAME		Dateiname	20011122
2	Importing	I_FLG_NO_FLUSH	Call by reference	☐	Type reference (TYPE)	RMSTE_XCL_FLUSH	' '	Frontend aktualisieren	20011122

#	Exception	Resumable	Description	Created on
1	DIALOG_ESCAPE	☐	Benutzer hat Speichern-Dialog abgebrochen	20011204
2	DOI_ERROR	☐	Fehler in der Desktop Office Integration aufgetreten	20011123
3	INTERNAL_ERROR	☐	programminterner Fehler	20011122
4	NO_SPREADSHEET_INTERFACE	☐	keine gültige Arbeitsmappe vorhanden	20011122
5	PARAMETER_ERROR	☐	Fehlerhafte(r) Parameter	20011122

Method SCREEN_UPDATE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	UPDATING	Call by reference	☐	Type reference (TYPE)	C		Aktualisieren?	20060127

Method SCREEN_UPDATE on class CL_RMST_DOI_ENCAPSULATION has no exception.

Method SET_ACTIVE_SHEET Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_FLG_NO_FLUSH	Call by reference	☐	Type reference (TYPE)	RMSTE_XCL_FLUSH	' '	Frontend aktualisieren	20011121
2	Importing	I_SHEET_NAME	Call by reference	☐	Type reference (TYPE)	RMSTE_XCL_SHEET_NAME		Name eines Excel-Arbeitsblattes	20011121

#	Exception	Resumable	Description	Created on
1	DOI_ERROR	☐	Fehler in der Desktop Office Integration aufgetreten	20011123
2	INTERNAL_ERROR	☐	programminterner Fehler	20011121
3	NO_SPREADSHEET_INTERFACE	☐	keine gültige Arbeitsmappe vorhanden	20011121
4	PARAMETER_ERROR	☐	Fehlerhafte(r) Parameter	20011121

Method SET_CELL_FORMAT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_CELLS	Call by reference	☐	Type reference (TYPE)	SOI_CELL_TABLE			20011122
2	Importing	I_FLG_NO_FLUSH	Call by reference	☐	Type reference (TYPE)	RMSTE_XCL_FLUSH	' '	Frontend aktualisieren	20011122

#	Exception	Resumable	Description	Created on
1	DOI_ERROR	☐	Fehler in der Desktop Office Integration aufgetreten	20011123
2	INTERNAL_ERROR	☐	programminterner Fehler	20011122
3	NO_SPREADSHEET_INTERFACE	☐	keine gültige Arbeitsmappe vorhanden	20011122
4	PARAMETER_ERROR	☐	Fehlerhafte(r) Parameter	20011122

Method SET_RANGES_FORMAT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_FORMATS	Call by reference	☐	Type reference (TYPE)	SOI_FORMAT_TABLE			20020131
2	Importing	I_FLG_NO_FLUSH	Call by reference	☐	Type reference (TYPE)	RMSTE_XCL_FLUSH	' '	Frontend aktualisieren	20060127

Method SET_RANGES_FORMAT on class CL_RMST_DOI_ENCAPSULATION has no exception.

Event Signatures

Event CLOSE_EVENT Signature

#	Parameter	Type	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	DOCUMENT_PROXY	Exporting	Value transfer	☑	Object reference (TYPE REF TO)	I_OI_DOCUMENT_PROXY		allgemeine Dokument-Schnittstelle	20011122

History

Last changed by/on	SAP	20060703
SAP Release Created in	471