DEFINE_BUTTON_CHOICE SAP Method Creates/Changes a button choice with the given attributes
Below is documentation, parameters and attributes of ABAP Method DEFINE_BUTTON_CHOICE within SAP class IF_FPM_CNR_GAF. There is also a number of example ABAP code snipts to help you use the functionality of this method.
This method is available within SAP systems depending on your version and release level, you can view further information by entering the class name IF_FPM_CNR_GAF into the relevant SAP transactions such as SE24 or SE80, and then selecting the method you are interested in.
Method Type - Instance
This is an Instance Method so needs to be instantiated first before you can access any of the methods. I.e. you need to create a local variable of TYPE ref to the class.The following technical details of method DEFINE_BUTTON_CHOICE can also be found below:
- Importing parameters
- Exporting parameters
- Changing parameters
- Returning parameters
- Exceptions
- Coding Examples
Parameters of Method DEFINE_BUTTON_CHOICE
.| Name | Type | Data Type | Description | Default Value |
| IT_MENU_ACTION_ITEMS | Importing | TYPE T_MENU_ACTION_ITEMS | menu elements of a Button-Choice | |
| IV_ELEMENT_ID | Importing | TYPE STRING | ID only for app-specific buttons, for later change | |
| IV_ENABLED | Importing | TYPE BOOLE_D | Supplement for True Boolean Type: 'X' == True '' == False | |
| IV_FUNCTION | Importing | TYPE STRING | see Interface IF_FPM_CONSTANTS attribute GC_BUTTON_CHOICE | |
| IV_IMAGE | Importing | TYPE FPM_IMAGE | Image | |
| IV_MAINSTEP_ID | Importing | TYPE STRING | Mainstep ID (current Mainstep if skipped) | |
| IV_REPEAT_SELECTED_ACTION | Importing | TYPE BOOLE_D | Data element for domain BOOLE: TRUE (='X') and FALSE (=' ') | |
| IV_SCREEN | Importing | TYPE FPM_FLOORPLAN_STATE | The screen where the UI-Element has to be added (INIT, MAIN) | |
| IV_SELECTED_ACTION_ITEM | Importing | TYPE STRING | element id of selected action item | |
| IV_SEQUENCE_ID | Importing | TYPE STRING | only relevant for non-standard buttons ('Other Functions'... | |
| IV_SUBSTEP_ID | Importing | TYPE STRING | Substep ID (skip it, if you change only the mainstep) | |
| IV_SUBVARIANT_ID | Importing | TYPE STRING | Subvariant ID (skip it, if you change only the mainstep) | |
| IV_TEXT | Importing | TYPE STRING | only relevant for certain buttons (see Spec of OIF Toolbar) | |
| IV_TOOLTIP | Importing | TYPE STRING | only relevant for certain buttons (see Spec of OIF Toolbar) | |
| IV_VARIANT_ID | Importing | TYPE STRING | Variant ID (current variant if skipped) | |
| IV_VISIBILITY | Importing | TYPE WDUI_VISIBILITY | Web Dynpro: Visibility |
Exceptions of Method DEFINE_BUTTON_CHOICE
This method does not have any exceptionsExample ABAP coding
DATA: lo_class TYPE REF TO IF_FPM_CNR_GAF.
DATA: lv_IT_MENU_ACTION_ITEMS TYPE T_MENU_ACTION_ITEMS,
lv_IV_ELEMENT_ID TYPE STRING,
lv_IV_ENABLED TYPE BOOLE_D,
lv_IV_FUNCTION TYPE STRING,
lv_IV_IMAGE TYPE FPM_IMAGE,
lv_IV_MAINSTEP_ID TYPE STRING,
lv_IV_REPEAT_SELECTED_ACTION TYPE BOOLE_D,
lv_IV_SCREEN TYPE FPM_FLOORPLAN_STATE,
lv_IV_SELECTED_ACTION_ITEM TYPE STRING,
lv_IV_SEQUENCE_ID TYPE STRING,
lv_IV_SUBSTEP_ID TYPE STRING,
lv_IV_SUBVARIANT_ID TYPE STRING,
lv_IV_TEXT TYPE STRING,
lv_IV_TOOLTIP TYPE STRING,
lv_IV_VARIANT_ID TYPE STRING,
lv_IV_VISIBILITY TYPE WDUI_VISIBILITY,
lv_other TYPE c.
CALL METHOD lo_class=>DEFINE_BUTTON_CHOICE(
EXPORTING
IT_MENU_ACTION_ITEMS = lv_IT_MENU_ACTION_ITEMS
IV_ELEMENT_ID = lv_IV_ELEMENT_ID
IV_ENABLED = lv_IV_ENABLED
IV_FUNCTION = lv_IV_FUNCTION
IV_IMAGE = lv_IV_IMAGE
IV_MAINSTEP_ID = lv_IV_MAINSTEP_ID
IV_REPEAT_SELECTED_ACTION = lv_IV_REPEAT_SELECTED_ACTION
IV_SCREEN = lv_IV_SCREEN
IV_SELECTED_ACTION_ITEM = lv_IV_SELECTED_ACTION_ITEM
IV_SEQUENCE_ID = lv_IV_SEQUENCE_ID
IV_SUBSTEP_ID = lv_IV_SUBSTEP_ID
IV_SUBVARIANT_ID = lv_IV_SUBVARIANT_ID
IV_TEXT = lv_IV_TEXT
IV_TOOLTIP = lv_IV_TOOLTIP
IV_VARIANT_ID = lv_IV_VARIANT_ID
IV_VISIBILITY = lv_IV_VISIBILITY ).
Links to Related Class(s)
IF_FPM_C...Full list of available SAP object classes
Search for further information about these or an SAP related objects