SAP CL_GUI_DOCUMENTS OO Class - Documents
CL_GUI_DOCUMENTS 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_DOCUMENTS 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_DOCUMENTS is CL_ALINK_CONSTANTSMethod list of CL_GUI_DOCUMENTS 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 |
CHECK_AND_SET_GOS | Check GOS and Activate if Necessary | Private |
CALL METHOD cl_gui_documents=>CHECK_AND_SET_GOS...more details | ||
CHECK_AND_SET_MARK | Check whether document to be displayed is selected | Private |
CALL METHOD cl_gui_documents=>CHECK_AND_SET_MARK...more details | ||
CHECK_EXITS | Check whether exits are activated | Private |
CALL METHOD cl_gui_documents=>CHECK_EXITS...more details | ||
CHECK_IF_EAI_SHOULD_BE_CALLED | Check whether ECL is called | Private |
CALL METHOD cl_gui_documents=>CHECK_IF_EAI_SHOULD_BE_CALLED...more details | ||
CHECK_KIND_OF_BROWSER | Private | |
CALL METHOD cl_gui_documents=>CHECK_KIND_OF_BROWSER...more details | ||
CLOSE_GOS | Close GOS Container | Private |
CALL METHOD cl_gui_documents=>CLOSE_GOS...more details | ||
| ||
CONSTRUCTOR | Constructor | Public |
CALL METHOD cl_gui_documents=>CONSTRUCTOR...more details | ||
CREATE_ECL | Private | |
CALL METHOD cl_gui_documents=>CREATE_ECL...more details | ||
DISPLAY_VIA_HTML_CONTROL | Display Using HTML Control | Private |
CALL METHOD cl_gui_documents=>DISPLAY_VIA_HTML_CONTROL...more details | ||
ELIMINATE_NOT_DISPLAYABLE | Private | |
CALL METHOD cl_gui_documents=>ELIMINATE_NOT_DISPLAYABLE...more details | ||
FIND_CONTREPTYPE | Private | |
CALL METHOD cl_gui_documents=>FIND_CONTREPTYPE...more details | ||
FIND_STANDARD_DISPLAY_COMMTYPE | Determining Standard Display Communication Method | Private |
CALL METHOD cl_gui_documents=>FIND_STANDARD_DISPLAY_COMMTYPE...more details | ||
GET_AND_ANALYSE_COMPONENTS | Determining and Analyzing Components | Private |
CALL METHOD cl_gui_documents=>GET_AND_ANALYSE_COMPONENTS...more details | ||
GET_DISPLAY_COMMUNICATION_TYPE | Determining the Communication Type | Private |
CALL METHOD cl_gui_documents=>GET_DISPLAY_COMMUNICATION_TYPE...more details | ||
GET_DOCUMENT_CLASS | Determining the Document Class | Private |
CALL METHOD cl_gui_documents=>GET_DOCUMENT_CLASS...more details | ||
INIT_VIEWING_CONTROL | Private | |
CALL METHOD cl_gui_documents=>INIT_VIEWING_CONTROL...more details | ||
INSERT_LAST_DOCUMENTS | Note the Displayed Document | Private |
CALL METHOD cl_gui_documents=>INSERT_LAST_DOCUMENTS...more details | ||
OPEN_DOCUMENT | Opens a Document | Public |
CALL METHOD cl_gui_documents=>OPEN_DOCUMENT...more details | ||
RESET_GLOBAL_VARIABLES | Setting Global Variables | Private |
CALL METHOD cl_gui_documents=>RESET_GLOBAL_VARIABLES...more details | ||
SET_GOS | Setting GOS Control | Private |
CALL METHOD cl_gui_documents=>SET_GOS...more details | ||
SET_PARAMETERS | Setting Set/Get Parameters | Private |
CALL METHOD cl_gui_documents=>SET_PARAMETERS...more details | ||
SINGLE_OR_MULTIPLE_DOCUMENT | Display one or more documents? | Private |
CALL METHOD cl_gui_documents=>SINGLE_OR_MULTIPLE_DOCUMENT...more details |
CL_GUI_DOCUMENTS 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 |
ANNO_COMPONENTS | Instance Attribute | Components of Stored Documents | LIKE AL_COMPONENTS | Private | |
COMMUNICATION_TYPE | Instance Attribute | Communication type | LIKE P | Private | |
COMPONENT_OBJECTS | Instance Attribute | Document Component Object List | LIKE DOC_COMPS | Private | |
CONTENTCONTAINER | Instance Attribute | Abstract Container for GUI Controls | LIKE CL_GUI_CONTAINER | Private | |
CONTREP_TYPE | Instance Attribute | Type of Content Repository | LIKE P | Private | |
DISPDOCS | Instance Attribute | Structure for Displaying Documents | LIKE TAB_TOADI | Private | |
DISPLAYED_DOCUMENTS | Instance Attribute | Displayed Documents | LIKE DISP_DOCUMENTS | Private | |
DOCICONCONTAINER | Instance Attribute | Abstract Container for GUI Controls | LIKE CL_GUI_CONTAINER | Private | |
DOCUMENT_COUNT | Instance Attribute | Number of Displayed Documents | LIKE I | Private | |
DOCUMENT_NR | Instance Attribute | Current Document Number | LIKE SAEINFO | Public | |
ECLCONTROL_ACTIVE | Instance Attribute | LIKE | Private | ||
ECL_CONTROL | Instance Attribute | Engineering Client 2D Viewer | LIKE CL_GUI_ECL_2DVIEWER | Private | |
GOSCONTAINER | Instance Attribute | Abstract Container for GUI Controls | LIKE CL_GUI_CONTAINER | Private | |
GOS_ACTIVE | Instance Attribute | LIKE | Private | ||
GO_GOS_TOOLBOX | Instance Attribute | Publication for Generic Object Services | LIKE CL_GOS_MANAGER | Private | |
G_ARCHIV_DOC_ID | Instance Attribute | SAP ArchiveLink: Document ID | LIKE SAPB-SAPADOKID | Public | |
G_ARCHIV_ID | Instance Attribute | Content Repository Identification | LIKE TOAAR-ARCHIV_ID | Public | |
G_DOCUMENT_CLASS | Instance Attribute | SAP ArchiveLink: Object type of business object | LIKE TOAOM-SAP_OBJECT | Public | |
G_DP_URI | Instance Attribute | URL for a Document Component | LIKE C | Private | |
G_GUID | Instance Attribute | GUID in 'CHAR' format with upper-/lowercase (!) | LIKE GUID_22 | Private | |
G_LANGUAGE | Instance Attribute | SAP System, Current Language | LIKE SY-LANGU | Public | |
G_OBJECT_ID | Instance Attribute | SAP ArchiveLink: Object ID (Object Identifier) | LIKE TOAV0-OBJECT_ID | Public | |
G_OBJECT_TYPE | Instance Attribute | SAP ArchiveLink: Object type of business object | LIKE TOAV0-SAP_OBJECT | Public | |
G_WINDOW_ID | Instance Attribute | Window_ID (of known display window) | LIKE SAPB-SAPWINID | Public | |
G_WINDOW_TITLE | Instance Attribute | SAP ArchiveLink Window_Title (title of window) | LIKE SAPB-SAPWINTITL | Public | |
HTMLCONTROL_ACTIVE | Instance Attribute | LIKE | Private | ||
HTML_CONTROL | Instance Attribute | HTML Control Proxy Class | LIKE CL_GUI_HTML_VIEWER | Private | |
ICONCONTAINER | Instance Attribute | Abstract Container for GUI Controls | LIKE CL_GUI_CONTAINER | Private | |
ICON_SPLITTER | Instance Attribute | Splitter Control | LIKE CL_GUI_SPLITTER_CONTAINER | Private | |
NOTE_EXIST | Instance Attribute | LIKE | Private | ||
NOTE_FUNCTION | Instance Attribute | LIKE | Private | ||
PAGE_COMPONENTS | Instance Attribute | Components of Stored Documents | LIKE AL_COMPONENTS | Private | |
TOBEMARKED | Instance Attribute | LIKE | Private | ||
WHOLECONTAINER | Instance Attribute | Abstract Container for GUI Controls | LIKE CL_GUI_CONTAINER | Private |
Links to Related Class(s)
CL_GUI_D...Full list of available SAP object classes
Search for further information about these or an SAP related objects