SAP ABAP Class CL_CNV_MBT_EXCEL_SHEET (Excel sheet for storing a table)

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_EXCEL_SHEET_DYNAMIC	Excel sheet that works with dynamic (deep) string tables	20110608
2	Inheritance (c INHERITING FROM c_ref)	CL_CNV_MBT_EXCEL_TITLE_SHEET	Title sheet for an Excel workbook	20110509
3	Inheritance (c INHERITING FROM c_ref)	CL_CNV_MBT_PIFD_EXCEL_SHEET	Excel sheet for storing a table	20110426

Properties

Class	CL_CNV_MBT_EXCEL_SHEET
Short Description	Excel sheet for storing a table
Super Class
Instantiability of a Class	1	Protected
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

Class CL_CNV_MBT_EXCEL_SHEET has no forward declaration.

Interfaces

Class CL_CNV_MBT_EXCEL_SHEET has no interface implemented.

Friends

#	Friend	Modeled only	Created on	Description
1	CL_CNV_MBT_EXCEL_DOCUMENT	☐	20110426	Excel document for storing data

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	OC_FIRST_DATA_LINE	Constant	Protected	☐	Type reference (TYPE)	I	10	First line to be used for data	20110608
2	OC_MAX_ROWS	Constant	Protected	☐	Type reference (TYPE)	I	1048576	Maximum rows in the excel sheet	20110614
3	OC_READ_BATCH_LINES	Constant	Protected	☐	Type reference (TYPE)	I	10	Number of lines to read in one batch	20110614
4	OC_READ_RANGE_NAME	Constant	Protected	☐	See coding		'READ_RANGE_01'	Name of the range for reading	20110614
5	OR_DATA_TABLE	Instance attribute	Protected	☐	Object reference (TYPE REF TO)	DATA			20110509
6	OR_HEADER_TABLE	Instance attribute	Protected	☐	Object reference (TYPE REF TO)	DATA			20110509
7	OT_TABLE_HEADER_LINE	Instance attribute	Protected	☐	Type reference (TYPE)	CNV_MBT_EXCEL_T_TABLE_HEADER		Table Header Line Description	20110607
8	OV_NAME	Instance attribute	Protected	☐	Type reference (TYPE)	CNV_MBT_EXCEL_SHEET_NAME		Name of an Excel worksheet	20110608
9	PR_CONTAINING_DOCUMENT	Instance attribute	Private	☐	Object reference (TYPE REF TO)	CL_CNV_MBT_EXCEL_DOCUMENT		Excel document for storing PIFD data	20110426

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	CONSTRUCTOR	Instance method	Public	Constructor	CONSTRUCTOR	20110426
2	FORMAT_AREA	Instance method	Protected	Method	Formats an area on the current sheet	20110509
3	FORMAT_HEADER	Instance method	Protected	Method	Formats the header area	20110509
4	GET_DATA_TABLE	Instance method	Public	Method	Returns the data table displayed on this sheet	20110426
5	GET_DATA_TABLE_OFFSET	Instance method	Public	Method	Returns the offset of the data table (first data line - 1)	20121113
6	GET_NAME	Instance method	Public	Method	Returns the sheet's name	20110426
7	READ_FROM_SHEET	Instance method	Protected	Method	Reads from a spreadsheet object (internal)	20110426
8	SET_DATA_TABLE	Instance method	Public	Method	Sets the data table to be displayed on this sheet	20110426
9	SET_HEADER_TABLE	Instance method	Public	Method	Sets the header for the sheet	20110428
10	SET_TABLE_HEADER_LINE	Instance method	Public	Method	Sets the table header line	20110607
11	WRITE_TABLE_HEADER_TO_SHEET	Instance method	Protected	Method	Writes the table header line to the worksheet	20110607
12	WRITE_TABLE_TO_SHEET	Instance method	Protected	Method	Write a table to a sheet	20110428
13	WRITE_TO_SHEET	Instance method	Protected	Method	Writes to a spreadsheet object (internal)	20110426

Events

Class CL_CNV_MBT_EXCEL_SHEET has no event.

Types

Class CL_CNV_MBT_EXCEL_SHEET has no local type.

Method Signatures

Method CONSTRUCTOR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IR_CONTAINING_DOCUMENT	Call by reference	☐	Object reference (TYPE REF TO)	CL_CNV_MBT_EXCEL_DOCUMENT		Excel document for storing PIFD data	20110426
2	Importing	IV_NAME	Call by reference	☐	Type reference (TYPE)	C		Name of the worksheet	20110426

Method CONSTRUCTOR on class CL_CNV_MBT_EXCEL_SHEET has no exception.

Method FORMAT_AREA Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_BACKGROUND_COLOR	Call by reference	☐	Type reference (TYPE)	I			20110509
2	Importing	IV_COLUMNS	Call by reference	☐	Type reference (TYPE)	I			20110509
3	Importing	IV_FRONT_COLOR	Call by reference	☐	Type reference (TYPE)	I			20110509
4	Importing	IV_LEFT	Call by reference	☐	Type reference (TYPE)	I			20110509
5	Importing	IV_ROWS	Call by reference	☐	Type reference (TYPE)	I			20110509
6	Importing	IV_TOP	Call by reference	☐	Type reference (TYPE)	I			20110509
7	Changing	XR_SPREADSHEET	Call by reference	☐	Object reference (TYPE REF TO)	I_OI_SPREADSHEET		Table interface	20110509

Method FORMAT_AREA on class CL_CNV_MBT_EXCEL_SHEET has no exception.

Method FORMAT_HEADER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	XR_SPREADSHEET	Call by reference	☐	Object reference (TYPE REF TO)	I_OI_SPREADSHEET		Table interface	20110509

Method FORMAT_HEADER on class CL_CNV_MBT_EXCEL_SHEET has no exception.

Method GET_DATA_TABLE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	XT_DATA_TABLE	Call by reference	☐	Type reference (TYPE)	STANDARD TABLE			20110426

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

Method GET_DATA_TABLE_OFFSET Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_DATA_OFFSET	Value transfer	☐	Type reference (TYPE)	CNV_MBT_EXCEL_DATA_OFFSET		Offset of Data Table in Excel Spreadsheet	20121113

Method GET_DATA_TABLE_OFFSET on class CL_CNV_MBT_EXCEL_SHEET has no exception.

Method GET_NAME Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_NAME	Value transfer	☐	Type reference (TYPE)	CNV_MBT_EXCEL_SHEET_NAME		Name of an Excel worksheet	20110426

Method GET_NAME on class CL_CNV_MBT_EXCEL_SHEET has no exception.

Method READ_FROM_SHEET Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IR_DATA_TABLE	Call by reference	☐	Object reference (TYPE REF TO)	DATA			20110426
2	Importing	IR_SPREADSHEET	Call by reference	☐	Object reference (TYPE REF TO)	I_OI_SPREADSHEET		Table interface	20110426
3	Importing	IV_DYNAMIC_COLUMNS	Call by reference	☐	Type reference (TYPE)	CNV_MBT_EXCEL_DYN_CLMN_COUNT		Number of dynamic columns	20110614

Method READ_FROM_SHEET on class CL_CNV_MBT_EXCEL_SHEET has no exception.

Method SET_DATA_TABLE Signature

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

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

Method SET_HEADER_TABLE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_HEADER_TABLE	Call by reference	☐	Type reference (TYPE)	STANDARD TABLE			20110428

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

Method SET_TABLE_HEADER_LINE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_TABLE_HEADER_LINE	Call by reference	☐	Type reference (TYPE)	CNV_MBT_EXCEL_T_TABLE_HEADER		Table Header Line Description	20110607

Method SET_TABLE_HEADER_LINE on class CL_CNV_MBT_EXCEL_SHEET has no exception.

Method WRITE_TABLE_HEADER_TO_SHEET Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	XR_SPREADSHEET	Call by reference	☐	Object reference (TYPE REF TO)	I_OI_SPREADSHEET		Table interface	20110607

Method WRITE_TABLE_HEADER_TO_SHEET on class CL_CNV_MBT_EXCEL_SHEET has no exception.

Method WRITE_TABLE_TO_SHEET Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IR_TABLE_REF	Call by reference	☐	Object reference (TYPE REF TO)	DATA			20110428
2	Importing	IV_FIRST_ROW	Call by reference	☐	Type reference (TYPE)	I			20110428
3	Changing	XR_SPREADSHEET	Call by reference	☐	Object reference (TYPE REF TO)	I_OI_SPREADSHEET		Table interface	20110428

Method WRITE_TABLE_TO_SHEET on class CL_CNV_MBT_EXCEL_SHEET has no exception.

Method WRITE_TO_SHEET Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	XR_SPREADSHEET	Call by reference	☐	Object reference (TYPE REF TO)	I_OI_SPREADSHEET		Table interface	20110426

Method WRITE_TO_SHEET on class CL_CNV_MBT_EXCEL_SHEET has no exception.

History

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