SAP OM_GRID_ADD_TO_DISPLAY_OBJECTS Function Module for









OM_GRID_ADD_TO_DISPLAY_OBJECTS is a standard om grid add to display objects SAP function module available within SAP R/3 or S/4 Hana systems, depending on your version and release level. It is used to perform a specific ABAP function and below is the pattern details, showing its interface including any import and export parameters, exceptions etc. there is also a full "cut and paste" ABAP pattern code example, along with implementation ABAP coding, documentation and contribution comments specific to this or related objects.


See here to view full function module documentation and code listing for om grid add to display objects FM, simply by entering the name OM_GRID_ADD_TO_DISPLAY_OBJECTS into the relevant SAP transaction such as SE37 or SE38.

Function Group: OM_GRID
Program Name: SAPLOM_GRID
Main Program: SAPLOM_GRID
Appliation area:
Release date: N/A
Mode(Normal, Remote etc): Normal Function Module
Update:



Function OM_GRID_ADD_TO_DISPLAY_OBJECTS pattern details

In-order to call this FM within your sap programs, simply using the below ABAP pattern details to trigger the function call...or see the full ABAP code listing at the end of this article. You can simply cut and paste this code into your ABAP progrom as it is, including variable declarations.
CALL FUNCTION 'OM_GRID_ADD_TO_DISPLAY_OBJECTS'"
EXPORTING
GRID_HANDLE = "
* INITIAL_KEYS = 'X' "
* CLEAR_SORTCRITERIA = ' ' "

TABLES
ADD_DISPLAYED_OBJECTS = "
* ADD_DISPLAYED_STRUCTURE = "
* LINES_TO_BE_COLORED = "

EXCEPTIONS
HANDLE_NOT_FOUND = 1
.



IMPORTING Parameters details for OM_GRID_ADD_TO_DISPLAY_OBJECTS

GRID_HANDLE -

Data type: CL_GUI_ALV_GRID
Optional: No
Call by Reference: No ( called with pass by value option)

INITIAL_KEYS -

Data type: FLAG
Default: 'X'
Optional: Yes
Call by Reference: No ( called with pass by value option)

CLEAR_SORTCRITERIA -

Data type: FLAG
Default: ' '
Optional: Yes
Call by Reference: No ( called with pass by value option)

TABLES Parameters details for OM_GRID_ADD_TO_DISPLAY_OBJECTS

ADD_DISPLAYED_OBJECTS -

Data type: TREE_OBJEC
Optional: No
Call by Reference: Yes

ADD_DISPLAYED_STRUCTURE -

Data type: TREE_STRUC
Optional: Yes
Call by Reference: Yes

LINES_TO_BE_COLORED -

Data type: LINECOLOR
Optional: Yes
Call by Reference: Yes

EXCEPTIONS details

HANDLE_NOT_FOUND -

Data type:
Optional: No
Call by Reference: Yes

Copy and paste ABAP code example for OM_GRID_ADD_TO_DISPLAY_OBJECTS Function Module

The ABAP code below is a full code listing to execute function module POPUP_TO_CONFIRM including all data declarations. The code uses the original data declarations rather than the latest in-line data DECLARATION SYNTAX but I have included an ABAP code snippet at the end to show how declarations would look using the newer method of declaring data variables on the fly. This will allow you to compare and fully understand the new inline method. Please note some of the newer syntax such as the @DATA is not available until a later 4.70 service pack (SP8), which i why i have stuck to the origianl for this example.

DATA:
lv_grid_handle  TYPE CL_GUI_ALV_GRID, "   
lv_handle_not_found  TYPE CL_GUI_ALV_GRID, "   
lt_add_displayed_objects  TYPE STANDARD TABLE OF TREE_OBJEC, "   
lv_initial_keys  TYPE FLAG, "   'X'
lt_add_displayed_structure  TYPE STANDARD TABLE OF TREE_STRUC, "   
lv_clear_sortcriteria  TYPE FLAG, "   ' '
lt_lines_to_be_colored  TYPE STANDARD TABLE OF LINECOLOR. "   

  CALL FUNCTION 'OM_GRID_ADD_TO_DISPLAY_OBJECTS'  "
    EXPORTING
         GRID_HANDLE = lv_grid_handle
         INITIAL_KEYS = lv_initial_keys
         CLEAR_SORTCRITERIA = lv_clear_sortcriteria
    TABLES
         ADD_DISPLAYED_OBJECTS = lt_add_displayed_objects
         ADD_DISPLAYED_STRUCTURE = lt_add_displayed_structure
         LINES_TO_BE_COLORED = lt_lines_to_be_colored
    EXCEPTIONS
        HANDLE_NOT_FOUND = 1
. " OM_GRID_ADD_TO_DISPLAY_OBJECTS




ABAP code using 7.40 inline data declarations to call FM OM_GRID_ADD_TO_DISPLAY_OBJECTS

The below ABAP code uses the newer in-line data declarations. This allows you to see the coding differences/benefits of the later inline syntax. Please note some of the newer syntax below, such as the @DATA is not available until 4.70 EHP 8.

 
 
 
DATA(ld_initial_keys) = 'X'.
 
 
DATA(ld_clear_sortcriteria) = ' '.
 
 


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!