Toolbar Tools

The PDFViewer component toolbar provides various tools that enable users to interact with the PDFViewer component and perform different actions over the displayed PDF content. This article describes the built-in tools and shows how to customize them.

By default, the PDFViewer displays all its built-in tools. To display only the required tools or change their order, set the tools property of the component to PDFViewerTool array.

The available tools are:

• pager—Allows you to navigate through the pages.
• spacer—Enables you to define spacing between the toolbar inner elements.
• zoomInOut—Displays buttons for zooming in and out.
• zoom—Renders a ComboBox component for setting predefined or custom zoom levels (default value is 125%).
• selection— Depending on the selected button, it allows you to:
  • scroll the document by dragging the page
  • select a text through dragging.
• search—Enables the search functionality.
• open—Allows you to select a PDF document from the file system.
• download—Enables you to download the viewed PDF document.
• print—Opens the browser print window.

The following example demonstrates how to reorder the built-in tools by setting the tools property of the PDFViewer.

Pager Tool

The pager tool allows you to navigate through the PDFViewer pages when the displayed PDF contains more than on page.

For the pager to work, set the height of the PDFViewer to be smaller than the height of the loaded document.

The following example demonstrates the pager tool of the PDFViewer in action.

Search Tool

The searching tool enables you to find a specific word or phrase inside the PDF document. Navigate through the results by using the Up and Down arrows.

The number of pages in the loaded PDF document might affect the performance of the PDFViewer search functionality. In case the performance falls below acceptable levels, consider removing the search tool to ensure optimal user experience.

The following example demonstrates the search tool of the PDFViewer in action.

Zooming Tools

The PDFViewer component allows you to zoom the PDF document by:

• using ZoomIn and ZoomOut buttons (zoomInOut tool). The default zoom rate is 0.25 (25%), but this could be customized by setting the zoomRate property.
• choosing from a predefined percentage values or setting you custom one (zoom tool). The default zoom level is 1.25 (125%), but could be customized by setting the zoom property.

You can also limit the zooming levels by setting the minZoom and maxZoom properties.

The following example demonstrates the zooming tools of the PDFViewer and how to limit the zooming levels.

Selection Tool

The selection tool allows you to configure the pointer functionality inside the PDF document. To highlight a text, select the pointer icon button. To scroll the content by using the pointer, select the hand icon button.

The following example demonstrates the selection tools of the PDFViewer component.

Download Tool

The download tool allows you to download the viewed document. You can configure the name of the file by setting the saveFileName option. Set the saveOptions property to further configure proxy URLs, targets and others. The saveOptions property accepts a SaveOptions object.

The following example demonstrates the download tool of the PDFViewer component and how to set the file name of the downloaded file.

Open Tool

The PDFViewer allows you to open a PDF file from your local file system. This is extremely useful when you want to preview and validate the selected PDF, before proceeding with a certain action.

The following example demonstrates the open tool of the PDFViewer component.

Print Tool

The print tool opens the browser print window which enables you to configure and print the document.

The following example demonstrates the upload tool of the PDFViewer component.

Suggested Links

• API Reference of the PDFViewer component
• API Index of the PDFViewer