Apryse SDK uses a viewing UI component developed in-house that you can customize.
The PDFViewCtrl has a large API set that can be used to control how the PDF is presented to the user. This guide highlights some of the most commonly used functionality.
If you are using a DocumentActivity (or PdfViewCtrlTabHostFragment2), the contained PDFViewCtrl can be customized through PDFViewCtrlConfig.
API | Description |
|---|---|
| Set how pages are presented and scrolled: in 1 or 2 columns, scrolled vertically or horizontally |
| Sets the zoom level relative to the page size, fit-width, fit-height or fit-page. |
| When a document is scrolled via horizontal swipes, use this method to control what zoom level new pages are rendered at. |
| Sets the color that is seen around pages. |
| Controls how low-resolution thumbnails are handled. Enlarged thumbnails are used in place of high-resolution content while the high-resolution content is being rendered. |
| Controls how frequently the high-resolution content is updated while it is being rendered. |
| Controls if annotations are visible. |
| Controls if form fields are shaded with light blue. |
| Controls how PDFs that use overprint colors are rendered. |
| Can be used to turn on night-mode and other color processing changes. |
The PDFViewCtrl is the view that displays the PDF - it does not include any toolbars, buttons or UI beyond presenting the PDF. It has a large API that can be used to control how the PDF is presented to the user. All of the APIs that you can use are well documented. This guide highlights some of the most commonly used functionality.
If you are using a PTDocumentController (or PTTabbedDocumentViewController), the contained PTPDFViewCtrl can be accessed as a property:
API | Description |
|---|---|
| Set how pages are presented and scrolled: in 1 or 2 columns, scrolled vertically or horizontally |
| Sets the zoom level relative to the page size, fit-width, fit-height or fit-page. |
| When a document is scrolled via horizontal swipes, use this method to control what zoom level new pages are rendered at. |
| Sets the color that is seen around pages. |
| Controls how low-resolution thumbnails are handled. Enlarged thumbnails are used in place of high-resolution content while the high-resolution content is being rendered. |
| This view is used for drawing system-content over the PDF. |
| Controls how frequently the high-resolution content is updated while it is being rendered. |
| Controls if annotations are visible. |
| Controls if form fields are shaded with light blue. |
| Controls how PDFs that use overprint colors are rendered. |
| Can be used to turn on night-mode and other color processing changes. |
The PDFViewCtrl includes two delegates (delegate and toolDelegate to relay touch and other events that occur on the control.
The first is a general purpose delegate, the second was designed specifically for enabling the Tools.framework functionality via its conforming object PTToolManager. If you are using the tools framework, a PTToolManager should always be assigned as the PTPDFViewCtrl's toolDelegate object. If you are not using the Tools.framework, it may be used for whatever purpose your app requires.
When using a PTDocumentController (or PTTabbedDocumentViewController), the PTPDFViewCtrl delegates are used internally and cannot be reassigned to another object. To receive the delegate callbacks, create a subclass of PTDocumentController and implement the required methods, being sure to call super.
Did you find this helpful?
Trial setup questions?
Ask experts on DiscordNeed other help?
Contact SupportPricing or product questions?
Contact Sales