PDF Viewer Preferences Application Programming Interfaces

The following Application Programming Interface functions control how the PDF viewer will display the output PDF document (or, more accurately, attempt to control as not all PDF viewers obey these preferences):

  I2PDF_SetViewerPreferenceCenterWindow
I2PDF_SetViewPrefCenterWindow
Parameters: None
Return Value: None
Notes:
  • The window displaying the PDF document should be displayed in the center of the computer's screen.

  •   I2PDF_SetViewerPreferenceHideToolbar
    I2PDF_SetViewPrefHideToolbar
    Parameters: None
    Return Value: None
    Notes:
  • The PDF viewer's toolbar should be hidden when the PDF document is active.

  •   I2PDF_SetViewerPreferenceHideMenubar
    I2PDF_SetViewPrefHideMenubar
    Parameters: None
    Return Value: None
    Notes:
  • The PDF viewer's menubar should be hidden when the PDF document is active.

  •   I2PDF_SetViewerPreferenceHideWindowUI
    I2PDF_SetViewPrefHideWindowUI
    Parameters: None
    Return Value: None
    Notes:
  • The user interface elements within the PDF document's window should be hidden.

  •   I2PDF_SetViewerPreferenceFitWindow
    I2PDF_SetViewPrefFitWindow
    Parameters: None
    Return Value: None
    Notes:
  • The PDF viewer should resize the window displaying the PDF document to fit the size of the first displayed page of the PDF document.

  •   I2PDF_SetPageModeNone
    Parameters: None
    Return Value: None
    Notes:
  • The PDF viewer should not show the outline (ie bookmark) or thumbnail navigation items when the PDF document is open.
  • This is the default if no other page mode is specified.

  •   I2PDF_SetPageModeOutlines
    Parameters: None
    Return Value: None
    Notes:
  • The PDF viewer should show the outline (ie bookmark) navigation item when the PDF document is open.

  •   I2PDF_SetPageModeUseThumbs
    Parameters: None
    Return Value: None
    Notes:
  • The PDF viewer should show the thumbnail navigation item when the PDF document is open.

  •   I2PDF_SetPageModeFullScreen
    Parameters: None
    Return Value: None
    Notes:
  • The PDF viewer should open the PDF document in full-screen mode without showing the menu bar, window controls or any other window.

  • Note: The following options specify the layout for the page when the PDF document is opened. If none of these is specified then the PDF viewer should default to a known user preference.

      I2PDF_SetPageLayoutSinglePage
    Parameters: None
    Return Value: None
    Notes:
  • Display the pages one page at a time.

  •   I2PDF_SetPageLayoutOneColumn
    I2PDF_SetPageLayout1Col
    Parameters: None
    Return Value: None
    Notes:
  • Display the pages in one column.

  •   I2PDF_SetPageLayoutTwoColumnLeft
    I2PDF_SetPageLayout2ColLeft
    Parameters: None
    Return Value: None
    Notes:
  • Display the pages in two columns, with odd-numbered pages on the left.

  •   I2PDF_SetPageLayoutTwoColumnRight
    I2PDF_SetPageLayout2ColRight
    Parameters: None
    Return Value: None
    Notes:
  • Display the pages in two columns, with odd-numbered pages on the right.

  •   I2PDF_SlideShow
    Parameters: transition - must be one of the following: SLIDESHOW_WIPE_RIGHT (1), SLIDESHOW_WIPE_UP (2), SLIDESHOW_WIPE_LEFT (3), SLIDESHOW_WIPE_DOWN (4), SLIDESHOW_BARN_DOORS_HORIZONTAL_OUT (5), SLIDESHOW_BARN_DOORS_HORIZONTAL_IN (6), SLIDESHOW_BARN_DOORS_VERTICAL_OUT (7), SLIDESHOW_BARN_DOORS_VERTICAL_IN (8), SLIDESHOW_BOX_OUT (9), SLIDESHOW_BOX_IN (10), SLIDESHOW_BLINDS_HORIZONTAL (11), SLIDESHOW_BLINDS_VERTICAL (12), SLIDESHOW_DISSOLVE (13), SLIDESHOW_GLITTER_RIGHT (14), SLIDESHOW_GLITTER_DOWN (15), SLIDESHOW_GLITTER_TOP_LEFT_TO_BOTTOM_RIGHT (16) and SLIDESHOW_REPLACE (17)
    transitionDuration - must be a double precision value between 1.0 and 10.0 inclusive
    pageDisplayDuration - must be a double precision value between 1.0 and 60.0 inclusive
    Return Value: 0 - success
    1 - invalid transition
    2 - invalid transition duration
    3 - invalid page display duration
    Notes:
  • Forces the PDF document to be displayed full screen with the chosen screen transition between each page. If displayed within a browser it is likely that this setting will be ignored and the PDF displayed normally within the browser window.

  •   I2PDF_SlideShow_Int
    Parameters: transition - must be one of the following: SLIDESHOW_WIPE_RIGHT (1), SLIDESHOW_WIPE_UP (2), SLIDESHOW_WIPE_LEFT (3), SLIDESHOW_WIPE_DOWN (4), SLIDESHOW_BARN_DOORS_HORIZONTAL_OUT (5), SLIDESHOW_BARN_DOORS_HORIZONTAL_IN (6), SLIDESHOW_BARN_DOORS_VERTICAL_OUT (7), SLIDESHOW_BARN_DOORS_VERTICAL_IN (8), SLIDESHOW_BOX_OUT (9), SLIDESHOW_BOX_IN (10), SLIDESHOW_BLINDS_HORIZONTAL (11), SLIDESHOW_BLINDS_VERTICAL (12), SLIDESHOW_DISSOLVE (13), SLIDESHOW_GLITTER_RIGHT (14), SLIDESHOW_GLITTER_DOWN (15), SLIDESHOW_GLITTER_TOP_LEFT_TO_BOTTOM_RIGHT (16) and SLIDESHOW_REPLACE (17)
    transitionDuration - must be an integer value between 1 and 10 inclusive
    pageDisplayDuration - must be an integer value between 1 and 60 inclusive
    Return Value: 0 - success
    1 - invalid transition
    2 - invalid transition duration
    3 - invalid page display duration
    Notes:
  • Forces the PDF document to be displayed full screen with the chosen screen transition between each page. If displayed within a browser it is likely that this setting will be ignored and the PDF displayed normally within the browser window.