VirtualViewer® V4.3 VirtualViewer HTML5 for .NET Client Administrator’s Guide Note: An online version of this manual contains information on the latest updates to Vir- tualViewer. To find the most recent version of this manual, please visit the online ver- sion at www.virtualviewer.com or download the most recent version from our website at www.snowbound.com/support/manuals.html. DOC-0168-01 Copyright Information While Snowbound® Software believes the information included in this publication is correct as of the publication date, information in this document is subject to change without notice. UNLESS EXPRESSLY SET FORTH IN A WRITTEN AGREEMENT SIGNED BY AN AUTHORIZED REPRESENTATIVE OF SNOWBOUND SOFTWARE CORPORATION MAKES NO WARRANTY OR REPRESENTATION OF ANY KIND WITH RESPECT TO THE INFORMATION CONTAINED HEREIN, INCLUDING WARRANTY OF MERCHANTABILITY AND FITNESS FOR A PURPOSE, NON-INFRINGEMENT, OR THOSE WHICH MAY BE IMPLIED THROUGH COURSE OF DEALING OR CUSTOM OF TRADE. WITHOUT LIMITING THE FOREGOING, CUSTOMER UNDERSTANDS THAT SNOWBOUND DOES NOT WARRANT THAT CUSTOMER’S OPERATION OF THE SOFTWARE WILL BE UNINTERRUPTED OR ERROR-FREE, THAT ALL DEFECTS IN THE SOFTWARE WILL BE CORRECTED, OR THAT THE RESULTS OF THE SOFTWARE WILL BE ERROR-FREE. Snow- bound Software Corporation assumes no responsibility or obligation of any kind for any errors contained herein or in connection with the furnishing, performance, or use of this document. Software described in Snowbound documents (a) is the property of Snowbound Software Corporation or the third party, (b) is furnished only under license, and (c) may be copied or used only as expressly permitted under the terms of the license. All contents of this manual are copyrighted by Snowbound Software Corporation. The information contained herein is the exclusive property of Snowbound Software Corporation and shall not be copied, transferred, photocopied, translated on paper, film, electronic media, or computer-readable form, or otherwise reproduced in any way, without the express written permission of Snowbound Soft- ware Corporation. Microsoft, MS, MS-DOS, Windows, Windows NT, and SQL Server are either trademarks or registered trademarks of Microsoft Cor- poration in the United States and/or other countries. Adobe, the Adobe logo, Acrobat, and the Acrobat logo are trademarks of Adobe Systems Incorporated. Sun, Sun Microsystems, the Sun Logo, and Java are trademarks or registered trademarks of Sun Microsystems, Inc. in the United States and other countries. iText, the Initial Developers of the Original Code are Bruno Lowagie and Paolo Soares. Portions created by Bruno Lowagie are Copy- right ©1999-2010 by Bruno Lowagie. Kakadu JPEG2000©, is copyrighted by Dr. David Taubman, and is proprietary to NewSouth Innovations, Pty. Ltd, Australia. Aspose™, Aspose.Cells© (copyrighted 2003), Aspose.Words© (copyrighted 2003), and Aspose.Slides© (copyrighted 2004), are all proprietary to Aspose Software, Pty. Ltd, Australia. United States Government Restricted Rights The Software is provided with RESTRICTED RIGHTS. Use, duplication or disclosure by the United States Government is subject to restrictions as set forth under subparagraph (c)(1)(ii) of The Rights in Technical Data and Computer Software clause of DFARS 252.227 –19 or subparagraphs (c)(i) and (2) of the Commercial Computer Software-Restricted Rights at 48 CFR 52.227 – 19 as applic- able. The Manufacturer is Snowbound Software Corporation, 309 Waverley Oaks Rd., Suite 401, Waltham, MA 02452, USA. All other trademarks and registered trademarks are the property of their respective holders. Manual Title: Snowbound Software VirtualViewer HTML5 for .NET Client Administrator’s Guide Part Number: DOC-0168-02 Revision: 02 VirtualViewer HTML5 for .NET Release Number: 4.3 VirtualViewer® Release Number: 4.3 Printing Date: May 2016 Published by Snowbound Software Corporation. 309 Waverley Oaks Road Suite 401 Waltham, MA 02452 USA phone: 617-607-2000 fax: 617-607-2002 ©1996 - 2016 by Snowbound Software Corporation. All rights reserved. Table of Contents Getting Started 19 System Requirements 19 Supported Operating Systems (Server) 19 Supported Browsers (Client and Server) 19 Exceptions to Supported File Formats and Platforms 20 Determining Memory Requirements 20 Determining Memory Needed for the Number of Users and Pages Viewed in Vir- tualViewer® HTML5 21 Licensing 21 Location of the Log Files 22 What to Expect in an Evaluation Version of VirtualViewer® HTML5 22 What to Expect in a Production Version of VirtualViewer® HTML5 23 Installing the Production Version of VirtualViewer® HTML5 23 Installation Checklist 23 Installing 24 Verifying 28 Running VirtualViewer® HTML5 in a Browser 28 Verifying that Your Documents Work in VirtualViewer HTML5 29 Verifying that Your Documents Work in VirtualViewer HTML5 29 Using VirtualViewer® HTML5 31 The Image Controls Toolbar 31 Exporting a Document 31 iii Exporting a Document with Annotations 31 Emailing a Document 32 Printing 34 Printing with or without Annotations 34 Printing Text and Non-text Annotations Separately 35 Zooming 35 Rubber Band Zoom 35 Magnifier 35 Page Controls 36 Fit-to-Page 36 Continuous Scrolling 36 Picture Controls 37 User Preference 37 Display Document and Page Properties 41 The Annotation Toolbar 42 Creating Annotations 42 Editing a Filled Annotation 42 Annotation Indicators and Navigation 46 Saving Annotations 47 Deleting Annotations 47 Using Text Edit Annotations 48 Using Image Rubber Stamp Annotations 49 Using Annotation Commenting 49 The Pages and Documents Panels 50 iv Hiding the Pages and Documents Panel 51 Document Notes 52 Creating Notes 53 Editing Notes 53 Bookmarks 53 Creating Bookmarks 54 Viewing Bookmarks 55 Text Searching 56 Setting the Default Colors 57 Working with Redactions 57 Redaction Information Warning Message 58 Redaction Areas 58 Redacting by Selecting Text 59 Search and Redact 59 Save Document As, Export Document, Email Document and Prints 60 Page Manipulations with Redactions 60 Annotation Redaction Tagging 60 Page Manipulations 61 Manipulating Page Order using Thumbnails 61 Page Manipulations 62 Selecting a Page 62 Loading the Page Manipulation Context Menu 62 Cutting, Copying, Deleting and Inserting Pages 62 Saving Page Manipulations 63 v Copy to New Document 63 Page Manipulations Across Multiple Browser Sessions 64 Customization 65 System Configuration 65 Configuring web.config 65 Servlet Tags for web.config 65 Customizing the User Interface 75 Configuring the Pages and Document Panel Display 75 availableDocuments 76 viewedDocuments 76 specifiedDocuments 77 Config.js Parameters 77 Descriptions of Config.js Parameters 77 Config.js Parameters 78 Hiding the Pages and Documents Panel 92 Disabling Page Manipulations 92 Disabling Copy to New Document 93 Configuring Text Edit Annotations 93 Configuring Image Rubber Stamp Annotations 94 Configuring the Magnifier 95 Configuring Default Annotation Values 95 Configuring the Annotations Checkbox 96 Configuring Email Documents 96 Print Dialog Box 97 vi Displaying the Include Annotations Checkbox 97 Displaying the Text and Non-text Checkbox 97 Localization 97 Localization Files 97 Converting Terms 98 Supporting Accents/Special Characters 98 Force a Specific Language 99 Using Keyboard Shortcuts 99 Customizing VirtualViewer® HTML5 through JavaScript API Methods 101 JavaScript API Descriptions 102 Document Methods for Setting, Printing, Exporting, and Saving 109 getDocumentId() 109 getClientInstanceId() 110 setClientInstanceId(id) 110 setDocumentId(id) 111 setSendDocumentCompletedHandler(fn) 111 setDocumentIdGenerator(fn) 111 setSaveDocumentCompletedHandler(fn) 112 setExportDocumentNameGenerator(fn) 112 setDocumentId(id) 112 getDisplayName() 113 getProperty(key, value) 113 setProperty(key, value) 113 emailDocument() 113 vii exportDocument() 114 getPageCount() 115 printDocument() 116 printDocumentLocal() 116 printDocumentServer() 116 reloadDocumentModel() 117 saveDocument(sync) 117 saveAllDocuments() 117 sendDocument() 118 Interacting with Document Pages within the Viewer 118 addPageToSelection() 118 closeTab(tabNumber) 118 copySelectionToNewDocument(newDocumentId) 118 copySelection() 119 collapseAllStickyNotes() 119 countPagesForDocument() 119 cutSelection(delPages) 119 cutSelectionToNewDocument(newDocumentId) 120 despeckleImage() 120 enterGuideMode() 120 enterPanMode() 120 enterSelectTextMode() 121 getActiveTab() 121 getBrightness() 121 viii getContrast() 121 getGamma() 122 getPageNumber() 122 getPageProperties() 122 getPagePropertyByCaption() 122 getPagePropertyByFieldId() 123 hideImageInfo() 123 removePageFromSelection() 123 showImageInfo() 123 toggleImageInfo() 123 toggleCrosshairGuide() 123 toggleHGuide() 124 toggleVGuide() 124 toggleSVGSupport() 124 pageHasAnnotation(pageNumber) 124 thumbsWithAnnotations() 124 showAnnotationIndicator() 124 removeAnnotationIndicators(pageNumber) 125 removeAllAnnotationIndicators() 125 showAllAnnotationIndicators() 125 showAnnotationNaviPanel() 125 pagesWithAnnotations() 125 goToNextPageWithAnn() 125 goToPrevPageWithAnn() 126 ix redoAnnotation() 126 undoAnnotation() 126 setAnnotationsEnabled() 126 setRedactionsEnabled() 126 pageManipulationsEnabled() 126 firstPage() 127 nextPage() 127 pasteSelection(beforePageNum) 127 previousPage() 127 lastPage() 127 flipX() 128 flipY() 128 init(openDoc) 128 initSpecifiedDocuments(documents) 128 initViaURL() 129 invertImage() 129 openInTab(id, newDocument) 129 rotateAllPagesBy() 130 rotateClock() 130 rotateCounter() 130 rotateImageBy(degrees) 130 rotateImageTo(degrees)