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_CONTROLMethod 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 Name | Description | Visability |
CLOSE_DOCUMENT | Closes the Document | Public |
CALL METHOD cl_gui_pdfviewer=>CLOSE_DOCUMENT...more details | ||
CONSTRUCTOR | Constructor | Public |
CALL METHOD cl_gui_pdfviewer=>CONSTRUCTOR...more details | ||
COPY_TO_CLIPBOARD | Copies the Selected Text to the Buffer | Public |
CALL METHOD cl_gui_pdfviewer=>COPY_TO_CLIPBOARD...more details | ||
CREATE_ANNOTATION | Generates Redlining Comments | Public |
CALL METHOD cl_gui_pdfviewer=>CREATE_ANNOTATION...more details | ||
CREATE_BOOKMARK | Generates a Bookmark | Public |
CALL METHOD cl_gui_pdfviewer=>CREATE_BOOKMARK...more details | ||
CREATE_LINK | Generates a Link | Public |
CALL METHOD cl_gui_pdfviewer=>CREATE_LINK...more details | ||
| ||
CREATE_THUMBNAILS | Generates Thumbnails | Public |
CALL METHOD cl_gui_pdfviewer=>CREATE_THUMBNAILS...more details | ||
CREATE_TOOLBAR | Generates a Toolbar for the PDF Viewer | Public |
CALL METHOD cl_gui_pdfviewer=>CREATE_TOOLBAR...more details | ||
CROP_PAGES | Crop Pages | Public |
CALL METHOD cl_gui_pdfviewer=>CROP_PAGES...more details | ||
DELETE_BOOKMARK | Deletes a Bookmark | Public |
CALL METHOD cl_gui_pdfviewer=>DELETE_BOOKMARK...more details | ||
DELETE_CURRENT_PAGE | Deletes the Current Page | Public |
CALL METHOD cl_gui_pdfviewer=>DELETE_CURRENT_PAGE...more details | ||
DELETE_PAGES | Deletes a number of pages from a document | Public |
CALL METHOD cl_gui_pdfviewer=>DELETE_PAGES...more details | ||
DELETE_THUMBNAILS | Deletes the thumbnails | Public |
CALL METHOD cl_gui_pdfviewer=>DELETE_THUMBNAILS...more details | ||
FIND_TEXT | Searches for a text pattern in a document | Public |
CALL METHOD cl_gui_pdfviewer=>FIND_TEXT...more details | ||
FIRST_PAGE | Goes to the first page of a document | Public |
CALL METHOD cl_gui_pdfviewer=>FIRST_PAGE...more details | ||
GET_ANNOTATION_INFO | Displays information on the annotations | Public |
CALL METHOD cl_gui_pdfviewer=>GET_ANNOTATION_INFO...more details | ||
GET_CURRENT_PAGE | Returns Information about the Current Page | Public |
CALL METHOD cl_gui_pdfviewer=>GET_CURRENT_PAGE...more details | ||
GET_NR_OF_PAGES | Gets the Number of Pages in the Document | Public |
CALL METHOD cl_gui_pdfviewer=>GET_NR_OF_PAGES...more details | ||
INSERT_PAGES | Insert Pages from Another Document | Public |
CALL METHOD cl_gui_pdfviewer=>INSERT_PAGES...more details | ||
LAST_PAGE | Goes to the Last Page of a Document | Public |
CALL METHOD cl_gui_pdfviewer=>LAST_PAGE...more details | ||
MARK_AREA | Allows the User to Select an Area | Public |
CALL METHOD cl_gui_pdfviewer=>MARK_AREA...more details | ||
MOVE_PAGE | Moves a Page Within a Document | Public |
CALL METHOD cl_gui_pdfviewer=>MOVE_PAGE...more details | ||
NEXT_PAGE | Goes to the Next Page in a Document | Public |
CALL METHOD cl_gui_pdfviewer=>NEXT_PAGE...more details | ||
OPEN_DOCUMENT | Loads a URL in the PDF Viewer | Public |
CALL METHOD cl_gui_pdfviewer=>OPEN_DOCUMENT...more details | ||
PASS_EVENT | Internal Use: Passed Events from the Event Handler | Public |
CALL METHOD cl_gui_pdfviewer=>PASS_EVENT...more details | ||
PASTE_FROM_CLIPBOARD | Insert from the Buffer | Public |
CALL METHOD cl_gui_pdfviewer=>PASTE_FROM_CLIPBOARD...more details | ||
PREVIOUS_PAGE | Goes to the Previous Page in a Document | Public |
CALL METHOD cl_gui_pdfviewer=>PREVIOUS_PAGE...more details | ||
Print the Document Using a Dialog Box | Public | |
CALL METHOD cl_gui_pdfviewer=>PRINT...more details | ||
REDO | Redo Last Step | Public |
CALL METHOD cl_gui_pdfviewer=>REDO...more details | ||
REGISTER_TOOLBAR_EVENTS | Registers the Toolbar Events | Private |
CALL METHOD cl_gui_pdfviewer=>REGISTER_TOOLBAR_EVENTS...more details | ||
REPLACE_PAGES | Replace Pages | Public |
CALL METHOD cl_gui_pdfviewer=>REPLACE_PAGES...more details | ||
ROTATE_CLOCKWISE | Rotates the Document by 90 Degrees | Public |
CALL METHOD cl_gui_pdfviewer=>ROTATE_CLOCKWISE...more details | ||
SAVE_DOCUMENT | Saves the PDF Document | Public |
CALL METHOD cl_gui_pdfviewer=>SAVE_DOCUMENT...more details | ||
SET_ACTIVE_TOOL | Activates a Tool in the Acrobat Reader OLE Server | Public |
CALL METHOD cl_gui_pdfviewer=>SET_ACTIVE_TOOL...more details | ||
SET_ANNOTATION_SETTINGS | Makes the Settings for Redlining Objects | Public |
CALL METHOD cl_gui_pdfviewer=>SET_ANNOTATION_SETTINGS...more details | ||
SET_VIEW_MODE | Sets the Display Mode | Public |
CALL METHOD cl_gui_pdfviewer=>SET_VIEW_MODE...more details | ||
UNDO | Undo Last Step | Public |
CALL METHOD cl_gui_pdfviewer=>UNDO...more details | ||
ZOOM_IN_OUT | Sets the Zoom Factor | Public |
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.
Name | Level | Description | Initial Value | Type | Visability |
ACROBAT_VS_READER | Instance Attribute | 'X' = Acrobat, ' ' = Reader | LIKE CHAR01 | Public | |
ACTUAL_SEARCH_TEXT | Instance Attribute | Current Search Text | LIKE CHAR255 | Public | |
AUTO_SPLIT_TOOLBAR | Instance Attribute | Split Toolbar Automatically | 'X' | LIKE CHAR01 | Public |
CURRENT_ZOOM | Instance Attribute | Zoom Factor | 100 | LIKE I | Public |
HTML_VIEWER | Instance Attribute | If Adobe Application Cannot Be Found | LIKE CL_GUI_HTML_VIEWER | Public | |
TB_BUTTONS_TABLE | Instance Attribute | Toolbar Buttons and Menus | LIKE TTB_BUTTON | Public | |
THIS_EVENT_HANDLER | Instance Attribute | Local Event Handler | LIKE LCL_EVENT_HANDLER | Private | |
THIS_SPLITTER | Instance Attribute | Splitter for Viewer and Toolbar | LIKE CL_GUI_SPLITTER_CONTAINER | Public | |
THIS_TOOLBAR | Instance Attribute | PDF Viewer Toolbar | LIKE CL_GUI_TOOLBAR | Public | |
TOOL_CROP | Constant | Cropping Tool | 2 | LIKE I | Public |
TOOL_HAND | Constant | Hand Tool | 1 | LIKE I | Public |
TOOL_LINK | Constant | Link Tool | 7 | LIKE I | Public |
TOOL_NOTE | Constant | Note Tool | 3 | LIKE I | Public |
TOOL_SELECT | Constant | Select Tool | 4 | LIKE I | Public |
TOOL_SELECT_GRAPHIC | Constant | Select Graphic Tool | 5 | LIKE I | Public |
TOOL_THREAD | Constant | Article Tool | 8 | LIKE I | Public |
TOOL_ZOOM | Constant | Zoom Tool | 6 | LIKE I | Public |
VERT_TOOLBAR | Instance Attribute | Toolbar in Right Splitter Container | LIKE 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 clickedDOCUMENT_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