ABAP_DOCU_SHOW SAP Function module - Display ABAP Keyword Documentation

Pattern for FM ABAP_DOCU_SHOW - ABAP DOCU SHOW

Associated Function Group: ABAP_DOCU
Released Date: 06.03.2000

CALL FUNCTION 'ABAP_DOCU_SHOW' "Display ABAP Keyword Documentation
* EXPORTING
*   area = 'ABEN'               " c             Documentation Area
*   name = 'ABAP'               " c             Document Name
*   langu = SY-LANGU            " syst-langu    Language
*   anchor =                    " c             Internal Text Mark for Direct Control
*   searched =                  " standard table  Search Terms for Full Text Search
*   search_mode =               " c             I, F for Index, Full Ttext
*   search_word =               " csequence     Search argument
  IMPORTING
    docu_container =            " cl_gui_control  Reference to Control
    .  "  ABAP_DOCU_SHOW

SAP Documentation for FM ABAP_DOCU_SHOW

Description

Display of keyword documentation in HTML control. The display depends on the user settings in the table ABDOCMODE (E: modeless dialog box, I: same box, M: one common external session for all external sessions).

Optional IMPORTING Parameters

AREA, Appropriate values are ABEN, ABAP, DYNP

NAME, Appropriate values are names of keywords such as MODULE

LANGU, Language key

ANCHOR, Internal marker, should be suitably transferred

The default values for the IMPORTING parameters are ABEN, ABAP, SY-LANGU.

EXPORTING Parameter

DOCU_CONTAINER, if display mode E (modless dialog box), reference to HTML control, otherwise initial.

Note on Use
It is sensible to set the focus to the HTML control after calling the function module and during the PBO event of the subsequent screen:

  IF NOT docu_container IS INITIAL.
   CALL METHOD cl_gui_control=>set_focus
                EXPORTING control = docu_container.
    CLEAR docu_container.
  ENDIF.


Caution

The controls used by the function module require a connection to a screen. Calling outside a screen sequence (for example, in an executable program) is not useful if the documentation is displayed in an amodal window.

Documentation extract taken from SAP system, Copyright (c) SAP AG

ABAP_DOCU_SEARCH

ABAP_DOCU_START

Share |