SAP CL_GUI_OBJECT OO Class - Proxy Class for a GUI Object
CL_GUI_OBJECT 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_OBJECT including details of:
- Interface class implementations
- Inheritance details
- Methods defined within class ( including link to full details )
- Attributes ( including initial values )
- Class Events
Interface Implementation
This OO class is an Interface Implementation, which means it will implement its own version of the methods from implementation class IF_CACHED_PROPMethod list of CL_GUI_OBJECT 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 |
| ADD_CACHE_PROP | Add new Cached Property | Protected |
| CALL METHOD cl_gui_object=>ADD_CACHE_PROP...more details | ||
| ASSIGN_PROPERTY | Assign_Property | Protected |
| CALL METHOD cl_gui_object=>ASSIGN_PROPERTY...more details | ||
| CALL_METHOD | Call_Method | Protected |
| CALL METHOD cl_gui_object=>CALL_METHOD...more details | ||
| CALL_METHOD_RESULT_GUI_OBJECT | Call Method rc=GUI_OBJECT, You can Check Obj. With IS_VALID | Protected |
| CALL METHOD cl_gui_object=>CALL_METHOD_RESULT_GUI_OBJECT...more details | ||
| CLASS_CONSTRUCTOR | CLASS_CONSTRUCTOR | Public |
| CALL METHOD cl_gui_object=>CLASS_CONSTRUCTOR...more details | ||
| CLASS_INIT | Additional External Class Constructor | Private |
| CALL METHOD cl_gui_object=>CLASS_INIT...more details | ||
|
| ||
| CONSTRUCTOR | Constructor | Public |
| CALL METHOD cl_gui_object=>CONSTRUCTOR...more details | ||
| FREE | Destructor | Public |
| CALL METHOD cl_gui_object=>FREE...more details | ||
| GET_CACHE_PROP | Read Value of a Cache Property | Protected |
| CALL METHOD cl_gui_object=>GET_CACHE_PROP...more details | ||
| GET_PROPERTY | Get_Property | Protected |
| CALL METHOD cl_gui_object=>GET_PROPERTY...more details | ||
| GET_PROPERTY_GUI_OBJECT | GetProperty rc=GUI_OBJECT, You Can Check obj With 'IS_VALID' | Protected |
| CALL METHOD cl_gui_object=>GET_PROPERTY_GUI_OBJECT...more details | ||
| INVALIDATE_CACHE | Invalidates the Cache | Protected |
| CALL METHOD cl_gui_object=>INVALIDATE_CACHE...more details | ||
| IS_CACHED_PROP | Property Managed in Cache? | Protected |
| CALL METHOD cl_gui_object=>IS_CACHED_PROP...more details | ||
| IS_CACHE_VALID | Query: Is the Cache Valid for this Control? | Protected |
| CALL METHOD cl_gui_object=>IS_CACHE_VALID...more details | ||
| IS_VALID | Check If a GUI_OBJECT Represents a Valid Frontend Object | Public |
| CALL METHOD cl_gui_object=>IS_VALID...more details | ||
| REMOVE_CACHE_PROP | Remove Cached Property from Cache | Protected |
| CALL METHOD cl_gui_object=>REMOVE_CACHE_PROP...more details | ||
| SET_CACHE_PROP | Write Value of a Cache Property | Protected |
| CALL METHOD cl_gui_object=>SET_CACHE_PROP...more details | ||
| SET_PROPERTY | Set_Property | Protected |
| CALL METHOD cl_gui_object=>SET_PROPERTY...more details | ||
| VALIDATE_CACHE | Validates the Cache | Private |
| CALL METHOD cl_gui_object=>VALIDATE_CACHE...more details | ||
CL_GUI_OBJECT 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 |
| ACTIVEX | Static Attribute | X: ActiveX to be called | LIKE CHAR01 | Public | |
| CATT_ACTIV | Static Attribute | X: CATT is Running | LIKE CHAR01 | Public | |
| CONTROLS_SUPPORTED | Static Attribute | Used for Background Check | LIKE CHAR1 | Protected | |
| GLOBAL_GUID | Static Attribute | GUID for ABAP Objects Controls | LIKE I | Protected | |
| GUI_DATA_CONSUMER | Static Attribute | Receives Global GUI Data | LIKE OBJECT | Private | |
| GUI_IS_RUNNING | Static Attribute | X: GUI is running | LIKE CHAR01 | Public | |
| H_CONTROL | Instance Attribute | H_CONTROL | LIKE CNTL_HANDLE | Protected | |
| H_GUI | Static Attribute | R, FUGR CNTL | LIKE OLE2_OBJECT | Public | |
| INIT_STATE | Static Attribute | Initialization Status | LIKE I | Private | |
| INIT_STATE_FINAL | Constant | Final Initialization | 2 | LIKE I | Private |
| INIT_STATE_PRELIMINARY | Constant | Preliminary Initialization | 1 | LIKE I | Private |
| IS_INIT | Static Attribute | R, FUGR CNTL | LIKE CHAR1 | Public | |
| JAVABEAN | Static Attribute | X: JavaBean to be called | LIKE CHAR01 | Public | |
| M_CLSID | Instance Attribute | Class ID | LIKE CHAR255 | Protected | |
| PROPERTY_CACHE | Instance Attribute | Cache for Datachange Properties | LIKE TY_PROPCACHE | Private | |
| PROP_CACHE_CURSOR | Instance Attribute | Current Cursor in Propcache | LIKE I | Private | |
| PROP_CACHE_SUPPORTED | Static Attribute | Cache Supported by Platform? | LIKE CHAR01 | Protected | |
| WWW_ACTIVE | Static Attribute | X: Web is Active | LIKE CHAR01 | Public | |
| XML_BLOB_SUPPORT | Static Attribute | DIAG XML Blob supported | LIKE CHAR01 | Protected |
CL_GUI_OBJECT types
TY_PROPCACHE - PropertyCache for DataChangePropagationTY_PROPCACHEENTRY - Entry in Property Cache
Links to Related Class(s)
CL_GUI_O...Full list of available SAP object classes
Search for further information about these or an SAP related objects