Page History

Panel

borderStyle	solid
title	Description

The PDF Viewer component displays a PDF that exists as a file in some accessible file system, or as a URL. Note that this component is simply for viewing existing PDFs. To create dynamic reports, or view dynamically generated reports use theReporting Module.

This component is typically used in conjunction with the File Explorer component, in order to create a PDF viewing window. Simply bind the Selected Path property in the PDF Viewer to the File Explorer's Selected Path property. See the File Explorer's documentation, as well as the File Explorer and PDF Viewer pages for further instructions on how to put these two components together.

Panel

title	Properties

Name

Description

Property Type

Scripting

Category

Border

The border surrounding this component. Options are: No border, Etched (Lowered), Etched (Raised), Bevel (Lowered), Bevel (Raised), Bevel (Double), Button Border, Field Border, Line Border, and Other Border.

Note
The border is unaffected by rotation.

Border

.border

Common

File Path

Path to the .pdf file to be displayed.

String

.filePath

Data

Footer Visible

If false, the Footer is not displayed.

Boolean

.footerVisible

Appearance

Name

The name of this component.

String

.name

Common

Page Fit Mode

Mode to fit the document within the viewer. (1 = Disabled, 2 = Actual Size, 3 = Fit Height, 4 = Fit Width)

Integer

.pageFitMode

Appearance

Page View Mode

How to display PDF in Viewer (1 = One Page, 2 = One Column, 3 = Two Page Left, 4 = Two Col Left, 5 = Two Page Right, 6 = Two Col Right)

Integer

.pageViewMode

Appearance

Toolbar Visible

Sets the top PDF control toolbar to visible.

Boolean

.toolBarVisible

Appearance

Utility Visible

Sets the Utility Sidebar to visible.

Boolean

.utilityPaneVisible

Appearance

Visible

If disabled, the component will be hidden.

Boolean

.visible

Common

Panel

title	PDF Viewer Toolbar

Toolbar Buttons

Name

Function

Save As

Will save the currently loaded pdf to the local computer.

Changed_in

Version	8.0.11

This button was removed, since the Save As functionality was never intended to be included on the component.

Print Document

Will print the currently loaded pdf from the local computer.

Search Document

Will open up a text field that can be used to search the currently loaded pdf for a specific word or phrase. *Note: This is located in the Utility Panel and can be accessed from there as well.

Show/Hide Utility Panel

Will show/hide the Utility panel. The Utility Panel contains the following tabs:

Search - Will search the document for a specific word or phrase.
Bookmarks - Will display all of the bookmarks for the loaded pdf and allow you to quickly jump to them.
Thumbnails - Will display a thumbnail view of all of the pages of the loaded pdf. Clicking on one will jump to it.
Annotations - Will create a multitude of annotations on the currently loaded pdf. After adding an annotation, it can be selected and then configured in the Utility Panel. Annotations include highlights, strike through, underlines, text notes, and actions like navigating to a url.
Layers - Will display the layers of the currently loaded pdf, if any.

First Page

Will navigate back to the first page of the pdf.

Current Page Number

Will show the current page number out of the total number of pages, also allowing a page number to be entered which will jump to that page immediately.

Last Page

Will navigate forward to the last page of the pdf.

Zoom Out

Will zoom out from the pdf.

Zoom

A drop down list that displays the current zoom, as well as giving the ability to switch between different preset zoom amounts.

Zoom In

Will zoom in to the pdf.

Actual Size

Will revert back to a 100% zoom which is the natural size of the pdf.

Fit In Window

Will fit the pdf to the pdf viewer window.

Fit Width

Will fit the pdf to the width of the pdf viewer.

Rotate Right

Will rotate the pdf right.

Rotate Left

Will rotate the pdf left.

Pan Tool

Will pan around a page of the pdf by clicking and dragging. Works better when zoomed in.

Text Select Tool

Can be used to select text in the pdf.

Zoom Marquee Tool

Will zoom into the pdf by clicking and dragging to select an area.

Zoom Dynamic Tool

Will zoom in and out using the scroll wheel.

Select Tool

Can be used to select objects on the pdf such as annotations.

Highlight Annotation Tool

Can be used to highlight text in the pdf. Can also be done from the Utility Panel and can be configured there as well.

Text Annotation Tool

Can be used to place a text comment on the pdf. Can be configured in the Utility Panel.

Show/Hide Form Highlighting

Show or hide highlighting on the form.

Single Page View Non-Continuous

View the pdf file one page at a time.

Single Page View Continuous

View the pdf file one page wide with continuous scrolling.

Facing Page View Non-Continuous

View the pdf file two pages at a time.

Facing Page View Continuous

View the pdf file two pages wide with continuous scrolling.

Panel

title	Scripting

Panel

title	Scripting Functions

Expand

title	.loadPDFBytes(bytes, name)

Description

This function will pass in the bytes of a PDF and load them into the PDF Viewer component. Please see Storing Files in a Database for more details

Parameters

string bytes - The bytes of the PDF to be displayed on the component

string name - The name of the PDF

Return

Nothing

Expand

title	.print(showDialog)

Since 7.8.2
Description

This function will print the PDF.

Parameters

boolean showDialog- If true, shows the user a print dialog. Default is true [optional]

Return

Nothing

Expand

title	.setZoomFactor(zoom)

Since 7.8.2
Description

This function will set the current zoom level of the PDF, adjusted to stay within the minimum / maximum zoom range. Will zoom in on center of page.

Parameters

float zoom- Zoom factor to use. 1.0 is no zoom.

Return

Nothing

Panel

title	Extension Functions

This component does not have extension functions associated with it.

Panel

title	Event Handlers

Expand

title	mouse

Expand

title	mouseClicked

This event signifies a mouse click on the source component. A mouse click the combination of a mouse press and a mouse release, both of which must have occurred over the source component. Note that this event fires after the pressed and released events have fired.

.source	The component that fired this event.
.button	The code for the button that caused this event to fire.
.clickCount	The number of mouse clicks associated with this event.
.x	The x-coordinate (with respect to the source component) of this mouse event.
.y	The y-coordinate (with respect to the source component) of this mouse event.
.popupTrigger	Returns True (1) if this mouse event is a popup trigger. What constitutes a popup trigger is operating system dependent, which is why this abstraction exists.
.altDown	True (1) if the Alt key was held down during this event, false (0) otherwise.
.controlDown	True (1) if the Control key was held down during this event, false (0) otherwise.
.shiftDown	True (1) if the Shift key was held down during this event, false (0) otherwise.

Expand

title	mouseEntered

This event fires when the mouse enters the space over the source component.

.source	The component that fired this event.
.button	The code for the button that caused this event to fire.
.clickCount	The number of mouse clicks associated with this event.
.x	The x-coordinate (with respect to the source component) of this mouse event.
.y	The y-coordinate (with respect to the source component) of this mouse event.
.popupTrigger	Returns True (1) if this mouse event is a popup trigger. What constitutes a popup trigger is operating system dependent, which is why this abstraction exists.
.altDown	True (1) if the Alt key was held down during this event, false (0) otherwise.
.controlDown	True (1) if the Control key was held down during this event, false (0) otherwise.
.shiftDown	True (1) if the Shift key was held down during this event, false (0) otherwise.

Expand

title	mouseExited

This event fires when the mouse leaves the space over the source component.

.source	The component that fired this event.
.button	The code for the button that caused this event to fire.
.clickCount	The number of mouse clicks associated with this event.
.x	The x-coordinate (with respect to the source component) of this mouse event.
.y	The y-coordinate (with respect to the source component) of this mouse event.
.popupTrigger	Returns True (1) if this mouse event is a popup trigger. What constitutes a popup trigger is operating system dependent, which is why this abstraction exists.
.altDown	True (1) if the Alt key was held down during this event, false (0) otherwise.
.controlDown	True (1) if the Control key was held down during this event, false (0) otherwise.
.shiftDown	True (1) if the Shift key was held down during this event, false (0) otherwise.

Expand

title	mousePressed

This event fires when a mouse button is pressed down on the source component.

.source	The component that fired this event.
.button	The code for the button that caused this event to fire.
.clickCount	The number of mouse clicks associated with this event.
.x	The x-coordinate (with respect to the source component) of this mouse event.
.y	The y-coordinate (with respect to the source component) of this mouse event.
.popupTrigger	Returns True (1) if this mouse event is a popup trigger. What constitutes a popup trigger is operating system dependent, which is why this abstraction exists.
.altDown	True (1) if the Alt key was held down during this event, false (0) otherwise.
.controlDown	True (1) if the Control key was held down during this event, false (0) otherwise.
.shiftDown	True (1) if the Shift key was held down during this event, false (0) otherwise.

Expand

title	mouseReleased

This event fires when a mouse button is released, if that mouse button's press happened over this component.

.source	The component that fired this event.
.button	The code for the button that caused this event to fire.
.clickCount	The number of mouse clicks associated with this event.
.x	The x-coordinate (with respect to the source component) of this mouse event.
.y	The y-coordinate (with respect to the source component) of this mouse event.
.popupTrigger	Returns True (1) if this mouse event is a popup trigger. What constitutes a popup trigger is operating system dependent, which is why this abstraction exists.
.altDown	True (1) if the Alt key was held down during this event, false (0) otherwise.
.controlDown	True (1) if the Control key was held down during this event, false (0) otherwise.
.shiftDown	True (1) if the Shift key was held down during this event, false (0) otherwise.

Expand

title	mouseMotion

Expand

title	mouseDragged

Fires when the mouse moves over a component after a button has been pushed.

.source	The component that fired this event.
.button	The code for the button that caused this event to fire.
.clickCount	The number of mouse clicks associated with this event.
.x	The x-coordinate (with respect to the source component) of this mouse event.
.y	The y-coordinate (with respect to the source component) of this mouse event.
.popupTrigger	Returns True (1) if this mouse event is a popup trigger. What constitutes a popup trigger is operating system dependent, which is why this abstraction exists.
.altDown	True (1) if the Alt key was held down during this event, false (0) otherwise.
.controlDown	True (1) if the Control key was held down during this event, false (0) otherwise.
.shiftDown	True (1) if the Shift key was held down during this event, false (0) otherwise.

Expand

title	mouseMoved

Fires when the mouse moves over a component, but no buttons are pushed.

.source	The component that fired this event.
.button	The code for the button that caused this event to fire.
.clickCount	The number of mouse clicks associated with this event.
.x	The x-coordinate (with respect to the source component) of this mouse event.
.y	The y-coordinate (with respect to the source component) of this mouse event.
.popupTrigger	Returns True (1) if this mouse event is a popup trigger. What constitutes a popup trigger is operating system dependent, which is why this abstraction exists.
.altDown	True (1) if the Alt key was held down during this event, false (0) otherwise.
.controlDown	True (1) if the Control key was held down during this event, false (0) otherwise.
.shiftDown	True (1) if the Shift key was held down during this event, false (0) otherwise.

Expand

title	propertyChange

Expand

title	propertyChange

Fires whenever a bindable property of the source component changes. This works for standard and custom (dynamic) properties.

.source

The component that fired this event.

.newValue

The new value that this property changed to.

.oldValue

The value that this property was before it changed. Note that not all components include an accurate oldValue in their events.

.propertyName

The name of the property that changed.

Note
Remember to always filter out these events for the property that you are looking for! Components often have many properties that change.

Panel

title	Customizers

The PDF Viewer component does not have a special customizer, however, it does use the Style Customizer and Custom Properties.

Vision Component Customizers

User Manual

GETTING STARTED

MODULES AND PLATFORM

APPENDIX

TUTORIALS & HELPFUL TRICKS

STRATEGIC PARTNER LINKS

RESOURCES

ALL USER MANUAL VERSIONS

Employees

Versions Compared

Old Version 12

New Version Current

Key