SAP CL_GUI_CONTROL OO Class - Proxy Class for Control in GUI
CL_GUI_CONTROL 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_CONTROL 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_CONTROL is CL_GUI_OBJECTMethod list of CL_GUI_CONTROL 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 |
CONSTRUCTOR | Constructor | Public |
CALL METHOD cl_gui_control=>CONSTRUCTOR...more details | ||
CONTROL_REGISTER_EVENT | Register Event for Control | Protected |
CALL METHOD cl_gui_control=>CONTROL_REGISTER_EVENT...more details | ||
CONTROL_UNREGISTER_EVENT | Unregister Event of Control | Protected |
CALL METHOD cl_gui_control=>CONTROL_UNREGISTER_EVENT...more details | ||
DISPATCH | Dispatch, MUST be Redefined | Public |
CALL METHOD cl_gui_control=>DISPATCH...more details | ||
FINALIZE | Finalize, Can be Redefined | Public |
CALL METHOD cl_gui_control=>FINALIZE...more details | ||
GET_ACCDESCRIPTION | Get accessibility description property | Public |
CALL METHOD cl_gui_control=>GET_ACCDESCRIPTION...more details | ||
| ||
GET_ADJUST_DESIGN | Get Current Adjust Design Status | Public |
CALL METHOD cl_gui_control=>GET_ADJUST_DESIGN...more details | ||
GET_ENABLE | Get enable/disable property | Public |
CALL METHOD cl_gui_control=>GET_ENABLE...more details | ||
GET_EVENT_PARAMETER | GET_EVENT_PARAMETER | Protected |
CALL METHOD cl_gui_control=>GET_EVENT_PARAMETER...more details | ||
GET_FOCUS | GET_FOCUS *** THIS WILL FLUSH *** | Public |
CALL METHOD cl_gui_control=>GET_FOCUS...more details | ||
GET_GRID_HANDLE | Get Current Grid Handle | Public |
CALL METHOD cl_gui_control=>GET_GRID_HANDLE...more details | ||
GET_GRID_STEP | Get Current Grid Step Value | Public |
CALL METHOD cl_gui_control=>GET_GRID_STEP...more details | ||
GET_HEIGHT | Get Height of Control | Public |
CALL METHOD cl_gui_control=>GET_HEIGHT...more details | ||
GET_LEFT | Get Left Coordinate Value of Control | Public |
CALL METHOD cl_gui_control=>GET_LEFT...more details | ||
GET_METRIC | Get Currently-Used Metric | Public |
CALL METHOD cl_gui_control=>GET_METRIC...more details | ||
GET_MODE | Is Control in Design Mode or Run Mode | Public |
CALL METHOD cl_gui_control=>GET_MODE...more details | ||
GET_NAME | Returns the Name | Public |
CALL METHOD cl_gui_control=>GET_NAME...more details | ||
GET_PATH | Returns the Complete Name abc/def/uvw | Public |
CALL METHOD cl_gui_control=>GET_PATH...more details | ||
GET_REGISTERED_EVENTS | GET_REGISTERED_EVENTS (Int / System) | Public |
CALL METHOD cl_gui_control=>GET_REGISTERED_EVENTS...more details | ||
GET_REGISTERED_EVENTS_EX | FINAL! GET_REGISTERED_EVENTS_EX (Structure) | Protected |
CALL METHOD cl_gui_control=>GET_REGISTERED_EVENTS_EX...more details | ||
GET_TOP | Get Top Coordinate Value of Control | Public |
CALL METHOD cl_gui_control=>GET_TOP...more details | ||
GET_VISIBLE | Is Control Visible | Public |
CALL METHOD cl_gui_control=>GET_VISIBLE...more details | ||
GET_WIDTH | Get Width of Control | Public |
CALL METHOD cl_gui_control=>GET_WIDTH...more details | ||
GET_WINDOW_PROPERTY | GET_WINDOW_PROPERTY | Protected |
CALL METHOD cl_gui_control=>GET_WINDOW_PROPERTY...more details | ||
INIT_CONTROL | Constructor - Substitute / Late Binding | Protected |
CALL METHOD cl_gui_control=>INIT_CONTROL...more details | ||
INIT_CONTROL_WITH_HWND | Control Will be Initialized Using a HWND | Protected |
CALL METHOD cl_gui_control=>INIT_CONTROL_WITH_HWND...more details | ||
IS_ALIVE | Life State in Current Situation | Public |
CALL METHOD cl_gui_control=>IS_ALIVE...more details | ||
REGISTER_CACHED_PROPERTY | Statement for Handling a Property in the Cache | Protected |
CALL METHOD cl_gui_control=>REGISTER_CACHED_PROPERTY...more details | ||
REGISTER_CACHED_W_PROPERTY | Register a Window Property to be Cached | Protected |
CALL METHOD cl_gui_control=>REGISTER_CACHED_W_PROPERTY...more details | ||
REG_EVENT_LEFT_CLICK_DESIGN | Register/Deregister Left Button Click Event in Design Mode | Public |
CALL METHOD cl_gui_control=>REG_EVENT_LEFT_CLICK_DESIGN...more details | ||
REG_EVENT_LEFT_CLICK_RUN_MODE | Register/Deregister Left Button Click Event in Run Mode | Public |
CALL METHOD cl_gui_control=>REG_EVENT_LEFT_CLICK_RUN_MODE...more details | ||
REG_EVENT_MOVE_CONTROL | Register/Deregister Move Control Event | Public |
CALL METHOD cl_gui_control=>REG_EVENT_MOVE_CONTROL...more details | ||
REG_EVENT_RIGHT_CLICK | Register/Unregister Right Button Click Event | Public |
CALL METHOD cl_gui_control=>REG_EVENT_RIGHT_CLICK...more details | ||
REG_EVENT_SIZE_CONTROL | Register/Unregister Size Control Event | Public |
CALL METHOD cl_gui_control=>REG_EVENT_SIZE_CONTROL...more details | ||
SET_ACCDESCRIPTION | Set accessibility description property | Public |
CALL METHOD cl_gui_control=>SET_ACCDESCRIPTION...more details | ||
SET_ADJUST_DESIGN | Toggle Between Adjust Design and Do Not Adjust Design | Public |
CALL METHOD cl_gui_control=>SET_ADJUST_DESIGN...more details | ||
SET_ALIGNMENT | SET_ALIGNMENT | Public |
CALL METHOD cl_gui_control=>SET_ALIGNMENT...more details | ||
SET_ENABLE | Set enable/disable property | Public |
CALL METHOD cl_gui_control=>SET_ENABLE...more details | ||
SET_FOCUS | SET_FOCUS | Public |
CALL METHOD cl_gui_control=>SET_FOCUS...more details | ||
SET_GRID_HANDLE | Set Current Grid Handle | Public |
CALL METHOD cl_gui_control=>SET_GRID_HANDLE...more details | ||
SET_GRID_STEP | Set Current Grid Step Value | Public |
CALL METHOD cl_gui_control=>SET_GRID_STEP...more details | ||
SET_HEIGHT | Set Height of Control | Public |
CALL METHOD cl_gui_control=>SET_HEIGHT...more details | ||
SET_LEFT | Set Left Coordinate Value of Control | Public |
CALL METHOD cl_gui_control=>SET_LEFT...more details | ||
SET_METRIC | Select Metric | Public |
CALL METHOD cl_gui_control=>SET_METRIC...more details | ||
SET_MODE | Toggle Control Between Design Mode and Run Mode | Public |
CALL METHOD cl_gui_control=>SET_MODE...more details | ||
SET_NAME | Sets the Name | Public |
CALL METHOD cl_gui_control=>SET_NAME...more details | ||
SET_POSITION | SET_POSITION | Public |
CALL METHOD cl_gui_control=>SET_POSITION...more details | ||
SET_REGISTERED_EVENTS | SET_REGISTERED_EVENTS (Int / System) | Public |
CALL METHOD cl_gui_control=>SET_REGISTERED_EVENTS...more details | ||
SET_REGISTERED_EVENTS_EX | FINAL! SET_REGISTERED_EVENTS_EX (Structure) | Protected |
CALL METHOD cl_gui_control=>SET_REGISTERED_EVENTS_EX...more details | ||
SET_TOP | Set Top Coordinate Value of Control | Public |
CALL METHOD cl_gui_control=>SET_TOP...more details | ||
SET_VISIBLE | Set Control Visible or Invisible | Public |
CALL METHOD cl_gui_control=>SET_VISIBLE...more details | ||
SET_WIDTH | Set Width of Control | Public |
CALL METHOD cl_gui_control=>SET_WIDTH...more details | ||
SET_WINDOW_PROPERTY | SET_WINDOW_PROPERTY | Protected |
CALL METHOD cl_gui_control=>SET_WINDOW_PROPERTY...more details | ||
UNREGISTER_CACHED_PROPERTY | Remove Cache Handling for This Property | Protected |
CALL METHOD cl_gui_control=>UNREGISTER_CACHED_PROPERTY...more details | ||
UNREGISTER_CACHED_W_PROPERTY | Remove Cache Handling for this Property ID | Protected |
CALL METHOD cl_gui_control=>UNREGISTER_CACHED_W_PROPERTY...more details |
CL_GUI_CONTROL 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 |
ADUST_DESIGN_FALSE | Constant | Don't adjust to container grid | 0 | LIKE I | Public |
ADUST_DESIGN_TRUE | Constant | Adjust to container grid | 1 | LIKE I | Public |
ALIGN_AT_BOTTOM | Constant | Constant | 8 | LIKE I | Public |
ALIGN_AT_LEFT | Constant | Constant | 1 | LIKE I | Public |
ALIGN_AT_RIGHT | Constant | Constant | 2 | LIKE I | Public |
ALIGN_AT_TOP | Constant | Constant | 4 | LIKE I | Public |
CFALSE | Constant | Boolean false | 0 | LIKE I | Protected |
CFW_MODE | Instance Attribute | Run/Design Mode | MODE_RUN | LIKE I | Protected |
CTRUE | Constant | Boolean True | 1 | LIKE I | Protected |
CUR_EVENT | Static Attribute | Current Event | LIKE CL_GUI_EVENT | Public | |
EVENTS_TO_REGISTER_CONTROL | Instance Attribute | Events to Register | LIKE CNTL_SIMPLE_EVENTS | Protected | |
EVENT_LEFT_CLICK_DESIGN | Constant | ID of Event Left Click When in Design Mode | 1 | LIKE I | Protected |
EVENT_LEFT_CLICK_RUN | Constant | ID of Event Left Click When Being Run | 16 | LIKE I | Protected |
EVENT_MOVE | Constant | ID of Event Move Control | 11 | LIKE I | Protected |
EVENT_RIGHT_CLICK | Constant | ID of Event Right Click | 2 | LIKE I | Protected |
EVENT_SIZE | Constant | ID of Event Size Control | 12 | LIKE I | Protected |
LIFETIME | Instance Attribute | Lifetime | cntl_lifetime_imode | LIKE I | Public |
LIFETIME_DEFAULT | Constant | Default Value for Lifetime | 0 | LIKE I | Public |
LIFETIME_DYNPRO | Constant | Lifetime: Screen | 1 | LIKE I | Public |
LIFETIME_IMODE | Constant | Lifetime: Internal Session | 2 | LIKE I | Public |
METRIC_DEFAULT | Constant | Default Metric | 0 | LIKE I | Public |
METRIC_MM | Constant | Millimeter Metric | 2 | LIKE I | Public |
METRIC_PIXEL | Constant | Pixel Metric | 1 | LIKE I | Public |
MODE_DESIGN | Constant | Control in Design Mode | 1 | LIKE I | Public |
MODE_RUN | Constant | Control in Run Mode | 0 | LIKE I | Public |
M_METRIC | Instance Attribute | Metric | METRIC_DEFAULT | LIKE I | Protected |
M_NAME | Instance Attribute | Name | LIKE STRING | Protected | |
PARENT | Instance Attribute | Parent Container | LIKE CL_GUI_CONTAINER | Public | |
PROPERTY_ACCDESCRIPTION | Constant | Shell accessibility description | 540 | LIKE I | Protected |
PROPERTY_ADJUST_DESIGN | Constant | Constant | 460 | LIKE I | Protected |
PROPERTY_ALIGN | Constant | Constant | 10 | LIKE I | Protected |
PROPERTY_CAPTION | Constant | Constant | 60 | LIKE I | Protected |
PROPERTY_ENABLE | Constant | Enable/Disable | 90 | LIKE I | Protected |
PROPERTY_GRID_HANDLE | Constant | Constant | 450 | LIKE I | Protected |
PROPERTY_GRID_STEP | Constant | Constant | 420 | LIKE I | Protected |
PROPERTY_HEIGHT | Constant | Constant | 120 | LIKE I | Protected |
PROPERTY_INNER_HEIGHT | Constant | Inner Height | 500 | LIKE I | Protected |
PROPERTY_INNER_WIDTH | Constant | Inner Width | 510 | LIKE I | Protected |
PROPERTY_LEFT | Constant | Constant | 170 | LIKE I | Protected |
PROPERTY_METRIC | Constant | Constant | 410 | LIKE I | Public |
PROPERTY_MODE | Constant | Constant | 210 | LIKE I | Protected |
PROPERTY_NAME | Constant | Constant | 520 | LIKE I | Protected |
PROPERTY_TABSTOP | Static Attribute | Control in Tab Chain? | 240 | LIKE I | Public |
PROPERTY_TOP | Constant | Constant | 270 | LIKE I | Protected |
PROPERTY_VISIBLE | Constant | Constant | 290 | LIKE I | Protected |
PROPERTY_WIDTH | Constant | Constant | 300 | LIKE I | Protected |
REGISTERED_EVENTS | Instance Attribute | Registered Events | LIKE CNTL_EVENTS | Protected | |
REGISTERED_EVENTS_COUNT | Instance Attribute | Registered_Events_Count | LIKE I | Protected | |
REGISTERED_SIMPLE_EVENTS | Instance Attribute | Registered Simple Events | LIKE CNTL_SIMPLE_EVENTS | Protected | |
SHELLEVT_CTXMNU_REQ | Constant | Shell EventId: Context Menu Requested | 13 | LIKE I | Protected |
SHELLEVT_CTXMNU_SEL | Constant | Shell EventId: Context Menu Selected | 14 | LIKE I | Protected |
SHELLEVT_DRAG | Constant | Shell EventId: Drag | 16 | LIKE I | Protected |
SHELLEVT_DRAGDROP | Constant | Shell EventId: DragDrop | 15 | LIKE I | Protected |
SHELLEVT_DROP | Constant | Shell EventId: Drop | 17 | LIKE I | Protected |
SHELLSTYLE | Instance Attribute | Shell Style | LIKE I | Protected | |
STATE_ALIVE | Constant | Control is Alive (on This Screen) | 0 | LIKE I | Public |
STATE_ALIVE_ON_OTHER_SCREEN | Constant | Control is Alive On Other Screen | 1 | LIKE I | Public |
STATE_DEAD | Constant | Control Already Destroyed | -1 | LIKE I | Public |
VISIBLE_FALSE | Constant | Constant for 'SET_VISIBLE' | '0' | LIKE CHAR1 | Public |
VISIBLE_TRUE | Constant | Constant for 'SET_VISIBLE' | '1' | LIKE CHAR1 | Public |
WS_BORDER | Constant | Constant | 8388608 | LIKE I | Public |
WS_CHILD | Constant | Constant | 1073741824 | LIKE I | Public |
WS_CLIPCHILDREN | Constant | Constant | 33554432 | LIKE I | Public |
WS_CLIPSIBLINGS | Constant | Constant | 67108864 | LIKE I | Public |
WS_MAXIMIZEBOX | Constant | Constant | 65536 | LIKE I | Public |
WS_MINIMIZEBOX | Constant | Constant | 131072 | LIKE I | Public |
WS_SYSMENU | Constant | Constant | 524288 | LIKE I | Public |
WS_THICKFRAME | Constant | Constant | 262144 | LIKE I | Public |
WS_VISIBLE | Constant | Constant | 268435456 | LIKE I | Public |
Events of Class CL_GUI_CONTROL
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... LEFT_CLICK_DESIGN - Left Mouse Button Pressed on Control in Design ModeLEFT_CLICK_RUN - Left Mouse Button Pressed on Control in Run Mode
MOVE_CONTROL - Control Moved
RIGHT_CLICK - Right Mouse Button Clicked on Control
SIZE_CONTROL - Control Resized
Links to Related Class(s)
CL_GUI_C...Full list of available SAP object classes
Search for further information about these or an SAP related objects