SAP CL_GUI_PDFVIEWER OO Class - PDF Viewer (Do Not Use!!)









CL_GUI_PDFVIEWER 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_PDFVIEWER 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_PDFVIEWER is CL_GUI_CONTROL

Method list of CL_GUI_PDFVIEWER 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
CLOSE_DOCUMENTCloses the DocumentPublic
CALL METHOD cl_gui_pdfviewer=>CLOSE_DOCUMENT...more details

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

COPY_TO_CLIPBOARDCopies the Selected Text to the BufferPublic
CALL METHOD cl_gui_pdfviewer=>COPY_TO_CLIPBOARD...more details

CREATE_ANNOTATIONGenerates Redlining CommentsPublic
CALL METHOD cl_gui_pdfviewer=>CREATE_ANNOTATION...more details

CREATE_BOOKMARKGenerates a BookmarkPublic
CALL METHOD cl_gui_pdfviewer=>CREATE_BOOKMARK...more details

CREATE_LINKGenerates a LinkPublic
CALL METHOD cl_gui_pdfviewer=>CREATE_LINK...more details

CREATE_THUMBNAILSGenerates ThumbnailsPublic
CALL METHOD cl_gui_pdfviewer=>CREATE_THUMBNAILS...more details

CREATE_TOOLBARGenerates a Toolbar for the PDF ViewerPublic
CALL METHOD cl_gui_pdfviewer=>CREATE_TOOLBAR...more details

CROP_PAGESCrop PagesPublic
CALL METHOD cl_gui_pdfviewer=>CROP_PAGES...more details

DELETE_BOOKMARKDeletes a BookmarkPublic
CALL METHOD cl_gui_pdfviewer=>DELETE_BOOKMARK...more details

DELETE_CURRENT_PAGEDeletes the Current PagePublic
CALL METHOD cl_gui_pdfviewer=>DELETE_CURRENT_PAGE...more details

DELETE_PAGESDeletes a number of pages from a documentPublic
CALL METHOD cl_gui_pdfviewer=>DELETE_PAGES...more details

DELETE_THUMBNAILSDeletes the thumbnailsPublic
CALL METHOD cl_gui_pdfviewer=>DELETE_THUMBNAILS...more details

FIND_TEXTSearches for a text pattern in a documentPublic
CALL METHOD cl_gui_pdfviewer=>FIND_TEXT...more details

FIRST_PAGEGoes to the first page of a documentPublic
CALL METHOD cl_gui_pdfviewer=>FIRST_PAGE...more details

GET_ANNOTATION_INFODisplays information on the annotationsPublic
CALL METHOD cl_gui_pdfviewer=>GET_ANNOTATION_INFO...more details

GET_CURRENT_PAGEReturns Information about the Current PagePublic
CALL METHOD cl_gui_pdfviewer=>GET_CURRENT_PAGE...more details

GET_NR_OF_PAGESGets the Number of Pages in the DocumentPublic
CALL METHOD cl_gui_pdfviewer=>GET_NR_OF_PAGES...more details

INSERT_PAGESInsert Pages from Another DocumentPublic
CALL METHOD cl_gui_pdfviewer=>INSERT_PAGES...more details

LAST_PAGEGoes to the Last Page of a DocumentPublic
CALL METHOD cl_gui_pdfviewer=>LAST_PAGE...more details

MARK_AREAAllows the User to Select an AreaPublic
CALL METHOD cl_gui_pdfviewer=>MARK_AREA...more details

MOVE_PAGEMoves a Page Within a DocumentPublic
CALL METHOD cl_gui_pdfviewer=>MOVE_PAGE...more details

NEXT_PAGEGoes to the Next Page in a DocumentPublic
CALL METHOD cl_gui_pdfviewer=>NEXT_PAGE...more details

OPEN_DOCUMENTLoads a URL in the PDF ViewerPublic
CALL METHOD cl_gui_pdfviewer=>OPEN_DOCUMENT...more details

PASS_EVENTInternal Use: Passed Events from the Event HandlerPublic
CALL METHOD cl_gui_pdfviewer=>PASS_EVENT...more details

PASTE_FROM_CLIPBOARDInsert from the BufferPublic
CALL METHOD cl_gui_pdfviewer=>PASTE_FROM_CLIPBOARD...more details

PREVIOUS_PAGEGoes to the Previous Page in a DocumentPublic
CALL METHOD cl_gui_pdfviewer=>PREVIOUS_PAGE...more details

PRINTPrint the Document Using a Dialog BoxPublic
CALL METHOD cl_gui_pdfviewer=>PRINT...more details

REDORedo Last StepPublic
CALL METHOD cl_gui_pdfviewer=>REDO...more details

REGISTER_TOOLBAR_EVENTSRegisters the Toolbar EventsPrivate
CALL METHOD cl_gui_pdfviewer=>REGISTER_TOOLBAR_EVENTS...more details

REPLACE_PAGESReplace PagesPublic
CALL METHOD cl_gui_pdfviewer=>REPLACE_PAGES...more details

ROTATE_CLOCKWISERotates the Document by 90 DegreesPublic
CALL METHOD cl_gui_pdfviewer=>ROTATE_CLOCKWISE...more details

SAVE_DOCUMENTSaves the PDF DocumentPublic
CALL METHOD cl_gui_pdfviewer=>SAVE_DOCUMENT...more details

SET_ACTIVE_TOOLActivates a Tool in the Acrobat Reader OLE ServerPublic
CALL METHOD cl_gui_pdfviewer=>SET_ACTIVE_TOOL...more details

SET_ANNOTATION_SETTINGSMakes the Settings for Redlining ObjectsPublic
CALL METHOD cl_gui_pdfviewer=>SET_ANNOTATION_SETTINGS...more details

SET_VIEW_MODESets the Display ModePublic
CALL METHOD cl_gui_pdfviewer=>SET_VIEW_MODE...more details

UNDOUndo Last StepPublic
CALL METHOD cl_gui_pdfviewer=>UNDO...more details

ZOOM_IN_OUTSets the Zoom FactorPublic
CALL METHOD cl_gui_pdfviewer=>ZOOM_IN_OUT...more details



CL_GUI_PDFVIEWER 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
ACROBAT_VS_READERInstance Attribute'X' = Acrobat, ' ' = ReaderLIKE
CHAR01
Public
ACTUAL_SEARCH_TEXTInstance AttributeCurrent Search TextLIKE
CHAR255
Public
AUTO_SPLIT_TOOLBARInstance AttributeSplit Toolbar Automatically'X'LIKE
CHAR01
Public
CURRENT_ZOOMInstance AttributeZoom Factor100LIKE
I
Public
HTML_VIEWERInstance AttributeIf Adobe Application Cannot Be FoundLIKE
CL_GUI_HTML_VIEWER
Public
TB_BUTTONS_TABLEInstance AttributeToolbar Buttons and MenusLIKE
TTB_BUTTON
Public
THIS_EVENT_HANDLERInstance AttributeLocal Event HandlerLIKE
LCL_EVENT_HANDLER
Private
THIS_SPLITTERInstance AttributeSplitter for Viewer and ToolbarLIKE
CL_GUI_SPLITTER_CONTAINER
Public
THIS_TOOLBARInstance AttributePDF Viewer ToolbarLIKE
CL_GUI_TOOLBAR
Public
TOOL_CROPConstantCropping Tool2LIKE
I
Public
TOOL_HANDConstantHand Tool1LIKE
I
Public
TOOL_LINKConstantLink Tool7LIKE
I
Public
TOOL_NOTEConstantNote Tool3LIKE
I
Public
TOOL_SELECTConstantSelect Tool4LIKE
I
Public
TOOL_SELECT_GRAPHICConstantSelect Graphic Tool5LIKE
I
Public
TOOL_THREADConstantArticle Tool8LIKE
I
Public
TOOL_ZOOMConstantZoom Tool6LIKE
I
Public
VERT_TOOLBARInstance AttributeToolbar in Right Splitter ContainerLIKE
CL_GUI_TOOLBAR
Public


Events of Class CL_GUI_PDFVIEWER

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... DOCUMENT_CLOSING - The Close button has been clicked
DOCUMENT_SAVED - The Save button has been clicked

Links to Related Class(s)

CL_GUI_P...
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!