SAP ABAP Class CL_GRFN_EXCEL (Excel utility class)

Hierarchy

☛ GRCFND_A (Software Component) GRC Foundation ABAP
   ⤷ GRC (Application Component) Governance, Risk and Compliance
     ⤷ GRFN_CLM (Package) Shared infrastructure for CLM integration

Properties

Class	CL_GRFN_EXCEL
Short Description	Excel utility class
Super Class
Instantiability of a Class	2	Public
Final	☐

General Data

Message Class
Program status
Category	0
Package	GRFN_CLM	Shared infrastructure for CLM integration
Created	20100819	SAP
Last change	20141106
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	OLE2	Type group use (TYPE-POOLS tp)	Type group use (TYPE-POOLS tp)

Interfaces

Class CL_GRFN_EXCEL has no interface implemented.

Friends

Class CL_GRFN_EXCEL has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	GC_XL_BOOL	Constant	Public	☐	See coding				20101018
2	GC_XL_DV_ALERT_STYLE	Constant	Public	☐	See coding				20100825
3	GC_XL_DV_TYPE	Constant	Public	☐	See coding				20100825
4	GC_XL_FORMAT_CONDITION_OP	Constant	Public	☐	See coding				20100825
5	GC_XL_XML_EXPORT_RESULT	Constant	Public	☐	See coding				20101018
6	MO_EXCEL	Instance attribute	Protected	☐	Type reference (TYPE)	OLE2_OBJECT			20100819

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	ACTIVATE_WORKSHEET	Instance method	Public	Method		20100819
2	ADD_COMPONENT	Instance method	Public	Method		20100827
3	ADD_LIST_OBJECT	Instance method	Public	Method		20100929
4	ADD_VBA	Instance method	Public	Method		20100827
5	ADD_WORKBOOK	Instance method	Public	Method		20100823
6	ADD_WORKSHEET	Instance method	Public	Method		20100823
7	ADD_XML_MAP	Instance method	Public	Method		20100907
8	CONSTRUCTOR	Instance method	Public	Constructor	CONSTRUCTOR	20100819
9	DELETE_WORKSHEET	Instance method	Public	Method		20100823
10	EXPORT	Instance method	Public	Method		20101014
11	EXPORT_XML	Instance method	Public	Method		20101014
12	GET_CELL_VALUE	Instance method	Public	Method		20100819
13	GET_EXCEL_OLE_OBJECT	Instance method	Public	Method		20100823
14	GET_RANGE_OLE_OBJECT	Instance method	Public	Method		20100825
15	GET_RANGE_VALUE	Instance method	Public	Method		20100820
16	GET_WORKSHEET_COUNT	Instance method	Public	Method		20100825
17	GET_WORKSHEET_NAME	Instance method	Public	Method		20100825
18	GET_XML_MAP	Instance method	Public	Method		20101014
19	IMPORT_XML	Instance method	Public	Method	Import XML string	20120611
20	OPEN_WORKBOOK	Instance method	Public	Method		20100819
21	QUIT	Instance method	Public	Method		20100819
22	SET_CELL_VALUE	Instance method	Public	Method		20100819
23	SET_LIST_COLUMN_NAME	Instance method	Public	Method		20100929
24	SET_LIST_COLUMN_XPATH_VALUE	Instance method	Public	Method		20100929
25	SET_RANGE_COLUMN_WIDTH	Instance method	Public	Method		20100825
26	SET_RANGE_INTERIOR	Instance method	Public	Method		20100825
27	SET_RANGE_NUMBER_FORMAT	Instance method	Public	Method		20101025
28	SET_RANGE_VALIDATION	Instance method	Public	Method		20100825
29	XML_IMPORT_XML	Instance method	Public	Method		20101014

Events

Class CL_GRFN_EXCEL has no event.

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	S_INDEX_VALUE	Public	See coding			20100823	begin of s_index_value, row type i, column type i, value type string, end of s_index_value
2	T_INDEX_VALUE	Public	See coding			20100823	t_index_value type table of s_index_value
3	T_STRING_TABLE	Public	See coding			20100823	t_string_table type table of string_table
4	XL_BOOL	Public	Type reference (TYPE)	I		20101018
5	XL_DV_ALERT_STYLE	Public	Type reference (TYPE)	I		20100825
6	XL_DV_TYPE	Public	Type reference (TYPE)	I		20100825
7	XL_FORMAT_CONDITION_OPERATOR	Public	Type reference (TYPE)	I		20100825
8	XL_XML_EXPORT_RESULT	Public	Type reference (TYPE)	I		20101018
9	XL_XML_IMPORT_RESULT	Public	Type reference (TYPE)	I		20120611

Method Signatures

Method ACTIVATE_WORKSHEET Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_COUNT	Call by reference	☑	Type reference (TYPE)	I			20100825
2	Importing	IV_NAME	Call by reference	☑	Type reference (TYPE)	STRING			20100819
3	Returning	RO_WORKSHEET	Value transfer	☐	Type reference (TYPE)	OLE2_OBJECT			20100819

Method ACTIVATE_WORKSHEET on class CL_GRFN_EXCEL has no exception.

Method ADD_COMPONENT Signature

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

Method ADD_COMPONENT on class CL_GRFN_EXCEL has no exception.

Method ADD_LIST_OBJECT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_RANGE	Call by reference	☐	Type reference (TYPE)	OLE2_OBJECT		Text for Screen 3000	20100929
2	Importing	IV_NAME	Call by reference	☑	Type reference (TYPE)	STRING			20100929
3	Returning	RO_LIST_OBJECT	Value transfer	☐	Type reference (TYPE)	OLE2_OBJECT			20100929

Method ADD_LIST_OBJECT on class CL_GRFN_EXCEL has no exception.

Method ADD_VBA Signature

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

Method ADD_VBA on class CL_GRFN_EXCEL has no exception.

Method ADD_WORKBOOK Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RO_WORKBOOK	Value transfer	☐	Type reference (TYPE)	OLE2_OBJECT			20100823

Method ADD_WORKBOOK on class CL_GRFN_EXCEL has no exception.

Method ADD_WORKSHEET 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)	STRING			20100823
2	Importing	IV_VISIBLE	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_TRUE		20110706

Method ADD_WORKSHEET on class CL_GRFN_EXCEL has no exception.

Method ADD_XML_MAP 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)	STRING			20100928
2	Importing	IV_SCHEMA	Call by reference	☐	Type reference (TYPE)	STRING			20100907
3	Returning	RO_XML_MAP	Value transfer	☐	Type reference (TYPE)	OLE2_OBJECT			20100907

Method ADD_XML_MAP on class CL_GRFN_EXCEL has no exception.

Method CONSTRUCTOR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_VISIBLE	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_TRUE		20100823

Method CONSTRUCTOR on class CL_GRFN_EXCEL has no exception.

Method DELETE_WORKSHEET 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)	STRING			20100823

Method DELETE_WORKSHEET on class CL_GRFN_EXCEL has no exception.

Method EXPORT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EV_IS_EXPORTABLE	Call by reference	☐	Type reference (TYPE)	XL_BOOL			20101018
2	Exporting	EV_RESULT	Call by reference	☐	Type reference (TYPE)	XL_XML_EXPORT_RESULT			20101018
3	Importing	IV_URL	Call by reference	☐	Type reference (TYPE)	STRING			20101014
4	Importing	IV_XML_MAP_NAME	Call by reference	☐	Type reference (TYPE)	STRING			20101014

Method EXPORT on class CL_GRFN_EXCEL has no exception.

Method EXPORT_XML Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EV_DATA	Call by reference	☐	Type reference (TYPE)	STRING			20101014
2	Importing	IV_XML_MAP_NAME	Call by reference	☐	Type reference (TYPE)	STRING			20101014

Method EXPORT_XML on class CL_GRFN_EXCEL has no exception.

Method GET_CELL_VALUE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_COLUMNINDEX	Call by reference	☐	Type reference (TYPE)	I			20100819
2	Importing	IV_ROWINDEX	Call by reference	☐	Type reference (TYPE)	I			20100819
3	Returning	RV_VALUE	Value transfer	☐	Type reference (TYPE)	STRING			20100819

Method GET_CELL_VALUE on class CL_GRFN_EXCEL has no exception.

Method GET_EXCEL_OLE_OBJECT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RO_OLE	Value transfer	☐	Type reference (TYPE)	OLE2_OBJECT			20100823

Method GET_EXCEL_OLE_OBJECT on class CL_GRFN_EXCEL has no exception.

Method GET_RANGE_OLE_OBJECT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_COLUMNINDEX	Call by reference	☐	Type reference (TYPE)	I			20100825
2	Importing	IV_COLUMNNUM	Call by reference	☐	Type reference (TYPE)	I			20100825
3	Importing	IV_ROWINDEX	Call by reference	☐	Type reference (TYPE)	I			20100825
4	Importing	IV_ROWNUM	Call by reference	☐	Type reference (TYPE)	I			20100825
5	Returning	RO_OLE	Value transfer	☐	Type reference (TYPE)	OLE2_OBJECT			20100825

Method GET_RANGE_OLE_OBJECT on class CL_GRFN_EXCEL has no exception.

Method GET_RANGE_VALUE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_INDEX_VALUE	Call by reference	☐	Type reference (TYPE)	T_INDEX_VALUE			20100823
2	Exporting	ET_STRING_TABLE	Call by reference	☐	Type reference (TYPE)	T_STRING_TABLE			20100823
3	Importing	IV_COLUMNINDEX	Call by reference	☐	Type reference (TYPE)	I			20100823
4	Importing	IV_COLUMNNUM	Call by reference	☐	Type reference (TYPE)	I			20100823
5	Importing	IV_ROWINDEX	Call by reference	☐	Type reference (TYPE)	I			20100823
6	Importing	IV_ROWNUM	Call by reference	☐	Type reference (TYPE)	I			20100823

Method GET_RANGE_VALUE on class CL_GRFN_EXCEL has no exception.

Method GET_WORKSHEET_COUNT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_COUNT	Value transfer	☐	Type reference (TYPE)	I			20100825

Method GET_WORKSHEET_COUNT on class CL_GRFN_EXCEL has no exception.

Method GET_WORKSHEET_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)	STRING			20100825

Method GET_WORKSHEET_NAME on class CL_GRFN_EXCEL has no exception.

Method GET_XML_MAP 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)	STRING			20101014
2	Returning	RO_XML_MAP	Value transfer	☐	Type reference (TYPE)	OLE2_OBJECT			20101014

Method GET_XML_MAP on class CL_GRFN_EXCEL has no exception.

Method IMPORT_XML Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_DATA	Call by reference	☐	Type reference (TYPE)	STRING			20120611
2	Importing	IV_XML_MAP_NAME	Call by reference	☐	Type reference (TYPE)	STRING			20120611
3	Returning	RV_RESULT	Value transfer	☐	Type reference (TYPE)	XL_XML_IMPORT_RESULT			20120611

Method IMPORT_XML on class CL_GRFN_EXCEL has no exception.

Method OPEN_WORKBOOK Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_FILENAME	Call by reference	☐	Type reference (TYPE)	STRING			20100819
2	Returning	RO_WORKBOOK	Value transfer	☐	Type reference (TYPE)	OLE2_OBJECT			20100819

Method OPEN_WORKBOOK on class CL_GRFN_EXCEL has no exception.

Method QUIT Signature

Method QUIT on class CL_GRFN_EXCEL has no parameter.
Method QUIT on class CL_GRFN_EXCEL has no exception.

Method SET_CELL_VALUE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_COLUMNINDEX	Call by reference	☐	Type reference (TYPE)	I			20100819
2	Importing	IV_ROWINDEX	Call by reference	☐	Type reference (TYPE)	I			20100819
3	Importing	IV_VALUE	Call by reference	☐	Type reference (TYPE)	STRING			20100819

Method SET_CELL_VALUE on class CL_GRFN_EXCEL has no exception.

Method SET_LIST_COLUMN_NAME Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_LIST_OBJECT	Call by reference	☐	Type reference (TYPE)	OLE2_OBJECT			20100929
2	Importing	IV_INDEX	Call by reference	☐	Type reference (TYPE)	I			20100929
3	Importing	IV_NAME	Call by reference	☐	Type reference (TYPE)	STRING			20100929

Method SET_LIST_COLUMN_NAME on class CL_GRFN_EXCEL has no exception.

Method SET_LIST_COLUMN_XPATH_VALUE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_LIST_OBJECT	Call by reference	☐	Type reference (TYPE)	OLE2_OBJECT			20100929
2	Importing	IO_MAP	Call by reference	☐	Type reference (TYPE)	OLE2_OBJECT			20100929
3	Importing	IV_INDEX	Call by reference	☐	Type reference (TYPE)	I			20100929
4	Importing	IV_XPATH	Call by reference	☐	Type reference (TYPE)	STRING			20100929

Method SET_LIST_COLUMN_XPATH_VALUE on class CL_GRFN_EXCEL has no exception.

Method SET_RANGE_COLUMN_WIDTH Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_COLUMNINDEX	Call by reference	☐	Type reference (TYPE)	I			20100825
2	Importing	IV_COLUMNNUM	Call by reference	☐	Type reference (TYPE)	I			20100825
3	Importing	IV_COLUMN_WIDTH	Call by reference	☐	Type reference (TYPE)	I			20100825
4	Importing	IV_ROWINDEX	Call by reference	☐	Type reference (TYPE)	I			20100825
5	Importing	IV_ROWNUM	Call by reference	☐	Type reference (TYPE)	I			20100825

Method SET_RANGE_COLUMN_WIDTH on class CL_GRFN_EXCEL has no exception.

Method SET_RANGE_INTERIOR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_COLOR_INDEX	Call by reference	☐	Type reference (TYPE)	I			20100825
2	Importing	IV_COLUMNINDEX	Call by reference	☐	Type reference (TYPE)	I			20100825
3	Importing	IV_COLUMNNUM	Call by reference	☐	Type reference (TYPE)	I			20100825
4	Importing	IV_ROWINDEX	Call by reference	☐	Type reference (TYPE)	I			20100825
5	Importing	IV_ROWNUM	Call by reference	☐	Type reference (TYPE)	I			20100825

Method SET_RANGE_INTERIOR on class CL_GRFN_EXCEL has no exception.

Method SET_RANGE_NUMBER_FORMAT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_COLUMNINDEX	Call by reference	☐	Type reference (TYPE)	I			20101025
2	Importing	IV_COLUMNNUM	Call by reference	☐	Type reference (TYPE)	I			20101025
3	Importing	IV_NUMBER_FORMAT	Call by reference	☑	Type reference (TYPE)	STRING			20101025
4	Importing	IV_ROWINDEX	Call by reference	☐	Type reference (TYPE)	I			20101025
5	Importing	IV_ROWNUM	Call by reference	☐	Type reference (TYPE)	I			20101025

Method SET_RANGE_NUMBER_FORMAT on class CL_GRFN_EXCEL has no exception.

Method SET_RANGE_VALIDATION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_ALERTSTYLE	Call by reference	☐	Type reference (TYPE)	XL_DV_ALERT_STYLE			20100825
2	Importing	IV_COLUMNINDEX	Call by reference	☐	Type reference (TYPE)	I			20100825
3	Importing	IV_COLUMNNUM	Call by reference	☐	Type reference (TYPE)	I			20100825
4	Importing	IV_FORMULA1	Call by reference	☐	Type reference (TYPE)	DATA			20100825
5	Importing	IV_FORMULA2	Call by reference	☑	Type reference (TYPE)	DATA			20100825
6	Importing	IV_IGNORE_BLANK	Call by reference	☑	Type reference (TYPE)	XL_BOOL			20101025
7	Importing	IV_OPERATOR	Call by reference	☐	Type reference (TYPE)	XL_FORMAT_CONDITION_OPERATOR			20100825
8	Importing	IV_ROWINDEX	Call by reference	☐	Type reference (TYPE)	I			20100825
9	Importing	IV_ROWNUM	Call by reference	☐	Type reference (TYPE)	I			20100825
10	Importing	IV_TYPE	Call by reference	☐	Type reference (TYPE)	XL_DV_TYPE			20100825

Method SET_RANGE_VALIDATION on class CL_GRFN_EXCEL has no exception.

Method XML_IMPORT_XML Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_DESTINATION	Call by reference	☐	Type reference (TYPE)	OLE2_OBJECT			20101014
2	Importing	IO_IMPORT_MAP	Call by reference	☐	Type reference (TYPE)	OLE2_OBJECT			20101014
3	Importing	IV_DATA	Call by reference	☐	Type reference (TYPE)	STRING			20101014

Method XML_IMPORT_XML on class CL_GRFN_EXCEL has no exception.

History

Last changed by/on	SAP	20141106
SAP Release Created in	V1000