SAP CL_GUI_FORMPAINTER OO Class - SAP Form Painter Control Proxy Class









CL_GUI_FORMPAINTER 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_FORMPAINTER 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_FORMPAINTER is CL_GUI_CONTROL

Method list of CL_GUI_FORMPAINTER 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
ADD_KEY_STROKEAdd key stroke for event key_pressedPublic
CALL METHOD cl_gui_formpainter=>ADD_KEY_STROKE...more details

ADD_TOOLBAR_BUTTONSAdd buttons to toolbarProtected
CALL METHOD cl_gui_formpainter=>ADD_TOOLBAR_BUTTONS...more details

CONSTRUCTORConstructorPublic
CALL METHOD cl_gui_formpainter=>CONSTRUCTOR...more details

CONVERT_INTERNAL_UNIT_TO_UNITConvert internal unit to unitProtected
CALL METHOD cl_gui_formpainter=>CONVERT_INTERNAL_UNIT_TO_UNIT...more details

CONVERT_UNIT_TO_INTERNAL_UNITConvert unit to internal unitProtected
CALL METHOD cl_gui_formpainter=>CONVERT_UNIT_TO_INTERNAL_UNIT...more details

CREATE_BITMAP_WINDOWCreate bitmap windowPublic
CALL METHOD cl_gui_formpainter=>CREATE_BITMAP_WINDOW...more details

CREATE_TEXT_WINDOWCreate text windowPublic
CALL METHOD cl_gui_formpainter=>CREATE_TEXT_WINDOW...more details

DELETE_WINDOWDelete windowPublic
CALL METHOD cl_gui_formpainter=>DELETE_WINDOW...more details

DESELECT_ALLDeselect windowPublic
CALL METHOD cl_gui_formpainter=>DESELECT_ALL...more details

GET_AUTO_ZOOMGet auto zoomPublic
CALL METHOD cl_gui_formpainter=>GET_AUTO_ZOOM...more details

GET_BORDERGet borderPublic
CALL METHOD cl_gui_formpainter=>GET_BORDER...more details

GET_CROSS_HAIRSGet crosshairsPublic
CALL METHOD cl_gui_formpainter=>GET_CROSS_HAIRS...more details

GET_DRAW_MODEGet draw modePublic
CALL METHOD cl_gui_formpainter=>GET_DRAW_MODE...more details

GET_GRIDGet gridPublic
CALL METHOD cl_gui_formpainter=>GET_GRID...more details

GET_MAJOR_GRIDGet major gridPublic
CALL METHOD cl_gui_formpainter=>GET_MAJOR_GRID...more details

GET_OPTIONSGet optionsPublic
CALL METHOD cl_gui_formpainter=>GET_OPTIONS...more details

GET_RULERGet rulerPublic
CALL METHOD cl_gui_formpainter=>GET_RULER...more details

GET_SNAP_TO_GRIDGet SnapToGridPublic
CALL METHOD cl_gui_formpainter=>GET_SNAP_TO_GRID...more details

GET_TRACKERGet trackerPublic
CALL METHOD cl_gui_formpainter=>GET_TRACKER...more details

GET_TRANSPARENTGet transparentPublic
CALL METHOD cl_gui_formpainter=>GET_TRANSPARENT...more details

GET_WINDOWGet a window from its namePublic
CALL METHOD cl_gui_formpainter=>GET_WINDOW...more details

GET_ZOOMGet zoomPublic
CALL METHOD cl_gui_formpainter=>GET_ZOOM...more details

INITInitializationPublic
CALL METHOD cl_gui_formpainter=>INIT...more details

PROCESS_CONTEXT_MENUDisplay and process a context menuPublic
CALL METHOD cl_gui_formpainter=>PROCESS_CONTEXT_MENU...more details

RAISE_PROPS_CHANGEDProps changedProtected
CALL METHOD cl_gui_formpainter=>RAISE_PROPS_CHANGED...more details

REG_CONTEXT_MENU_REQUESTEDRegister event context menu requestedPublic
CALL METHOD cl_gui_formpainter=>REG_CONTEXT_MENU_REQUESTED...more details

REG_CONTEXT_MENU_SELECTEDRegister event context menu selectedPublic
CALL METHOD cl_gui_formpainter=>REG_CONTEXT_MENU_SELECTED...more details

REG_CONTEXT_MENU_TOOLBARRegister event context menu toolbarProtected
CALL METHOD cl_gui_formpainter=>REG_CONTEXT_MENU_TOOLBAR...more details

REG_OPTIONS_DIALOG_REQUESTEDRegister event options dialog requestedProtected
CALL METHOD cl_gui_formpainter=>REG_OPTIONS_DIALOG_REQUESTED...more details

REG_WINDOWS_PROPS_CHANGEDRegister event windows properties changedPublic
CALL METHOD cl_gui_formpainter=>REG_WINDOWS_PROPS_CHANGED...more details

REG_WINDOW_CREATERegister event window createPublic
CALL METHOD cl_gui_formpainter=>REG_WINDOW_CREATE...more details

REG_WINDOW_DBLCLICKRegister event doubleclick on windowPublic
CALL METHOD cl_gui_formpainter=>REG_WINDOW_DBLCLICK...more details

REG_WINDOW_KEY_PRESSEDRegister event window key pressedPublic
CALL METHOD cl_gui_formpainter=>REG_WINDOW_KEY_PRESSED...more details

REG_WINDOW_PROPS_CHANGEDRegister event window properties changedPublic
CALL METHOD cl_gui_formpainter=>REG_WINDOW_PROPS_CHANGED...more details

REG_WINDOW_SELECTEDRegister event window selectedPublic
CALL METHOD cl_gui_formpainter=>REG_WINDOW_SELECTED...more details

REMOVE_ALL_KEY_STROKESRemove all key strokes for event key_pressedPublic
CALL METHOD cl_gui_formpainter=>REMOVE_ALL_KEY_STROKES...more details

SELECTED_WINDOWGet selected windowPublic
CALL METHOD cl_gui_formpainter=>SELECTED_WINDOW...more details

SET_AUTO_ZOOMSet auto zoomPublic
CALL METHOD cl_gui_formpainter=>SET_AUTO_ZOOM...more details

SET_BORDERSet borderPublic
CALL METHOD cl_gui_formpainter=>SET_BORDER...more details

SET_CPISet CPIPublic
CALL METHOD cl_gui_formpainter=>SET_CPI...more details

SET_CROSS_HAIRSSet crosshairsPublic
CALL METHOD cl_gui_formpainter=>SET_CROSS_HAIRS...more details

SET_DRAW_MODESet draw modePublic
CALL METHOD cl_gui_formpainter=>SET_DRAW_MODE...more details

SET_FORMPAINTER_MODEToggle control between design mode and run modePublic
CALL METHOD cl_gui_formpainter=>SET_FORMPAINTER_MODE...more details

SET_GRIDSet gridPublic
CALL METHOD cl_gui_formpainter=>SET_GRID...more details

SET_LPISet LPIPublic
CALL METHOD cl_gui_formpainter=>SET_LPI...more details

SET_MAJOR_GRIDSet major gridPublic
CALL METHOD cl_gui_formpainter=>SET_MAJOR_GRID...more details

SET_OPTIONSSet optionsPublic
CALL METHOD cl_gui_formpainter=>SET_OPTIONS...more details

SET_PAGE_FORMATSet page formatPublic
CALL METHOD cl_gui_formpainter=>SET_PAGE_FORMAT...more details

SET_RULERSet RulerPublic
CALL METHOD cl_gui_formpainter=>SET_RULER...more details

SET_SNAP_TO_GRIDSet SnapToGridPublic
CALL METHOD cl_gui_formpainter=>SET_SNAP_TO_GRID...more details

SET_TOOLBARSet ToolbarPublic
CALL METHOD cl_gui_formpainter=>SET_TOOLBAR...more details

SET_TRACKERSet trackerPublic
CALL METHOD cl_gui_formpainter=>SET_TRACKER...more details

SET_TRANSPARENTSet TransparentPublic
CALL METHOD cl_gui_formpainter=>SET_TRANSPARENT...more details

SET_WALLPAPERSet wallpaperPublic
CALL METHOD cl_gui_formpainter=>SET_WALLPAPER...more details

SET_ZOOMSet zoomPublic
CALL METHOD cl_gui_formpainter=>SET_ZOOM...more details

SHOW_OPTIONS_DIALOGShow options dialogPublic
CALL METHOD cl_gui_formpainter=>SHOW_OPTIONS_DIALOG...more details

UNREG_CONTEXT_MENU_REQUESTEDDeregister event context menu requestedPublic
CALL METHOD cl_gui_formpainter=>UNREG_CONTEXT_MENU_REQUESTED...more details

UNREG_CONTEXT_MENU_SELECTEDDeregister event context menu selectedPublic
CALL METHOD cl_gui_formpainter=>UNREG_CONTEXT_MENU_SELECTED...more details

UNREG_WINDOWS_PROPS_CHANGEDUnregister event windows properties changedPublic
CALL METHOD cl_gui_formpainter=>UNREG_WINDOWS_PROPS_CHANGED...more details

UNREG_WINDOW_CREATEDeregister event window createPublic
CALL METHOD cl_gui_formpainter=>UNREG_WINDOW_CREATE...more details

UNREG_WINDOW_DBLCLICKUnregister event doubleclick on windowPublic
CALL METHOD cl_gui_formpainter=>UNREG_WINDOW_DBLCLICK...more details

UNREG_WINDOW_KEY_PRESSEDUnregister event window key pressedPublic
CALL METHOD cl_gui_formpainter=>UNREG_WINDOW_KEY_PRESSED...more details

UNREG_WINDOW_PROPS_CHANGEDDeregister event window properties changedPublic
CALL METHOD cl_gui_formpainter=>UNREG_WINDOW_PROPS_CHANGED...more details

UNREG_WINDOW_SELECTEDDeregister event window selectedPublic
CALL METHOD cl_gui_formpainter=>UNREG_WINDOW_SELECTED...more details



CL_GUI_FORMPAINTER 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
CO_GRID_STYLE_CROSSConstantCrosses4LIKE
I
Public
CO_GRID_STYLE_DASHEDConstantDashed grid1LIKE
I
Public
CO_GRID_STYLE_DOTConstantDots3LIKE
I
Public
CO_GRID_STYLE_DOTTEDConstantDotted grid2LIKE
I
Public
CO_GRID_STYLE_SOLIDConstantSolid grid0LIKE
I
Public
CO_INTERNAL_UNIT_CHConstantCharacters per Inch0LIKE
I
Protected
CO_INTERNAL_UNIT_CMConstantCentimeters1LIKE
I
Protected
CO_INTERNAL_UNIT_INConstantInches2LIKE
I
Protected
CO_INTERNAL_UNIT_LNConstantLines per Inch3LIKE
I
Protected
CO_INTERNAL_UNIT_MMConstantMillimeters4LIKE
I
Protected
CO_INTERNAL_UNIT_PTConstantPoints5LIKE
I
Protected
CO_INTERNAL_UNIT_TWConstantTwips6LIKE
I
Protected
CO_KEY_COPYConstantCTRL-C Key7LIKE
I
Public
CO_KEY_CUTConstantCTRL-X Key6LIKE
I
Public
CO_KEY_DELETEConstantDelete Key2LIKE
I
Public
CO_KEY_ENTERConstantEnter Key5LIKE
I
Public
CO_KEY_F1ConstantF1 Key1LIKE
I
Public
CO_KEY_F4ConstantF4 Key4LIKE
I
Public
CO_KEY_INSERTConstantInsert Key3LIKE
I
Public
CO_KEY_PASTEConstantCTRL-V Key8LIKE
I
Public
CO_MODE_DESIGNConstantDesign mode1LIKE
I
Public
CO_MODE_RUNConstantRun mode0LIKE
I
Public
CO_TRACKER_STYLE_DOTTED_LINEConstantDotted line for the border2LIKE
I
Public
CO_TRACKER_STYLE_HATCH_BORDERConstantHatched pattern for the rectangle border4LIKE
I
Public
CO_TRACKER_STYLE_HATCH_INSIDEConstantHatched pattern covers the rectangle32LIKE
I
Public
CO_TRACKER_STYLE_RESIZEINSIDEConstantResize handles located inside8LIKE
I
Public
CO_TRACKER_STYLE_RESIZEOUTSIDEConstantResize handles located outside16LIKE
I
Public
CO_TRACKER_STYLE_SOLID_LINEConstantSolid line for the border1LIKE
I
Public
CO_UNIT_CHConstantCharacters per Inch'CH'LIKE
TDUNIT
Public
CO_UNIT_CMConstantCentimeters'CM'LIKE
TDUNIT
Public
CO_UNIT_INConstantInches'IN'LIKE
TDUNIT
Public
CO_UNIT_LNConstantLines per Inch'LN'LIKE
TDUNIT
Public
CO_UNIT_MMConstantMillimeters'MM'LIKE
TDUNIT
Public
CO_UNIT_PTConstantPoints'PT'LIKE
TDUNIT
Public
CO_UNIT_TWConstantTwips'TW'LIKE
TDUNIT
Public
EVENTID_CONTEXT_MENU_REQUESTEDConstantEvent context menu requested1LIKE
I
Public
EVENTID_CONTEXT_MENU_SELECTEDConstantEvent context menu selected2LIKE
I
Public
EVENTID_CONTEXT_MENU_TOOLBARConstantEvent context menu toolbar6LIKE
I
Protected
EVENTID_OPTIONS_DIALOG_REQConstantEvent options dialog requested7LIKE
I
Protected
EVENTID_WINDOWS_PROPS_CHANGEDConstantEvent windows properties changed10LIKE
I
Public
EVENTID_WINDOW_CREATEConstantEvent window create3LIKE
I
Public
EVENTID_WINDOW_DBLCLICKConstantEvent doubleclick on window8LIKE
I
Public
EVENTID_WINDOW_KEY_PRESSEDConstantEvent window key pressed9LIKE
I
Public
EVENTID_WINDOW_PROPS_CHANGEDConstantEvent window properties changed5LIKE
I
Public
EVENTID_WINDOW_SELECTEDConstantEvent window selected4LIKE
I
Public
M_CPIInstance AttributeCharacters per InchLIKE
SSFFORMHD-CPI
Public
M_LPIInstance AttributeLines per inchLIKE
SSFFORMHD-LPI
Public
M_MODEInstance AttributeModeLIKE
I
Public
M_PAGE_HEIGHTInstance AttributePage heightLIKE
SSFDOCSTRC-WWIDTH
Public
M_PAGE_HEIGHT_UNITInstance AttributePage height unitLIKE
SSFDOCSTRC-U_WWIDTH
Public
M_PAGE_WIDTHInstance AttributePage widthLIKE
SSFDOCSTRC-WHEIGHT
Public
M_PAGE_WIDTH_UNITInstance AttributePage width unitLIKE
SSFDOCSTRC-U_WHEIGHT
Public
M_TOOLBARInstance AttributeToolbarLIKE
I
Public
M_VERSIONInstance AttributeForm Painter Control versionLIKE
I
Private
M_WALLPAPER_HEIGHTInstance AttributeWallpaper heightLIKE
SSFDOCSTRC-WHEIGHT
Public
M_WALLPAPER_HEIGHT_UNITInstance AttributeWallpaper height unitLIKE
SSFDOCSTRC-U_WHEIGHT
Public
M_WALLPAPER_LEFTInstance AttributeWallpaper left positionLIKE
SSFDOCSTRC-WLEFT
Public
M_WALLPAPER_LEFT_UNITInstance AttributeWallpaper left position unitLIKE
SSFDOCSTRC-U_WLEFT
Public
M_WALLPAPER_TOPInstance AttributeWallpaper top positionLIKE
SSFDOCSTRC-WTOP
Public
M_WALLPAPER_TOP_UNITInstance AttributeWallpaper top position unitLIKE
SSFDOCSTRC-U_WTOP
Public
M_WALLPAPER_URLInstance AttributeWallpaper URLLIKE
SSFURL
Public
M_WALLPAPER_WIDTHInstance AttributeWallpaper widthLIKE
SSFDOCSTRC-WWIDTH
Public
M_WALLPAPER_WIDTH_UNITInstance AttributeWallpaper width unitLIKE
SSFDOCSTRC-U_WWIDTH
Public
M_WANTDBLCLICKEVENTInstance AttributeWant doubleclick event?LIKE
I
Public
M_WINDOWSInstance AttributeScreensLIKE
WINDOWS
Protected
WINDOW_DELETINGInstance AttributeWindow deleting in progress?LIKE
I
Private


Events of Class CL_GUI_FORMPAINTER

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... CONTEXT_MENU_REQUESTED - Context menu requested
CONTEXT_MENU_SELECTED - Context menu selected
FORMPAINTER_CLICK - Click on the Form Painter (outside of any window)
FORMPAINTER_DBLCLICK - Doubleclick on the form painter (outside of any window)
FORMPAINTER_KEY_PRESSED - Key pressed on the form painter (outside of any window)
WINDOW_CREATE - Window create



CL_GUI_FORMPAINTER types

WINDOWS - WINDOWS

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



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!