Documentation

Guides

Included in this package are two guides:

  • User Guide: This document describes how to use WebViewer features from an end-user's perspective.
  • Developer Integration Guide: This guide is intended to help developers integrate WebViewer into their own application. Please also see the samples pages.

API Reference

Also available are the API References for WebViewer and each of its viewers

  • WebViewer.js: This API reference details how to use the WebViewer.js universal viewer wrapper.
    Developers can refer to this API reference for integrating WebViewer with their own applications.
  • WebViewer HTML5: This API reference details how to use the DocumentViewer component, as well as the full-featured and customizable ReaderControl.
    Developers can refer to this API reference for making customizations to the HTML5 WebViewer.
  • WebViewer Silverlight This API reference details how to customize the Silverlight WebViewer component.
  • WebViewer Flash This API reference details how to customize the Flash WebViewer component.

Getting Started

To get started, convert your documents to the web-optimized XOD file. Choose from one of the three options:

  1. PDFNet Cloud API: a web service that converts your documents and hosts them in the cloud. Sign up for a free evaluation account to start converting.
  2. DocPub CLI: a command-line tool that converts documents to XOD
  3. PDFNet SDK with WebViewer add-on: the full PDFNet SDK for working with PDF files and exporting them to XOD

For more information, please visit http://www.pdftron.com/pdfnet/webviewer/download.html

Once you have converted your documents to XOD files, all you need to do is pass your XOD file URL to the WebViewer. The most basic usage of WebViewer is as simple as this: 

<script>
var myWebViewerContainer = document.createElement("div");
var myWebViewer = new PDFTron.WebViewer({
    initialDoc : "path/to/xod"
}, myWebViewerContainer);
</script>