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_OBJECT

Method 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 NameDescriptionVisability
CONSTRUCTORConstructorPublic
CALL METHOD cl_gui_control=>CONSTRUCTOR...more details

CONTROL_REGISTER_EVENTRegister Event for ControlProtected
CALL METHOD cl_gui_control=>CONTROL_REGISTER_EVENT...more details

CONTROL_UNREGISTER_EVENTUnregister Event of ControlProtected
CALL METHOD cl_gui_control=>CONTROL_UNREGISTER_EVENT...more details

DISPATCHDispatch, MUST be RedefinedPublic
CALL METHOD cl_gui_control=>DISPATCH...more details

FINALIZEFinalize, Can be RedefinedPublic
CALL METHOD cl_gui_control=>FINALIZE...more details

GET_ACCDESCRIPTIONGet accessibility description propertyPublic
CALL METHOD cl_gui_control=>GET_ACCDESCRIPTION...more details

GET_ADJUST_DESIGNGet Current Adjust Design StatusPublic
CALL METHOD cl_gui_control=>GET_ADJUST_DESIGN...more details

GET_ENABLEGet enable/disable propertyPublic
CALL METHOD cl_gui_control=>GET_ENABLE...more details

GET_EVENT_PARAMETERGET_EVENT_PARAMETERProtected
CALL METHOD cl_gui_control=>GET_EVENT_PARAMETER...more details

GET_FOCUSGET_FOCUS *** THIS WILL FLUSH ***Public
CALL METHOD cl_gui_control=>GET_FOCUS...more details

GET_GRID_HANDLEGet Current Grid HandlePublic
CALL METHOD cl_gui_control=>GET_GRID_HANDLE...more details

GET_GRID_STEPGet Current Grid Step ValuePublic
CALL METHOD cl_gui_control=>GET_GRID_STEP...more details

GET_HEIGHTGet Height of ControlPublic
CALL METHOD cl_gui_control=>GET_HEIGHT...more details

GET_LEFTGet Left Coordinate Value of ControlPublic
CALL METHOD cl_gui_control=>GET_LEFT...more details

GET_METRICGet Currently-Used MetricPublic
CALL METHOD cl_gui_control=>GET_METRIC...more details

GET_MODEIs Control in Design Mode or Run ModePublic
CALL METHOD cl_gui_control=>GET_MODE...more details

GET_NAMEReturns the NamePublic
CALL METHOD cl_gui_control=>GET_NAME...more details

GET_PATHReturns the Complete Name abc/def/uvwPublic
CALL METHOD cl_gui_control=>GET_PATH...more details

GET_REGISTERED_EVENTSGET_REGISTERED_EVENTS (Int / System)Public
CALL METHOD cl_gui_control=>GET_REGISTERED_EVENTS...more details

GET_REGISTERED_EVENTS_EXFINAL! GET_REGISTERED_EVENTS_EX (Structure)Protected
CALL METHOD cl_gui_control=>GET_REGISTERED_EVENTS_EX...more details

GET_TOPGet Top Coordinate Value of ControlPublic
CALL METHOD cl_gui_control=>GET_TOP...more details

GET_VISIBLEIs Control VisiblePublic
CALL METHOD cl_gui_control=>GET_VISIBLE...more details

GET_WIDTHGet Width of ControlPublic
CALL METHOD cl_gui_control=>GET_WIDTH...more details

GET_WINDOW_PROPERTYGET_WINDOW_PROPERTYProtected
CALL METHOD cl_gui_control=>GET_WINDOW_PROPERTY...more details

INIT_CONTROLConstructor - Substitute / Late BindingProtected
CALL METHOD cl_gui_control=>INIT_CONTROL...more details

INIT_CONTROL_WITH_HWNDControl Will be Initialized Using a HWNDProtected
CALL METHOD cl_gui_control=>INIT_CONTROL_WITH_HWND...more details

IS_ALIVELife State in Current SituationPublic
CALL METHOD cl_gui_control=>IS_ALIVE...more details

REGISTER_CACHED_PROPERTYStatement for Handling a Property in the CacheProtected
CALL METHOD cl_gui_control=>REGISTER_CACHED_PROPERTY...more details

REGISTER_CACHED_W_PROPERTYRegister a Window Property to be CachedProtected
CALL METHOD cl_gui_control=>REGISTER_CACHED_W_PROPERTY...more details

REG_EVENT_LEFT_CLICK_DESIGNRegister/Deregister Left Button Click Event in Design ModePublic
CALL METHOD cl_gui_control=>REG_EVENT_LEFT_CLICK_DESIGN...more details

REG_EVENT_LEFT_CLICK_RUN_MODERegister/Deregister Left Button Click Event in Run ModePublic
CALL METHOD cl_gui_control=>REG_EVENT_LEFT_CLICK_RUN_MODE...more details

REG_EVENT_MOVE_CONTROLRegister/Deregister Move Control EventPublic
CALL METHOD cl_gui_control=>REG_EVENT_MOVE_CONTROL...more details

REG_EVENT_RIGHT_CLICKRegister/Unregister Right Button Click EventPublic
CALL METHOD cl_gui_control=>REG_EVENT_RIGHT_CLICK...more details

REG_EVENT_SIZE_CONTROLRegister/Unregister Size Control EventPublic
CALL METHOD cl_gui_control=>REG_EVENT_SIZE_CONTROL...more details

SET_ACCDESCRIPTIONSet accessibility description propertyPublic
CALL METHOD cl_gui_control=>SET_ACCDESCRIPTION...more details

SET_ADJUST_DESIGNToggle Between Adjust Design and Do Not Adjust DesignPublic
CALL METHOD cl_gui_control=>SET_ADJUST_DESIGN...more details

SET_ALIGNMENTSET_ALIGNMENTPublic
CALL METHOD cl_gui_control=>SET_ALIGNMENT...more details

SET_ENABLESet enable/disable propertyPublic
CALL METHOD cl_gui_control=>SET_ENABLE...more details

SET_FOCUSSET_FOCUSPublic
CALL METHOD cl_gui_control=>SET_FOCUS...more details

SET_GRID_HANDLESet Current Grid HandlePublic
CALL METHOD cl_gui_control=>SET_GRID_HANDLE...more details

SET_GRID_STEPSet Current Grid Step ValuePublic
CALL METHOD cl_gui_control=>SET_GRID_STEP...more details

SET_HEIGHTSet Height of ControlPublic
CALL METHOD cl_gui_control=>SET_HEIGHT...more details

SET_LEFTSet Left Coordinate Value of ControlPublic
CALL METHOD cl_gui_control=>SET_LEFT...more details

SET_METRICSelect MetricPublic
CALL METHOD cl_gui_control=>SET_METRIC...more details

SET_MODEToggle Control Between Design Mode and Run ModePublic
CALL METHOD cl_gui_control=>SET_MODE...more details

SET_NAMESets the NamePublic
CALL METHOD cl_gui_control=>SET_NAME...more details

SET_POSITIONSET_POSITIONPublic
CALL METHOD cl_gui_control=>SET_POSITION...more details

SET_REGISTERED_EVENTSSET_REGISTERED_EVENTS (Int / System)Public
CALL METHOD cl_gui_control=>SET_REGISTERED_EVENTS...more details

SET_REGISTERED_EVENTS_EXFINAL! SET_REGISTERED_EVENTS_EX (Structure)Protected
CALL METHOD cl_gui_control=>SET_REGISTERED_EVENTS_EX...more details

SET_TOPSet Top Coordinate Value of ControlPublic
CALL METHOD cl_gui_control=>SET_TOP...more details

SET_VISIBLESet Control Visible or InvisiblePublic
CALL METHOD cl_gui_control=>SET_VISIBLE...more details

SET_WIDTHSet Width of ControlPublic
CALL METHOD cl_gui_control=>SET_WIDTH...more details

SET_WINDOW_PROPERTYSET_WINDOW_PROPERTYProtected
CALL METHOD cl_gui_control=>SET_WINDOW_PROPERTY...more details

UNREGISTER_CACHED_PROPERTYRemove Cache Handling for This PropertyProtected
CALL METHOD cl_gui_control=>UNREGISTER_CACHED_PROPERTY...more details

UNREGISTER_CACHED_W_PROPERTYRemove Cache Handling for this Property IDProtected
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.

NameLevelDescriptionInitial ValueTypeVisability
ADUST_DESIGN_FALSEConstantDon't adjust to container grid0LIKE
I
Public
ADUST_DESIGN_TRUEConstantAdjust to container grid1LIKE
I
Public
ALIGN_AT_BOTTOMConstantConstant8LIKE
I
Public
ALIGN_AT_LEFTConstantConstant1LIKE
I
Public
ALIGN_AT_RIGHTConstantConstant2LIKE
I
Public
ALIGN_AT_TOPConstantConstant4LIKE
I
Public
CFALSEConstantBoolean false0LIKE
I
Protected
CFW_MODEInstance AttributeRun/Design ModeMODE_RUNLIKE
I
Protected
CTRUEConstantBoolean True1LIKE
I
Protected
CUR_EVENTStatic AttributeCurrent EventLIKE
CL_GUI_EVENT
Public
EVENTS_TO_REGISTER_CONTROLInstance AttributeEvents to RegisterLIKE
CNTL_SIMPLE_EVENTS
Protected
EVENT_LEFT_CLICK_DESIGNConstantID of Event Left Click When in Design Mode1LIKE
I
Protected
EVENT_LEFT_CLICK_RUNConstantID of Event Left Click When Being Run16LIKE
I
Protected
EVENT_MOVEConstantID of Event Move Control11LIKE
I
Protected
EVENT_RIGHT_CLICKConstantID of Event Right Click2LIKE
I
Protected
EVENT_SIZEConstantID of Event Size Control12LIKE
I
Protected
LIFETIMEInstance AttributeLifetimecntl_lifetime_imodeLIKE
I
Public
LIFETIME_DEFAULTConstantDefault Value for Lifetime0LIKE
I
Public
LIFETIME_DYNPROConstantLifetime: Screen1LIKE
I
Public
LIFETIME_IMODEConstantLifetime: Internal Session2LIKE
I
Public
METRIC_DEFAULTConstantDefault Metric0LIKE
I
Public
METRIC_MMConstantMillimeter Metric2LIKE
I
Public
METRIC_PIXELConstantPixel Metric1LIKE
I
Public
MODE_DESIGNConstantControl in Design Mode1LIKE
I
Public
MODE_RUNConstantControl in Run Mode0LIKE
I
Public
M_METRICInstance AttributeMetricMETRIC_DEFAULTLIKE
I
Protected
M_NAMEInstance AttributeNameLIKE
STRING
Protected
PARENTInstance AttributeParent ContainerLIKE
CL_GUI_CONTAINER
Public
PROPERTY_ACCDESCRIPTIONConstantShell accessibility description540LIKE
I
Protected
PROPERTY_ADJUST_DESIGNConstantConstant460LIKE
I
Protected
PROPERTY_ALIGNConstantConstant10LIKE
I
Protected
PROPERTY_CAPTIONConstantConstant60LIKE
I
Protected
PROPERTY_ENABLEConstantEnable/Disable90LIKE
I
Protected
PROPERTY_GRID_HANDLEConstantConstant450LIKE
I
Protected
PROPERTY_GRID_STEPConstantConstant420LIKE
I
Protected
PROPERTY_HEIGHTConstantConstant120LIKE
I
Protected
PROPERTY_INNER_HEIGHTConstantInner Height500LIKE
I
Protected
PROPERTY_INNER_WIDTHConstantInner Width510LIKE
I
Protected
PROPERTY_LEFTConstantConstant170LIKE
I
Protected
PROPERTY_METRICConstantConstant410LIKE
I
Public
PROPERTY_MODEConstantConstant210LIKE
I
Protected
PROPERTY_NAMEConstantConstant520LIKE
I
Protected
PROPERTY_TABSTOPStatic AttributeControl in Tab Chain?240LIKE
I
Public
PROPERTY_TOPConstantConstant270LIKE
I
Protected
PROPERTY_VISIBLEConstantConstant290LIKE
I
Protected
PROPERTY_WIDTHConstantConstant300LIKE
I
Protected
REGISTERED_EVENTSInstance AttributeRegistered EventsLIKE
CNTL_EVENTS
Protected
REGISTERED_EVENTS_COUNTInstance AttributeRegistered_Events_CountLIKE
I
Protected
REGISTERED_SIMPLE_EVENTSInstance AttributeRegistered Simple EventsLIKE
CNTL_SIMPLE_EVENTS
Protected
SHELLEVT_CTXMNU_REQConstantShell EventId: Context Menu Requested13LIKE
I
Protected
SHELLEVT_CTXMNU_SELConstantShell EventId: Context Menu Selected14LIKE
I
Protected
SHELLEVT_DRAGConstantShell EventId: Drag16LIKE
I
Protected
SHELLEVT_DRAGDROPConstantShell EventId: DragDrop15LIKE
I
Protected
SHELLEVT_DROPConstantShell EventId: Drop17LIKE
I
Protected
SHELLSTYLEInstance AttributeShell StyleLIKE
I
Protected
STATE_ALIVEConstantControl is Alive (on This Screen)0LIKE
I
Public
STATE_ALIVE_ON_OTHER_SCREENConstantControl is Alive On Other Screen1LIKE
I
Public
STATE_DEADConstantControl Already Destroyed-1LIKE
I
Public
VISIBLE_FALSEConstantConstant for 'SET_VISIBLE''0'LIKE
CHAR1
Public
VISIBLE_TRUEConstantConstant for 'SET_VISIBLE''1'LIKE
CHAR1
Public
WS_BORDERConstantConstant8388608LIKE
I
Public
WS_CHILDConstantConstant1073741824LIKE
I
Public
WS_CLIPCHILDRENConstantConstant33554432LIKE
I
Public
WS_CLIPSIBLINGSConstantConstant67108864LIKE
I
Public
WS_MAXIMIZEBOXConstantConstant 65536LIKE
I
Public
WS_MINIMIZEBOXConstantConstant 131072LIKE
I
Public
WS_SYSMENUConstantConstant524288LIKE
I
Public
WS_THICKFRAMEConstantConstant 262144LIKE
I
Public
WS_VISIBLEConstantConstant268435456LIKE
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 Mode
LEFT_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



Comments on this SAP object

What made you want to lookup this SAP object? Please tell us what you were looking for and anything you would like to be included on this page!