SAP ABAP Class CL_CNV_MBT_EXCEL_DOCUMENT (Excel document for storing data)

Hierarchy

☛ DMIS (Software Component) DMIS 2011_1
   ⤷ CA-EUR (Application Component) European Monetary Union: Euro
     ⤷ CNV_MBT_MAIN_620 (Package) DMIS objects for release starting with 620

Meta Relationship - Used By

#	Relationship type	Used by	Short Description	Created on
1	Inheritance (c INHERITING FROM c_ref)	CL_CNV_MBT_PIFD_EXCEL_DOCUMENT	Excel document for storing PIFD data	20110426

Properties

Class	CL_CNV_MBT_EXCEL_DOCUMENT
Short Description	Excel document for storing data
Super Class
Instantiability of a Class	2	Public
Final	☐

General Data

Message Class
Program status
Category	0
Package	CNV_MBT_MAIN_620	DMIS objects for release starting with 620
Created	20110426	SAP
Last change	20141030
Shared Memory-enabled	☐
Fixed point arithmetic	☑
Unicode checks active	☑

Forward declarations

#	Type group / Object type	Type	Type Description
1	ABAP	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

Class CL_CNV_MBT_EXCEL_DOCUMENT has no interface implemented.

Friends

Class CL_CNV_MBT_EXCEL_DOCUMENT has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	PR_CONTAINER	Instance attribute	Private	☐	Object reference (TYPE REF TO)	CL_GUI_CUSTOM_CONTAINER		Container for Custom Controls in the Screen Area	20110426
2	PR_CONTAINER_CONTROL	Instance attribute	Private	☐	Object reference (TYPE REF TO)	I_OI_CONTAINER_CONTROL		Document Container Control Interface	20110426
3	PR_DOCUMENT	Instance attribute	Private	☐	Object reference (TYPE REF TO)	I_OI_DOCUMENT_PROXY		General Document Interface	20110426
4	PR_SPREADSHEET	Instance attribute	Private	☐	Object reference (TYPE REF TO)	I_OI_SPREADSHEET		Table interface	20110426
5	PT_SHEETS	Instance attribute	Private	☐	Type reference (TYPE)	CNV_MBT_EXCEL_T_SHEETS		List of Excel sheet objects	20110426
6	PT_STANDARD_SHEETS	Instance attribute	Private	☐	Type reference (TYPE)	SOI_SHEETS_TABLE		Standard sheets in a new workbook	20110426

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	CLOSE	Instance method	Public	Method	Closes and releases the Excel document	20110426
2	CONSTRUCTOR	Instance method	Public	Constructor	CONSTRUCTOR	20110426
3	CREATE_NEW_DOCUMENT	Static method	Public	Method	Creates a new Excel file	20110426
4	CREATE_NEW_DYNAMIC_SHEET	Instance method	Public	Method	Creates a new sheet that can handle dynamic tables	20110608
5	CREATE_NEW_SHEET	Instance method	Public	Method	Creates a new sheet in the workbook	20110426
6	CREATE_NEW_TITLE_SHEET	Instance method	Public	Method	Creates a new title sheet in the workbook	20110509
7	DELETE_STANDARD_SHEETS	Instance method	Public	Method	Deletes the standard sheets of a newly created workbook	20110426
8	GET_SHEETS	Instance method	Public	Method	Returns the sheets of the workbook	20110426
9	LOAD	Static method	Public	Method	Loads an Excel file	20110426
10	SAVE	Instance method	Public	Method	Saves the workbook	20110426

Events

Class CL_CNV_MBT_EXCEL_DOCUMENT has no event.

Types

Class CL_CNV_MBT_EXCEL_DOCUMENT has no local type.

Method Signatures

Method CLOSE Signature

Method CLOSE on class CL_CNV_MBT_EXCEL_DOCUMENT has no parameter.
Method CLOSE on class CL_CNV_MBT_EXCEL_DOCUMENT has no exception.

Method CONSTRUCTOR Signature

Method CONSTRUCTOR on class CL_CNV_MBT_EXCEL_DOCUMENT has no parameter.
Method CONSTRUCTOR on class CL_CNV_MBT_EXCEL_DOCUMENT has no exception.

Method CREATE_NEW_DOCUMENT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_DOCUMENT_TITLE	Call by reference	☐	Type reference (TYPE)	C			20110426
2	Returning	RR_DOCUMENT	Value transfer	☐	Object reference (TYPE REF TO)	CL_CNV_MBT_EXCEL_DOCUMENT		Excel document for storing PIFD data	20110426

#	Exception	Resumable	Description	Created on
1	CX_CNV_MBT_EXCEL_ERROR	☐	Excel load error	20120307

Method CREATE_NEW_DYNAMIC_SHEET Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_NAME	Call by reference	☐	Type reference (TYPE)	C			20110608
2	Returning	RR_SHEET	Value transfer	☐	Object reference (TYPE REF TO)	CL_CNV_MBT_EXCEL_SHEET_DYNAMIC		Excel sheet that works with dynamic (deep) string tables	20110608

#	Exception	Resumable	Description	Created on
1	CX_CNV_MBT_EXCEL_INVALID_PARAM	☐	Invalid Parameter	20110608

Method CREATE_NEW_SHEET Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_NAME	Call by reference	☐	Type reference (TYPE)	C			20110426
2	Returning	RR_SHEET	Value transfer	☐	Object reference (TYPE REF TO)	CL_CNV_MBT_EXCEL_SHEET		Excel sheet for storing a table	20110426

#	Exception	Resumable	Description	Created on
1	CX_CNV_MBT_EXCEL_INVALID_PARAM	☐	Invalid Parameter	20110509

Method CREATE_NEW_TITLE_SHEET Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RR_SHEET	Value transfer	☐	Object reference (TYPE REF TO)	CL_CNV_MBT_EXCEL_TITLE_SHEET		Title sheet for an Excel workbook	20110509

Method CREATE_NEW_TITLE_SHEET on class CL_CNV_MBT_EXCEL_DOCUMENT has no exception.

Method DELETE_STANDARD_SHEETS Signature

Method DELETE_STANDARD_SHEETS on class CL_CNV_MBT_EXCEL_DOCUMENT has no parameter.
Method DELETE_STANDARD_SHEETS on class CL_CNV_MBT_EXCEL_DOCUMENT has no exception.

Method GET_SHEETS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RT_SHEETS	Value transfer	☐	Type reference (TYPE)	CNV_MBT_EXCEL_T_SHEETS		List of Excel sheet objects	20110426

Method GET_SHEETS on class CL_CNV_MBT_EXCEL_DOCUMENT has no exception.

Method LOAD Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_SHEET_TABLES	Call by reference	☑	Type reference (TYPE)	CNV_MBT_EXCEL_T_SHEET_TAB		Worksheets and the tables used to read their data	20110426
2	Importing	IV_FILE_URL	Value transfer	☐	Type reference (TYPE)	STRING			20110426
3	Importing	IV_IGNORE_INCONSISTENCIES	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE	Ignore inconsistencies like wrong worksheet count	20110712
4	Returning	RR_DOCUMENT	Value transfer	☐	Object reference (TYPE REF TO)	CL_CNV_MBT_EXCEL_DOCUMENT		Excel document for storing PIFD data	20110426

#	Exception	Resumable	Description	Created on
1	CX_CNV_MBT_EXCEL_LOAD_ERROR	☐	Excel load error	20110426

Method SAVE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_FILE_NAME	Call by reference	☐	Type reference (TYPE)	STRING			20110426

#	Exception	Resumable	Description	Created on
1	CX_CNV_MBT_EXCEL_EDIT_ERROR	☐	Excel manipulation error	20110426
2	CX_CNV_MBT_EXCEL_SAVE_ERROR	☐	Excel save error	20110426

History

Last changed by/on	SAP	20141030
SAP Release Created in	2010_1_620