KeyView Software Version 12.6 Viewing SDK Programming Guide Document Release Date: June 2020 Software Release Date: June 2020 Viewing SDK Programming Guide Legal notices Copyright notice © Copyright 2016-2020 Micro Focus or one of its affiliates. The only warranties for products and services of Micro Focus and its affiliates and licensors (“Micro Focus”) are set forth in the express warranty statements accompanying such products and services. Nothing herein should be construed as constituting an additional warranty. Micro Focus shall not be liable for technical or editorial errors or omissions contained herein. The information contained herein is subject to change without notice. Documentation updates The title page of this document contains the following identifying information: l Software Version number, which indicates the software version. l Document Release Date, which changes each time the document is updated. l Software Release Date, which indicates the release date of this version of the software. To check for updated documentation, visit https://www.microfocus.com/support-and-services/documentation/. Support Visit the MySupport portal to access contact information and details about the products, services, and support that Micro Focus offers. This portal also provides customer self-solve capabilities. It gives you a fast and efficient way to access interactive technical support tools needed to manage your business. As a valued support customer, you can benefit by using the MySupport portal to: l Search for knowledge documents of interest l Access product documentation l View software vulnerability alerts l Enter into discussions with other software customers l Download software patches l Manage software licenses, downloads, and support contracts l Submit and track service requests l Contact customer support l View information about all services that Support offers Many areas of the portal require you to sign in. If you need an account, you can create one when prompted to sign in. To learn about the different access levels the portal uses, see the Access Levels descriptions. KeyView (12.6) Page 2 of 387 Viewing SDK Programming Guide Contents Part I: Overview of Viewing SDK 13 Chapter 1: Introduction to Viewing SDK 14 Overview 14 Features 14 Viewing SDK and Visual Basic 15 Platforms, Compilers, and Dependencies 15 Supported Platforms 15 Supported Compilers 15 Software Dependencies 15 Windows Installation 16 Package Contents 17 License Information 17 Enable Advanced Document Readers 18 Update License Information 18 Directory Structure 19 Chapter 2: Getting Started 22 Before You Begin 22 View Initialization Information 22 Use an Initialization File 22 Viewing API 23 ActiveX Control 23 Use the Windows Registry File 23 Viewing API 24 ActiveX Control 24 Remove Functionality from an Application 25 Deploy Viewing API Applications 25 Deploy ActiveX Control Applications 26 Develop .NET Applications 26 Method and Property Naming Conventions 27 Sample Code 27 Deploy .NET Applications 28 Part II: Viewing API 30 Chapter 3: Use the Viewing API 31 Overview of the Viewing API 31 Create a Viewing API Window 32 Get the Viewer Window of the Document 33 Open and View a Document 33 Notification Messages 34 Save a Document 34 KeyView (12.6) Page 3 of 387 Viewing SDK Programming Guide Convert a Document 35 Print a Document 35 Change the Print Job Name 36 Determine the Document Format 36 Extract Document Metadata 37 Change Document Options 37 Annotate, Highlight, or Index a Document 37 Draw a Page 38 Draw a Page into a Supplied Device Context 38 Edit a Document 38 Search for Text 38 Copy Text 39 Modify the Document View 39 Change the Layout of a Document 39 Change the Aspect Ratio of a Document 39 Invert, Rotate, or Magnify a Document 39 Display or Hide Gridlines in a Document 40 Play a Multimedia Document 40 Change the Current Object in a Document 41 View Deleted Items and Document Revision Marks 41 View Container Files 42 Microsoft Outlook Personal Folders (PST) Files 42 Choose the Reader to use for PST Files 43 Lotus Notes Database (NSF) 44 System Requirements 44 Installation and Configuration 45 Format Notes 45 View Mail Messages and Mail Stores 45 View Archive Files 47 Extract Subfiles to a Viewing Window or Disk 48 Display Subfiles in the Preview Pane 48 Set a Password for a Container File 49 View PDF Documents 49 Use the Acrobat ActiveX Control 49 Use the Microsoft WebBrowser ActiveX Control 49 Use a Graphic-Based PDF Reader 50 Use the kppdfrdr Reader 50 Use the kppdf2rdr Reader 51 Specify the Graphic-based Reader 51 View or Extract PDF Portfolio Documents 52 View Microsoft Visio Files 53 Extract Microsoft Excel Formulas 53 Chapter 4: Viewing API Sample Programs 56 Overview 56 Compile the Sample Programs 56 Run the Sample Programs 56 KeyView (12.6) Page 4 of 387 Viewing SDK Programming Guide Viewing SDK Initialization Information 56 hellovapi 57 Load kvvapi.dll 57 Create the VAPI Window 57 Open a Document 58 hellovapi.c 59 hellovapi.h 64 hellovapi.rc 64 vapidemo 64 mfckv 64 rtfdemo 65 prntdemo 65 filetype 65 ihademo 65 drawdemo 66 uzipdemo 66 Chapter 5: Message Parameters 67 VAPIM_ANNOTATE 69 VAPIM_ENABLEINDEX 70 VAPIM_GETNEXTTEXTBUFFER 72 VAPIM_GETPAGEFROMLOGICAL 72 VAPIM_GETSUMMARYINFO 73 VAPIM_GETTEXT 74 VAPIM_GOTO_PAGE 74 VAPIM_HAVEHILITE 75 VAPIM_POSITION 75 VAPIM_POSITIONHILITE 76 VAPIM_SETCURSOR 77 VAPIM_SETHILITE 77 VAPIM_SETHILITEOPTIONS 78 VAPIM_SETINDEXBUFCHARSET 79 VAPIM_SHOWHITS 79 VAPIM_CONVERT 80 VAPIMWP_CANCONVERT 81 VAPIMWP_DRAW_DRAWPAGE 81 VAPIMWP_DRAW_DRAWTOFILE 83 VAPIMWP_DRAW_GETPAGECOUNT 84 VAPIMWP_DRAW_GETPAGESIZE 84 VAPIMWP_DRAW_GETWORKBOOKPAGECOUNT 85 VAPIMWP_DRAW_INIT 86 VAPIMWP_DRAW_SHUTDOWN 87 VAPIMWP_EDIT_CANCOPY 87 VAPIMWP_EDIT_CANFIND 88 VAPIMWP_EDIT_CANSELECTALL 89 VAPIMWP_EDIT_COPY 90 VAPIMWP_EDIT_FIND 90 KeyView (12.6) Page 5 of 387 Viewing SDK Programming Guide VAPIMWP_EDIT_FIND_UNICODE 91 VAPIMWP_EDIT_GETFINDTEXT 91 VAPIMWP_EDIT_SELECTALL 92 VAPIMWP_FILE_CANSAVEAS 93 VAPIMWP_FILE_CANUNZIP 94 VAPIMWP_FILE_CLOSE 94 VAPIMWP_FILE_SAVEAS 95 VAPIMWP_FILE_UNZIP 95 VAPIMWP_INIT_GETCHARSET 96 VAPIMWP_INIT_GETDESCRIP 97 VAPIMWP_INIT_GETDOCCLASS 97 VAPIMWP_INIT_GETDOCFORMAT 98 VAPIMWP_INIT_GETFILENAME 99 VAPIMWP_INIT_GETHWNDVIEWER 100 VAPIMWP_INIT_JUMPTOFIRSTHILIITE 100 VAPIMWP_INIT_OPEN_DOCUMENT 101 VAPIMWP_INIT_SETPASSWORD 103 VAPIMWP_INIT_SETSRCCHARSET 104 VAPIMWP_INIT_SETTRGCHARSET 104 VAPIMWP_MULTIOBJ_CANMULTIOBJ 105 VAPIMWP_MULTIOBJ_CANNEXTOBJ 106 VAPIMWP_MULTIOBJ_CANPREVOBJ 107 VAPIMWP_MULTIOBJ_CANSETCURRENTOBJ 107 VAPIMWP_MULTIOBJ_GETOBJCOUNT 108 VAPIMWP_MULTIOBJ_NEXTOBJ 109 VAPIMWP_MULTIOBJ_OBJNAME 109 VAPIMWP_MULTIOBJ_PREVOBJ 110 VAPIMWP_MULTIOBJ_SETCURRENTOBJ 111 VAPIMWP_OPTIONS_GETOPTIONS_EX 111 VAPIMWP_OPTIONS_SETOPTIONS_EX 112 VAPIMWP_PRINT_ANNOTATIONS 113 VAPIMWP_PRINT_CANPRINT 114 VAPIMWP_PRINT_PAGESETUP 114 VAPIMWP_PRINT_PRINT 115 VAPIMWP_PRINT_PRINTHEADER 116 VAPIMWP_PRINT_PRINTSETUP 116 VAPIMWP_PRINT_PRINTTOPD 117 VAPIMWP_PRINT_PRINTTOPRINTER 117 VAPIMWP_PRINT_SETPRINTNAME 118 VAPIMWP_VIEW_CANASPECTRATIO 119 VAPIMWP_VIEW_CANDECREASEFONT 120 VAPIMWP_VIEW_CANFITTOWINDOW 120 VAPIMWP_VIEW_CANGOTO 121 VAPIMWP_VIEW_CANGRIDLINES 122 VAPIMWP_VIEW_CANINCREASEFONT 122 VAPIMWP_VIEW_CANINVERT 123 KeyView (12.6) Page 6 of 387 Viewing SDK Programming Guide VAPIMWP_VIEW_CANLAYOUT 124 VAPIMWP_VIEW_CANMAGNIFY 125 VAPIMWP_VIEW_CANPAUSE 125 VAPIMWP_VIEW_CANPLAY 126 VAPIMWP_VIEW_CANPREVIEWPANE 127 VAPIMWP_VIEW_CANROTATE 128 VAPIMWP_VIEW_CANSTOP 128 VAPIMWP_VIEW_DECREASEFONT 129 VAPIMWP_VIEW_END 130 VAPIMWP_VIEW_GETASPECTRATIO 130 VAPIMWP_VIEW_GETGRIDLINES 131 VAPIMWP_VIEW_GETINVERT 132 VAPIMWP_VIEW_GETLAYOUT 133 VAPIMWP_VIEW_GETMAGNIFY 133 VAPIMWP_VIEW_GETPLAYMODE 134 VAPIMWP_VIEW_GETPREVIEWPANE 135 VAPIMWP_VIEW_GETROTATE 136 VAPIMWP_VIEW_GOTOPAGE 136 VAPIMWP_VIEW_INCREASEFONT 137 VAPIMWP_VIEW_LOOP 138 VAPIMWP_VIEW_PAUSE 138 VAPIMWP_VIEW_PLAY 139 VAPIMWP_VIEW_SETASPECTRATIO 139 VAPIMWP_VIEW_SETGRIDLINES 140 VAPIMWP_VIEW_SETINVERT 141 VAPIMWP_VIEW_SETLAYOUT 141 VAPIMWP_VIEW_SETMAGNIFY 142 VAPIMWP_VIEW_SETPREVIEWPANE 143 VAPIMWP_VIEW_SETROTATE 144 VAPIMWP_VIEW_STOP 144 Chapter 6: Notification Message Parameters 146 VAPINM_ANNOTATION_HIT 146 VAPINM_EXTENT 147 VAPINM_SELECTION 148 VAPINM_TEXTBUFFER 148 VAPINM_USERCLICK 150 VAPINM_VIEW_FILE 150 VAPINMWP_INIT_DISABLEUI 151 VAPINMWP_INIT_DOCTYPE 152 VAPINMWP_INIT_GETTEMPFILEPATH 152 VAPINMWP_INIT_OPENDOCDONE 153 VAPINMWP_INIT_PAGENUMBER 154 VAPINMWP_MULTIOBJ_OBJNAME 154 VAPINMWP_OPTIONS_GETOPTIONS_EX 155 VAPINMWP_PRINT_PRINTDONE 156 Chapter 7: Structures 157 KeyView (12.6) Page 7 of 387 Viewing SDK Programming Guide ADDOCINFO 157 ALL_OPTIONS_EX 158 KPTPIOobj 159 KVSumInfoElemEx 160 KVSummaryInfoEx 160 TPVAPIAnnotation 161 TPVAPIConvert 162 TPVAPICreateParams 163 TPVAPIDrawFileInfo 164 TPVAPIDrawPageInfo 165 TPVAPIExtract 166 TPVAPIFindInfo 167 TPVAPIFirstLast 168 TPVAPIGetText 168 TPVAPIHiLiteColor 169 TPVAPIHiLiteOptions 170 TPVAPIOpenDocumentInfo 170 TPVAPIPageSize 174 TPVAPIPosition 175 TPVAPITextInfo 176 Part III: Viewing ActiveX Control 177 Chapter 8: Use the Viewing ActiveX Control 178 Overview of the Viewing ActiveX Control 178 Open and View a Document 179 Save a Document 179 Convert a Document 180 Print a Document 180 Determine the Document Format 181 Extract Document Metadata 181 Search for Text in a Document 181 Copy a Selected Area of Text 182 Copy all the Text in a Document 182 Create a Thumbnail Image of a Document Page 182 Filter a Document 183 Highlight Text in a Document 183 Annotate Text in a Document 183 Chapter 9: Control Sample Programs 184 Viewing