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_CONTROL

Method 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 NameDescriptionVisability
ADD_GENERIC_HTML_ATTRIBUTESPrivate
CALL METHOD cl_gui_html_viewer=>ADD_GENERIC_HTML_ATTRIBUTES...more details

ADJUST_HTML_DATAPrivate
CALL METHOD cl_gui_html_viewer=>ADJUST_HTML_DATA...more details

APPEND_QUERY_PARAMETERAppends Parameters to Query TablePrivate
CALL METHOD cl_gui_html_viewer=>APPEND_QUERY_PARAMETER...more details

CHECK_LOADED_OBJECTChecks If Object was Already LoadedPrivate
CALL METHOD cl_gui_html_viewer=>CHECK_LOADED_OBJECT...more details

CLOSE_DOCUMENTCloses Last Opened DocumentPublic
CALL METHOD cl_gui_html_viewer=>CLOSE_DOCUMENT...more details

CONSTRUCTORInstantiates an HTML ViewerPublic
CALL METHOD cl_gui_html_viewer=>CONSTRUCTOR...more details

CONVERT_TABLE_AS_RAWConverts a Table to One of Type 'RAW'Private
CALL METHOD cl_gui_html_viewer=>CONVERT_TABLE_AS_RAW...more details

DETACH_URL_IN_BROWSERPrivate
CALL METHOD cl_gui_html_viewer=>DETACH_URL_IN_BROWSER...more details

DO_REFRESHForces a HTML page displayed to be reloadedPublic
CALL METHOD cl_gui_html_viewer=>DO_REFRESH...more details

DRAG_ACCEPT_FILESPrivate
CALL METHOD cl_gui_html_viewer=>DRAG_ACCEPT_FILES...more details

ENABLE_SAPSSOActivate/Deactivate SSO for ICEMANPublic
CALL METHOD cl_gui_html_viewer=>ENABLE_SAPSSO...more details

ENABLE_SIMPLEBROWSINGPrivate
CALL METHOD cl_gui_html_viewer=>ENABLE_SIMPLEBROWSING...more details

EXECUTE_SCRIPTExecutes a Java script set with SET_SCRIPTProtected
CALL METHOD cl_gui_html_viewer=>EXECUTE_SCRIPT...more details

EXECWBExecutes an OLE command. Only for WB_CMDID_PRINT.Public
CALL METHOD cl_gui_html_viewer=>EXECWB...more details

FILL_QUERY_PARSE_BUFFERFills Parse BufferPrivate
CALL METHOD cl_gui_html_viewer=>FILL_QUERY_PARSE_BUFFER...more details

FILL_QUERY_TABLEFills Query TablePrivate
CALL METHOD cl_gui_html_viewer=>FILL_QUERY_TABLE...more details

FILTER_DOCUMENT_CONTENTFilters the malicious contentPublic
CALL METHOD cl_gui_html_viewer=>FILTER_DOCUMENT_CONTENT...more details

FLUSH_EVENT_PARAMETERSGets Event ParametersPrivate
CALL METHOD cl_gui_html_viewer=>FLUSH_EVENT_PARAMETERS...more details

GENERATE_NEW_URLGenerates a URL for loading a data object (BDS)Public
CALL METHOD cl_gui_html_viewer=>GENERATE_NEW_URL...more details

GET_BROWSER_STRINGGet the info string of the browser startedPublic
CALL METHOD cl_gui_html_viewer=>GET_BROWSER_STRING...more details

GET_CURRENT_URLDetermines the URL of the HTML page currently displayedPublic
CALL METHOD cl_gui_html_viewer=>GET_CURRENT_URL...more details

GET_DOCUMENT_EXTENSIONDetermines the file name extension based on MIME subtypePrivate
CALL METHOD cl_gui_html_viewer=>GET_DOCUMENT_EXTENSION...more details

GET_RECOMMENDED_CHARSETGets the GUI Default Character Set for HTML DisplayPublic
CALL METHOD cl_gui_html_viewer=>GET_RECOMMENDED_CHARSET...more details

GET_SAPEVENT_POSTDATAGets the POST data through DPPrivate
CALL METHOD cl_gui_html_viewer=>GET_SAPEVENT_POSTDATA...more details

GET_URL_ATTRIBUTESPrivate
CALL METHOD cl_gui_html_viewer=>GET_URL_ATTRIBUTES...more details

GO_BACKNavigates backward in the HTML browserPublic
CALL METHOD cl_gui_html_viewer=>GO_BACK...more details

GO_FORWARDNavigates forward in the HTML browserPublic
CALL METHOD cl_gui_html_viewer=>GO_FORWARD...more details

GO_HOMEDisplays the homepage of the browser installedPublic
CALL METHOD cl_gui_html_viewer=>GO_HOME...more details

INIT_R3HTTP_PATHR/3 HTTP Service URL for Web Repository and BDSProtected
CALL METHOD cl_gui_html_viewer=>INIT_R3HTTP_PATH...more details

IS_CHARBASED_TABLEChecks if table is of type CPrivate
CALL METHOD cl_gui_html_viewer=>IS_CHARBASED_TABLE...more details

LOAD_BDS_OBJECTLoads a BDS object from BDS class 'SAPTHML'Protected
CALL METHOD cl_gui_html_viewer=>LOAD_BDS_OBJECT...more details

LOAD_BDS_SAP_ICONLoads an SAP iconProtected
CALL METHOD cl_gui_html_viewer=>LOAD_BDS_SAP_ICON...more details

LOAD_DATALoads the data from the ABAP program through DPPublic
CALL METHOD cl_gui_html_viewer=>LOAD_DATA...more details

LOAD_HTML_DOCUMENTLoads an HTML document from the Web Object RepositoryPublic
CALL METHOD cl_gui_html_viewer=>LOAD_HTML_DOCUMENT...more details

LOAD_MIME_OBJECTLoads an HTML document from the Web RepositoryPublic
CALL METHOD cl_gui_html_viewer=>LOAD_MIME_OBJECT...more details

SAPEVENT_ACKNOWLEGDEPrivate
CALL METHOD cl_gui_html_viewer=>SAPEVENT_ACKNOWLEGDE...more details

SET_DOCUMENT_CHARSETSets the Character Set for the HTML DisplayPublic
CALL METHOD cl_gui_html_viewer=>SET_DOCUMENT_CHARSET...more details

SET_NAVIGATION_STYLESets the navigation stylePublic
CALL METHOD cl_gui_html_viewer=>SET_NAVIGATION_STYLE...more details

SET_SCRIPTSets a Java script for later use. Only IE.Protected
CALL METHOD cl_gui_html_viewer=>SET_SCRIPT...more details

SET_SCRIPT_ON_ABAP_COMPLETEDSets ScriptOnABAPCompleted. Only IE.Protected
CALL METHOD cl_gui_html_viewer=>SET_SCRIPT_ON_ABAP_COMPLETED...more details

SET_SCRIPT_ON_DATA_SUBMITTEDSets ScriptOnDataSubmitted. Only IEProtected
CALL METHOD cl_gui_html_viewer=>SET_SCRIPT_ON_DATA_SUBMITTED...more details

SET_UI_FLAGSets the UI flag such as 3D frame or IE context menuPublic
CALL METHOD cl_gui_html_viewer=>SET_UI_FLAG...more details

SHOW_DATAUse SHOW_URLPublic
CALL METHOD cl_gui_html_viewer=>SHOW_DATA...more details

SHOW_DATA_EXDO NOT USEPublic
CALL METHOD cl_gui_html_viewer=>SHOW_DATA_EX...more details

SHOW_URLShows the Web page for the URL specifiedPublic
CALL METHOD cl_gui_html_viewer=>SHOW_URL...more details

SHOW_URL_EXDO NOT USEPublic
CALL METHOD cl_gui_html_viewer=>SHOW_URL_EX...more details

SHOW_URL_IN_BROWSERShows the URL in a separate browser windowPublic
CALL METHOD cl_gui_html_viewer=>SHOW_URL_IN_BROWSER...more details

STOPEnds loading an HTML pagePublic
CALL METHOD cl_gui_html_viewer=>STOP...more details

TRACK_CONTEXT_MENUDisplays a context menuPublic
CALL METHOD cl_gui_html_viewer=>TRACK_CONTEXT_MENU...more details

TRANSLATE_QUERY_STRINGTranslates the query stringPrivate
CALL METHOD cl_gui_html_viewer=>TRANSLATE_QUERY_STRING...more details

UPDATE_TABLE_DP_OBJECTUpdates the objects tablePrivate
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.

NameLevelDescriptionInitial ValueTypeVisability
M_ACTIONInstance Attributeaction codeLIKE
CNHT_URL_PREFIX
Private
M_BDSInstance AttributeBDS instanceLIKE
CL_BDS_DOCUMENT_SET
Protected
M_BROWSERInstance AttributeIE browser handleLIKE
CNTL_HANDLE
Private
M_BROWSER_STRINGInstance AttributeBrowser stringLIKE
CHAR255
Public
M_CTXMENU_FCODEInstance Attributecontext menu item FCodeLIKE
UI_FUNC
Protected
M_DEFAULT_SAPGUI_CHARSETInstance AttributeSAPGUI Character Set for HTMLLIKE
STRING
Private
M_DP_LIFETIMEInstance AttributeDP lifetimeCNDP_LIFETIME_TRANSACTIONLIKE
CNHT_DP_LIFETIME
Public
M_FRAMEInstance Attributeframe name, where sapevent is firedLIKE
CNHT_URL_PREFIX
Private
M_GETDATAInstance AttributegetdataLIKE
CNHT_URL
Private
M_HDPInstance AttributeData Provider handleLIKE
CNTL_HANDLE
Public
M_HTTP_HOSTInstance AttributeHTTP Host NameLIKE
PLG_HOST
Private
M_HTTP_HTMLVIEWERInstance AttributePath of HTTP Service for the HTML ViewerLIKE
STRING
Public
M_HTTP_SERVICEInstance AttributeHTTP Service Port NumberLIKE
PLG_SRV
Private
M_ID_CTXMENU_REQUESTConstantrequired a context menu4LIKE
I
Public
M_ID_CTXMENU_SELECTEDConstantwhen a context menu item selected3LIKE
I
Public
M_ID_NAVIGATE_COMPLETEConstantID of event NAVIGATE_COMPLETE2LIKE
I
Public
M_ID_SAPEVENTConstantID of SAPEVENT1LIKE
I
Public
M_POSTDATAInstance Attributetable contains the postdataLIKE
CNHT_POST_DATA_TAB
Private
M_QUERY_TABLEInstance Attributequery tableLIKE
CNHT_QUERY_TABLE
Private
M_QUERY_TABLE_DISABLEDInstance AttributeQUERY_TABLE in SAPEVENT?LIKE
CHAR1
Private
M_R3ONLYInstance AttributeNavigation: Only in R/3' 'LIKE
CHAR1
Private
M_RESULTInstance AttributeresultLIKE
I
Public
M_SAPEVENT_NAMESPACEInstance AttributeSAPEVENT Namespace'SAPEVENT:'LIKE
CNHT_SAPEVENT_NAMESPACE
Protected
M_SAPEVENT_NAMESPACE_LENInstance Attributelength of the namespace9LIKE
I
Protected
M_SIZE_OF_POSTDATAInstance Attributelength of the postdata0LIKE
I
Private
M_STYLEInstance AttributeNavigation styleLIKE
TEXT8
Private
M_TABLE_DP_OBJECTInstance AttributeObjects loaded in the HTML ViewerLIKE
THT_OBJECT
Private
M_UIFLAGInstance AttributeUI setting0LIKE
I
Public
M_UNIQUE_URL_IDStatic Attributeunique URL IDLIKE
CNHT_UNIQUE_ID
Protected
M_URLInstance AttributeURLLIKE
CNHT_URL
Private
M_URL_PREFIXInstance AttributeURL local prefixLIKE
CNHT_URL_PREFIX
Private
M_USE_SAPEVENT_ACKNOWLEGDEInstance AttributeFlag for Calling the SAPEVENT_ACKNOWLEDGE Method''LIKE
CHAR1
Protected
STYLE_NEWWINDOWBYLINKConstantNavigation for R/3 source only'B'LIKE
CHAR1
Public
STYLE_R3ONLYConstantNavigation for R/3 source only'C'LIKE
CHAR1
Public
UIFLAG_NO3DBORDERConstantUI flag to disable 3D border4LIKE
I
Public
UIFLAG_NOIEMENUConstantUI flag to disable IE context menu2LIKE
I
Public
UIFLAG_USE_SAPGUI_CHARSETConstantAutmatically Set the SAPGUI Character Set for HTML Display2097152LIKE
I
Public
WB_CMDID_PRINTConstantCommand ID for printing6LIKE
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 required
CTXMENU_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



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!