PrizmDoc® v14.2 Release - Updated
PrizmDoc / Developer Guide / PrizmDoc / Configure PrizmDoc / Configuration Options / Define the View Mode
In This Topic
    Define the View Mode
    In This Topic

    Introduction

    The ViewMode enumeration defines view modes known by PCCViewer.ViewerControl. The ViewerControl uses a specified view mode to set or update how documents that contain different sized pages are displayed in the Viewer. This enumeration is a convenience for API developers. Instead of using it, you can pass in the string values of the view mode (enumeration values) directly to the API.

    There are three view modes available:

    • Document - PrizmDoc maintains the relative size of each page when displaying a document. For example, if page 2 is smaller than page 1, it will appear smaller. In this view mode, the user can choose to scroll through the document or select one of the View icons to go from the First page to the Last page of the document.
    • EqualWidthPages - PrizmDoc scales each page so that their width is the same. For example, if page 2 is smaller than page 1, it will be scaled larger so that its width is equal to the width of page 1. In this view mode, the user can choose to scroll through the document or select one of the View icons to go from the First page to the Last page of the document.
    • SinglePage - PrizmDoc displays a single page at a time. Each page is scaled to fit within a view box, which is the initial size of the Viewer and increases in size when zooming in (and decreases in size when zooming out). After the Viewer initializes, the view mode may not be changed to or from SinglePage view mode (or an exception will occur). In this view mode, the user selects one of the View icons to go from the First page to the Last page of the document which simulates a smooth transition from page to page. This view mode is non-scrolling.

    To set the ViewMode:

    Example

    // use the enumeration
    myViewerControl.setViewMode(PCCViewer.ViewMode.SinglePage);
    // or just use the string value
    myViewerControl.setViewMode("SinglePage");