SAP CL_GUI_VIEWER_CONTROL OO Class - SAP 3D VE Viewer Integration in SAP GUI
CL_GUI_VIEWER_CONTROL 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_VIEWER_CONTROL 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_VIEWER_CONTROL is CL_GUI_CONTROLMethod list of CL_GUI_VIEWER_CONTROL 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 |
| ACTIVATE_MODEL_VIEW | Activate model view in VE Viewer | Public |
| CALL METHOD cl_gui_viewer_control=>ACTIVATE_MODEL_VIEW...more details | ||
| ADD_ITEMS | add additional items | Public |
| CALL METHOD cl_gui_viewer_control=>ADD_ITEMS...more details | ||
| CONSTRUCTOR | Constructor | Public |
| CALL METHOD cl_gui_viewer_control=>CONSTRUCTOR...more details | ||
| DESERIALIZE_ACTION_R | Deserialize Action request information | Private |
| CALL METHOD cl_gui_viewer_control=>DESERIALIZE_ACTION_R...more details | ||
| DESERIALIZE_METADATA_R | Deserialize metadata information | Private |
| CALL METHOD cl_gui_viewer_control=>DESERIALIZE_METADATA_R...more details | ||
| DESERIALIZE_MODEL_VIEW_DETAILS | Deserialize Model View Properties | Private |
| CALL METHOD cl_gui_viewer_control=>DESERIALIZE_MODEL_VIEW_DETAILS...more details | ||
|
| ||
| DESERIALIZE_PMI_METADATA | Deserialize PMI Metadata information | Private |
| CALL METHOD cl_gui_viewer_control=>DESERIALIZE_PMI_METADATA...more details | ||
| DESERIALIZE_SAP_ERROR | Deserialize sap_error event | Private |
| CALL METHOD cl_gui_viewer_control=>DESERIALIZE_SAP_ERROR...more details | ||
| DESERIALIZE_SAP_HIERARCHY | Deserialize SAP_HIERARCHY Event | Private |
| CALL METHOD cl_gui_viewer_control=>DESERIALIZE_SAP_HIERARCHY...more details | ||
| DESERIALIZE_SAVED_LAYER_R | Deserialize save layers information | Private |
| CALL METHOD cl_gui_viewer_control=>DESERIALIZE_SAVED_LAYER_R...more details | ||
| DESERIALIZE_SCREENSHOT | Deserialize PMI Metadata information | Private |
| CALL METHOD cl_gui_viewer_control=>DESERIALIZE_SCREENSHOT...more details | ||
| DESERIALIZE_STEP_PROPERTIES_R | Deserialize Step poperties information | Private |
| CALL METHOD cl_gui_viewer_control=>DESERIALIZE_STEP_PROPERTIES_R...more details | ||
| DESERIALIZE_VISUALIZATION_R | Deserialize Visualization information | Private |
| CALL METHOD cl_gui_viewer_control=>DESERIALIZE_VISUALIZATION_R...more details | ||
| DESERIALIZE_VISUAL_INDEX_R | Deserialize Visual Index information | Private |
| CALL METHOD cl_gui_viewer_control=>DESERIALIZE_VISUAL_INDEX_R...more details | ||
| GET_MODEL_VIEW_PROPERTIES | Get Model View Properties of Viewable file | Public |
| CALL METHOD cl_gui_viewer_control=>GET_MODEL_VIEW_PROPERTIES...more details | ||
| GET_SAP_HIERARCHY | Method to get sap hierachy | Public |
| CALL METHOD cl_gui_viewer_control=>GET_SAP_HIERARCHY...more details | ||
| GET_SCREENSHOT | Get Screeshot | Public |
| CALL METHOD cl_gui_viewer_control=>GET_SCREENSHOT...more details | ||
| HANDL_VWR_EVENTS | Process on received information by event id | Private |
| CALL METHOD cl_gui_viewer_control=>HANDL_VWR_EVENTS...more details | ||
| LOAD_ASSEMBLY | Load assembly in SAP VE Viewer | Public |
| CALL METHOD cl_gui_viewer_control=>LOAD_ASSEMBLY...more details | ||
| LOAD_VIEWER | Load single into SAP VE Viewer | Public |
| CALL METHOD cl_gui_viewer_control=>LOAD_VIEWER...more details | ||
| PAINT_PARTS | Paint parts in viewable | Public |
| CALL METHOD cl_gui_viewer_control=>PAINT_PARTS...more details | ||
| PREPARE_METADATA_REQUEST | Method will process on received Visualization XML | Private |
| CALL METHOD cl_gui_viewer_control=>PREPARE_METADATA_REQUEST...more details | ||
| REGISTER_VWR_EVENTS | Register VE Viewer events in control framework | Private |
| CALL METHOD cl_gui_viewer_control=>REGISTER_VWR_EVENTS...more details | ||
| REMOVE_PART | Remove item from viewable file | Public |
| CALL METHOD cl_gui_viewer_control=>REMOVE_PART...more details | ||
| REQUEST_METADATA | Request for metadata to SAP VE viewer | Public |
| CALL METHOD cl_gui_viewer_control=>REQUEST_METADATA...more details | ||
| REQUEST_PMI_METADATA | Request PMI Metadata from VE Viewer | Public |
| CALL METHOD cl_gui_viewer_control=>REQUEST_PMI_METADATA...more details | ||
| REQUEST_STEP_PROPERTIES | Reuqest for steps and properties of viewable files | Public |
| CALL METHOD cl_gui_viewer_control=>REQUEST_STEP_PROPERTIES...more details | ||
| SAP_EXECUTE_QUERY | Method to execute query | Public |
| CALL METHOD cl_gui_viewer_control=>SAP_EXECUTE_QUERY...more details | ||
| SAVE_LAYERS | Save Layer or conversation information | Public |
| CALL METHOD cl_gui_viewer_control=>SAVE_LAYERS...more details | ||
| SERIALIZE_ACTIVATE_MODEL_VIEW | Construct xString-XML for activating model views | Private |
| CALL METHOD cl_gui_viewer_control=>SERIALIZE_ACTIVATE_MODEL_VIEW...more details | ||
| SERIALIZE_ADDITIONAL_ACTIONS | Construct xString-XML for Actions in Viewer | Private |
| CALL METHOD cl_gui_viewer_control=>SERIALIZE_ADDITIONAL_ACTIONS...more details | ||
| SERIALIZE_ADD_ITEMS | Construct xString-XML for Add item | Private |
| CALL METHOD cl_gui_viewer_control=>SERIALIZE_ADD_ITEMS...more details | ||
| SERIALIZE_ASSEMBLY_VIEW | Construct xString-XML for assembly view | Private |
| CALL METHOD cl_gui_viewer_control=>SERIALIZE_ASSEMBLY_VIEW...more details | ||
| SERIALIZE_CONTROL_PARAMS | Construct xString-XML for control params | Private |
| CALL METHOD cl_gui_viewer_control=>SERIALIZE_CONTROL_PARAMS...more details | ||
| SERIALIZE_EXCLUDE_ACTIONS | Construct xString-XML for excluded Viewer actions | Private |
| CALL METHOD cl_gui_viewer_control=>SERIALIZE_EXCLUDE_ACTIONS...more details | ||
| SERIALIZE_EXECUTE_QUERY | Construct xString-XML for Execute Query | Private |
| CALL METHOD cl_gui_viewer_control=>SERIALIZE_EXECUTE_QUERY...more details | ||
| SERIALIZE_HIDE_HIGHTLIGHT | Construct xString-XML for hide hightlight | Private |
| CALL METHOD cl_gui_viewer_control=>SERIALIZE_HIDE_HIGHTLIGHT...more details | ||
| SERIALIZE_LAYERS | Construct xString-XML to display layer of RH file | Private |
| CALL METHOD cl_gui_viewer_control=>SERIALIZE_LAYERS...more details | ||
| SERIALIZE_LOAD_INPUT | Construct xString-XML to display RH files | Private |
| CALL METHOD cl_gui_viewer_control=>SERIALIZE_LOAD_INPUT...more details | ||
| SERIALIZE_METADATA | Construct xString-XML for set metadata | Private |
| CALL METHOD cl_gui_viewer_control=>SERIALIZE_METADATA...more details | ||
| SERIALIZE_METADATA_REQUEST | Construct xString-XML for Metadata request | Private |
| CALL METHOD cl_gui_viewer_control=>SERIALIZE_METADATA_REQUEST...more details | ||
| SERIALIZE_PAINTING | Construct xString-XML for paint method | Private |
| CALL METHOD cl_gui_viewer_control=>SERIALIZE_PAINTING...more details | ||
| SERIALIZE_PMI_METADATA_REQUEST | Construct xString-XML for PMI Metadata request | Private |
| CALL METHOD cl_gui_viewer_control=>SERIALIZE_PMI_METADATA_REQUEST...more details | ||
| SERIALIZE_REMOVE_ITEM | Construct xString-XML for remove item | Private |
| CALL METHOD cl_gui_viewer_control=>SERIALIZE_REMOVE_ITEM...more details | ||
| SERIALIZE_SET_ZOOM | Construct xString-XML for set zoom method | Private |
| CALL METHOD cl_gui_viewer_control=>SERIALIZE_SET_ZOOM...more details | ||
| SERIALIZE_VISUALIZATION | Construct xString-XML for visualization info | Private |
| CALL METHOD cl_gui_viewer_control=>SERIALIZE_VISUALIZATION...more details | ||
| SET_DYNAMIC_LABEL | Setting Dynamic label | Public |
| CALL METHOD cl_gui_viewer_control=>SET_DYNAMIC_LABEL...more details | ||
| SET_METADATA | Set metadata in viewable file | Public |
| CALL METHOD cl_gui_viewer_control=>SET_METADATA...more details | ||
| SET_TOOLTIP | Set tooltip | Public |
| CALL METHOD cl_gui_viewer_control=>SET_TOOLTIP...more details | ||
| SET_VISUALIZATION | Visualized a part in viewable file | Public |
| CALL METHOD cl_gui_viewer_control=>SET_VISUALIZATION...more details | ||
| SET_ZOOM | Zoom particular part in viewble | Public |
| CALL METHOD cl_gui_viewer_control=>SET_ZOOM...more details | ||
CL_GUI_VIEWER_CONTROL 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 |
| GC_ERROR_MESSAGE | Constant | Message Type | 'E' | LIKE MSGTY | Public |
| GC_MESSAGEID | Constant | Message identification | 'VEVWR_MSG' | LIKE MSGID | Private |
| GC_SAP_ACTION | Constant | Eventid of viewer event SAP_Action | 1 | LIKE I | Public |
| GC_SAP_DEFECT_LOCATION | Constant | Eventid of viewer event SAP_Defect_Location | 9 | LIKE I | Public |
| GC_SAP_ERROR | Constant | Eventid of viewer event SAP_Error | 3 | LIKE I | Public |
| GC_SAP_GET_HIERARCHY | Constant | Eventid of viewer event SAP_HIERARCHY | 20 | LIKE I | Public |
| GC_SAP_GET_SCREENSHOT | Constant | Eventid of viewer event SAP_GET_SCREENSHOT | 16 | LIKE I | Public |
| GC_SAP_LOAD_DONE | Constant | Eventid of viewer event SAP_Load_Done | 2 | LIKE I | Public |
| GC_SAP_METADATA | Constant | Eventid of viewer event SAP_Metadata | 6 | LIKE I | Public |
| GC_SAP_MODEL_VIEW_PROPERTIES | Constant | Event of Viewer event SAP_GET_MODEL_VIEW_PROERTIES | 14 | LIKE I | Public |
| GC_SAP_PMI_METADATA | Constant | Eventid of viewer event SAP_PMI_METADATA | 15 | LIKE I | Public |
| GC_SAP_REMOVE_DONE | Constant | Eventid of viewer event SAP_Reomve_Done | 8 | LIKE I | Public |
| GC_SAP_SAVE_LAYER_DONE | Constant | Eventid of viewer event SAP_Save_Layer_Done | 4 | LIKE I | Public |
| GC_SAP_SET_LAYER_CHANGE | Constant | Eventid of viewer event SAP_Set_Layer_Change | 5 | LIKE I | Public |
| GC_SAP_STEP_PROCEDURE | Constant | Eventid of viewer event SAP_Step_Procedure | 13 | LIKE I | Public |
| GC_SAP_VISUALIZATION | Constant | Eventid of viewer event SAP_Visualization | 7 | LIKE I | Public |
| GC_SAP_VISUAL_INDEX | Constant | Eventid of viewer event SAP_Visual_Index | 10 | LIKE I | Public |
| GC_SAP_VISUAL_INDEX_SETS | Constant | Eventid of viewer event SAP_Visual_Index_Sets | 11 | LIKE I | Public |
| GC_SUCCESS_MSGTY | Constant | Message Type | 'S' | LIKE MSGTY | Public |
| GC_WARNING_MSGTY | Constant | Message Type | 'W' | LIKE MSGTY | Public |
| MO_GUI_VIEWER_MODEL | Instance Attribute | Control Model interface for VE Viewer integration in SAP GUI | LIKE IF_GUI_VIEWER_CONTROL_MODEL | Private | |
| MT_EVENT_PROPERTY | Instance Attribute | Viewer event property name and event name table | LIKE VEVWR_EVENT_T_PROPERTY | Public | |
| MT_METADATA_REQUEST | Instance Attribute | Table type of structure VEVWR_S_VISUALIZATION | LIKE VEVWR_T_VISUALIZATION | Private | |
| MV_ID_FIELD | Instance Attribute | ID Field in the Viewer | LIKE /PLMU/VWR_ID_FIELD | Private | |
| MV_MESSAGE | Instance Attribute | Message received from viewer event SAP_Error | LIKE STRING | Private | |
| MV_OBJECT_ID | Instance Attribute | object id received from VE Viewer | LIKE STRING | Private | |
| MV_VISUALIZATION | Instance Attribute | Visualization event requested | LIKE BOOL | Private | |
| MV_VISUALIZATION_STATUS | Instance Attribute | Visualization status | LIKE BOOL | Private | |
| MV_VISUAL_INDEX | Instance Attribute | Visual Index event requested | LIKE BOOL | Private | |
| MV_VISUAL_INDEX_R | Instance Attribute | Visualization data received from SAP_VISUAL_INDEX event | LIKE STRING | Private |
Links to Related Class(s)
CL_GUI_V...Full list of available SAP object classes
Search for further information about these or an SAP related objects