SAP ABAP Class CL_GUI_HTML_EDITOR (HTML Editor)
Hierarchy
☛ SAP_BASIS (Software Component) SAP Basis Component
   ⤷ BC-FES-CTL (Application Component) SAP GUI for Windows Controls
     ⤷ SAPHTMLEDITOR (Package) Development Class for HTML Editor
Meta Relationship - Using
# Relationship type Using Short Description Created on
1 Inheritance (c INHERITING FROM c_ref)  CL_GUI_CONTROL Proxy Class for Control in GUI 19990205
Properties
Class CL_GUI_HTML_EDITOR  
Short Description HTML Editor    
Super Class CL_GUI_CONTROL Proxy Class for Control in GUI 
Instantiability of a Class 2  Public 
Final    
General Data
Message Class    
Program status     
Category 0   
Package SAPHTMLEDITOR   Development Class for HTML Editor 
Created 19990205   SAP 
Last change 00000000   SAP 
Shared Memory-enabled    
Fixed point arithmetic    
Unicode checks active    
Forward declarations
# Type group / Object type Type Type Description
1 CNDP Type group use (TYPE-POOLS tp)  Type group use (TYPE-POOLS tp)
2 CNHE Type group use (TYPE-POOLS tp)  Type group use (TYPE-POOLS tp)
3 CNTB Type group use (TYPE-POOLS tp)  Type group use (TYPE-POOLS tp)
4 CNTL Type group use (TYPE-POOLS tp)  Type group use (TYPE-POOLS tp)
5 SFES Type group use (TYPE-POOLS tp)  Type group use (TYPE-POOLS tp)
Interfaces
Class CL_GUI_HTML_EDITOR has no interface implemented.
Friends
Class CL_GUI_HTML_EDITOR has no friend class.
Attributes
# Attribute Level Visibility Read only Typing Associated Type Initial Value Description Created on
1 FALSE Constant Public Type reference (TYPE) I 0 boolean like value 'FALSE' to handle properties of control 19990205
2 MIMESUBTYPE Constant Protected Type reference (TYPE) MY_STRING 'X-R3HTML' mime Subtype 19990205
3 MIMETYPE Constant Protected Type reference (TYPE) MY_STRING 'Application' MIME Type 19990205
4 M_DP Instance attribute Protected Type reference (TYPE) CNTL_HANDLE Handle for the Data Provider 19990526
5 M_FCODE Instance attribute Private Type reference (TYPE) UI_FUNC Function Code 19990608
6 M_ID_FUNCTION_SELECTED Constant Public Type reference (TYPE) I 1 Event ID 19990608
7 M_RESULT Instance attribute Public Type reference (TYPE) I 0 Result 19990608
8 TRUE Constant Public Type reference (TYPE) I 1 boolean like value 'TRUE' to handle properties of Control 19990205
Methods
# Method Level Visibility Method type Description Created on
1 CONSTRUCTOR Instance method Public Constructor Creates and Links the HTML Editor Control 19990205
2 INSERT_HTML Instance method Public Method insert HTML text into the document 19990608
3 SET_HTML_AS_STREAM Instance method Public Method Send HTML as stream to control (incl. " " and " ") 19990205
4 SET_SELECTED_HTML_AS_STREAM Instance method Public Method Replace Selected HTML with Stream 19990205
5 SET_TOOLBAR_XML Instance method Public Method Loads the Toolbar XML File 20000614
6 SET_URL Instance method Public Method Loads a Document by URL 20000614
Events
# Event Type Visibility Description Created on
1 FUNCTION_SELECTED Instance Event
(0) 		Public
(2) 		Is fired when a button or a menu item was selected 19990608
Types
# Type Visibility Typing Associated Type Description Created on Type Source
1 MY_STRING Protected See coding MY_STRING 19990205
Method Signatures

Method CONSTRUCTOR Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing LIFETIME Value transfer Type reference (TYPE) I for lifetime management 19990205
2 Importing PARENT Value transfer Object reference (TYPE REF TO) CL_GUI_CONTAINER Parent Container 19990205
3 Importing SHELLSTYLE Value transfer Type reference (TYPE) I shell style 19990526
4 Importing TOOLBARXML Value transfer Type reference (TYPE) STRING XML Datei Url 20000614
5 Importing USER_ACTIONS Value transfer Type reference (TYPE) CNHE_ITAB_ACTIONS user defined actions 19990608
6 Importing USER_TOOLBAR Value transfer Type reference (TYPE) TTB_BUTTON table for configuration of the user toolbar 19990608
# Exception Resumable Description Created on
1 CNTL_ERROR Error while performing creation of HTMLEdit control! 19990526
2 CNTL_INSTALL_ERROR Error while initializing HTMLEdit control! 19990526
3 DP_ERROR Error in calling a Data Provider method 19990608

Method INSERT_HTML Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing HTML_TEXT Call by reference Type reference (TYPE) CNHE_HTML_TEXT HTML source 19990608
# Exception Resumable Description Created on
1 CNTL_ERROR error in call_method of CFW 19990608

Method SET_HTML_AS_STREAM Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing HTML Call by reference Type reference (TYPE) TABLE text as stream with carriage returns and linefeeds 19990205
# Exception Resumable Description Created on
1 ERROR_DP Error while sending data via the DataProvider! 19990205
2 ERROR_DP_CREATE Error while creating DataProvider Object 19990205

Method SET_SELECTED_HTML_AS_STREAM Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing SELECTED_HTML Call by reference Type reference (TYPE) TABLE text as stream to replace selection 19990205
# Exception Resumable Description Created on
1 ERROR_CNTL_BROWSE_MODE Error while control in browse mode ! 19990205
2 ERROR_DP Error while sending HTML via the DataProvider! 19990205
3 ERROR_DP_CREATE Error while creating DataProvider! 19990205

Method SET_TOOLBAR_XML Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing URL Call by reference Type reference (TYPE) STRING Url einer Dokument 20000614
# Exception Resumable Description Created on
1 CNTL_ERROR CFW Fehler 20000614

Method SET_URL Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing URL Call by reference Type reference (TYPE) STRING Url einer Dokument 20000614
# Exception Resumable Description Created on
1 CNTL_ERROR CFW Fehler 20000614
Event Signatures

Event FUNCTION_SELECTED Signature
# Parameter Type Pass Value Optional Typing Method Associated Type Default value Description Created on
1 FCODE Exporting Value transfer Type reference (TYPE) UI_FUNC FCode 19990608
History
Last changed by/on SAP  00000000 
SAP Release Created in