Functions/Properties

Setup & configuration

• componentVersion: Retrieve the component version number.
• setConfig: Process a configuration command.

Opening & closing PDF files

• loadFile: Load a PDF file from disk.
• loadFileWithPassword: Load a PDF file from disk, with a password.
• loadStream: Load a PDF file from an OLE IStream object.
• loadStreamWithPassword: Load a PDF file from an OLE IStream object, with a password.
• loadURL: Load a PDF file from via a URL.
• loadURLWithPassword: Load a PDF file via a URL, with a password.
• closeFile: Close the currently open PDF file.

Saving PDF files

• saveAs: Save the currently open PDF file to disk.

Navigation

• numPages: Get the number of pages.
• currentPage: Get/set the currently displayed page number.
• midPage: Get the page number at the middle of the window.
• gotoFirstPage: Move to the first page.
• gotoLastPage: Move to the last page.
• gotoNextPage: Move to the next page.
• gotoPreviousPage: Move to the previous page.
• gotoNamedDestination: Move to a named destination.
• goForward: Move forward along the history list.
• goBackward: Move backward along the history list.
• scrollPageUp: Scroll the display up.
• scrollPageDown: Scroll the display down.
• scrollTo: Scroll to a specific position.
• scrollBy: Scroll to a specific position.
• scrollX: Get the x coordinate of the current scroll position.
• scrollY: Get the y coordinate of the current scroll position.

Zoom factor and rotation angle

• zoom: Get/set the current zoom factor.
• zoomPercent: Get the current zoom factor as a percentage.
• zoomPage: Zoom to fit the page to the window.
• zoomWidth: Zoom to fit the page width to the window.
• zoomHeight: Zoom to fit the page height to the window.
• zoomToRect2: Zoom to a specific rectangle.
• zoomCentered: Zoom to a specific rectangle.
• zoomToCurrentWidth: Zoom so that the current page horizontally fills the window.
• rotate: Get/set the page rotation.

Page display mode

• displayMode: Get/set page display mode.
• displaySingle: Display a single page at a time.
• displayContinuous: Display pages stacked vertically.
• displaySideBySideSingle: Display two facing pages at a time.
• displaySideBySideContinuous: Display facing pages, stacked vertically.
• displayHorizontalContinuous: Display pages stacked horizontally.

Page change events

• pageChange: Event for page changes (at top of window).
• midPageChange: Event for page changes (in middle of window).

Coordinates

• convertWindowToPDFCoords2: Convert PDF coordinates to window coordinates.
• convertPDFToWindowCoords2: Convert PDF coordinates to window coordinates.
• getWindowPageRange: Get the range of pages intersected by a window coordinate rectangle.

Selection

• getCurrentSelection2: Get the current selection.
• isCurrentSelection: Check to see if there is a current selection.
• getCurrentSelectionPage: Get the page number of the current selection.
• getCurrentSelectionX0: Get the x0 coordinate of the current selection.
• getCurrentSelectionY0: Get the y0 coordinate of the current selection.
• getCurrentSelectionX1: Get the y0 coordinate of the current selection.
• getCurrentSelectionY1: Get the y1 coordinate of the current selection.
• setCurrentSelection2: Change the selection.
• clearSelection: Clear the selection.
• setBlockSelectMode: Select block selection mode.
• setLinearSelectMode: Select linear selection mode.
• setSelectionColor: Set the selection color.
• enableSelect: Enable or disable selection.
• selectDone: Event for selection.
• getSelectedText: Get the currently selected text.
• copySelection: Copy the current selection to the clipboard.

Keyboard and mouse events

• enableKeyEvents: Enable or disable keyboard events.
• enableMouseEvents: Enable or disable mouse events.
• enableMouseBtnEvents: Enable or disable mouse events for specific buttons.
• enableMouseMoveEvents: Enable or disable mouse movement events when no button is pressed.
• enableMouseWheelEvents: Enable or disable mouse wheel events.
• KeyDown: Key-down event.
• KeyUp: Key-up event.
• KeyPress: Key-press event.
• MouseDown2: Mouse button-down event.
• MouseUp2: Mouse button-up event.
• MouseDoubleClick2: Mouse button double-click event.
• MouseMove2: Mouse movement event.
• MouseDownWin: Mouse button-down event with window coordinates.
• MouseUpWin: Mouse button-up event with window coordinates.
• MouseDoubleClickWin: Mouse button double-click event with window coordinates.
• MouseMoveWin: Mouse movement event with window coordinates.
• MouseWheel: Mouse wheel event.

Touch support

• enableTouchPan: Enable or disable touch panning.
• enableTouchZoom: Enable or disable touch zooming.
• touchZoom: Touch zoom event.

Hyperlinks

• enableHyperlinks: Enable or disable hyperlink support.
• enableExternalHyperlinks: Enable or disable external hyperlink support.
• onLink2: Check to see if a point is inside a hyperlink.
• gotoLinkAt2: Activate the link at the specified coordinates.
• linkClick: Event for clicks on hyperlinks.

Annotations

• onAnnot: Check for an annotation containing the specified point.
• getAnnotType: Get the type of an annotation.
• getAnnotContent: Get the type of an annotation.

Redrawing

• enableRedraw: Enable or disable window redraws.
• redraw: Window redraw event.

Text find

• find: Find a text string.
• findNext: Find the next occurrence of a text string.
• find2: Find a text string.
• find2Backward: Find backwards (flag for find2).
• find2CaseSensitive: Find case-sensitive (flag for find2).
• find2Next: Find next occurrence (flag for find2).
• find2OnePageOnly: Search only the current page (flag for find2).
• find2WholeWord: Search for whole words only (flag for find2).

Extracting text

• extractTextFromPage: Extract text from a specified rectangle.
• textEncoding: Set the encoding to use for text extraction.
• setPhysicalLayoutTextMode: Set physical layout mode for text extraction.
• setTableLayoutTextMode: Set table layout mode for text extraction.
• discardDiagonalText: Discard diagonal text when doing text extraction.
• okToExtractText: Check to see if the PDF file allows text extraction.

Extracting graphics

• convertPageToPicture2: Convert a page to a Picture object.
• convertRegionToPicture2: Convert a rectangular region to a Picture object.
• convertPageToBMP2: Write a page to an image file.
• convertRegionToBMP2: Write a rectangular region to an image file.
• imageMono: Monochrome color setting for rasterization.
• imageGray: Grayscale color setting for rasterization.
• imageRGB: RGB color setting for rasterization.
• imageDevNToRGB: DeviceN-to-RGB color setting for rasterization.
• imageGrayToMono: Gray-to-monochrome color setting for rasterization.

Highlighting regions

• addRegion: Add a highlighted region.
• setRegionLabel: Update a highlighted region's label.
• setRegionResizable: Make a highlighted region resizable or not.
• deleteRegion: Delete a highlighted region.
• deleteAllRegions: Delete all highlighted region.
• numRegions: Get the current number of regions.
• getRegion: Get a region handle.
• getSelectedRegion: Get the selected region.
• setSelectedRegion: Set the selected region.
• makeRegionVisible: Make a region visible.
• getRegionInfo: Get the parameters of a region.
• loadHighlightFile2: Load a highlight file.
• loadHighlightStream2: Load a highlight file via a stream.
• loadHighlightURL2: Load a highlight file via a URL.
• regionSelected: Event for region selection.
• regionDoubleClick: Event for region double-click events.
• regionChanged: Set a callback function for region changes.

PDF metadata

• getInfoString: Get the content of a document info field.
• pdfVersion: Get the PDF version number.
• getFileName: Get the file name of the currently open PDF file.

Page size and rotation

• getPageWidth: Get the width of the specified page.
• getPageHeight: Get the height of the specified page.
• getPageBoxXMin: Get the minimum x coordinate of the specified page box.
• getPageBoxYMin: Get the minimum y coordinate of the specified page box.
• getPageBoxXMax: Get the maximum x coordinate of the specified page box.
• getPageBoxYMax: Get the maximum y coordinate of the specified page box.
• getPageRotation: Get the default rotation for the specified page.
• getPageUserUnit: Get the UserUnit scaling factor for the specified page.

Other PDF file information

• fileIsDamaged: Check to see if the PDF file is damaged.
• getFormType2: Get the type of form in the PDF file.

Printing

• printWithDialog: Print the PDF file with a printing dialog.
• printSilently: Print the PDF file without user interaction.
• print3: Print the PDF file.
• startPrintJob: Start a print job.
• printToJob: Add pages to a print job.
• finishPrintJob: Finish a print job.
• addPrintOverlayText: Add a printing overlay text item.
• printOverlayUnder: Underlay mode (addPrintOverlayText flag).
• clearPrintOverlayText: Clear all printing overlay text items.
• printGDIOverlay: Event at the end of each printed page.
• okToPrint: Check to see if the PDF file allows printing.
• shrinkToPrintable: Scale pages to fit the printable area.
• printForceGDI: Force the print operation to go through GDI.
• printForceImage: Force the print operation to print as images.
• printRawSpoolFile: Force the spool file to be in raw format.
• printForceMono: Force printing in monochrome.
• printHDPI: Set the horizontal print resolution.
• printVDPI: Set the vertical print resolution.
• printBin: Set the paper bin ID for printing.
• printPaper: Set the paper size/type ID for printing.
• printEmulatedMultiCopy: Enable/disable emulated multi copy mode for printing.
• printStatus: Event called periodically while printing.

Printer information

• getNumPrinters: Get the number of available printers.
• getPrinterName: Get a printer name.
• getNumPrinterBins: Get the number of available paper bins/trays.
• getPrinterBinID: Get a paper bin ID.
• getPrinterBinName: Get a paper bin name.
• getNumPrinterPapers: Get the number of available paper sizes.
• getPrinterPaperID: Get a paper size ID.
• getPrinterPaperName: Get a paper size name.

Page labels

• hasPageLabels: Check if the PDF file has page labels.
• getPageLabelFromPageNum: Convert a page number to a page label.
• getPageNumFromPageLabel: Convert a page label to a page number.

Outline

• getOutlineNumChildren: Get the number of children of an outline node.
• getOutlineChild: Get an outline node child.
• getOutlineTitle: Get the text associated with an outline node.
• getOutlineStartsOpen: Check to see if an outline node starts open.
• getOutlineTargetPage: Get the target page number for an outline node.
• gotoOutlineTarget: Jump to the target of an outline node.

Layers

• getNumLayers: Get the number of layers.
• getLayer: Get a layer handle.
• getLayerName: Get the name of a layer.
• getLayerVisibility: Get the visibility state of a layer.
• setLayerVisibility: Set the visibility state of a layer.
• getLayerViewState: Get the suggested state of a layer for viewing mode.
• getLayerPrintState: Get the suggested state of a layer for printing mode.
• getLayerOrderRoot: Get the root of the layer display order tree.
• getLayerOrderIsName: Check to see if a layer display order node is a name.
• getLayerOrderName: Get the name of a layer display order node.
• getLayerOrderLayer: Get the layer associated with a layer display order node.
• getLayerOrderNumChildren: Get the number of children attached to a layer display order node.
• getLayerOrderChild: Get a child of a layer display order node.

Embedded files

• getNumEmbeddedFiles: Get the number of embedded files.
• getEmbeddedFileName: Get the name of an embedded file.
• saveEmbeddedFile: Save an embedded file.

Prepress settings

• enableDeviceNOverprintPreview: Enable or disable DeviceN+overprint preview mode.
• enableColorManagement: Enable or disable color management.

Miscellaneous settings

• showScrollbars: Enable/disable scrollbars.
• showBorder: Show/hide a "sunken" window border.
• matteColor: Set the matte color.
• reverseVideo: Turn reverse video mode on/off.
• enableBeeps: Enable/disable beeps.
• showPasswordDialog: Enable/disable the password dialog.
• mouseCursor: Change the mouse cursor.
• mouseCursor2: Change the mouse cursor.
• mouseLinkCursor: Change the mouse cursor shown over links.
• mouseLinkCursor2: Change the mouse cursor shown over links.

Miscellaneous

• errorMsg: Error event.
• windowHandle: Get the viewer window handle.