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_CONSTANTS

Method 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 NameDescriptionVisability
CHECK_AND_SET_GOSCheck GOS and Activate if NecessaryPrivate
CALL METHOD cl_gui_documents=>CHECK_AND_SET_GOS...more details

CHECK_AND_SET_MARKCheck whether document to be displayed is selectedPrivate
CALL METHOD cl_gui_documents=>CHECK_AND_SET_MARK...more details

CHECK_EXITSCheck whether exits are activatedPrivate
CALL METHOD cl_gui_documents=>CHECK_EXITS...more details

CHECK_IF_EAI_SHOULD_BE_CALLEDCheck whether ECL is calledPrivate
CALL METHOD cl_gui_documents=>CHECK_IF_EAI_SHOULD_BE_CALLED...more details

CHECK_KIND_OF_BROWSERPrivate
CALL METHOD cl_gui_documents=>CHECK_KIND_OF_BROWSER...more details

CLOSE_GOSClose GOS ContainerPrivate
CALL METHOD cl_gui_documents=>CLOSE_GOS...more details

CONSTRUCTORConstructorPublic
CALL METHOD cl_gui_documents=>CONSTRUCTOR...more details

CREATE_ECLPrivate
CALL METHOD cl_gui_documents=>CREATE_ECL...more details

DISPLAY_VIA_HTML_CONTROLDisplay Using HTML ControlPrivate
CALL METHOD cl_gui_documents=>DISPLAY_VIA_HTML_CONTROL...more details

ELIMINATE_NOT_DISPLAYABLEPrivate
CALL METHOD cl_gui_documents=>ELIMINATE_NOT_DISPLAYABLE...more details

FIND_CONTREPTYPEPrivate
CALL METHOD cl_gui_documents=>FIND_CONTREPTYPE...more details

FIND_STANDARD_DISPLAY_COMMTYPEDetermining Standard Display Communication MethodPrivate
CALL METHOD cl_gui_documents=>FIND_STANDARD_DISPLAY_COMMTYPE...more details

GET_AND_ANALYSE_COMPONENTSDetermining and Analyzing ComponentsPrivate
CALL METHOD cl_gui_documents=>GET_AND_ANALYSE_COMPONENTS...more details

GET_DISPLAY_COMMUNICATION_TYPEDetermining the Communication TypePrivate
CALL METHOD cl_gui_documents=>GET_DISPLAY_COMMUNICATION_TYPE...more details

GET_DOCUMENT_CLASSDetermining the Document ClassPrivate
CALL METHOD cl_gui_documents=>GET_DOCUMENT_CLASS...more details

INIT_VIEWING_CONTROLPrivate
CALL METHOD cl_gui_documents=>INIT_VIEWING_CONTROL...more details

INSERT_LAST_DOCUMENTSNote the Displayed DocumentPrivate
CALL METHOD cl_gui_documents=>INSERT_LAST_DOCUMENTS...more details

OPEN_DOCUMENTOpens a DocumentPublic
CALL METHOD cl_gui_documents=>OPEN_DOCUMENT...more details

RESET_GLOBAL_VARIABLESSetting Global VariablesPrivate
CALL METHOD cl_gui_documents=>RESET_GLOBAL_VARIABLES...more details

SET_GOSSetting GOS ControlPrivate
CALL METHOD cl_gui_documents=>SET_GOS...more details

SET_PARAMETERSSetting Set/Get ParametersPrivate
CALL METHOD cl_gui_documents=>SET_PARAMETERS...more details

SINGLE_OR_MULTIPLE_DOCUMENTDisplay 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.

NameLevelDescriptionInitial ValueTypeVisability
ANNO_COMPONENTSInstance AttributeComponents of Stored DocumentsLIKE
AL_COMPONENTS
Private
COMMUNICATION_TYPEInstance AttributeCommunication typeLIKE
P
Private
COMPONENT_OBJECTSInstance AttributeDocument Component Object ListLIKE
DOC_COMPS
Private
CONTENTCONTAINERInstance AttributeAbstract Container for GUI ControlsLIKE
CL_GUI_CONTAINER
Private
CONTREP_TYPEInstance AttributeType of Content RepositoryLIKE
P
Private
DISPDOCSInstance AttributeStructure for Displaying DocumentsLIKE
TAB_TOADI
Private
DISPLAYED_DOCUMENTSInstance AttributeDisplayed DocumentsLIKE
DISP_DOCUMENTS
Private
DOCICONCONTAINERInstance AttributeAbstract Container for GUI ControlsLIKE
CL_GUI_CONTAINER
Private
DOCUMENT_COUNTInstance AttributeNumber of Displayed DocumentsLIKE
I
Private
DOCUMENT_NRInstance AttributeCurrent Document NumberLIKE
SAEINFO
Public
ECLCONTROL_ACTIVEInstance AttributeLIKE
Private
ECL_CONTROLInstance AttributeEngineering Client 2D ViewerLIKE
CL_GUI_ECL_2DVIEWER
Private
GOSCONTAINERInstance AttributeAbstract Container for GUI ControlsLIKE
CL_GUI_CONTAINER
Private
GOS_ACTIVEInstance AttributeLIKE
Private
GO_GOS_TOOLBOXInstance AttributePublication for Generic Object ServicesLIKE
CL_GOS_MANAGER
Private
G_ARCHIV_DOC_IDInstance AttributeSAP ArchiveLink: Document IDLIKE
SAPB-SAPADOKID
Public
G_ARCHIV_IDInstance AttributeContent Repository IdentificationLIKE
TOAAR-ARCHIV_ID
Public
G_DOCUMENT_CLASSInstance AttributeSAP ArchiveLink: Object type of business objectLIKE
TOAOM-SAP_OBJECT
Public
G_DP_URIInstance AttributeURL for a Document ComponentLIKE
C
Private
G_GUIDInstance AttributeGUID in 'CHAR' format with upper-/lowercase (!)LIKE
GUID_22
Private
G_LANGUAGEInstance AttributeSAP System, Current LanguageLIKE
SY-LANGU
Public
G_OBJECT_IDInstance AttributeSAP ArchiveLink: Object ID (Object Identifier)LIKE
TOAV0-OBJECT_ID
Public
G_OBJECT_TYPEInstance AttributeSAP ArchiveLink: Object type of business objectLIKE
TOAV0-SAP_OBJECT
Public
G_WINDOW_IDInstance AttributeWindow_ID (of known display window)LIKE
SAPB-SAPWINID
Public
G_WINDOW_TITLEInstance AttributeSAP ArchiveLink Window_Title (title of window)LIKE
SAPB-SAPWINTITL
Public
HTMLCONTROL_ACTIVEInstance AttributeLIKE
Private
HTML_CONTROLInstance AttributeHTML Control Proxy ClassLIKE
CL_GUI_HTML_VIEWER
Private
ICONCONTAINERInstance AttributeAbstract Container for GUI ControlsLIKE
CL_GUI_CONTAINER
Private
ICON_SPLITTERInstance AttributeSplitter ControlLIKE
CL_GUI_SPLITTER_CONTAINER
Private
NOTE_EXISTInstance AttributeLIKE
Private
NOTE_FUNCTIONInstance AttributeLIKE
Private
PAGE_COMPONENTSInstance AttributeComponents of Stored DocumentsLIKE
AL_COMPONENTS
Private
TOBEMARKEDInstance AttributeLIKE
Private
WHOLECONTAINERInstance AttributeAbstract Container for GUI ControlsLIKE
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



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!