SAP ABAP Class CL_SALV_EXPORT_TOOL (Tool for stand-alone access to ALV export services)
Hierarchy
☛
SAP_UI (Software Component) User Interface Technology
⤷
BC-WD-CMP-ATS (Application Component) ABAP Table/Tree Services
⤷
SALV_ST_PUB (Package) ALV Services for Tables: Public API
SAP_UI (Software Component) User Interface Technology⤷
BC-WD-CMP-ATS (Application Component) ABAP Table/Tree Services⤷
SALV_ST_PUB (Package) ALV Services for Tables: Public APIMeta Relationship - Used By
| # | Relationship type | Used by | Short Description | Created on |
|---|---|---|---|---|
| 1 | Inheritance (c INHERITING FROM c_ref) | CL_SALV_EXPORT_TOOL_XLS | ALV tool for export to Microsoft Excel | 20090904 |
Properties
| Class | CL_SALV_EXPORT_TOOL | |
| Short Description | Tool for stand-alone access to ALV export services | |
| Super Class | ||
| Instantiability of a Class | 2 | Public |
| Final |
General Data
| Message Class | ||
| Program status | ||
| Category | 0 | |
| Package | SALV_ST_PUB | ALV Services for Tables: Public API |
| Created | 20090904 | SAP |
| Last change | 20141120 | |
| Shared Memory-enabled | ||
| Fixed point arithmetic | ||
| Unicode checks active |
Forward declarations
Class CL_SALV_EXPORT_TOOL has no forward declaration.
Interfaces
Class CL_SALV_EXPORT_TOOL has no interface implemented.
Friends
Class CL_SALV_EXPORT_TOOL has no friend class.
Attributes
| # | Attribute | Level | Visibility | Read only | Typing | Associated Type | Initial Value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | R_DATA |
Instance attribute | Protected | Object reference (TYPE REF TO) | DATA | Ref to data table to be exported | 20090904 |
Methods
| # | Method | Level | Visibility | Method type | Description | Created on |
|---|---|---|---|---|---|---|
| 1 | CHECK_CONFIGURATION |
Instance method | Public | Method | Checks for potential problems in the export configuration | 20090904 |
| 2 | CHECK_DATA_REFERENCE |
Static method | Private | Method | 20140814 | |
| 3 | CREATE_FOR_EXCEL |
Static method | Public | Method | Creates export tool instance for export to Microsoft Excel | 20090904 |
| 4 | READ_RESULT |
Instance method | Public | Method | exports R_DATA to requested format | 20090904 |
Events
Class CL_SALV_EXPORT_TOOL has no event.
Types
| # | Type | Visibility | Typing | Associated Type | Description | Created on | Type Source |
|---|---|---|---|---|---|---|---|
| 1 | YT_MSG | Public | See coding | Table of T100 messages | 20090904 | yt_msg type standard table of symsg with default key
|
|
| 2 | Y_FILENAME | Public | Type reference (TYPE) | STRING | 20090904 | |
|
| 3 | Y_FILE_CONTENT | Public | Type reference (TYPE) | XSTRING | 20090904 | |
|
| 4 | Y_MIME_TYPE | Public | Type reference (TYPE) | STRING | 20090904 | |
Method Signatures
Method CHECK_CONFIGURATION Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 |  Exporting |
T_MESSAGES_INFO | Call by reference | Type reference (TYPE) | YT_MSG | restrictions of low priority (e.g. formatting issues) | 20090904 | ||
| 2 | Exporting |
T_MESSAGES_WARNING | Call by reference | Type reference (TYPE) | YT_MSG | restrictions users should know about (e.g. loss of data) | 20090904 |
Method CHECK_CONFIGURATION on class CL_SALV_EXPORT_TOOL has no exception.
Method CHECK_DATA_REFERENCE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 |  Importing |
IR_DATA | Call by reference | Object reference (TYPE REF TO) | DATA | 20140814 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 |  CX_SALV_NOT_INDEX_TABLE |
20140814 |
Method CREATE_FOR_EXCEL Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
FORMAT_SELECTION_PATH | Call by reference | Type reference (TYPE) | CL_SALV_EXPORT_TOOL_XLS=>Y_FORMAT_SELECTION_PATH | CL_SALV_EXPORT_TOOL_XLS=>CS_FORMAT_SELECTION_PATH-WD_ALV_CUSTOMIZING_AND_PERSO | 20130104 | ||
| 2 | Importing |
PROVIDER | Call by reference | Type reference (TYPE) | CL_SALV_EXPORT_TOOL_XLS=>Y_EXPORT_PROVIDER | CL_SALV_EXPORT_TOOL_XLS=>CS_EXPORT_PROVIDER-DEFAULT | 20140814 | ||
| 3 | Importing |
R_DATA | Value transfer | Object reference (TYPE REF TO) | DATA | ref to table containing data for export | 20090904 | ||
| 4 |  Returning |
R_INSTANCE | Value transfer | Object reference (TYPE REF TO) | CL_SALV_EXPORT_TOOL_XLS | Tool for stand-alone access to ALV export services | 20090904 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_SALV_ILL_EXPORT_FORMAT_PATH |
20130104 | ||
| 2 | CX_SALV_NOT_INDEX_TABLE |
20140814 |
Method READ_RESULT Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Exporting |
CONTENT | Call by reference | Type reference (TYPE) | Y_FILE_CONTENT | exported file content | 20090904 | ||
| 2 | Exporting |
FILENAME | Call by reference | Type reference (TYPE) | Y_FILENAME | suggested filename | 20090904 | ||
| 3 | Exporting |
MIME_TYPE | Call by reference | Type reference (TYPE) | Y_MIME_TYPE | mime type of exported file | 20090904 | ||
| 4 | Exporting |
T_MESSAGES_INFO | Call by reference | Type reference (TYPE) | YT_MSG | restrictions of low priority (e.g. formatting issues) | 20090904 | ||
| 5 | Exporting |
T_MESSAGES_WARNING | Call by reference | Type reference (TYPE) | YT_MSG | restrictions users should know about (e.g. loss of data) | 20090904 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_SALV_EXPORT_ERROR |
Unspecified Export Exception | 20090904 |
History
| Last changed by/on | SAP | 20141120 |
| SAP Release Created in | 800 |
