SAP CL_GUI_FRONTEND_SERVICES OO Class - Frontend Services
CL_GUI_FRONTEND_SERVICES is a standard SAP object class available within R/3 SAP systems depending on your version and release level. You can view/maintain the class details by entering its name into the relevant SAP transactions such as SE24, SE80 or even SE84. Below is the documentation available for class CL_GUI_FRONTEND_SERVICES including details of:
- Interface class implementations
- Inheritance details
- Methods defined within class ( including link to full details )
- Attributes ( including initial values )
- Class Events
Inheritance
This OO class has a superclass assigned to it, which means it will inherit its objects and methods. The superclass for CL_GUI_FRONTEND_SERVICES is CL_GUI_OBJECTMethod list of CL_GUI_FRONTEND_SERVICES SAP class
A method is a coding block that performs a certain procedure (i.e. ABAP functionality) on an object within the overall SAP class. In simple terms if the object is an SAP database table a method could be the procedure to add a record or to delete a record. If you are new to OO in many respects, the implementation of a method is similar to a function module and can be called in a very similar way using CALL METHOD.
Instead of "CALL FUNCTION", Methods are referenced using the following syntax: CALL METHOD =>methodname EXPORTING/IMPORTING...
| Method Name | Description | Visability |
| CHECK_GUI_SUPPORT | Checks GUI-Supported Features | Public |
| CALL METHOD cl_gui_frontend_services=>CHECK_GUI_SUPPORT...more details | ||
| CLASS_CONSTRUCTOR | Class Constructor | Public |
| CALL METHOD cl_gui_frontend_services=>CLASS_CONSTRUCTOR...more details | ||
| CLIPBOARD_EXPORT | Exports data to clipboard | Public |
| CALL METHOD cl_gui_frontend_services=>CLIPBOARD_EXPORT...more details | ||
| CLIPBOARD_IMPORT | Imports data from clipboard | Public |
| CALL METHOD cl_gui_frontend_services=>CLIPBOARD_IMPORT...more details | ||
| CONSTRUCTOR | Create in Private Section | Public |
| CALL METHOD cl_gui_frontend_services=>CONSTRUCTOR...more details | ||
| DIRECTORY_BROWSE | Shows a Directory Selection Window | Public |
| CALL METHOD cl_gui_frontend_services=>DIRECTORY_BROWSE...more details | ||
|
| ||
| DIRECTORY_CREATE | Creates a Directory in the Client | Public |
| CALL METHOD cl_gui_frontend_services=>DIRECTORY_CREATE...more details | ||
| DIRECTORY_DELETE | Deletes a Directory in the Client | Public |
| CALL METHOD cl_gui_frontend_services=>DIRECTORY_DELETE...more details | ||
| DIRECTORY_EXIST | Checks whether a directory exists | Public |
| CALL METHOD cl_gui_frontend_services=>DIRECTORY_EXIST...more details | ||
| DIRECTORY_GET_CURRENT | Returns the Current Directory | Public |
| CALL METHOD cl_gui_frontend_services=>DIRECTORY_GET_CURRENT...more details | ||
| DIRECTORY_LIST_FILES | Lists Files in a Given Directory | Public |
| CALL METHOD cl_gui_frontend_services=>DIRECTORY_LIST_FILES...more details | ||
| DIRECTORY_SET_CURRENT | Sets the Current Directory (Do NOT Use) | Public |
| CALL METHOD cl_gui_frontend_services=>DIRECTORY_SET_CURRENT...more details | ||
| DISABLEHISTORYFORFIELD | Disables a Specific History Field | Public |
| CALL METHOD cl_gui_frontend_services=>DISABLEHISTORYFORFIELD...more details | ||
| ENVIRONMENT_GET_VARIABLE | Gets an Environment Variable | Public |
| CALL METHOD cl_gui_frontend_services=>ENVIRONMENT_GET_VARIABLE...more details | ||
| ENVIRONMENT_SET_VARIABLE | Sets an Environment Variable | Public |
| CALL METHOD cl_gui_frontend_services=>ENVIRONMENT_SET_VARIABLE...more details | ||
| EXECUTE | Starts an Application or Opens a Document in the Client | Public |
| CALL METHOD cl_gui_frontend_services=>EXECUTE...more details | ||
| FILE_COPY | Copies a File | Public |
| CALL METHOD cl_gui_frontend_services=>FILE_COPY...more details | ||
| FILE_DELETE | Deletes a File | Public |
| CALL METHOD cl_gui_frontend_services=>FILE_DELETE...more details | ||
| FILE_EXIST | Checks if a File Exists | Public |
| CALL METHOD cl_gui_frontend_services=>FILE_EXIST...more details | ||
| FILE_GET_ATTRIBUTES | Gets File Attributes for a File | Public |
| CALL METHOD cl_gui_frontend_services=>FILE_GET_ATTRIBUTES...more details | ||
| FILE_GET_SIZE | Returns the Size of a File | Public |
| CALL METHOD cl_gui_frontend_services=>FILE_GET_SIZE...more details | ||
| FILE_GET_VERSION | Returns the Version Number from Resource of a File | Public |
| CALL METHOD cl_gui_frontend_services=>FILE_GET_VERSION...more details | ||
| FILE_OPEN_DIALOG | Displays a File Open Dialog | Public |
| CALL METHOD cl_gui_frontend_services=>FILE_OPEN_DIALOG...more details | ||
| FILE_SAVE_DIALOG | Shows a File Save Dialog | Public |
| CALL METHOD cl_gui_frontend_services=>FILE_SAVE_DIALOG...more details | ||
| FILE_SET_ATTRIBUTES | Set File Attributes | Public |
| CALL METHOD cl_gui_frontend_services=>FILE_SET_ATTRIBUTES...more details | ||
| GET_COMPUTER_NAME | Get Computer Name | Public |
| CALL METHOD cl_gui_frontend_services=>GET_COMPUTER_NAME...more details | ||
| GET_DESKTOP_DIRECTORY | Get Desktop Directory | Public |
| CALL METHOD cl_gui_frontend_services=>GET_DESKTOP_DIRECTORY...more details | ||
| GET_DRIVE_FREE_SPACE_MEGABYTE | Returns Drive's Free Space in MB | Public |
| CALL METHOD cl_gui_frontend_services=>GET_DRIVE_FREE_SPACE_MEGABYTE...more details | ||
| GET_DRIVE_TYPE | Get Drive Type | Public |
| CALL METHOD cl_gui_frontend_services=>GET_DRIVE_TYPE...more details | ||
| GET_FILE_SEPARATOR | Private | |
| CALL METHOD cl_gui_frontend_services=>GET_FILE_SEPARATOR...more details | ||
| GET_FREE_SPACE_FOR_DRIVE | Returns Free Space on Drive | Public |
| CALL METHOD cl_gui_frontend_services=>GET_FREE_SPACE_FOR_DRIVE...more details | ||
| GET_GUI_PROPERTIES | Returns Stream of GUI Properties | Public |
| CALL METHOD cl_gui_frontend_services=>GET_GUI_PROPERTIES...more details | ||
| GET_GUI_VERSION | Returns the Upload/Download Paths | Public |
| CALL METHOD cl_gui_frontend_services=>GET_GUI_VERSION...more details | ||
| GET_IP_ADDRESS | Gets IP Address | Public |
| CALL METHOD cl_gui_frontend_services=>GET_IP_ADDRESS...more details | ||
| GET_LF_FOR_DESTINATION_GUI | Destinations' SAP GUI Line Feed | Public |
| CALL METHOD cl_gui_frontend_services=>GET_LF_FOR_DESTINATION_GUI...more details | ||
| GET_PLATFORM | Return Operating System Platform | Public |
| CALL METHOD cl_gui_frontend_services=>GET_PLATFORM...more details | ||
| GET_SAPGUI_DIRECTORY | Gets GUI Start Directory | Public |
| CALL METHOD cl_gui_frontend_services=>GET_SAPGUI_DIRECTORY...more details | ||
| GET_SAPGUI_WORKDIR | Returns .. Documents and Settings DNR SAPWorkdir (Example) | Public |
| CALL METHOD cl_gui_frontend_services=>GET_SAPGUI_WORKDIR...more details | ||
| GET_SAPLOGON_ENCODING | Return to saplogon Codepage | Public |
| CALL METHOD cl_gui_frontend_services=>GET_SAPLOGON_ENCODING...more details | ||
| GET_SCREENSHOT | Makes a screenshot of the current window | Public |
| CALL METHOD cl_gui_frontend_services=>GET_SCREENSHOT...more details | ||
| GET_SYSTEM_DIRECTORY | Get System Directory | Public |
| CALL METHOD cl_gui_frontend_services=>GET_SYSTEM_DIRECTORY...more details | ||
| GET_TEMP_DIRECTORY | Returns the Path to the TEMP Directory | Public |
| CALL METHOD cl_gui_frontend_services=>GET_TEMP_DIRECTORY...more details | ||
| GET_UPLOAD_DOWNLOAD_PATH | Gets the upload/download paths | Public |
| CALL METHOD cl_gui_frontend_services=>GET_UPLOAD_DOWNLOAD_PATH...more details | ||
| GET_USER_NAME | Get User Name | Public |
| CALL METHOD cl_gui_frontend_services=>GET_USER_NAME...more details | ||
| GET_WINDOWS_DIRECTORY | Get Windows Directory | Public |
| CALL METHOD cl_gui_frontend_services=>GET_WINDOWS_DIRECTORY...more details | ||
| GUI_DOWNLOAD | Download Data to Client PC | Public |
| CALL METHOD cl_gui_frontend_services=>GUI_DOWNLOAD...more details | ||
| GUI_UPLOAD | Upload Data from Client PC | Public |
| CALL METHOD cl_gui_frontend_services=>GUI_UPLOAD...more details | ||
| IS_SCRIPTING_ACTIVE | Checks whether scripting is currently running | Public |
| CALL METHOD cl_gui_frontend_services=>IS_SCRIPTING_ACTIVE...more details | ||
| IS_TERMINAL_SERVER | Checks if the GUI Runs Under Terminal Services | Public |
| CALL METHOD cl_gui_frontend_services=>IS_TERMINAL_SERVER...more details | ||
| IS_VALID_HANDLE | Checks the validity of the instance | Private |
| CALL METHOD cl_gui_frontend_services=>IS_VALID_HANDLE...more details | ||
| RAISE_SCRIPTING_EVENT | Raise scripting event | Public |
| CALL METHOD cl_gui_frontend_services=>RAISE_SCRIPTING_EVENT...more details | ||
| REGISTRY_DELETE_KEY | Deletes a Registry Key | Public |
| CALL METHOD cl_gui_frontend_services=>REGISTRY_DELETE_KEY...more details | ||
| REGISTRY_DELETE_VALUE | Deletes a Registry Value | Public |
| CALL METHOD cl_gui_frontend_services=>REGISTRY_DELETE_VALUE...more details | ||
| REGISTRY_GET_DWORD_VALUE | Reads a Registry REG_DWORD Value | Public |
| CALL METHOD cl_gui_frontend_services=>REGISTRY_GET_DWORD_VALUE...more details | ||
| REGISTRY_GET_VALUE | Reads a Registry REG_SZ, REG_SZ_EXPAND Value | Public |
| CALL METHOD cl_gui_frontend_services=>REGISTRY_GET_VALUE...more details | ||
| REGISTRY_SET_DWORD_VALUE | Writes a Registry REG_DWORD Value | Public |
| CALL METHOD cl_gui_frontend_services=>REGISTRY_SET_DWORD_VALUE...more details | ||
| REGISTRY_SET_VALUE | Writes a REG_SZ, REG_SZ_EXPAND Registry Value | Public |
| CALL METHOD cl_gui_frontend_services=>REGISTRY_SET_VALUE...more details | ||
| SHOW_DOCUMENT | Displays a document on the front end | Public |
| CALL METHOD cl_gui_frontend_services=>SHOW_DOCUMENT...more details | ||
| SHOW_DOCUMENT_FALLBACK | Helper function of SHOW_DOCUMENT for older clients | Private |
| CALL METHOD cl_gui_frontend_services=>SHOW_DOCUMENT_FALLBACK...more details | ||
| STRCMPI | String comparison (not case-sensitive) | Private |
| CALL METHOD cl_gui_frontend_services=>STRCMPI...more details | ||
| TYPEAHEAD_EXPORT | Exports data to clipboard | Public |
| CALL METHOD cl_gui_frontend_services=>TYPEAHEAD_EXPORT...more details | ||
CL_GUI_FRONTEND_SERVICES attributes
List of attributes within class CL_ABAP_CHAR_UTILITIES. These can be referenced using the following syntax CL_ABAP_CHAR_UTILITIES=>. Although depending on where you are inserting the ABAP code you do need to check if the attribute is public or private.
| Name | Level | Description | Initial Value | Type | Visability |
| ACTION_APPEND | Constant | Action: Append | 1 | LIKE I | Public |
| ACTION_CANCEL | Constant | ACTION_CANCEL | 9 | LIKE I | Public |
| ACTION_OK | Constant | ACTION_OK | 0 | LIKE I | Public |
| ACTION_REPLACE | Constant | Action: Replace | 2 | LIKE I | Public |
| ERROR_CODE | Static Attribute | Error Code Set by Class Constructor | 0 | LIKE I | Private |
| ERROR_NOT_SUPPORTED_BY_GUI | Static Attribute | error code: not supported by gui | -1 | LIKE I | Private |
| ERROR_NO_GUI | Static Attribute | Error Code: No GUI | -2 | LIKE I | Private |
| FILETYPE_ALL | Static Attribute | File Type | LIKE STRING | Public | |
| FILETYPE_EXCEL | Static Attribute | File Type | LIKE STRING | Public | |
| FILETYPE_HTML | Static Attribute | File Type | LIKE STRING | Public | |
| FILETYPE_POWERPOINT | Static Attribute | File Type | LIKE STRING | Public | |
| FILETYPE_RTF | Static Attribute | File Type | LIKE STRING | Public | |
| FILETYPE_TEXT | Static Attribute | File Type | LIKE STRING | Public | |
| FILETYPE_WORD | Static Attribute | File Type | LIKE STRING | Public | |
| FILETYPE_XML | Static Attribute | File Type | LIKE STRING | Public | |
| FILE_SEPARATOR | Instance Attribute | LIKE | Private | ||
| GUIFEATURE | Static Attribute | String Type | 'GF' | LIKE STRING | Private |
| GUI_CRLF | Instance Attribute | LIKE | Private | ||
| HANDLE | Static Attribute | One Instance Only | LIKE CL_GUI_FRONTEND_SERVICES | Private | |
| HKEY_CLASSES_ROOT | Constant | Registry Branch | 0 | LIKE I | Public |
| HKEY_CURRENT_USER | Constant | Registry Branch | 1 | LIKE I | Public |
| HKEY_LOCAL_MACHINE | Constant | Registry Branch | 2 | LIKE I | Public |
| HKEY_USERS | Constant | Registry Branch | 3 | LIKE I | Public |
| ICALL | Static Attribute | Internal Use | 0 | LIKE I | Private |
| M_PLATFORM | Static Attribute | Platform Attribute | 0 | LIKE I | Private |
| PLATFORM_AIX | Constant | Platform Constant | 11 | LIKE I | Public |
| PLATFORM_HPUX | Constant | Platform Constant | 9 | LIKE I | Public |
| PLATFORM_LINUX | Constant | Platform Constant | 8 | LIKE I | Public |
| PLATFORM_MAC | Constant | Platform Constant | 6 | LIKE I | Public |
| PLATFORM_MACOSX | Constant | Platform Constant | 13 | LIKE I | Public |
| PLATFORM_NT351 | Constant | Platform Constant | 3 | LIKE I | Public |
| PLATFORM_NT40 | Constant | Platform Constant | 4 | LIKE I | Public |
| PLATFORM_NT50 | Constant | Platform Constant | 5 | LIKE I | Public |
| PLATFORM_OS2 | Constant | Platform Constant | 7 | LIKE I | Public |
| PLATFORM_SOLARIS | Constant | Platform Constant | 12 | LIKE I | Public |
| PLATFORM_TRU64 | Constant | Platform Constant | 10 | LIKE I | Public |
| PLATFORM_UNKNOWN | Constant | Platform Constant | -1 | LIKE I | Public |
| PLATFORM_WINDOWS95 | Constant | Platform Constant | 1 | LIKE I | Public |
| PLATFORM_WINDOWS98 | Constant | Platform Constant | 2 | LIKE I | Public |
| PLATFORM_WINDOWSXP | Constant | Platform Constant | 14 | LIKE I | Public |
| SAPLOGON_ENCODING | Instance Attribute | LIKE | Private |
Links to Related Class(s)
CL_GUI_F...Full list of available SAP object classes
Search for further information about these or an SAP related objects