SAP CL_GUI_HTML_VIEWER OO Class - HTML Control Proxy Class
CL_GUI_HTML_VIEWER 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_HTML_VIEWER 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_HTML_VIEWER is CL_GUI_CONTROLMethod list of CL_GUI_HTML_VIEWER 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 Name | Description | Visability |
| ADD_GENERIC_HTML_ATTRIBUTES | Private | |
| CALL METHOD cl_gui_html_viewer=>ADD_GENERIC_HTML_ATTRIBUTES...more details | ||
| ADJUST_HTML_DATA | Private | |
| CALL METHOD cl_gui_html_viewer=>ADJUST_HTML_DATA...more details | ||
| APPEND_QUERY_PARAMETER | Appends Parameters to Query Table | Private |
| CALL METHOD cl_gui_html_viewer=>APPEND_QUERY_PARAMETER...more details | ||
| CHECK_LOADED_OBJECT | Checks If Object was Already Loaded | Private |
| CALL METHOD cl_gui_html_viewer=>CHECK_LOADED_OBJECT...more details | ||
| CLOSE_DOCUMENT | Closes Last Opened Document | Public |
| CALL METHOD cl_gui_html_viewer=>CLOSE_DOCUMENT...more details | ||
| CONSTRUCTOR | Instantiates an HTML Viewer | Public |
| CALL METHOD cl_gui_html_viewer=>CONSTRUCTOR...more details | ||
|
| ||
| CONVERT_TABLE_AS_RAW | Converts a Table to One of Type 'RAW' | Private |
| CALL METHOD cl_gui_html_viewer=>CONVERT_TABLE_AS_RAW...more details | ||
| CREATE_OBJECT_TO_SCRIPT | ActiveX objects used in WebView2 HTML control | Public |
| CALL METHOD cl_gui_html_viewer=>CREATE_OBJECT_TO_SCRIPT...more details | ||
| DETACH_URL_IN_BROWSER | Private | |
| CALL METHOD cl_gui_html_viewer=>DETACH_URL_IN_BROWSER...more details | ||
| DO_REFRESH | Forces a HTML page displayed to be reloaded | Public |
| CALL METHOD cl_gui_html_viewer=>DO_REFRESH...more details | ||
| DRAG_ACCEPT_FILES | Private | |
| CALL METHOD cl_gui_html_viewer=>DRAG_ACCEPT_FILES...more details | ||
| ENABLE_REMOTE_SECURITY_SESSION | Security session in exchange to provided re-entrance ticket | Public |
| CALL METHOD cl_gui_html_viewer=>ENABLE_REMOTE_SECURITY_SESSION...more details | ||
| ENABLE_SAPSSO | Activate/Deactivate SSO for ICEMAN | Public |
| CALL METHOD cl_gui_html_viewer=>ENABLE_SAPSSO...more details | ||
| ENABLE_SIMPLEBROWSING | Private | |
| CALL METHOD cl_gui_html_viewer=>ENABLE_SIMPLEBROWSING...more details | ||
| EXECUTE_SCRIPT | Executes a Java script set with SET_SCRIPT | Protected |
| CALL METHOD cl_gui_html_viewer=>EXECUTE_SCRIPT...more details | ||
| EXECWB | Executes an OLE command. Only for WB_CMDID_PRINT. | Public |
| CALL METHOD cl_gui_html_viewer=>EXECWB...more details | ||
| FILL_QUERY_PARSE_BUFFER | Fills Parse Buffer | Private |
| CALL METHOD cl_gui_html_viewer=>FILL_QUERY_PARSE_BUFFER...more details | ||
| FILL_QUERY_TABLE | Fills Query Table | Private |
| CALL METHOD cl_gui_html_viewer=>FILL_QUERY_TABLE...more details | ||
| FILTER_DOCUMENT_CONTENT | Filters the malicious content | Public |
| CALL METHOD cl_gui_html_viewer=>FILTER_DOCUMENT_CONTENT...more details | ||
| FLUSH_EVENT_PARAMETERS | Gets Event Parameters | Private |
| CALL METHOD cl_gui_html_viewer=>FLUSH_EVENT_PARAMETERS...more details | ||
| GENERATE_NEW_URL | Generates a URL for loading a data object (BDS) | Public |
| CALL METHOD cl_gui_html_viewer=>GENERATE_NEW_URL...more details | ||
| GET_BROWSER_STRING | Get the info string of the browser started | Public |
| CALL METHOD cl_gui_html_viewer=>GET_BROWSER_STRING...more details | ||
| GET_CURRENT_URL | Determines the URL of the HTML page currently displayed | Public |
| CALL METHOD cl_gui_html_viewer=>GET_CURRENT_URL...more details | ||
| GET_DOCUMENT_EXTENSION | Determines the file name extension based on MIME subtype | Private |
| CALL METHOD cl_gui_html_viewer=>GET_DOCUMENT_EXTENSION...more details | ||
| GET_ICON_FONT_STYLE | To get style information for SVG icons | Public |
| CALL METHOD cl_gui_html_viewer=>GET_ICON_FONT_STYLE...more details | ||
| GET_RECOMMENDED_CHARSET | Gets the GUI Default Character Set for HTML Display | Public |
| CALL METHOD cl_gui_html_viewer=>GET_RECOMMENDED_CHARSET...more details | ||
| GET_SAPEVENT_POSTDATA | Gets the POST data through DP | Private |
| CALL METHOD cl_gui_html_viewer=>GET_SAPEVENT_POSTDATA...more details | ||
| GET_URL_ATTRIBUTES | Private | |
| CALL METHOD cl_gui_html_viewer=>GET_URL_ATTRIBUTES...more details | ||
| GO_BACK | Navigates backward in the HTML browser | Public |
| CALL METHOD cl_gui_html_viewer=>GO_BACK...more details | ||
| GO_FORWARD | Navigates forward in the HTML browser | Public |
| CALL METHOD cl_gui_html_viewer=>GO_FORWARD...more details | ||
| GO_HOME | Displays the homepage of the browser installed | Public |
| CALL METHOD cl_gui_html_viewer=>GO_HOME...more details | ||
| INIT_R3HTTP_PATH | R/3 HTTP Service URL for Web Repository and BDS | Protected |
| CALL METHOD cl_gui_html_viewer=>INIT_R3HTTP_PATH...more details | ||
| IS_CHARBASED_TABLE | Checks if table is of type C | Private |
| CALL METHOD cl_gui_html_viewer=>IS_CHARBASED_TABLE...more details | ||
| LOAD_BDS_OBJECT | Loads a BDS object from BDS class 'SAPTHML' | Protected |
| CALL METHOD cl_gui_html_viewer=>LOAD_BDS_OBJECT...more details | ||
| LOAD_BDS_SAP_ICON | Loads an SAP icon | Protected |
| CALL METHOD cl_gui_html_viewer=>LOAD_BDS_SAP_ICON...more details | ||
| LOAD_DATA | Loads the data from the ABAP program through DP | Public |
| CALL METHOD cl_gui_html_viewer=>LOAD_DATA...more details | ||
| LOAD_HTML_DOCUMENT | Loads an HTML document from the Web Object Repository | Public |
| CALL METHOD cl_gui_html_viewer=>LOAD_HTML_DOCUMENT...more details | ||
| LOAD_ICON_FONT | Load Icon Font | Public |
| CALL METHOD cl_gui_html_viewer=>LOAD_ICON_FONT...more details | ||
| LOAD_MIME_OBJECT | Loads an HTML document from the Web Repository | Public |
| CALL METHOD cl_gui_html_viewer=>LOAD_MIME_OBJECT...more details | ||
| SAPEVENT_ACKNOWLEGDE | Private | |
| CALL METHOD cl_gui_html_viewer=>SAPEVENT_ACKNOWLEGDE...more details | ||
| SET_DOCUMENT_CHARSET | Sets the Character Set for the HTML Display | Public |
| CALL METHOD cl_gui_html_viewer=>SET_DOCUMENT_CHARSET...more details | ||
| SET_NAVIGATION_STYLE | Sets the navigation style | Public |
| CALL METHOD cl_gui_html_viewer=>SET_NAVIGATION_STYLE...more details | ||
| SET_SCRIPT | Sets a Java script for later use. Only IE. | Protected |
| CALL METHOD cl_gui_html_viewer=>SET_SCRIPT...more details | ||
| SET_SCRIPT_ON_ABAP_COMPLETED | Sets ScriptOnABAPCompleted. Only IE. | Protected |
| CALL METHOD cl_gui_html_viewer=>SET_SCRIPT_ON_ABAP_COMPLETED...more details | ||
| SET_SCRIPT_ON_DATA_SUBMITTED | Sets ScriptOnDataSubmitted. Only IE | Protected |
| CALL METHOD cl_gui_html_viewer=>SET_SCRIPT_ON_DATA_SUBMITTED...more details | ||
| SET_UI_FLAG | Sets the UI flag such as 3D frame or IE context menu | Public |
| CALL METHOD cl_gui_html_viewer=>SET_UI_FLAG...more details | ||
| SHOW_DATA | Use SHOW_URL | Public |
| CALL METHOD cl_gui_html_viewer=>SHOW_DATA...more details | ||
| SHOW_DATA_EX | DO NOT USE | Public |
| CALL METHOD cl_gui_html_viewer=>SHOW_DATA_EX...more details | ||
| SHOW_URL | Shows the Web page for the URL specified | Public |
| CALL METHOD cl_gui_html_viewer=>SHOW_URL...more details | ||
| SHOW_URL_EX | DO NOT USE | Public |
| CALL METHOD cl_gui_html_viewer=>SHOW_URL_EX...more details | ||
| SHOW_URL_IN_BROWSER | Shows the URL in a separate browser window | Public |
| CALL METHOD cl_gui_html_viewer=>SHOW_URL_IN_BROWSER...more details | ||
| STOP | Ends loading an HTML page | Public |
| CALL METHOD cl_gui_html_viewer=>STOP...more details | ||
| TRACK_CONTEXT_MENU | Displays a context menu | Public |
| CALL METHOD cl_gui_html_viewer=>TRACK_CONTEXT_MENU...more details | ||
| TRANSLATE_QUERY_STRING | Translates the query string | Private |
| CALL METHOD cl_gui_html_viewer=>TRANSLATE_QUERY_STRING...more details | ||
| UPDATE_TABLE_DP_OBJECT | Updates the objects table | Private |
| CALL METHOD cl_gui_html_viewer=>UPDATE_TABLE_DP_OBJECT...more details | ||
CL_GUI_HTML_VIEWER 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.
| Name | Level | Description | Initial Value | Type | Visability |
| M_ACTION | Instance Attribute | action code | LIKE CNHT_URL_PREFIX | Private | |
| M_BDS | Instance Attribute | BDS instance | LIKE CL_BDS_DOCUMENT_SET | Protected | |
| M_BROWSER | Instance Attribute | IE browser handle | LIKE CNTL_HANDLE | Private | |
| M_BROWSER_STRING | Instance Attribute | Browser string | LIKE CHAR255 | Public | |
| M_CTXMENU_FCODE | Instance Attribute | context menu item FCode | LIKE UI_FUNC | Protected | |
| M_DEFAULT_SAPGUI_CHARSET | Instance Attribute | SAPGUI Character Set for HTML | LIKE STRING | Private | |
| M_DP_LIFETIME | Instance Attribute | DP lifetime | CNDP_LIFETIME_TRANSACTION | LIKE CNHT_DP_LIFETIME | Public |
| M_FRAME | Instance Attribute | frame name, where sapevent is fired | LIKE CNHT_URL_PREFIX | Private | |
| M_GETDATA | Instance Attribute | getdata | LIKE CNHT_URL | Private | |
| M_HDP | Instance Attribute | Data Provider handle | LIKE CNTL_HANDLE | Public | |
| M_HTTP_HOST | Instance Attribute | HTTP Host Name | LIKE PLG_HOST | Private | |
| M_HTTP_HTMLVIEWER | Instance Attribute | Path of HTTP Service for the HTML Viewer | LIKE STRING | Public | |
| M_HTTP_SERVICE | Instance Attribute | HTTP Service Port Number | LIKE PLG_SRV | Private | |
| M_ID_CTXMENU_REQUEST | Constant | required a context menu | 4 | LIKE I | Public |
| M_ID_CTXMENU_SELECTED | Constant | when a context menu item selected | 3 | LIKE I | Public |
| M_ID_NAVIGATE_COMPLETE | Constant | ID of event NAVIGATE_COMPLETE | 2 | LIKE I | Public |
| M_ID_SAPEVENT | Constant | ID of SAPEVENT | 1 | LIKE I | Public |
| M_POSTDATA | Instance Attribute | table contains the postdata | LIKE CNHT_POST_DATA_TAB | Private | |
| M_QUERY_TABLE | Instance Attribute | query table | LIKE CNHT_QUERY_TABLE | Private | |
| M_QUERY_TABLE_DISABLED | Instance Attribute | QUERY_TABLE in SAPEVENT? | LIKE CHAR1 | Private | |
| M_R3ONLY | Instance Attribute | Navigation: Only in R/3 | ' ' | LIKE CHAR1 | Private |
| M_RESULT | Instance Attribute | result | LIKE I | Public | |
| M_SAPEVENT_NAMESPACE | Instance Attribute | SAPEVENT Namespace | 'SAPEVENT:' | LIKE CNHT_SAPEVENT_NAMESPACE | Protected |
| M_SAPEVENT_NAMESPACE_LEN | Instance Attribute | length of the namespace | 9 | LIKE I | Protected |
| M_SIZE_OF_POSTDATA | Instance Attribute | length of the postdata | 0 | LIKE I | Private |
| M_STYLE | Instance Attribute | Navigation style | LIKE TEXT8 | Private | |
| M_TABLE_DP_OBJECT | Instance Attribute | Objects loaded in the HTML Viewer | LIKE THT_OBJECT | Private | |
| M_UIFLAG | Instance Attribute | UI setting | 0 | LIKE I | Public |
| M_UNIQUE_URL_ID | Static Attribute | unique URL ID | LIKE CNHT_UNIQUE_ID | Protected | |
| M_URL | Instance Attribute | URL | LIKE CNHT_URL | Private | |
| M_URL_PREFIX | Instance Attribute | URL local prefix | LIKE CNHT_URL_PREFIX | Private | |
| M_USE_SAPEVENT_ACKNOWLEGDE | Instance Attribute | Flag for Calling the SAPEVENT_ACKNOWLEDGE Method | '' | LIKE CHAR1 | Protected |
| STYLE_NEWWINDOWBYLINK | Constant | Navigation for R/3 source only | 'B' | LIKE CHAR1 | Public |
| STYLE_R3ONLY | Constant | Navigation for R/3 source only | 'C' | LIKE CHAR1 | Public |
| UIFLAG_NO3DBORDER | Constant | UI flag to disable 3D border | 4 | LIKE I | Public |
| UIFLAG_NOIEMENU | Constant | UI flag to disable IE context menu | 2 | LIKE I | Public |
| UIFLAG_USE_SAPGUI_CHARSET | Constant | Autmatically Set the SAPGUI Character Set for HTML Display | 2097152 | LIKE I | Public |
| WB_CMDID_PRINT | Constant | Command ID for printing | 6 | LIKE I | Public |
Events of Class CL_GUI_HTML_VIEWER
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... CTXMENU_REQUEST - context menu requiredCTXMENU_SELECTED - is fired after a context menu item slected
NAVIGATE_COMPLETE - is fired after navigation
SAPEVENT - is fired from a HTML page
Links to Related Class(s)
CL_GUI_H...Full list of available SAP object classes
Search for further information about these or an SAP related objects