SAP CL_GUI_HTML_EDITOR OO Class - HTML Editor
CL_GUI_HTML_EDITOR 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_EDITOR 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_EDITOR is CL_GUI_CONTROLMethod list of CL_GUI_HTML_EDITOR 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 |
| CONSTRUCTOR | Creates and Links the HTML Editor Control | Public |
| CALL METHOD cl_gui_html_editor=>CONSTRUCTOR...more details | ||
| INSERT_HTML | insert HTML text into the document | Public |
| CALL METHOD cl_gui_html_editor=>INSERT_HTML...more details | ||
| SET_HTML_AS_STREAM | Send HTML as stream to control (incl. ' r' and ' n') | Public |
| CALL METHOD cl_gui_html_editor=>SET_HTML_AS_STREAM...more details | ||
| SET_SELECTED_HTML_AS_STREAM | Replace Selected HTML with Stream | Public |
| CALL METHOD cl_gui_html_editor=>SET_SELECTED_HTML_AS_STREAM...more details | ||
| SET_TOOLBAR_XML | Loads the Toolbar XML File | Public |
| CALL METHOD cl_gui_html_editor=>SET_TOOLBAR_XML...more details | ||
| SET_URL | Loads a Document by URL | Public |
| CALL METHOD cl_gui_html_editor=>SET_URL...more details | ||
|
| ||
CL_GUI_HTML_EDITOR 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 |
| FALSE | Constant | boolean like value 'FALSE' to handle properties of control | 0 | LIKE I | Public |
| MIMESUBTYPE | Constant | mime Subtype | 'X-R3HTML' | LIKE MY_STRING | Protected |
| MIMETYPE | Constant | MIME Type | 'Application' | LIKE MY_STRING | Protected |
| M_DP | Instance Attribute | Handle for the Data Provider | LIKE CNTL_HANDLE | Protected | |
| M_FCODE | Instance Attribute | Function Code | LIKE UI_FUNC | Private | |
| M_ID_FUNCTION_SELECTED | Constant | Event ID | 1 | LIKE I | Public |
| M_RESULT | Instance Attribute | Result | 0 | LIKE I | Public |
| TRUE | Constant | boolean like value 'TRUE' to handle properties of Control | 1 | LIKE I | Public |
Events of Class CL_GUI_HTML_EDITOR
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... FUNCTION_SELECTED - Is fired when a button or a menu item was selectedCL_GUI_HTML_EDITOR types
MY_STRING - MY_STRINGLinks 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