Manual - PDF Tools AG
Contents
1. Any CPU Solution Explorer 5 Solution Viewer 1 project 4 E Viewer gt Ej Properties gt gj References gt Converters gt Lg Exceptions gt Resources e App xaml MainWindow xaml mss we PasswordWindow xaml a ta PdfViewerAPI dil Gy Solut ER Class ME Prop El Reso Mi Tea e s E dM Bre B Te Now press the run button and the viewer should pop up PDF Tools AG Premium PDF Technology 3 Heights PDF Viewer NET WPF Control Version 4 5 Page 11 of 21 July 2 2015 Now you can open a file using the left most button in the toolbar and try out the component PDF Tools AG Premium PDF Technology 3 Heights PDF Viewer NET WPF Control Version 4 5 Page 12 of 21 July 2 2015 4 2 Open a file Use the Open method to open a PDF file from disk If the call fails then the license might be invalid so check for a valid license in this case if Viewer Open dialog FileName null if PdfViewerWPF GetLicenseIsValid MessageBox Show Properties MainWindowRes invalid license Properties MainWindowRes open error MessageBoxButton OK MessageBoxImage Error else To open a PDF file for memory use the method OpenMem 4 3 Open a file using a password A password must be provided if the file is encrypted with a user password For documents that have no user password set use the default password an e2. TOOLS COM VPDEIA Premium PDF Technology 3 Heights PDF Viewer NET WPF Control Version 4 5 User Manual Contact pdfsupport pdf tools com Owner PDF Tools AG Kasernenstrasse 1 8184 Bachenb lach Switzerland http www pdf tools com Copyright 2001 2015 3 Heights PDF Viewer NET WPF Control Version 4 5 Page 2 of 21 July 2 2015 Table of Content 1 Introduction 4 1 14 Description I I I I e nn nnn nnn rn nnn n nennen nnn nnn nnn nennen nnne nennen 4 MID m 4 FE NVA 6 cii g 4 Formats u ee 4 Compliance ee 5 Penn 1C1 a e TSPORRHBRPRSRSRBERBEREFEFFFIFSFSEERPRLFEFIFFFSFBELFEERFEFLFFFSPEFEPRELFUFSFIFEFSFEPBEEERFEFFFEFSFSFEPEFEFLFEFEFEFSFEFELEFEFFFEFTTFFE 5 1 3 Operating SYSTEM Sesinin detested ese nn EN nice sedi eas PE E ER FERE PEE E FERE FERA PRI REEF PAY eet 5 2 Installation 3 License Management 3 1 Graphical License Manager Too 44444sssnnnssnnnnnnnnnennnnnnnnnnnnnnnnnnnnnpnnnnnnnnennnnner nennen 8 List all installed license Keys nete eia irai ei ai i iP i nii brine 8 Add and delete license keys ssssssssssss eee 8 Display the properties of a license sssssssssssssseeeene nennen nnn 8 Select between different license keys for a single product sssssssssssesese 9 3 2 Command Line License Manager Tool ssssssssssssseneem enne nnne 9 List allinstalled lice
3. Windows A complete description of all commands and options can be obtained by running the program without parameters licmgr List all installed license keys licmgr list The currently active license for a specific product ist marked with a star on the left side Add and delete license keys Install new license key licmgr store X XXXXX XXXXX XXXXX XXXXX XXXXX XXXXX Delete old license key licmgr delete X XXXXX XXXXX XXXXX XXXXX XXXXX XXXXX Both commands have the optional argument s that defines the scope of the action e g For all users e u Current user Select between different license keys for a single product licmgr select X XXXXX XXXXX XXXXX XXXXX XXXXX XXXXX 3 3 License Key Storage The license keys are stored in the registry e HKLM Software PDF Tools AG for all users e HKCU Software PDF Tools AG for the current user PDF Tools AG Premium PDF Technology 3 Heights PDF Viewer NET WPF Control Version 4 5 Page 10 of 21 July 2 2015 User s Guide 4 1 Getting started After installing PDF Viewer you can open the sample program in Visual Studio to run and test the component Here are the steps 1 Go to the sample directory e g C Program Files PDF Tools VWWA Samples CS NET Viewer 2 Open the file Viewer sin 3 This should now look like this n oo Viewer Microsoft Visual Studio File Edit View Build Debug Team Data Tools Test Analyze Window Help Ply u iX 33 9 0 1 5 uniodeDeb
4. lt custom PdfViewerWPF Name PdfViewer Grid Row 1 FitMode FitWidth LayoutMode LayoutDocument Style StaticResource CustomStyle gt PDF Tools AG Premium PDF Technology 3 Heights PDF Viewer NET WPF Control Version 4 5 Page 14 of 21 July 2 2015 Programmer s Reference The following section lists all methods and properties of the COM interface of the 3 Heights PDF Viewer NET WPF Control 5 1 Methods Close bool Close Close the currently open document The method blocks until the document is closed Return value True _ if the file was open False otherwise Dispose void Dispose Release unmanaged resources After calling this method the object cannot be used anymore Open bool Open string filename string password Open a document from an input file This method makes the objects in the document accessible If there is an already open document it is closed first Parameters filename The input file name and optionally the file path drive or server string according to the operating systems file name specification rules password The user or the owner password of the encrypted PDF document If this parameter is null or an empty string the default i e no password is used If the document is not a PDF document this parameter is ignored Return value True _ if the file could be opened False otherwise OpenMem bool OpenMem byte memBlock string
5. cases a simple rules applies Higher quality takes more resources memory CPU and therefore lowers the performance The following settings have an impact on the performance e Content of the PDF A document with thousands of objects requires more time for rendering than a page with plain text e Resolution The higher the size of the viewer window the more pixels need to be drawn and the lower the performance e Thumbnails Displaying thumbnails reduces the performance Use outlines instead 6 2 Fonts and Text Font Replacement Strategy This section describes the exact behavior of font handling of the rendering engine It is rather technical and it is not required to be understood in order to properly use the software The following steps are performed sequentially in the search of a font If a font is found the search is stopped otherwise the next step is performed 1 Ifthe font is not embedded a If the font name appears in the Replace section in the configuration file fonts ini the name is replaced and looked up in the installed font collection b ifitis a standard font it is replaced by the equivalent TrueType font name and it is looked up in the installed font collection c If the font name appears in the Fonts section in the configuration file fonts ini the name is replaced and looked up in the installed font collection d If the font has Italic or Bold in its name the font without these styles is looked up in the
6. installed font collection 2 If afont name is looked up in the installed font collection then the name compare is performed as follows a PostScript name b TrueType name without blanks a missing style is interpreted as Regular or Normal c TrueType name without modifications 3 If the font is embedded it is converted to a Windows compatible font and temporarily installed 4 If the font is not embedded and the Unicodes are available then the nearest font from the installed font collection is tailored to the metrics of the font e g Times Roman Helvetica Courier PDF Tools AG Premium PDF Technology 3 Heights PDF Viewer NET WPF Control Version 4 5 Page 20 of 21 July 2 2015 5 If the font is embedded then it is converted to outlines 6 In all other cases the nearest font from the installed font collection is used Using the Font Mapping File fonts ini fonts ini is a configuration file to map fonts used in the PDF to fonts pre installed on the system The mapping file must reside a directory named Fonts which must be a direct sub directory of where the main DLL or executable resides The mapping file is optional It consists of two sections fonts and replace Both sections are used to map fonts in the PDF to fonts in the installed font collection on the operating system This comes into play when the font in the PDF document does not have an embedded font program or the embedded font is not u
7. 5 Is the brush to use for the rectangular overlays of search results ShowOutlines bool ShowOutlines Get and set the show status of the document outlines If set to true the outline pane is visible Default true ShowThumbnails bool ShowThumbnails Get and set the show status of the page thumbnails If set to true the thumnail pane is visible PDF Tools AG Premium PDF Technology 3 Heights PDF Viewer NET WPF Control Version 4 5 Page 18 of 21 July 2 2015 Default true UserUnit double UserUnit Get the documents user unit measure in points 1 pt 1 72 inch Default 1 0 Zoom double Zoom Get and set the zoom factor A zoom factor of 1 0 denotes true size The zoom factor depends on the fit mode and the size of the viewport Default depends on fit mode 5 3 Delegates SearchResultDelegate void SearchResultDelegate string searchText bool success If Search and SearchNext is used then this delegate is called back if the search operation terminates The string parameter returns the text which was searched for and a bool which returns true if the text was found PDF Tools AG Premium PDF Technology 3 Heights PDF Viewer NET WPF Control Version 4 5 Page 19 of 21 July 2 2015 Tips Tricks and Troubleshooting 6 1 Performance The 3 Heights PDF Viewer NET WPF Control provides a variety of settings to tune the performance In most
8. End void SearchEnd Terminate a previously started text search operation Highlights from previous text searches are removed ScrollToBottom Method void ScrollToBottom Scrolls vertically to the bottom of the current view ScrollToLeftEnd Method void ScrollToLeftEnd Scrolls to the horizontally to the beginning of the current view ScrollToRightEnd Method void ScrollToRightEnd Scrolls to the horizontally to the end of the current view PDF Tools AG Premium PDF Technology 3 Heights PDF Viewer NET WPF Control Version 4 5 Page 16 of 21 July 2 2015 ScrollToTop Method void ScrollToTop Scrolls vertically to the top of the current view SetLicenseKey bool SetLicenseKey string licenseKey Set the license key The call to this method is required if the license key is passed programmatically If the license key has been installed using the license manager then this call is obsolete Parameters licenseKey The license key string Return value True if the license key is valid False otherwise GetLicenselsValid bool GetLicenseIsValid Check whether the license key is valid Return value True ifa valid license key was found False otherwise 5 2 Properties Border double Border Get and set the border size in user units Default 0 Destination Destination Destination Get and set the actual destination in the docum
9. S LLICSMSCK CY aae E 16 GetLicenselsValid nere REIR ERE ERYR ERE 16 Propertl8s r n RRRERRREERRRORRXXRRRREFER RR nenne 16 BONN MEET 16 Destination 16 IEitMode soe eMe 16 La yYOUTMOUG f I 17 PageCo nt n n 17 PAGONG UUDUEUUDUDDDEUEUUDUDUDUDDDUDUDEUEDET 17 I esolitiOnu cones a nude eU miU IM IE 17 Dc 17 SearchOverlayBrush saiia anakaa aa aa ana aaa karahana karahaan ani hana arabai binitin hikas 17 SMOWOUTINGS cea E EEEE EEI AA AAA AARAA ERE 17 ShowThumbnails eesesssessssesseeseeeeneenenn nnn nnne nennen nnn n nnns nnn nnns nnns nnns nnns anann 17 MISS T MIE EL 18 ZOOM n 18 DOIG AICS I 18 SearchResultDelegate sssssssssssssssseeeee eene nennen nnns nnne nennen nnns 18 Tips Tricks and Troubleshooting PerfORaFi6e sr a tse aac E ree e er e erede dada ahaha taste REA 19 F ntsand Text M 19 Font Replacement Strategy ssssssssssssssssssseeneneee enne nnne nnnnenrr nnn nnn 19 Using the Font Mapping File fonts ini essssssssseeen nnn 20 UnimplementedTeatlires 0 2 nannte 21 PDF Tools AG Premium PDF Technology 3 Heights PDF Viewer NET WPF Control Version 4 5 Page 4 of 21 J
10. Volume Pagef PY V M 0 1CA0J YTC HL FR BAT REN v riim mS ee Maintainance Expiration 2033 12 31 2 Lniaht TRM Tanana ta ANE Camcartar Chall List all installed license keys The license manager always shows a list of all installed license keys in the left pane of the window This includes licenses of other PDF Tools products The user can choose between e Licenses available for all users Administrator rights are needed for modifications e Licenses available for the current user only Add and delete license keys License keys can be added or deleted with the Add Key and Delete buttons in the toolbar e The Add key button installs the license key into the currently selected list e The Delete button deletes the currently selected license keys Display the properties of a license If a license is selected in the license list its properties are displayed in the right pane of the window PDF Tools AG Premium PDF Technology 3 Heights PDF Viewer NET WPF Control Version 4 5 Page 9 of 21 July 2 2015 Select between different license keys for a single product More than one license key can be installed for a specific product The checkbox on the left side in the license list marks the currently active license key 3 2 Command Line License Manager Tool The command line license manager tool licmgr is available in the bin directory for all platforms except
11. ecutable binary code e binw64 Contains the runtime executable binary code that is specific for 64 bit platform e doc Contains documentation files e Samples Contains sample programs to run the component 5 Ensure the two system environment variables TEMP and TMP exist and point to an existing directory This directory is required to temporarily install fonts that are embedded in PDF documents Control Panel gt System gt Advanced gt Environment Variables F Environment Variables a User variables for hba Variable Value System variables Variable Value z PSModulePath C windows system32 WindowsPowerS TEMP C TEMP 3 TMP C VTEMP E USERNAME SYSTEM Here is an overview of the files that come with the PDF Viewer There is also the option to download the software as MSI file which makes the installation easier PDF Tools AG Premium PDF Technology 3 Heights PDF Viewer NET WPF Control Version 4 5 Page 7 of 21 July 2 2015 bin PdfViewerAPI all bin x64 PdfViewerAPI all bin PdfViewerNET dil bin PdfViewerWPF dil bin PdfViewerWPF xml doc pdf Samples The native DLL contains the main functionality for 32 bit platforms The native DLL contains the main functionality for 64 bit platforms The NET interface DLL is a wrapper to the native DLL required The NET assembly of the PDF Viewer component required The inter
12. ent Setting the destination navigates to the corresponding position in the document If the zoom is 0 the current zoom is used The page denotes the first page in the viewport The x and y positions denote the top left corner in the viewport FitMode FitMode FitMode Get and set the fit mode The fit mode defines whether the whole page or the page width fits into the view port or the page is shown in its true size Default FitWidth PDF Tools AG Premium PDF Technology 3 Heights PDF Viewer NET WPF Control Version 4 5 Page 17 of 21 July 2 2015 LayoutMode LayoutMode LayoutMode Get and set the layout mode The layout mode defines whether the view port shows a part of a single page or of the whole document Default LayoutDocument PageCount int PageCount Get the number of pages in the document Zero if the document is not open PageNo int PageNo Get and set the page number Setting the page number navigates to the given page see Destination Resolution Resolution Resolution Get and set the display resolution in dpi Initially the resolution is set to the resolution of the display device Rotate int Rotate Get and set the rotate angle in multiples of 90 degrees Each individual page is rotated by the given angle Default 0 SearchOverlayBrush Property Brush SearchOverlayBrush Accessors Get Set Default lightblue SolidColorBrush with opacity of 0
13. face documentation for Visual Studio The user s manual and programming reference Sample programs to run the component PDF Tools AG Premium PDF Technology 3 Heights PDF Viewer NET WPF Control Version 4 5 Page 8 of 21 July 2 2015 License Management 3 1 There are three possibilities to pass the license key to the application 1 The license key is installed using the GUI tool Graphical user interface This is the easiest way if the licenses are managed manually It is only available on Windows 2 The license key is installed using the shell tool This is the preferred solution for all non Windows systems and for automated license management 3 The license key is passed to the application at runtime via the LicenseKey property This is the preferred solution for OEM scenarios Graphical License Manager Tool The GUI tool LicenseManager exe is located in the bin directory of the product kit PDF Tools License Ma File Edit Help X 5 Add Key Delete Refresh List All Users Curent User License Properties 3 Heights TM Document Converter Name Value V f 0 10A0M EUR EEE Key 0 J0A94 CR RI La A 0 BCASN VEI ET PL PREIS Product 3 Heights TM Image 3 Heights TM Image to PDF Converter API af Intended Use Productive V v 0 J0A94 iiini Un niat C n B S v Platform Windows 3 Heights TM Image to PDF Converter Service v
14. mpty string if Viewer Open dialog FileName null if PdfViewerWPF GetLicenseIsValid else PasswordWindow window new PasswordWindow Viewer Open dialog FileName window Password 4 4 Navigate There are various ways how the user can navigate in a document with the viewer control The application programmer has all options to enable disable or limit the user s navigation The following features can be used to navigate PDF Tools AG Premium PDF Technology 4 5 3 Heights PDF Viewer NET WPF Control Version 4 5 Page 13 of 21 July 2 2015 e Use the property Page to set page number to be displayed The page range goes from 1 to PageCount e Use the mouse e Use horizontal and vertical scroll bars e Use the mouse wheel to scroll e Use the property Destination to move to a specific location and zoom level within the document e Use the outlines bookmarks or thumbnails from the navigation panel at left hand side of the control to random access a position e Internal and external links within the content of the PDF document can also be used to navigate Use Custom Styles to Modify the Control The PdfViewerWPF control can be customized using custom styles Note that named controls e g PART MainViewer may not be removed from the style file They may be hidden though Example create a custom style resource CustomStyle xaml and add it to the control in MainWindow xaml
15. nse Keys rer terere pere Pe verus 9 Add arid delete license Keys tei ttes espe tare ipe dsee d pet dues d peo dsss Des dsse ose dado dede 9 Select between different license keys for a single product sssssssssseee 9 3 3 License Key Storage i isi nr Ee HII ail nine eet FREE ERE niin nn nin Fe bd eu Ed EHPTS 9 441 Getting started erre E erster tere VeveVeveV evel ENE ET EN EN vet ever ever NEN PENET 10 42 30bD6ndafile eeeneenteseeMEMMEMI III IM etree erereee 12 4 3 OPM er TIS tsinga DassWOldu ciue nts Yee eects nega vee UMEmEE UII 12 44 INAVIQ ALG SERERERERRRERERERERERERERENGREREREREIENFRERFRENTHENFRERENENCNENCHENENE a 12 4 5 Use Custom Styles to Modify the Control eene 13 M iere 14 ClOSB ccc eenonono cuneo ne dcumengsne dune Mi Ii S 14 DISPOSE ss 5555555555555 beh Seis be bas bagi badd ba ad bad seeded ds LG La da 14 ie 14 OpenMlri ier aaa Re Ra RR RP RR RES 14 Search E 15 VSETKO AIDT EDS E 15 Sear hE NAs i eE a cave bevy a MS 15 SCHOlTOBOt Mauser ee en 15 SCHOMTOL SHEN Euren 15 ferelliKel iei 15 Rofo ge Kelle o H U M RMS 16 PDF Tools AG Premium PDF Technology 3 Heights PDF Viewer NET WPF Control Version 4 5 Page 3 of 21 July 2 2015 5 2 5 3 6 1 6 2 6 3 M
16. password Open a document from a memory block This method makes the objects in the document accessible If there is an already open document it is closed first Parameters memBlock Memory block containing the document stream as one dimensional byte array PDF Tools AG Premium PDF Technology 3 Heights PDF Viewer NET WPF Control Version 4 5 Page 15 of 21 July 2 2015 password The user or the owner password of the encrypted PDF document If this parameter is null or an empty string the default i e no password is used If the document is not a PDF document this parameter is ignored Return value True _ if the file could be opened False otherwise Search void Search string searchText SearchResultDelegate resultDelegate Search text in the document The search starts at the current page In the case of a successful search the document is positioned to the next occurrence of the text and the found string is highlighted Parameters searchText The text to search resultDelegate Callback for the result of the current search SearchNext void SearchNext SearchResultDelegate resultDelegate Continue a previously started text search operation The search starts at the current page In the case of a successful search the document is positioned to the next occurrence of the text and the found string is highlighted Parameters resultDelegate Callback for the result of the current search Search
17. port for touch input Multi touch zoom and scrolling inertia Formats Input Formats e PDF 1 0 1 7 PDF A PDF Tools AG Premium PDF Technology 3 Heights PDF Viewer NET WPF Control Version 4 5 Page 5 of 21 July 2 2015 Compliance Standards ISO 32000 1 PDF 1 7 ISO 19005 1 PDF A 1 ISO 19005 2 PDF A 2 ISO 19005 3 PDF A 3 1 2 Interfaces The API interface technology is suitable for all NET languages such as C and VB NET 1 3 Operating Systems Windows XP Vista 7 8 32 and 64 bit Windows Server 2003 2008 2008 R2 2012 32 and 64 bit PDF Tools AG Premium PDF Technology 3 Heights PDF Viewer NET WPF Control Version 4 5 Page 6 of 21 July 2 2015 Installation The software distribution kit of the 3 Heights PDF Viewer NET WPF Control comes as a ZIP archive containing various files including runtime binary executable code files required for the developer documentation and license terms There is a single ZIP archive available suitable for both 32 bit platforms as well as 64 bit platforms 1 Download the ZIP archive of the product for your specific platform from your download account at www pdf tools com Open the ZIP archive Check the appropriate option to preserve file paths folder names and unzip the archive to a local folder e g C program files pdf tools 4 The unzip process now creates the following subdirectories e bin Contains the standard runtime ex
18. s font directory and open it by double clicking The first line in the property window displays the font family name this may vary depending on the operating system The font family name does not include font styles so an example of a font family name is Arial but not Arial Italic font_style is an optional style that is added coma separated after the font family name The style is always one word Examples of font styles are Italic Bold Boldltalic Example fonts Ryumin Light MS Mincho GothicBBB Medium MS Gothic replace PDF Tools AG Premium PDF Technology 3 Heights PDF Viewer NET WPF Control Version 4 5 Page 21 of 21 July 2 2015 Ariallta Arial BoldItalic 6 3 Unimplemented features The 3 Heigths rendering engine supports transparency functions such as a number of blend modes as well as isolated and non isolated transparency groups but not transparency in general Certain types of tiling and shading patterns may not correctly be reproduced by the rendering engine PDF Tools AG Premium PDF Technology
19. sable The mapping only works if the font types of the specified fonts are matching e g if the font in the PDF is a symbolic font such as Symbol or ZapfdingBats the mapped font must be symbolic too The section fonts is only considered if the font matcher does not find an appropriate font amongst the existing installed fonts It is suggested to only use this section The section replace is stronger and applied before the font matcher This means a font will be replaced as defined even if the correct installed font is available on the system Syntax The syntax of the mapping file is this fonts PDF font l installed font 1l font style PDF font 2 installed font 2 font style replace PDF font n installed font n font style PDF font is the name of the font in the PDF This name can be found in one of the following ways e Use any tool that can list fonts Such as 3 Heights PDF Extract or 3 Heights PDF Optimization Ignore possible prefixes of subset fonts A subset prefix consists of 6 characters followed by the plus sign For example KHFOKE MonotypeCorsiva in this case only use MonotypeCorsiva as font name in the mapping file e Open the document with Adobe Acrobat use the MarkUp Text Tool C mark the text of which you would like to know the font name right click it select Properties installed_font_ is the font family name of the installed font To retrieve this name find the font in the Window
20. uly 2 2015 Introduction 1 1 Description The 3 Heights PDF Viewer NET WPF Control is a component which can be seamlessly integrated in NET Windows Presentation Foundation WPF applications The control offers many options for displaying PDF documents files can be viewed in single page or multi page mode and the navigation supports links bookmarks and calling up pages arbitrarily The component supports PDF documents in many languages the reproduction of Japanese Chinese Korean Russian etc is no problem at all Viewing e Display PDF file in single page or multi page mode e Enter password to decrypt PDF documents e Open files from file system or from internet HTTP HTTPS FTP e Query the number of pages in a document e Scale the display fit to page size fit to page width actual size zoom e Set display resolution e Reproduce documents with Chinese Japanese and Korean fonts CJK e Read document from file or memory e Convert viewer coordinates to PDF coordinates e Rotate the page e Set the border size Navigation e Show and hide windows for bookmarks and page thumbnails e Jump to a bookmark s location e Jump to the location of a link within the document e Move windows vertically and horizontally using the mouse or keyboard e Enlarge and reduce windows with the aid of a zoom rectangle or zoom factor e Freely select any page in the document for display e Query the position of the cursor e Text search e Sup
Download Pdf Manuals
Related Search