ABAP OO Class Methods

CL_GUI_FRONTEND_SERVICES SAP 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

Also check out the Resources section below to view useful tips, screenshots, links and general information related to this SAP class and its methods, or even add your own for future reference.




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_OBJECT



Methods of CL_GUI_FRONTEND_SERVICES







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 CL_ABAP_CHAR_UTILITIES=>methodname EXPORTING/IMPORTING...



CHECK_GUI_SUPPORT - Checks GUI-Supported Features
CLASS_CONSTRUCTOR - Class Constructor
CLIPBOARD_EXPORT - Exports data to clipboard
CLIPBOARD_IMPORT - Imports data from clipboard
CONSTRUCTOR - Create in Private Section
DIRECTORY_BROWSE - Shows a Directory Selection Window
DIRECTORY_CREATE - Creates a Directory in the Client
DIRECTORY_DELETE - Deletes a Directory in the Client
DIRECTORY_EXIST - Checks whether a directory exists
DIRECTORY_GET_CURRENT - Returns the Current Directory
DIRECTORY_LIST_FILES - Lists Files in a Given Directory
DIRECTORY_SET_CURRENT - Sets the Current Directory (Do NOT Use)
DISABLEHISTORYFORFIELD - Disables a Specific History Field
ENVIRONMENT_GET_VARIABLE - Gets an Environment Variable
ENVIRONMENT_SET_VARIABLE - Sets an Environment Variable
EXECUTE - Starts an Application or Opens a Document in the Client
FILE_COPY - Copies a File
FILE_DELETE - Deletes a File
FILE_EXIST - Checks if a File Exists
FILE_GET_ATTRIBUTES - Gets File Attributes for a File
FILE_GET_SIZE - Returns the Size of a File
FILE_GET_VERSION - Returns the Version Number from Resource of a File
FILE_OPEN_DIALOG - Displays a File Open Dialog
FILE_SAVE_DIALOG - Shows a File Save Dialog
FILE_SET_ATTRIBUTES - Set File Attributes
GET_COMPUTER_NAME - Get Computer Name
GET_DESKTOP_DIRECTORY - Get Desktop Directory
GET_DRIVE_FREE_SPACE_MEGABYTE - Returns Drive's Free Space in MB
GET_DRIVE_TYPE - Get Drive Type
GET_FILE_SEPARATOR - Get File Separator
GET_FREE_SPACE_FOR_DRIVE - Returns Free Space on Drive
GET_GUI_PROPERTIES - Returns Stream of GUI Properties
GET_GUI_VERSION - Returns the Upload/Download Paths
GET_IP_ADDRESS - Gets IP Address
GET_LF_FOR_DESTINATION_GUI - Destinations' SAP GUI Line Feed
GET_PLATFORM - Return Operating System Platform
GET_SAPGUI_DIRECTORY - Gets GUI Start Directory
GET_SAPGUI_WORKDIR - Returns ..\\Documents and Settings\DNR\SAPWorkdir (Example)
GET_SAPLOGON_ENCODING - Return to saplogon Codepage


GET_SCREENSHOT - Makes a screenshot of the current window
GET_SYSTEM_DIRECTORY - Get System Directory
GET_TEMP_DIRECTORY - Returns the Path to the TEMP Directory
GET_UPLOAD_DOWNLOAD_PATH - Gets the upload/download paths
GET_USER_NAME - Get User Name
GET_WINDOWS_DIRECTORY - Get Windows Directory
GUI_DOWNLOAD - Download Data to Client PC
GUI_UPLOAD - Upload Data from Client PC
IS_SCRIPTING_ACTIVE - Checks whether scripting is currently running
IS_TERMINAL_SERVER - Checks if the GUI Runs Under Terminal Services
IS_VALID_HANDLE - Checks the validity of the instance
RAISE_SCRIPTING_EVENT - Raise scripting event
REGISTRY_DELETE_KEY - Deletes a Registry Key
REGISTRY_DELETE_VALUE - Deletes a Registry Value
REGISTRY_GET_DWORD_VALUE - Reads a Registry REG_DWORD Value
REGISTRY_GET_VALUE - Reads a Registry REG_SZ, REG_SZ_EXPAND Value
REGISTRY_SET_DWORD_VALUE - Writes a Registry REG_DWORD Value
REGISTRY_SET_VALUE - Writes a REG_SZ, REG_SZ_EXPAND Registry Value
SHOW_DOCUMENT - Displays a document on the front end
SHOW_DOCUMENT_FALLBACK - Helper function of SHOW_DOCUMENT for older clients
STRCMPI - String comparison (not case-sensitive)
TYPEAHEAD_EXPORT - Exports data to clipboard


CL_GUI_FRONTEND_SERVICES Attributes

List of attributes within class CL_GUI_FRONTEND_SERVICES. These can be referenced using the following syntax CL_GUI_FRONTEND_SERVICES=>. Although depending on where you are inserting the ABAP code you do need to check if the attribute is public or private.


NameDescriptionInitial Value
ACTION_APPEND Action: Append 1
ACTION_CANCEL ACTION_CANCEL 9
ACTION_OK ACTION_OK 0
ACTION_REPLACE Action: Replace 2
ERROR_CODE Error Code Set by Class Constructor 0
ERROR_NOT_SUPPORTED_BY_GUI error code: not supported by gui -1
ERROR_NO_GUI Error Code: No GUI -2
FILETYPE_ALL File Type
FILETYPE_EXCEL File Type
FILETYPE_HTML File Type
FILETYPE_POWERPOINT File Type
FILETYPE_RTF File Type
FILETYPE_TEXT File Type
FILETYPE_WORD File Type
FILETYPE_XML File Type
FILE_SEPARATOR File Separator
GUIFEATURE String Type 'GF'


GUI_CRLF Gui Crlf
HANDLE One Instance Only
HKEY_CLASSES_ROOT Registry Branch 0
HKEY_CURRENT_USER Registry Branch 1
HKEY_LOCAL_MACHINE Registry Branch 2
HKEY_USERS Registry Branch 3
ICALL Internal Use 0
M_PLATFORM Platform Attribute 0
PLATFORM_AIX Platform Constant 11
PLATFORM_HPUX Platform Constant 9
PLATFORM_LINUX Platform Constant 8
PLATFORM_MAC Platform Constant 6
PLATFORM_MACOSX Platform Constant 13
PLATFORM_NT351 Platform Constant 3
PLATFORM_NT40 Platform Constant 4
PLATFORM_NT50 Platform Constant 5
PLATFORM_OS2 Platform Constant 7
PLATFORM_SOLARIS Platform Constant 12
PLATFORM_TRU64 Platform Constant 10
PLATFORM_UNKNOWN Platform Constant -1
PLATFORM_WINDOWS95 Platform Constant 1
PLATFORM_WINDOWS98 Platform Constant 2
PLATFORM_WINDOWSXP Platform Constant 14
SAPLOGON_ENCODING Saplogon Encoding




Events of the Class CL_GUI_FRONTEND_SERVICES

Events are created within your class using special event handler methods. These must be registered at runtime for the event and can then be triggered using the ABAP syntax: RAISE EVENT EXPOTING...