SAP ABAP Class CL_CNV_MBT_620_SPRD_DYN_TAB_IO (Spreadsheet table I/O for SAPGUI)

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

Properties

Class	CL_CNV_MBT_620_SPRD_DYN_TAB_IO
Short Description	Spreadsheet table I/O for SAPGUI
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	20120112	SAP
Last change	20141030
Shared Memory-enabled	☐
Fixed point arithmetic	☑
Unicode checks active	☑

Forward declarations

Class CL_CNV_MBT_620_SPRD_DYN_TAB_IO has no forward declaration.

Interfaces

Class CL_CNV_MBT_620_SPRD_DYN_TAB_IO has no interface implemented.

Friends

Class CL_CNV_MBT_620_SPRD_DYN_TAB_IO has no friend class.

Attributes

Class CL_CNV_MBT_620_SPRD_DYN_TAB_IO has no attribute.

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	BUILD_FILE_EXTENSION	Static method	Private	Method	Create the file extension from a file type	20120307
2	BUILD_FILE_FILTER	Static method	Private	Method	Create the file filter from the list of allowed file types	20120307
3	BUILD_FILE_FILTER_ENTRY	Static method	Private	Method	Create the file filter entry for the file type	20120307
4	EXTRACT_FILE_EXTENSION	Static method	Private	Method	Extract the file extension from a file path	20120307
5	FILTER_ALLOWED_FILE_TYPES	Static method	Private	Method	Filters the list of file types to retain only allowed ones	20120307
6	GET_ALL_FILE_TYPES	Static method	Private	Method	Returns all technically possible file types	20120307
7	GET_FIELD_CATALOG	Static method	Private	Method	Build the field catalog for the given table	20120307
8	LOAD_FROM_LOCAL_MACHINE	Static method	Public	Method	Load the table from file on the local machine (via SAPGUI)	20120307
9	READ_FILE_FROM_DISK	Static method	Public	Method	Read a file from the client's hard disk	20120307
10	READ_FROM_EXCEL	Static method	Private	Method	Read Excel file from disk	20120307
11	READ_FROM_ODS	Static method	Private	Method	Read ODS file from disk	20120307
12	READ_TABLE_FROM_DISK	Static method	Public	Method	Read table from disk according to its file type	20120307
13	SAVE_TO_LOCAL_MACHINE	Static method	Public	Method	Save the table to a file on the local machine (via SAPGUI)	20120307
14	WRITE_FILE_TO_DISK	Static method	Public	Method	Writes a file to the client's hard disk	20120307
15	WRITE_TABLE_TO_DISK	Static method	Public	Method	Write table to disk according to file type	20120307
16	WRITE_TO_EXCEL	Static method	Private	Method	Write table to disk as an Excel file	20120307
17	WRITE_TO_ODS	Static method	Private	Method	Write table to disk as an ODS file	20120307

Events

Class CL_CNV_MBT_620_SPRD_DYN_TAB_IO has no event.

Types

Class CL_CNV_MBT_620_SPRD_DYN_TAB_IO has no local type.

Method Signatures

Method BUILD_FILE_EXTENSION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_FILE_TYPE	Call by reference	☐	Type reference (TYPE)	STRING		File type	20120307
2	Returning	RV_FILE_EXTENSION	Value transfer	☐	Type reference (TYPE)	STRING		File extension	20120307

Method BUILD_FILE_EXTENSION on class CL_CNV_MBT_620_SPRD_DYN_TAB_IO has no exception.

Method BUILD_FILE_FILTER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_FILE_TYPES	Call by reference	☐	Type reference (TYPE)	STRING_TABLE		List of file types	20120307
2	Returning	RV_FILE_FILTER	Value transfer	☐	Type reference (TYPE)	STRING		File filter for dialog	20120307

Method BUILD_FILE_FILTER on class CL_CNV_MBT_620_SPRD_DYN_TAB_IO has no exception.

Method BUILD_FILE_FILTER_ENTRY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_FILE_TYPE	Call by reference	☐	Type reference (TYPE)	STRING		File type	20120307
2	Returning	RV_FILE_FILTER_ENTRY	Value transfer	☐	Type reference (TYPE)	STRING		File filter entry	20120307

Method BUILD_FILE_FILTER_ENTRY on class CL_CNV_MBT_620_SPRD_DYN_TAB_IO has no exception.

Method EXTRACT_FILE_EXTENSION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_FILE_PATH	Call by reference	☐	Type reference (TYPE)	STRING			20120307
2	Returning	RV_FILE_EXTENSION	Value transfer	☐	Type reference (TYPE)	STRING			20120307

#	Exception	Resumable	Description	Created on
1	CX_CNV_MBT_620_SPRD_IO	☐	General I/O error	20120307

Method FILTER_ALLOWED_FILE_TYPES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	XT_FILE_TYPES	Call by reference	☐	Type reference (TYPE)	STRING_TABLE		Table of Strings	20120307

Method FILTER_ALLOWED_FILE_TYPES on class CL_CNV_MBT_620_SPRD_DYN_TAB_IO has no exception.

Method GET_ALL_FILE_TYPES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RT_FILE_TYPES	Value transfer	☐	Type reference (TYPE)	STRING_TABLE		Table of Strings	20120307

Method GET_ALL_FILE_TYPES on class CL_CNV_MBT_620_SPRD_DYN_TAB_IO has no exception.

Method GET_FIELD_CATALOG Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_TABLE	Call by reference	☐	Type reference (TYPE)	STANDARD TABLE			20120307
2	Returning	RT_FIELD_CATALOG	Value transfer	☐	Type reference (TYPE)	LVC_T_FCAT		Field Catalog for List Viewer Control	20120307

Method GET_FIELD_CATALOG on class CL_CNV_MBT_620_SPRD_DYN_TAB_IO has no exception.

Method LOAD_FROM_LOCAL_MACHINE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_ALLOWED_FILE_TYPES	Value transfer	☑	Type reference (TYPE)	STRING_TABLE		List of all allowed file types (if available)	20120307
2	Importing	IT_FIELD_CATALOG	Value transfer	☑	Type reference (TYPE)	LVC_T_FCAT		Field Catalog for List Viewer Control	20120307
3	Importing	IV_DEFAULT_FILE_NAME	Call by reference	☑	Type reference (TYPE)	STRING		Default file name	20120307
4	Importing	IV_DEFAULT_FILE_TYPE	Value transfer	☐	Type reference (TYPE)	STRING	'ODS'	Default file type (if available)	20120307
5	Importing	IV_HEADER_LENGTH	Call by reference	☐	Type reference (TYPE)	I	8	Header Length	20120307
6	Importing	IV_WORKSHEET_NAME	Call by reference	☐	Type reference (TYPE)	STRING	'Sheet1'	Worksheet name	20120307
7	Changing	XT_TABLE	Call by reference	☐	Type reference (TYPE)	STANDARD TABLE		Table read from the file	20120307

#	Exception	Resumable	Description	Created on
1	CX_CNV_MBT_620_SPRD_IO	☐	General I/O error	20120307
2	CX_CNV_MBT_620_SPRD_LOAD	☐	Spreadsheet load error	20120307
3	CX_CNV_MBT_620_SPRD_NOT_SPRTD	☐	Not supported	20120307
4	CX_CNV_MBT_620_SPRD_USR_CNCL	☐	Action was canceled by the user	20120307

Method READ_FILE_FROM_DISK Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_FILE_PATH	Call by reference	☐	Type reference (TYPE)	STRING		Absolute file path	20120307
2	Changing	XV_FILE	Call by reference	☐	Type reference (TYPE)	XSTRING		Binary file	20120307

#	Exception	Resumable	Description	Created on
1	CX_CNV_MBT_620_SPRD_IO	☐	General I/O error	20120307

Method READ_FROM_EXCEL Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_FIELD_CATALOG	Value transfer	☐	Type reference (TYPE)	LVC_T_FCAT		Field Catalog for List Viewer Control	20120307
2	Importing	IV_FILE_PATH	Call by reference	☐	Type reference (TYPE)	STRING		Absolute file path	20120307
3	Importing	IV_HEADER_LENGTH	Call by reference	☐	Type reference (TYPE)	I		Header Length	20120307
4	Importing	IV_WORKSHEET_NAME	Call by reference	☐	Type reference (TYPE)	STRING		Worksheet name	20120307
5	Changing	XT_TABLE	Call by reference	☐	Type reference (TYPE)	STANDARD TABLE		Table to be written to the file	20120307

#	Exception	Resumable	Description	Created on
1	CX_CNV_MBT_620_SPRD_IO	☐	General I/O error	20120307
2	CX_CNV_MBT_620_SPRD_LOAD	☐	Spreadsheet load error	20120307
3	CX_CNV_MBT_620_SPRD_NOT_SPRTD	☐	Not supported	20120307

Method READ_FROM_ODS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_FIELD_CATALOG	Call by reference	☐	Type reference (TYPE)	LVC_T_FCAT		Field Catalog for List Viewer Control	20120307
2	Importing	IV_FILE_PATH	Call by reference	☐	Type reference (TYPE)	STRING		Absolute file path	20120307
3	Importing	IV_HEADER_LENGTH	Call by reference	☐	Type reference (TYPE)	I		Header Length	20120307
4	Importing	IV_WORKSHEET_NAME	Call by reference	☐	Type reference (TYPE)	STRING		Worksheet name	20120307
5	Changing	XT_TABLE	Call by reference	☐	Type reference (TYPE)	STANDARD TABLE		Table to be written to the file	20120307

#	Exception	Resumable	Description	Created on
1	CX_CNV_MBT_620_SPRD_IO	☐	General I/O error	20120307
2	CX_CNV_MBT_620_SPRD_LOAD	☐	Spreadsheet load error	20120307
3	CX_CNV_MBT_620_SPRD_NOT_SPRTD	☐	Not supported	20120307

Method READ_TABLE_FROM_DISK Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_FIELD_CATALOG	Call by reference	☑	Type reference (TYPE)	LVC_T_FCAT		Field Catalog for List Viewer Control	20120307
2	Importing	IV_FILE_PATH	Call by reference	☐	Type reference (TYPE)	STRING		Absolute file path	20120307
3	Importing	IV_HEADER_LENGTH	Call by reference	☐	Type reference (TYPE)	I	8	Header Length	20120307
4	Importing	IV_WORKSHEET_NAME	Call by reference	☐	Type reference (TYPE)	STRING	'Sheet1'	Worksheet name	20120307
5	Changing	XT_TABLE	Call by reference	☐	Type reference (TYPE)	STANDARD TABLE		Table read from the file	20120307

#	Exception	Resumable	Description	Created on
1	CX_CNV_MBT_620_SPRD_IO	☐	General I/O error	20120307
2	CX_CNV_MBT_620_SPRD_LOAD	☐	Spreadsheet load error	20120307
3	CX_CNV_MBT_620_SPRD_NOT_SPRTD	☐	Not supported	20120307

Method SAVE_TO_LOCAL_MACHINE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_ALLOWED_FILE_TYPES	Value transfer	☑	Type reference (TYPE)	STRING_TABLE		List of all allowed file types (if available)	20120307
2	Importing	IT_FIELD_CATALOG	Call by reference	☑	Type reference (TYPE)	LVC_T_FCAT		Field Catalog for List Viewer Control	20120307
3	Importing	IT_HEADER	Call by reference	☑	Type reference (TYPE)	STRING_TABLE		Header lines	20120307
4	Importing	IT_TABLE	Call by reference	☐	Type reference (TYPE)	STANDARD TABLE		Table to be written to the file	20120307
5	Importing	IV_DEFAULT_FILE_NAME	Call by reference	☑	Type reference (TYPE)	STRING		Default file name	20120307
6	Importing	IV_DEFAULT_FILE_TYPE	Value transfer	☐	Type reference (TYPE)	STRING	'ODS'	Default file type (if available)	20120307
7	Importing	IV_HEADER_LENGTH	Call by reference	☐	Type reference (TYPE)	I	8	Header Length	20120307
8	Importing	IV_WORKSHEET_NAME	Call by reference	☐	Type reference (TYPE)	STRING	'Sheet1'	Worksheet name	20120307

#	Exception	Resumable	Description	Created on
1	CX_CNV_MBT_620_SPRD_IO	☐	General I/O error	20120307
2	CX_CNV_MBT_620_SPRD_NOT_SPRTD	☐	Not supported	20120307
3	CX_CNV_MBT_620_SPRD_SAVE	☐	Error saving spreadsheet	20120307
4	CX_CNV_MBT_620_SPRD_USR_CNCL	☐	Action was canceled by the user	20120307

Method WRITE_FILE_TO_DISK Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_FILE	Value transfer	☐	Type reference (TYPE)	XSTRING		Binary file	20120307
2	Importing	IV_FILE_PATH	Call by reference	☐	Type reference (TYPE)	STRING		Absolute file path	20120307

#	Exception	Resumable	Description	Created on
1	CX_CNV_MBT_620_SPRD_IO	☐	General I/O error	20120307

Method WRITE_TABLE_TO_DISK Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_FIELD_CATALOG	Call by reference	☑	Type reference (TYPE)	LVC_T_FCAT		Field Catalog for List Viewer Control	20120307
2	Importing	IT_HEADER	Call by reference	☑	Type reference (TYPE)	STRING_TABLE		Header lines	20120307
3	Importing	IT_TABLE	Call by reference	☐	Type reference (TYPE)	STANDARD TABLE		Table to be written to the file	20120307
4	Importing	IV_FILE_PATH	Call by reference	☐	Type reference (TYPE)	STRING		Absolute file path	20120307
5	Importing	IV_HEADER_LENGTH	Call by reference	☐	Type reference (TYPE)	I	8	Header Length	20120307
6	Importing	IV_WORKSHEET_NAME	Call by reference	☐	Type reference (TYPE)	STRING	'Sheet1'	Worksheet name	20120307

#	Exception	Resumable	Description	Created on
1	CX_CNV_MBT_620_SPRD_IO	☐	General I/O error	20120307
2	CX_CNV_MBT_620_SPRD_NOT_SPRTD	☐	Not supported	20120307
3	CX_CNV_MBT_620_SPRD_SAVE	☐	Error saving spreadsheet	20120307

Method WRITE_TO_EXCEL Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_FIELD_CATALOG	Value transfer	☐	Type reference (TYPE)	LVC_T_FCAT		Field Catalog for List Viewer Control	20120307
2	Importing	IT_HEADER	Call by reference	☐	Type reference (TYPE)	STRING_TABLE		Header lines	20120307
3	Importing	IT_TABLE	Call by reference	☐	Type reference (TYPE)	STANDARD TABLE		Table to be written to the file	20120307
4	Importing	IV_FILE_PATH	Call by reference	☐	Type reference (TYPE)	STRING		Absolute file path	20120307
5	Importing	IV_HEADER_LENGTH	Call by reference	☐	Type reference (TYPE)	I		Header Length	20120307
6	Importing	IV_WORKSHEET_NAME	Call by reference	☐	Type reference (TYPE)	STRING		Worksheet name	20120307

#	Exception	Resumable	Description	Created on
1	CX_CNV_MBT_620_SPRD_NOT_SPRTD	☐	Not supported	20120307
2	CX_CNV_MBT_620_SPRD_SAVE	☐	Error saving spreadsheet	20120307

Method WRITE_TO_ODS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_FIELD_CATALOG	Call by reference	☐	Type reference (TYPE)	LVC_T_FCAT		Field Catalog for List Viewer Control	20120307
2	Importing	IT_HEADER	Call by reference	☐	Type reference (TYPE)	STRING_TABLE		Header lines	20120307
3	Importing	IT_TABLE	Call by reference	☐	Type reference (TYPE)	STANDARD TABLE		Table to be written to the file	20120307
4	Importing	IV_FILE_PATH	Call by reference	☐	Type reference (TYPE)	STRING		Absolute file path	20120307
5	Importing	IV_HEADER_LENGTH	Call by reference	☐	Type reference (TYPE)	I		Header Length	20120307
6	Importing	IV_WORKSHEET_NAME	Call by reference	☐	Type reference (TYPE)	STRING		Worksheet name	20120307

#	Exception	Resumable	Description	Created on
1	CX_CNV_MBT_620_SPRD_IO	☐	General I/O error	20120307
2	CX_CNV_MBT_620_SPRD_NOT_SPRTD	☐	Not supported	20120307
3	CX_CNV_MBT_620_SPRD_SAVE	☐	Error saving spreadsheet	20120307

History

Last changed by/on	SAP	20141030
SAP Release Created in