Home

PDF-XChange Viewer ActiveX SDK - Tracker Software Products Ltd

1. Contents Rect Styles lt ltem gt Stamp Styles lt ltem gt Sticky Note Styles lt ltem gt StrikeOut Styles lt ltem gt TextBox Styles lt ltem gt TIPEWTIEN a Aenea alien Aa elie ied 129 Styl6S ANA atest rane Median ad eae a 130 MEMO A AA AAA AAA AAA ee 130 Underline Styles MMS RI AA Deets betel abst 132 DOCUMENTS NN A AAA ad Wave Miia nite 133 steme A ia 135 lt Methodss ui A Mi aii elas 138 AGA TACO Meira AAA AAA ada 138 GlearOperations HIST A ee ad ee ee Gee ii 138 Clear Selections xcsexscent atti SOA A ela 139 COS a disdain anid ee de Aia 139 Delete AllA ta hMeNtS pcia AAA AAA A 140 Delete Atacama AAA A AA 140 DeletePages Export ExtractPages Flush GetAllSelected Texto A ee ee 143 CAME A naw eid chien i Ble isan Ll eee 143 GetATIACHMENIDES Ctra thine Andie Higashi edie Aba 144 GetAttachmentMod Date 27 22 40 ete A ek a eas 145 GetAttachmentName sis chiens wie deine cd eee 145 GetAttachments Gov ited aati el ie Aine Mie 146 GeEtATACHMENISIZ csi ose ores dened vice genes a A 146 GetSelectedAnnnotswies a vies e ed ten ee ees 147 GetS lectedFields s26 202 che oie tnt tein Naot Aether hk ee ev a a te SA 147 GetSelectedPage Thumbnails siis aicen a e T A a a as 148 GetSelectedWidget CA a en a NEN AS HighlightSelectioN iiniu dad Highlight lextBy File sucia E E T InSertEmplyPAgES vicodin ea a vad E o arai saen InsertPages IsOperationGrantS O cusiiroiini iaa
2. Gets all text to specified file DoVerb Documents 0 GetAllSelectedText C PdfText txt NULL 0 Gets all text to stream object which contained in Dataln DoVerb Documents 0 GetAllSelectedText Dataln NULL 0 See Also IPDFXCview DoVerb Objects Documents lt ltem gt Gets all text from current document Name GetAllText m PDF XChange Viewer ActiveX SDK Arguments 1 No BSTR Specifies path to output file in which text will be stored Stream Specifies stream object in which text will be stored 2 No Boolea Exclude new line characters from output CR LF Default value is false n Outputs 1 BSTR Output text Appears only when first argument is not specified Return Value Returns S_OK on success or an error value otherwise To obtain the text description of a received error code use IPDFXCview GetTextFromResult Remarks For example in pseudocode Gets all text to string variable DataOut DoVerb Documents 0 GetAllText NULL DataOut 0 Gets all text to specified file DoVerb Documents 0 GetAllText C PdfText txt NULL 0 Gets all text to stream object which contained in Dataln DoVerb Documents 0 GetAllText Dataln NULL 0 See Also IPDFXCview DoVerb Objects Documents lt ltem gt Gets name of the attachment Name GetAttachmentName Arguments 1 Yes LONG The zero based index of the attachment in the attachments list or name of
3. Integer String R Integer String RW Integer String R Integer String R Integer String R Integer String R Integer String RW Description Description Contains number of all pages in the document Contains index of the current page Specifies page magnification coefficient zoom in the page view window For possible values see the Pages Magnifications Specifies page magnification mode For possible values see the Pages Magnification Modes Specifies page layout in the page view window For possible values see the Pages Layouts Contains actual width in pixels of the pages view Contains actual height in pixels of the pages view Contains actual X position of the top left corner of pages view window relative to desktop Contains actual Y position of the top left corner of pages view window relative to desktop Specifies the display rotation factor of the page view number of degrees multiple 90 Gets pages with any selection Reference 161 This object is an array of items each item is represented by lt ltem gt For more information about object names notation see Object Name Notation Examples for usage in pseudocode 1 1 get pages count DoVerb Documents 4095 Pages Count get Dataln DataOut 0 or GetProperty Documents 4095 Pages Count DataOut 0 or DoDocumentVerb 4095 Pages Count get Dataln DataOut 0 or
4. Name DiscardAllCachedChanges Arguments Nothing Return Value Returns S_OK on success or an error value otherwise To obtain the text description of a received error code use IPDFXCview GetTextFromResult See Also IPDFXCview DoVerb IPDFXCview DiscardAllCachedChanges 2 2 1 11ExecuteCommand This operation can be used to perform a Ul command Name ExecuteCommand Arguments Req Type Description 1 Yes LONG The unique identifier or special unique name of the Ul command For more BSTR information see Objects Commands Return Value Returns S_OK or an error value otherwise For obtaining text description of received error code you can use IPDFXCview GetTextFromResult See Also IPDFXCview DoVerb Objects Commands 2 2 1 12ExportDocument Exports a document to an image file s with the format parameters previously defined by Objects Export Name Reference 55 ExportDocument Arguments 1 Yes LONG The unique identifier of the document or full file name of the document BSTR Return Value Returns S_OK on success or an error value otherwise To obtain the text description of a received error code use IPDFXCview GetTextFromResult See Also IPDFXCview DoVerb IPDFXCview ExportDocument 2 2 1 13 ExtractDocumentPages Extracts pages from PDF document using parameters previously defined by Objects Operations ExtractPages Name ExtractDocumentPages Arguments 1 Yes LONG The un
5. SetProperty Operations ExtractPages RangeType Exact SetProperty Operations ExtractPages RangeText 1 5 10 pages DoVerb Documents 0 ExtractPages NULL NULL PXCVA_NoUI See Also IPDFXCview DoVerb Operations ExtractDocumentPages Objects Operations ExtractPages Flushes all of the user s cached changes for a document stops editing and updates document s structure Can be used before saving of the document Name Flush Arguments Reference m None Return Value Returns S_OK on success or an error value otherwise To obtain the text description of a received error code use IPDFXCview GetTextFromResult See Also IPDFXCview DoVerb IPDFXCview FlushDocument Objects Documents lt ltem gt Gets all selected text from current document Name GetAllSelectedText Arguments 1 No BSTR Specifies path to output file in which text will be stored Stream Specifies stream object in which text will be stored 2 No Boolea Exclude new line characters from output CR LF Default value is false n Outputs 1 BSTR Output text Appears only when first argument is not specified Return Value Returns S_OK on success or an error value otherwise To obtain the text description of a received error code use IPDFXCview GetTextFromResult Remarks For example in pseudocode Gets all text to string variable DataOut DoVerb Documents 0 GetAllSelectedText NULL DataOut 0
6. ecceeeesseseceeseeeseeeseeeseeeaeeeaeeeaeceaessaecsaecsaesseesaeeeseetaeeeseeeaeeeaeeeaeeeaeees Tex tAligh wty ss cid ANG A tel ag Ae ha ee Text Editor Notifications Filter FlAgS mcimmiaianara e a ir Text File Pacing Modes A a it Text Rendering Mode tics eee itech terete et nn pane tele neat eine ele ceed nee TOOIS a en wth ite ete ie ei abies ies SA als Se a le ae User Choices User Interface Languages Simple Notifications Global WT Athan as Catena ard envy neat aia A EN NNA Select TOO terns arses ee et eee ie ete eae Meee tenets e teetering TEX GEC Res voces A BON A NA aetege ay 3 VAVASCHIPUSUP PONE iii cidcid A A svat T A app Bookmark console Field SR veces sustsuunassdncey sessesuueavacsercdccssucudsdsteiedcedsadedvadbersenedteuedsescey global identity Link OCG TOM Plate ccesecesasesssccassasdstvacsasnescauenstvncssctusbecessestdcodectantacnd AUREA AA AAA andan a adds A aida A gt EMUMOG ratiOn cui dl PXCVA_DocumentSaveFFlagS econ ar 281 PXCVA_EventTypes PROV A A A A it PXCVA_ViewObjectTypesS cnmmcicmcsririrrraaa rar 283 5 Simple ActiveX Control cocida 284 IPDFXCprevieW comicios 284 Methods ii ada 285 Print Vil PDF XChange Viewer ActiveX SDK Propertie Siisera O e o u ds eeen 285 AlloW AC eA toria a E N AEREE 285 Locked Vie W 0 a AAA a ara e E 286 ReadOniy O ca AA A eee ilar cei ieee da Se 286 Settings URL A e e ti aa 287
7. DoVerb Documents 0 RotatePages NULL NULL 0 2 Rotates 1 5 10 pages to 90 degrees in current PDF document SetProperty Operations RotatePages RangeType Exact SetProperty Operations RotatePages RangeText 1 5 10 pages SetProperty Operations RotatePages Direction Clockwise DoVerb Documents 0 RotatePages NULL NULL PXCVA_NoUI See Also IPDFXCview DoVerb Operations RotateDocumentPages Objects Operations RotateP ages Saves a document in a number of different ways depending on the Flags parameter in DoVerb function Name Save Arguments Req Type Description 1 No BSTR The destination file name or Stream Object IStrea m 2 No LONG The save flags For more information see PXCVA_DocumentSaveFlags Return Value Returns S_OK on success or an error value otherwise To obtain the text description of a received error code use IPDFXCview GetTextFromResult Remarks Use this operation to save or copy the specified document To display the standard Save File dialog pass NULL as the Destination file name If you want to skip possible error dialogs then you must set the PXCVA_Flags PXCVA_NoUI flag in the Flags argument For example in pseudocode save first document directly to C TestCopy pdf file DoVerb Documents 0 Save DataIn C TestCopy pdf NULL PXCVA_NoUi save first document to Stream DoVerb Documents 0 SaveDocument DataIn Str
8. Extract pages into the new external file s For possible named values see the Booleans Default value is 0 false If means true then specifies to extract selected pages into the one external file otherwise each page will be extracted into the separated file This option can be used if ExtractToFiles is enabled For possible named values see the Booleans Default value is 0 each page to the new file Specifies the fully qualified name of the folder to receive the new single page PDF files Specifies a macro based file name to use for the created files It supports macros for generic names See Name Generation Macros When enabled the pages will be extracted to separate files named and located according to DestFileName and DestFolder properties For possible named values see the Booleans Default value is 0 false IPDFXCview DoVerb IPDFXCview GetProperty IPDFXCview SetProperty Operations ExtractDocumentPages Objects Documents lt ltem gt ExtractPages 2 2 2 11 3 InsertEmptyPages Reference Allows to specify settings for insertion of empty pages to PDF document Contained Objects Name PaperWidth PaperHeight PaperMode PaperName Orientation Count InsertBefore See Also Type Double RWS Double RWS Integer String RWS String RWS Integer String RWS Integer RWS Integer RWS Description Specifies new pages width in points Default value i
9. Supported Properties All are supported Supported Methods All are supported See Also IPDFXCview RunJavaScript JavaScript for Acrobat API Reference util A static JavaScript object that defines a number of utility methods and convenience functions for string and date formatting and parsing 2 4 2 4 1 Reference Supported Properties There are no properties for this object Supported Methods crackURL 6 mico printf printx spansToXML scand xmlToSpans See Also IPDFXCview RunJavaScript JavaScript for Acrobat API Reference Enumerations Enumerations Enumeration Description PXCVA DocumentSaveFlags The flags shown in this enumeration allow you to use special document save modes see also IPDFXCview SaveDocument PXCVA_EventType The values shown in this enumeration allow you to identify different types of received events see also IPDEXCviewEvents OnEvent PXCVA_Flags The flags shown in this enumeration allow you to condition the behaviour of the various actions Combinations of these flags are usually passed in the last Flags argument PXCVA_ViewObjectType The values shown in this enumeration allow you to determine different types of view objects see also IPDFXCview GetViewObjectFromName See Also IPDFXCview DoVerb IPDFXCview SaveDocument IPDFXCviewEvents OnEvent PXCVA_DocumentSaveFlags The flags shown in this enumeration allow you to use special document save
10. Ul Group Special object for Ul customizing RW Remarks If you want to skip the original dialog you must pass a new non zero value to the UserChoice property You may also change the destination file name at run time For example in pseudocode function OnEvent Type Name Dataln DataOut Flags if Type PXCVA_OnDisplayPrompt if Name Prompts ConfirmDocumentIncSave set another file name SetProperty Prompts ConfirmDocumentIncSave FileName DataIn C Test2 pdf 0 skip original dialog and try to save document into C Test2 pdf SetProperty Prompts ConfirmDocumentIncSave UserChoice Dataln Yes 0 See Also IPDFXCviewEvents OnEvent PXCVA_EventTypes PXCVA_OnDisplayPrompt IPDFXCview SaveDocument IPDFXCview GetProperty IPDFXCview SetProperty 2 2 2 15 2 ConfirmDocumentSave This is a special object for modifying the confirmation dialog when a document was changed to save changes before closing Reference 215 You must implement a special event handler see _IPDFXCviewEvents OnEvent and match the type of the received event with the PXCVA_EventTypes PXCVA_OnDisplayPrompt constants and the name with the Prompts ConfirmDocumentSave string Contained Objects Name Type Description ID Integer Specifies the unique ID of the document R FileName String Represents destination file name for specified R document UserChoice Integer User s choice for this c
11. DashType Integer Specifies line dash type Used if BType is equal String to D RWS For possible named values see the Dash Types Specifies appearance of header which can be placed before each text file Contained Objects UseText Integer Displays the text label in the header String For possible named values see the Booleans RWS Default value is 0 PDF XChange Viewer ActiveX SDK Text String RWS BackColor Integer String RWS UseLine Integer String RWS Line Group RWS LineColor Integer String RWS LineAbove Integer String RWS Defines line style in file header Contained Objects Name Type Width Double RWS BType String RWS DashType Integer String RWS 2 2 2 11 6 RotatePages Allows to specify settings for page rotation Contained Objects Name Type RangeType Integer String RW RangeFilter Integer String RW RangeText String RW Direction Integer Text of header s lt supports macros for generic names See Name Generation Macros The default value is empty Specifies the background color for text label For possible named values see the Colors Default value is 1 none transparent Displays the line in the header For possible named values see the Booleans Default value is 0 Defines line style Specifies line color For possible named values see the Colors Default value is RGB 0 0 0 black Moves the line above the text label in the header For
12. DataOut 112 PDF XChange Viewer ActiveX SDK for i 0 to Count 1 GetProperty Commenting Line Styles i ID See Also Objects Commenting DataOut 0 IPDFXCview DoVerb IPDFXCview GetProperty IPDFXCview SetProperty Defines item template for each commenting line style Contained Objects Name Type ID Integer RS Name String RWS Integer String RWS Start End Integer String RWS FColor Integer String RWS SColor Integer String RWS Double RWS Opacity BlendMode Integer String RWS Border Group RWS DefSubj String RWS DefSubjMode Integer String RWS See Also Objects Commentina Description Specifies the unique ID of the comment style Defines name of comment style Specifies line starting style For possible named values see the Line Ending Default value is 0 none Specifies line endings style For possible named values see the Line Ending Default value is 0 none Specifies fill color for the comment For possible named values see the Colors Default value is 1 none Specifies stroke color for the comment For possible named values see the Colors Default value is RGB 255 0 0 red Specifies the opacity of the comment Default value is 1 0 100 opacity Specifies the blend mode for the comment For possible named values see the Blend Modes Default value is 0 Normal Spec
13. DataOut DoDocumentVerb docID NULL GetSelectionState Dataln DataOut 0 if DataOut 0 we have selection in this document See Also IPDFXCview DoVerb IPDFXCview GetProperty IPDFXCview SetProperty IPDFXCviewE vents OnEvent 2 2 2 10 11 TextEditor Informs about text editing in the document Contained Objects Name Type Description Filter Integer Specifies filter for receiving text editing events For String possible named values see the Text Editor RWS Notifications Filter Flags You may use a combination of one or more of the following values Default value is 0 None Type Integer Represents type of the text editor notification String Contains one value from the Text Editor Notifications R Filter Flagsenumeration except None and All values Document Integer Contains the ID of the document with the active text R editor module Remarks Example for usage in pseudocode 1 enable receiving all text editor events SetProperty Notifications TextEditor Filter A11 0 2 catch selection changes and check selection state for the document function OnEvent Type Name Dataln DataOut Flags if Type PXCVA_OnNamedNotify and Name Notifications TextEditor then obtain notifications type GetProperty Notifications TextEditor Type DataOut PXCVA_GetNamec if DataOut End Reference 195 obtain changed document GetProperty Notifications
14. Dim charsCount As Integer charsCount dataOut If charsCount gt 0 Then Dim j As Long ere J 0 to CharcscCouime T Dim spChar As IPDFXCsmartp Call spPageChars GetItemPointByIndex j spChar If IsNull spChar False Then Call spChar GetProperty Code dataOut 0 Dale tees Sterestem ch ChrW dataOut End Tf Next j 3 7 Delphi var i j integer spDoc spPageChars spChar IPDFXCsmartp dataIn dataOut OleVariant pagesCount charsCount integer iDocID integer ch WideChar begin CoPDFXCviewl DoVerb Documents inttostr iDocID SP dataln dateabut 00 spDoc IDispatch dataOut as IPDFXCsmartp spDoc GetProperty Pages Count dataOut 0 pagesCount dataOut for 1 s 0 to pacgesCoumt i co begin spDoc GetSubPoint Pages inttostr 1 Text Chars spPageChars dataOut 0 spPageChars GetProperty Count dataOut 0 charsCount dataOut or J 0 to caszsCoume 1 elo begin spPageChars GetItemPointByIndex j spChar 1f spChar nil then continue spChar GetProperty Code data0ut 0 ch WideChar integer dataOut end end end See Also IPDFXCview DoVerb Objects Documents lt ltem gt Pages lt ltem gt Text IPDFXCsmartp How to Extract Text from Document To use examples below you should open a document and obtain the unique identifier of the opened document C with ATL Cerdas SAS Sir Clos sa MURO Sa Sesa csi
15. Fit 6 3647 Rotate 180 9 3647 Rotate 90 CCW s PDF XChange Viewer ActiveX SDK 3647 5 3647 4 3647 2 3641 8 3637 2 3637 0 3636 9 3636 8 3636 6 3343 3 3343 3343 3342 3342 3342 3342 3342 3342 3342 3635 3635 3635 3635 3631 3631 Flip Horizontal Flip Vertical Zoom In Show Comment Styles Select All Paste Copy Cut Undo Apply Default Appearance Apply Default Appearance for Selected Links Set Current Link Appearance as Default Make Same Height Make Same Width Distribute Horisontally Align Right Edges Align Rights Edges Align Horizontal Centers Align Left Edges Align Vertical Centers Align Top Edges Ratio Value From Ratio Unit To Show Cover Page in Facing Mode Show Gaps Between Pages Clear Shortcut Reset Shortcut Reference at 3 3633 Properties 3 3633 Insert Separator Before 4 3633 Show Preview 4 3633 Show Text 0 3632 Default Style 8 3632 Delete 7 3632 Reset 6 3631 Reset this Popup Menu 6 Reset this Popup Menu to Defaults 3631 Reset Menu Bar 5 Reset Menu Bar to Defaults 3630 Text Properties 8 Show Text Properties 3630 Diameter 1 Eraser Diameter 3381 Save Embedded File to Disk 3 Save Embedded File to Disk 3381 Open Embedded File 2 Open Embedded File 3629 Delete Collection 6 Delete Selected Collection 3629 Cre
16. IPDFXCview ExportDocument 2 2 2 6 Find Contains all supported properties for simple text searching Contained Objects Name Type Description Text String Specifies text for searching in active PDF RWS document Options Group Specifies find options RWS Remarks To start find text in active document you may execute FindNext Ul commanad See Also IPDFXCview DoVerb IPDFXCview GetProperty IPDFXCview SetProperty Commands List 2 2 2 6 1 Options Contains options for simple text search Contained Objects Name Type Description WholeWordsOnly Integer String Search only whole words RWS For possible named values see the Booleans Default value is 0 CaseSensitive Integer String Use case sensitive search RWS For possible named values see the Booleans Default value is 0 IncludeBookmarks Integer String Search in bookmarks RWS For possible named values see the Booleans Default value is 0 IncludeComments Integer String Search in comments RWS For possible named values see the Booleans Default value is 0 DenyNotFoundMessage _ Integer String Hide message which informs about end of search RWS For possible named values see the Booleans Default value is 0 See Also IPDFXCview DoVerb IPDFXCview GetProperty IPDFXCview SetProperty 2 2 2 7 Forms Allows to specify settings for PDF forms Contained Objects PDF XChange Viewer ActiveX SDK Name Type HighlightFields Group RWS See Also
17. NoToAIll 101 SaveAs 103 Auto Special code that instructs generation of unique names to 102 automatically output files See Objects Prompts ConfirmFileReplace Automatic 102 The same as Auto See Also Objects Prompts 2 2 3 65 User Interface Languages Supported Values String Integer Description Value Value Auto 0 Selects the user s regional settings in UI System Default E Selects the application s default language see also the Objects International DefaultLocalelD Builtln 2 Selects the application s built in language English US English US A i 0x0409 Selects the English US language in Ul English German DE r 0x0407 Selects the German DE language in Ul German French FR 0x040C Selects the French FR language in UI French Russian 0x0419 Selects the Russian language in UI Ukrainian 0x0422 Selects the Ukrainian language in Ul Remarks These values are basic only For other supported languages please look at lt FolderOfExeModule gt Languages folder See also Objects General ApplicationModulePath See Also Objects International LocalelD Reference 2 2 4 Simple Notifications This section represents a groups of special named notifications e Global e Text Editor e Select Tool Remarks Example for usage in pseudocode to prevent keyboard input function OnEvent Type Name DataIn DataOut Flags Type PXCVA_OnNamedNotify and Name Global CheckKey then De 0
18. Operations InsertEmptyDocumentPages Objects Operations InsertEmptyP ages Inserts pages from source document into current document using parameters previously defined by Objects Operations InsertP ages Name IMSS rtrages Arguments None Return Value Returns S_OK on success or an error value otherwise To obtain the text description of a received error code use IPDFXCview GetTextFromResult Remarks For example in pseudocode 1 Show Insert Pages dialog DoVerb Documents 0 InsertPages NULL NULL 0 2 Insert 1 3 pages from PDF file to the begin of current document SetProperty Operations InsertPages RangeType Exact SetProperty Operations InsertPages RangeText 1 3 pages SetProperty Operations InsertPages FromExternal 1 SetProperty Operations InsertPages File c SomeFile pdf SetProperty Operations InsertPages InsertBefore 0 DoVerb Documents 0 InsertPages NULL NULL PXCVA_NoUI Reference 153 See Also IPDFXCview DoVerb Operations InsertDocumentPages Objects Operations InsertPages Returns the permission for operation with the document Name IsOperationGranted Arguments 1 Yes LONG Specifies the object identifier 2 Yes LONG Specifies the operation identifier which is depended with the object Object Identifiers 1 Document 2 Page 3 Link 4 Bookmark 5 Thumbnail 6 Annotation 7 Form 8 Signature 9 Named Embedded File Operation Identifier
19. Type Integer R Integer String R String R W Description Retrieves unique ID of the document Retrieves document save mode identifier See_Document Save Modes Retrieves destination file name and you may change it to other valid file name If document is being saved in a stream then this value will be empty 187 188 PDF XChange Viewer ActiveX SDK Cancel Integer Allows to stop saving of the document R For possible named values see the Booleans Default value is 0 false See Also IPDFXCview DoVerb IPDFXCview GetProperty IPDFXCview SetProperty IPDFXCviewE vents OnEvent 2 2 2 10 3 ContextMenu Used for confirmation and customization of context menu before it displaying Contained Objects Name Type Description X Integer Retrieves screen x position of the popup menu R y Integer Retrieves screen y position of the popup menu R MenuName String Retrieves name of context menu R UserChoice Integer Allows to deny showing default context menu String For possible named values see the Context Menu RW User Choices This parameter can be also set to specific command ID see also Objects Commands which will run instead of context menu Default value is 0 show default context menu Remarks Example for usage in pseudocode add Sticky Note annotation instead of Hand context menu function OnEvent Type Name Dataln DataOut Flags if Type PXCVA_OnNamedNotify and
20. s 2 The unique identifier of detected view object 3 The proper name of detected view object 4 The number of characters of the name that was parsed See Also IPDFXCview DoVerb IPDFXCview GetViewObjectFromName 2 2 1 22HasVisibleBars Tests visibility of Ul bars menubar toolbars status bar etc Name HasVisibleBars Arguments Nothing Return Value Returns S_OK on success or an error value otherwise To obtain the text description of a received error code use IPDFXCview GetTextFromResult If successful then it returns in DataOut the non zero number when any Ul bar is visible or zero otherwise See Also IPDFXCview DoVerb 2 2 1 23InsertDocumentPages Inserts pages from source document into current document using parameters previously defined by Objects Operations InsertP ages Name InsertDocumentPages Arguments Req Type Description 1 Yes LONG The unique identifier of the document or full file name of the document BSTR Return Value Returns S_OK on success or an error value otherwise To obtain the text description of a received error code use IPDFXCview GetTextFromResult See Also IPDFXCview DoVerb Objects Operations InsertPages Objects Documents lt ltem gt InsertPages 60 PDF XChange Viewer ActiveX SDK 2 2 1 24InsertEmptyDocumentPages Inserts empty pages to PDF document using parameters previously defined by Objects Operations InsertEmptyPages N
21. spDoc GetProperty Pages Count out dataOut 0 int pagesCount int dataOut som mie i 0p a lt pagescolmep is 204 PDF XChange Viewer ActiveX SDK VB 6 0 PDFXCviewAxLib IPDFXCsmartp spPageChars GOD oOe Cae Smorodime WiPeicae te a wOSicwaing y WI wesc Clases Oe spPageChars dataOut 0 spPageChars GetProperty Count out dataOut 0 int charsCount int dataOut for aime 3 OF 7 lt Cmaicsicoumty Farr PDFXCviewAxLib IPDFXCsmartp spChar spPageChars GetItemPointByIndex j out spChar if spChar null continue dataOut 0 spChar GetProperty Code out dataOut 0 Char ch Char int dataOut System Runtime InteropServices Marshal ReleaseComObject spChar System Runtime InteropServices Marshal ReleaseComObject spPageChars System Runtime InteropServices Marshal ReleaseComObject spDoc Dim dataln As Variant Dim dataOut As Variant Dim spDoc As IPDFXCsmartp Dim pagesCount As Integer Dim objName As String objName Documents amp iDocID dataIn 0 Call CoPDFXCviewl DoVerb objName SP dataIn dataOut 0 Set spDoc dataOut dataOut 0 Call spDoc GetProperty Pages Count dataOut 0 pagesCount dataOut Dim i As Integer EN 0 to Ap ges Count al Dim spPageChars As IPDFXCsmartp Call spDoc GetSubPoint Pages amp i amp Text Chars spPageChars dataOut 0 Call spPageChars GetProperty Count data0ut 0
22. 2 2 4 1 Global Supported Global Named Notifications Name Description Global OperationsHistoryChanged Signals if operations history has been changed Undo Redo Global CheckSysKey Control sends this notification to the client when the user holds down the ALT key and then presses another key WM_SYSKEYDOWN windows message The Dataln parameter of the OnEvent procedure contains the virtual key code To prevent the default processing write O zero to the DataOut parameter Global CheckKey Control sends this notification to the client when the user presses any key WM_KEYDOWN windows message The Dataln parameter of the OnEvent procedure contains the virtual key code To prevent the default processing write O zero to the DataOut parameter Global Focus Gained This simple event informs you the control any window 2 2 4 2 Select Tool from control gained or already have the input focus This event is periodically sent to the client when the end user interacts with the control clicks by mouse activates any window of control etc Supported Named Notifications Name Description SelectTool OnSelectionChanged Signals if selection in active document has been changed Remarks This notification is obsolete Please look to Objects Notifications Selection 271 PDF XChange Viewer ActiveX SDK 2 2 4 3 Text Editor Supported Named Notifications Name TextEditor OnStart Description Signals if Text
23. 3331 Zoom Tools 3 3331 Link Tools 7 3331 Measuring Tools 6 3625 Whole Words Only 2 Find Whole Words Only 3290 Display Pages Count of this Document 7 3644 Character to from Gliph Index 7 Translate Selected Character to from Gliph Index PDF XChange Viewer ActiveX SDK 3644 Character to from Hex Code 6 Translate Selected Character to from Hex Code 3341 Text Formatting y 3331 Comment And Markup Tools 4 3331 Basic Tools y 3331 Tools 0 2 3648 Line Weights 3 Show all lines with a one pixel stroke wath regardless of the zoom level 3653 Edit Description 7 3653 Add New 5 Add New Attachment 3653 Save 4 Save Selected Attachment into an external File 3653 Open 3 Open Selected Attachment 5760 New Document 0 3335 Window 0 5767 Help 0 3600 Cause Exception 3 3625 Include Comments 4 Searches the Text of Any Comments added to the PDF 3319 Look in Sub Folders 7 3655 Include Document Info 4 Searches the Text in Document Info in title subject author keywords etc 3655 Include Pages Content 2 Searches the Text of Any Pages 3625 Include Bookmarks 5 Searches the Text of Any Bookmarks 3625 Case Sensitive 3 Case Sensitive Search 3337 No Properties 3 No One Object with Properties is Currently Selected 3310 Align Center Reference 3311 Align Right 0 3324 Delete 0 Delete Comment 3323
24. Accesses the properties of the commenting Contained Objects Name Type Description no PDF XChange Viewer ActiveX SDK Styles Array Defines item style representation RWS See Also Objects Commenting 2 2 2 3 7 1 Styles This object represents array of all comments styles and provides additional operations with them Item Template lt ltem gt defines item template for each style representation Contained Objects Count Integer Contains number of all accessible styles R Remarks This object is an array of items where each item is represented as lt ltem gt For more information about object naming notation see Object Name Notation Examples for usage in pseudocode Enumerate all styles for highlight comment GetProperty Commenting Highlight SsStyles Count DataOut 0 Count DataOut for i 0 to Count 1 GetProperty Commenting Highlight Styles i ID DataOut 0 See Also Objects Commenting IPDFXCview DoVerb IPDFXCview GetProperty IPDFXCview SetProperty Defines item template for each commenting highlight style Contained Objects ID Integer Specifies the unique ID of the comment style RS Name String Defines name of comment style RWS SColor Integer Specifies stroke color for the comment String For possible named values see the Colors RWS Default value is RGB 255 255 0 yellow Opacity Double Specifies the opacity of the comment R
25. All are supported Supported Methods There are no methods for this object See Also IPDFXCview RunJavaScript JavaScript for Acrobat API Reference Link This object is used to set and get the properties and to set the JavaScript action of a link Supported Properties All are supported 279 260 PDF XChange Viewer ActiveX SDK 2 3 12 2 3 13 2 3 14 Supported Methods All are supported See Also IPDFXCview RunJavaScript JavaScript for Acrobat API Reference OCG An OGG object represents an optional content group in a PDF file Content in the file can belong to one or more optional content groups Content belonging to one or more OCGs is referred to as optional content and its visibility is determined by the states ON or OFF of the OCGs to which it belongs In the simplest case optional content belongs to a single OCG with the content being visible when the OCG is on and hidden when the OCG is off More advanced visibility behavior can be achieved by using multiple OCGs and different visibility mappings Supported Properties All are supported Supported Methods All are supported See Also IPDFXCview RunJavaScript JavaScript for Acrobat API Reference Template Template objects are named pages within the document These pages may be hidden or visible and can be copied or spawned They are typically used to dynamically create content for example to add pages to an invoice on overflow
26. BSTR the attachment Outputs 1 BSTR The description of the attachment Return Value Returns S_OK or an error value otherwise To obtain the text description of a received error Reference as code use IPDFXCview Get TextFromResult See Also IPDFXCview DoDocumentVerb Gets the last modification date of the attachment Name GetAttachmentModDate Arguments 1 Yes LONG The zero based index of the attachment in the attachments list or name of BSTR the attachment Outputs 1 LONGLONG Contains a 64 bit value representing the number of 100 nanosecond intervals INT64 since January 1 1601 UTC same as in standard windows FILETIME structure Return Value Returns S_OK or an error value otherwise To obtain the text description of a received error code use IPDFXCview GetTextFromResult See Also IPDFXCview DoDocumentVerb Gets name of the attachment Name GetAttachmentName Arguments 1 Yes LONG The zero based index of the attachment in the list of attachments Outputs 1 BSTR The name of the attachment Return Value Returns S_OK or an error value otherwise To obtain the text description of a received error code use IPDFXCview GetTextFromResult 196 PDF XChange Viewer ActiveX SDK See Also IPDFXCview DoDocumentVerb Gets count of the document s attachments Name GetAttachmentsCount Arguments None Outputs 1 LONG The count of attachments Return Value Returns
27. DataOut 0 set n DataOut 0 SetProperty ColorManagement Custom RGB Dataln sRGB IEC61966 2 1 3 also enable custom color settings SetProperty ColorManagement Current See Also 0 DataIn Custom 0 IPDFXCview DoVerb IPDFXCview GetProperty IPDFXCview SetProperty 2 2 2 1 1 lt ltem gt Defines the item template for each supported color settings profile representation Contained Objects Name Type Name String RWS RGB String RWS CMYK String RWS Grayscale String RWS Flags Integer RWS Description Defines the special unique name of color settings profile Defines the name of the RGB Red Green Blue working space Defines the name of the CMYK Cyan Magenta Yellow and blacK working space Defines the name of the Grayscale working space For now there is only one possible value equal to 1 which means using output indent Default value is 0 PDF XChange Viewer ActiveX SDK Remarks The item named as Off value of Name object above represents default color settings profile is read only See Also Objects ColorManagement 2 2 2 2 Commands Represents an array of all supported named Ul commands and provides more operations with them Item Template lt ltem gt defines item template for each named Ul command representation Contained Objects Name Type Description Count Integer Contains the number of all supported named UI R com
28. End FColor SColor Opacity BlendMode Border Type Integer RS String RWS Integer String RWS Integer String RWS Integer String RWS Integer String RWS Double RWS Integer String RWS Group RWS Description Specifies the unique ID of the comment style Defines name of comment style Specifies line starting style For possible named values see the Line Ending Default value is 0 none Specifies line endings style For possible named values see the Line Ending Default value is 4 Open Arrow Specifies fill color for the comment For possible named values see the Colors Default value is 1 none Specifies stroke color for the comment For possible named values see the Colors Default value is RGB 255 0 0 red Specifies the opacity of the comment Default value is 1 0 100 opacity Specifies the blend mode for the comment For possible named values see the Blend Modes Default value is 0 Normal Specifies border for the comment Reference 103 DefSubj String Specifies default subject text for comment RWS This value will be used only if DefSubjMode is set to Custom DefSubjMode Integer Specifies mode for default subject String For possible named values see the Subject RWS Modes Default value is 0 Default See Also Objects Commenting IPDFXCview DoVerb IPDFXCview GetProperty IPDFXCview SetProperty 2
29. Forms Group Allows to specify settings for PDF forms RWS General Group Accesses the main properties of the Activex RWS control PDF XChange Viewer ActiveX SDK International Group Controls Ul localization RWS Notifications Group Allows to receive and modify Viewer events RWS Operations Group Allows to specify settings for operations RWS PageDisplay Group Controls the pages of the documents displaying RWS Performance Group Controls the performance of the control RWS Print Group Represents all supported properties for print of RWS documents See also IPDFXCview Print Document Prompts Group Controls and overrides UI confirms prompts RWS messages See also _IPDFXCviewEvents OnEvent Search Group Contains all supported properties for extended text RWS searching using search panel in Viewer Tools Group Contains all supported tools and operations with RWS them View Group Controls more attributes of main view visibility RWS positions layouts for main bars panes windows Also provides customizing of main menu and toolbars Remarks All object names are case independent i e the two names General AllowAllAccelerators and general allowAllAccelerators are equal for all name input methods See Also IPDFXCview DoVerb IPDFXCview GetProperty IPDFXCview SetProperty IPDFXCview DoDocumentVerb 2 2 2 1 ColorManagement Controls the colors of the displayed documents Item Te
30. ID LONG Eaten Parameters Name in BSTR that specifies the name of document object For more information see Objects Documents ID out Pointer to a LONG value that receives the unique identifier of detected document If your application does not need this information set it to NULL Eaten out Pointer to a LONG value that receives the number of characters of the name that was parsed If your application does not need this information set it to NULL Return Value Returns S_OK if successful or an error value otherwise To obtain the text description of a received error code use GetTextFromResult Remarks Call this method to identify the object name which will be received by _IPDFXCviewEvents OnEvent notification For example in pseudocode GetDocumentFromName Documents 4095 Panes Thumbnails Visible ID Eaten result ID 4095 Eaten 17 32 PDF XChange Viewer ActiveX SDK See Also IPDFXCview GetViewObjectFromName Operations GetDocumentFromName 2 1 1 3 2 GetTextFromResult This method is used to obtain the text description of returned error codes by other methods This method is a simplified variant of a special call to the DoVerb method Syntax HRESULT GetTextFromResult HRESULT Result BSTR Text y Parameters Result in HRESULT that specifies the result code which is returned by other methods Text out Pointer to a BSTR that receives the
31. PXCVA_OnDisplayPrompt if Name Prompts ConfirmOpenSite get current url GetProperty Prompts ConfirmOpenSite Name DataOut 0 if DataOut www unknownsite com set another URL SetProperty Prompts ConfirmOpenSite Name Dataln http www MySite com 0 Fi skip original dialog and try to open specified URL 220 PDF XChange Viewer ActiveX SDK SetProperty Prompts ConfirmOpenSite UserChoice Dataln Yes 0 See Also IPDFXCviewEvents OnEvent PXCVA_EventTypes PXCVA_ OnDisplayPrompt IPDFXCview GetProperty IPDFXCview SetProperty 2 2 2 15 7 CreateFolderError This is a special object for modifying the confirmation dialog when an error occurs during new folder creation You must implement a special event handler see _IPDFXCviewEvents OnEvent and match the type of the received event with the PXCVA_EventTypes PXCVA_OnDisplayPrompt constants and the name with the Prompts CreateFolderError string Contained Objects Name Type Description FolderName String Represents full folder name RW ErrorCode Integer Creation folder error code R UserChoice Integer User s choice for this case String Initial value is O default processing RW Supported named values for this prompt Default Retry Cancel See also User Choices Ul Group Special object for Ul customizing RW Remarks If you want to skip the original dialog you must pass a new
32. See Also IPDFXCview DoVerb Objects Documents lt ltem gt Objects Documents lt ltem gt GetAllSelectedText Highlights selection Name HighlightSelection Arguments Req Type Description 1 No LONG The color COLORREF of the highlight By default means 00FFFF yellow 2 No Double The opacity of the highlight comment By default set to 1 0 100 opaque Return Value Returns S_OK on success or an error value otherwise To obtain the text description of a received error code use IPDFXCview GetTextFromResult Remarks For example in pseudocode Highlight selection with violet color and 65 opacity DoVerb Documents 0 HighlightSelection DataIn 0x800080 0 65 NULL See Also IPDFXCview DoVerb Objects Documents lt tem gt Highlights text in the document by special input file with information for highlighting of the text See adobe s Highlight File Format The short description of this format pseudo xml lt XML gt Reference 151 lt Body units characters words version verNum type highlight underline strikeout color rgb r g b FFFFFFFF opacity 0 1 gt lt Highlight gt lt loc pg pageIndex pos startChar len charsCount type highlight underline strikeout color rgb r g b FFFFFFFF opacity 0 1 gt lt Highlight gt lt Body gt lt XML gt Note the blue parameters are unsupported by adobe but are supported by our products this Activex b
33. Type Array RWS Description Defines item style representation This object represents array of all comments styles and provides additional operations with them Item Template Reference 121 lt ltem gt defines item template for each style representation Contained Objects Name Type Description Count Integer Contains number of all accessible styles R Remarks This object is an array of items where each item is represented as lt ltem gt For more information about object naming notation see Object Name Notation Examples for usage in pseudocode Enumerate all styles for polyline comment GetProperty Commenting Polyline Styles Count DataOut 0 Count Data0ut for i 0 to Count 1 GetProperty Commenting Polyline Styles i ID DataOut 0 See Also Objects Commenting IPDFXCview DoVerb IPDFXCview GetProperty IPDFXCview SetProperty Defines item template for each commenting polyline style Contained Objects Name Type Description ID Integer Specifies the unique ID of the comment style RS Name String Defines name of comment style RWS Start Integer Specifies line starting style String For possible named values see the Line Ending RWS Default value is 0 none End Integer Specifies line endings style String For possible named values see the Line Ending RWS Default value is 4 Open Arrow FColor Integer Specifies fill color for the comment String Fo
34. boundaries included Default value is 128 Scaling Conversion options Name Type Description ScaleType Integer Specifies image scale type See the Image Scale String Types RWS Default value is None 0 ConvType Integer Specifies image conversion type See the Image String Conversion Types RWS Default value is None 0 ScaleTo Integer Specifies dpi of the scaled images RWS Default value is 96 ScaleAbove Integer If dpi of image is more than it then image will be RWS scaled to the new dpi which is specified in the ScaleTo Default value is 128 Remarks For example in pseudocode setup scale type for colored images enable downsampling SetProperty Operations NewDocument FromImages Graphics ColorImg ScaleType DataIn Bicubic NULL 0 Specifies appearance of text labels for images on the pages Contained Objects Name Type Description UseLabels Integer Enables labels for images String For possible named values see the Booleans RWS Default value is 0 Text String Text of label s It supports macros for generic RWS names See Name Generation Macros The default value is empty BackColor Integer Specifies the background color for text label String For possible named values see the Colors RWS Default value is 1 none transparent LabelAbove Integer Moves the text label above image String For possible named values see the Booleans RWS Default value is 0 202 PDF X
35. received error code use IPDFXCview GetTextFromResult Remarks For example in pseudocode Displays print dialog for first document DoVerb Documents 0 Print NULL NULL 0 Print first document directly without dialog DoVerb Documents 0 Print NULL NULL PXCVA_NoUT Reference 155 See Also IPDFXCview DoVerb IPDFXCview PrintDocument Objects Documents lt Item gt Removes the document protection Can be successful only if the document has been opened with owner permissions For example if the document is the password protected then you should specify the special owner password for opening Name RemoveSecurity Arguments None Return Value Returns S_OK on success or an error value otherwise To obtain the text description of a received error code use IPDFXCview GetTextFromResult Remarks For example in pseudocode DoDocumentVerb docld RemoveSecurity NULL NULL 0 See Also IPDFXCview DoVerb IPDFXCview CloseDocument Objects Documents lt tem gt Rotates pages in document using parameters previously defined by Objects Operations RotatePages Name ROCA SP ages Arguments None Return Value Returns S_OK on success or an error value otherwise To obtain the text description of a received error code use IPDFXCview GetTextFromResult Remarks For example in pseudocode 1 Show rotate pages dialog 156 PDF XChange Viewer ActiveX SDK
36. 179 180 PDF XChange Viewer ActiveX SDK 2 1 Highlight only CheckBoxes fields SetProperty Documents 4095 Form HighlightFields Mask CheckBoxes 0 SetProperty Documents 4095 Form HighlightFields Visible true 0 2 2 Highlight CheckBoxes and TextBoxes fields SetProperty Documents 4095 Form HighlightFields Mask 0x00000008 OxC SetProperty Documents 4095 Form HighlightFields Visible true 0 See Also IPDFXCview GetProperty IPDFXCview SetProperty Objects Documents lt ltem gt Form Objects Forms HighlightFields 2 2 2 4 1 4 View This is the common object that contains the document view attributes visibility positions layouts for document bars panes windows Also allows customizing of the document toolbars Contained Objects Name Type Description Bars Array Represents all Ul bars menu command status RWS bars For details about document bars see the Document Bars Panes Array Represents all Ul panes named containers for RWS special views For details about document panes see the Document Panes ShowScrollBars Integer Controls visibility of scroll bars in pages view String For possible named values see the Booleans RW Default value is 1 Remarks Examples for usage in pseudocode 4095 is an example target document s unique ID 1 1 get bars count Same as panes DoVerb Documents 4095 View Bars Count get Dataln DataOut 0 or GetProp
37. 2 2 3 3 Callout Accesses the properties of the commenting Contained Objects Styles Array Defines item style representation RWS See Also Objects Commenting 2 2 2 3 3 1 Styles This object represents array of all comments styles and provides additional operations with them Item Template lt ltem gt defines item template for each style representation Contained Objects Count Integer Contains number of all accessible styles R Remarks This object is an array of items where each item is represented as lt ltem gt For more information about object naming notation see Object Name Notation Examples for usage in pseudocode Enumerate all styles for callout comment GetProperty Commenting Callout Styles Count DataOut 0 Count Data0ut for i 0 to Count 1 GetProperty Commenting Callout Styles i 1D DataOut 0 PDF XChange Viewer ActiveX SDK See Also Objects Commenting IPDFXCview DoVerb IPDFXCview GetProperty IPDFXCview SetProperty Defines item template for each commenting callout style Contained Objects Name ID Name End FColor SColor Opacity BlendMode Border TextFormat DefSubj DefSubjMode See Also Objects Commenting Type Integer RS String RWS Integer String RWS Integer String RWS Integer String RWS Double RWS Integer String RWS Group RWS Group RWS String RW
38. 286 PDF XChange Viewer ActiveX SDK Parameters Value0ut out Pointer to a VARIANT_BOOL that receives flag for accelerators usage Valueln in BSTR that specifies flag for accelerators usage Return Value Returns S_OK if successful or an error value otherwise To obtain the text description of a received error code use GetTextFromResult See Also Objects General AllowAllAccelerators 2 5 1 2 2 LockedView Allows or denies all Ul customization Syntax HRESULT get_LockedView VARIANT BOOL Valueout HRESULT put_LockedView VARIANT_BOOL Valueln Parameters Value0ut out Pointer to a VARIANT_BOOL that receives flag for view locking Valueln in BSTR that specifies flag for view locking Return Value Returns S_OK if successful or an error value otherwise To obtain the text description of a received error code use GetTextFromResult See Also Objects View Locked 2 5 1 2 3 ReadOnly Allows or denies all modification operations for all documents Syntax HRESULT get_ReadOnly VARIANT _BOOL valueout HRESULT put_ReadOnly VARIANT_BOOL Valueln Parameters Value0ut out Pointer to a VARIANT_BOOL that receives read only flag Valueln Reference in BSTR that specifies read only flag Return Value Returns S_OK if successful or an error value otherwise To obtain the text description of a received error code use GetTextFromResult See Also Objects Gen
39. 300 AllowToFile Collate Copies DestFileFolder DestFileTitle Duplex Gradients Resol NotesAndPopups PaperHeight PaperName PaperRotate PaperWidth PopupsAlpha PrinterName PrintSpec RangeFilter RangeReverse RangeText Integer RWS Integer String RW String RW String RWS String RWS Integer String RW Integer RWS Integer String RWS Integer RW String RW Integer RWS Integer RW Double RWS String RW Integer String RWS Integer String RWS Integer String RWS String RWS Reference 211 Enables disables the ToFile see below feature for end users For possible named values see the Booleans Default value is 1 Sorts pages during printing For possible named values see the Booleans Default value is 0 Contains number of copies to print Default value is 1 Specifies destination folder name If this value is empty then the lt My Documents gt standard folder will be used automatically Default value is empty NULL or Specifies destination file name It supports macros for generic names See Name Generation Macros Selects duplex or double sided printing for printers capable of duplex printing For possible named values see the Duplex Printing Default value is 0 None Sets or gets the page resolution in pixels per inch DPI for Gradient Fills Valid values are 50 72 96 100 150 300 400
40. 600 DPI Default value is 150 Prints the PDF document with Notes and Popups For possible named values see the Booleans Default value is 0 Paper height in tenths of a millimeter Default value is 2970 The name of the standard type of paper to print on Defines the rotation factor for the paper For possible named values see the Paper Orientation Default value is 0 Paper width in tenths of a millimeter Default value is 2100 Specifies the degree of opacity for Popups Default value is 0 75 Contains name of current printer Defines the filter for printing of special PDF content comments and markups For possible values see the Print Specials By default document and markups will be printed Specifies an additional filter for the page range For possible values see the Range Filters Default value is 1 all pages Specifies whether to print selected pages in reverse order For possible named values see the Booleans Default value is 0 Specifies the exact pages to print The string should contain the page numbers and or page ranges separated by commas counting from the start of the 212 PDF XChange Viewer ActiveX SDK document For example 1 3 5 12 RangeType Integer String Defines the type of page range RWS For possible values see the Range Types Default value is 1 all pages ScaleSimple Group Represents advanced options for some simple page RWS scaling during printing for one page
41. Contained Objects ID Integer Specifies the unique ID of the comment style RS Name String Defines name of comment style RWS FColor Integer Specifies fill color for the comment String For possible named values see the Colors Reference 131 RWS Default value is 1 none SColor Integer Specifies stroke color for the comment String For possible named values see the Colors RWS Default value is RGB 0 0 0 black Opacity Double Specifies the opacity of the comment RWS Default value is 1 0 100 opacity BlendMode Integer Specifies the blend mode for the comment String For possible named values see the Blend RWS Modes Default value is 0 Normal Border Group Specifies border for the comment RWS TextFormat Group Specifies text format for the comment RWS DefSubj String Specifies default subject text for comment RWS This value will be used only if DefSubjMode is setto Custom DefSubjMode Integer Specifies mode for default subject String For possible named values see the Subject RWS Modes Default value is 0 Default See Also Objects Commenting IPDFXCview DoVerb IPDFXCview GetProperty IPDFXCview SetProperty 2 2 2 3 21 Underline Accesses the properties of the commenting Contained Objects Name Type Description Styles Array Defines item style representation RWS See Also Objects Commenting 2 2 2 3 21 1 Styles This object represents array of all comments
42. Data File Export Data from Form Export to Image Export Pages to Image s Extract Pages Facing File Attachment Tool Attach a File as Comment Click the page to pin a file attachment to that place on the page Find Find the Specified Text Case Sensitive Case Sensitive Search Find the Specified Text Include Bookmarks Searches the Text of Any Bookmarks Include Comments Searches the Text of Any Comments added to the PDF Include Pages Content Searches the Text of Any Pages Find Next Finds the Next Occurrence Find Options FindPrevious FindW holeWords FirstPage FitPage FitVisible FitWidth FlattenAnnots FlipLine FontsList FullScreenMode FullScreenModeExi t FullSearch GoBack GoBack GoBackDoc GoForward GoForward GoForwardDoc GoToHomePage GoToNextSearchO ccur GoToPage GoToPrevSearchO ccur HandTool HelpContents HideAllBars 3299 1 3299 4 3288 5 3290 1 3290 3 3290 2 3634 0 3311 5 3323 0 3301 4 3302 0 3298 7 3231 6 3289 0 3289 2 3231 7 3289 1 3289 3 3314 y 3297 9 3288 9 3297 8 3261 3 3314 5 3655 7 PDF XChange Viewer ActiveX SDK FindPrevious FirstPage FitPage FitVisible FitWidth FullScreen FindSearch GoBack GoBack GoBackDoc GoForward GoForward GoForwardDoc GoToPage HandMenultem HelpUserGuide Find Previous Finds the Previous Occurrence W
43. Editor has just started TextEditor OnStop Signals if Text Editor has just stopped Remarks These notifications are obsolete Please look to Objects Notifications TextEditor 2 3 JavaScript Support Currently supported JavaScript objects methods and properties are listed below sorted by object name in alphabetic order For more information please refer to the JavaScript for Acrobat API Reference Supported Objects Name Annotation app Bookmark console a Do el FullScreen global Description This object represents a PDF annotation A static JavaScript object that represents the PDF XChange Viewer control It defines a number of vewer specific functions plus a variety of utility routines and convenience functions This object represents a node in the bookmark tree that appears in the bookmarks navigational panel see also Document Panes Bookmarks are typically used as a table of contents allowing the user to navigate quickly to topics of interest This object is a static object that enables an access to the JavaScript console for executing JavaScript and displaying debug messages This object provides the interface between a PDF document open in the viewer and the JavaScript interpreter It provides methods and properties for accessing PDF document All JavaScript scripts are executed as the result of a particular event For each of these events JavaScript creates an event object During th
44. GetDocumentProperty 4095 Pages Count DataOut 0 1 2 get width of first page DoVerb Documents 4095 Pages 0 Width get Dataln DataOut 0 ES O GetProperty Documents 4095 Pages 0 Width DataOut 0 Ls or GetDocumentProperty 4095 Pages 0 Width DataOut 0 2 1 set pages layout set continuous layout DoVerb Documents 4095 Pages Layout set Dataln 1 DataOut 0 DoDocumentVerb 4095 Pages Layout set Dataln 1 DataOut 0 or put named value DoVerb Documents 4095 Pages Layout set Dataln Continuous DataOut 0 or SetProperty Documents 4095 Pages Layout Dataln Continuous 0 or SetDocumentProperty 4095 Pages Layout DataIn Continuous 0 2 2 change width of first page DoVerb Documents t4095 Pages 0 Width set DataIn 100 0 DataOut 0 if 0r SetProperty Documents 4095 Pages 0 Width Dataln 100 0 0 or SetDocumentProperty 4095 Pages 0 Width Datalo 100 0 0 See Also IPDFXCview DoVerb Objects Documents Objects Documents lt ltem gt See Objects Documents lt ltem gt Pages Methods 162 PDF XChange Viewer ActiveX SDK Gets pages with any selection Name GetSelectedRanges Outputs Can contains one or more pairs of numbers in a format the first number is an index 0 basea of the first page in the selection range the second number is count of t
45. Licensee agrees to make all records available pertaining to the Licensee s accounting and other related information without exception on written request within 24 hours of receipt of such a request during normal working hours In the event that such an audit reveals any material inaccuracy in the reporting of the licensee sales and royalty liabilities to TRACKER Licensee shall e Make full payment to TRACKER of all outstanding royalty liabilities within 7 days of demand e Pay in full all fees and associated costs of the audit howsoever arising e Immediately cease all sales of all products containing Tracker Software Products Ltd s Toolkits or intellectual property until guarantees of the future reliability of the Licensee s reporting to the satisfaction of Tracker Software Products Ltd are provided e These remedies shall not restrict or limit such other avenues for compensation or damages as may be allowed by the laws of Canada but set forth the minimum remedy that Tracker Software Products shall be entitled to without delay further negotiation or legal recourse 5 OTHER RESTRICTIONS The licenses granted under this Agreement are expressly conditioned upon Licensee s compliance with all the terms and conditions of this Agreement Licensee may not use copy rent lease sell sublicense assign or otherwise transfer the Software except as expressly provided for in this Agreement Licensee may make a reasonable number of archival copies
46. Operations SummarizeAnnots Output TXT FileName CommentsFromPDF axCoPDFXCviewl DoVerb Documents 0 SummarizeAnnots dataln out dataOut int PDFXCviewAxLib PXCVA_Flags PXCVA_NoUL Call CoPDFXCviewl SetProperty Operations SummarizeAnnots Output Type WEEN Call CoPDFXCviewl SetProperty Operations SummarizeAnnots Output AutoView false Call CoPDFXCviewl SetProperty Operations SummarizeAnnots Output TXT FolderName C Call CoPDFXCviewl SetProperty Operations SummarizeAnnots Output TXT FileName Comment sSFromPDF Call CoPDFXCviewl DoVerb Documents 0 SummarizeAnnots Nothing Nothing PXCVA_Flags PXCVA_NOUI Delphi var data0ut OleVariant begin CoPDFXCviewl SetProperty Operations SummarizeAnnots Output Type txt 0 CoPDFXCviewl SetProperty Operations SummarizeAnnots Output AutoView relsen O CoPDFXCviewl SetProperty Operations SummarizeAnnots Output TX FolderName C 0 CoPDFXCviewl SetProperty Operations SummarizeAnnots Output TXT FileName CommentsFromPDF 0 CoPDFXCviewl DoVerb Documents 0 SummarizeAnnots dataOut PXCVA_NOUI end See Also IPDFXCview DoVerb Objects Operations SummarizeAnnots Tracker Software Products Who are we and what do we do We at Tracker Software Products take great pride in the software products we create and distr
47. PDF XChange Base Viewer SDK or one of our other PDF XChange Tools SDK s must be owned prior to additional CDLP License packs being purchased Please note prices subject to change please check our web site for the latest available costing s 1 3 1 License Text License Agreement for the PDF XChange Viewer SDK from Tracker Software Products Canada Ltd 2006 2009 6 PDF XChange Viewer ActiveX SDK PRINTED BELOW IN ITS ENTIRETY IS THE LICENSE AGREEMENT GOVERNING YOUR USE OF THE SOFTWARE PLEASE READ THE LICENSE AGREEMENT IMPORTANT TRACKER SOFTWARE PRODUCTS LTD IS WILLING TO LICENSE THE ENCLOSED SOFTWARE TO YOU ONLY UPON THE CONDITION THAT YOU ACCEPT ALL OF THE TERMS CONTAINED IN THE LICENSE AGREEMENT PRINTED BELOW PLEASE READ THE TERMS CAREFULLY BEFORE OPENING THE PACKAGE CONTAINING THE DISKETTE S CD R S Electronic File OR CLICKING THE ACCEPT BUTTON DURING INSTALLATION AS SUCH CONDUCT INDICATES YOUR ACCEPTANCE TO ALL OF THE TERMS OF THIS LICENSE AGREEMENT IF YOU DO NOT AGREE TO THE TERMS TRACKER SOFTWARE PRODUCTS LTD IS UNWILLING TO LICENSE THE SOFTWARE TO YOU IN WHICH CASE YOU MUST IMMEDIATELY RETURN THE PACKAGE AND ALL ACCOMPANYING MATERIAL TO TRACKER SOFTWARE PRODUCTS LTD OR YOUR AUTHORIZED DEALER FOR A FULL REFUND This License Agreement Agreement is a legal agreement between Tracker Software Products Canada Ltd Tracker a Company registered in Canada principally located at 466 Trans Canada Highway Duncan BC V
48. Pages Cross Out Text Cross Out Text Tool Cross Out the Selected Text Cut Cut the Selection and Place on the Clipboard Delete Delete the Selection Delete All Page Guides Delete Guides on Current Page Delete Pages Delete Reply DeleteSelectedPag 3381 es 9 DeselectAll 3324 8 DistanceTool 3634 6 DocumentOptions 3337 0 DocumentPropertie 3327 Ss 0 EraserTool 3630 0 ExportAllSettings 3640 9 ExportAnnots 3635 1 ExportFormData 3307 3 ExportTolmage 3294 5 ExtractPages 3603 8 Facing 3289 7 FileAttachmentTool 3322 4 Find 5763 6 FindCaseSensitive 3299 5 FindEdit 3299 0 FindIncludeBookm 3299 arks 7 FindIncludeComme 3299 nts 6 FindIncludePagesC 3655 ontent 3 FindNext 3299 2 FindOptions 3299 3 DeselectAll MeasureLineMenultem Generallnfo Annots Tool EraselnkMenultem AcroForm FormData_ExportData ImageConversion Export ExtractPages TwoPages Annots Tool FileAttachmentMenultem Find FindEdit FindAgain Reference Delete Selected Pages Deselect All Distance Tool Distance tool to measure distance between two points Document Options Contains Viewing Editing Manipulating etc Options for this Document Document Properties Show Properties of the Active Document Eraser Tool Eraser Tool erases only those parts that were drawn by a Pencil Tool Export All Settings to Data File Export All Application s Settings to Data File Export Comments to
49. RW Supported named values for this prompt Default OK Cancel See also User Choices Ul Group Special object for Ul customizing RW Remarks If you want to skip the original dialog you must pass a new non zero value to the UserChoice property For example in pseudocode function OnEvent Type Name Dataln DataOut Flags if Type PXCVA_OnDisplayPrompt if Name Prompts EnterDocumentPassword get current file name if need GetProperty Prompts EnterDocumentPassword FileName DataOut 0 set open password SetProperty Prompts EnterDocumentPassword Password DataIn 123 0 222 PDF XChange Viewer ActiveX SDK and skip original dialog SetProperty Prompts EnterDocumentPassword UserChoice DataIn OK 0 See Also IPDFXCviewE vents OnEvent PXCVA EventTypes PXCVA OnDisplayPrompt IPDFXCview OpenDocument IPDFXCview GetProperty IPDFXCview SetProperty 2 2 2 15 9 FileWriteError This is a special object for modifying the confirmation dialog when an error occurs during file writing You must implement a special event handler see _IPDFXCviewEvents OnEvent and match the type of the received event with the PXCVA_EventTypes PXCVA_OnDisplayPrompt constants and the name with the Prompts FileWriteError string Contained Objects Name Type Description FileName String Represents destination file name for specified RW document ErrorCode Integer
50. Return Value Returns S_OK if successful or an error value otherwise To obtain the text description of a received error code use GetTextFromResult Remarks Call this method to recognize object name which is received through _IPDFXCviewEvents OnEvent notification For example in pseudocode GetViewObjectFromName View Bars Menu Visible Type ID ProperName Eaten result Type PXCVA_ViewObjectType PXCVA_Bar ID 33009 ProperName Menu Baten 18 See Also IPDFXCview GetDocumentFromName Operations GetViewObjectFromName 2 1 1 4 Properties Properties Property Name Description Property The common property accessor parameterized by name See Also General Methods Document Methods Auxiliary Methods 2 1 1 4 1 Property Sets or gets the any property which specified by name Syntax HRESULT get_Property BSTR Name LONG Flags VARIANT DataOut HRESULT put_Property BSTR Name LONG Flags VARIANT Dataln Parameters Name in BSTR that specifies full name of the property as string identifier For more information see Named Objects DataOut ss PDF XChange Viewer ActiveX SDK out Pointer to a VARIANT structure that receives value of the property specified by Name Dataln in VARIANT that specifies the new value of the property specified by Name Flags in LONG that specifies optional flags This argument can be 0 Also you can pass the P
51. Return Value Returns S_OK if successful or an error value otherwise To obtain the text description of a received error code use GetTextFromResult Remarks This call has no effect in SDI Single Document Interface mode See Also IPDFXCview GetActiveDocument IPDFXCview GetDocumentsCount Operations ActivateDocument 2 1 1 2 2 CloseAllDocuments Closes all opened documents This method is a simplified variant of a special call to the DoVerb method Syntax HRESULT CloseAllDocuments LONG Flags 22 PDF XChange Viewer ActiveX SDK i Parameters Flags in LONG that specifies optional flags For more information see PXCVA Flags This argument can be 0 Return Value Returns S_OK if successful or an error value otherwise To obtain the text description of a received error code use GetTextFromResult Remarks If you want to deny all Ul prompts and alerts when calling this method then you must specify the PXCVA Flags PXCVA_NOUI flag in Flags See Also IPDFXCview CloseDocument Operations CloseAllDocuments 2 1 1 2 3 CloseDocument Closes the opened document This method is a simplified variant of a special call to the DoVerb method Syntax HRESULT CloseDocument LONG ID LONG Flags y Parameters ID in LONG that specifies unique identifier of the opened document This argument can be O for the active document Flags in LONG that specifies optional flags For more informatio
52. Specifies output PDF page height in points Default value is 842 pt 297 mm When specified output PDF file will be saved to disk For possible named values see the Booleans Default value is 0 Specifies destination folder name If this value is empty then the lt My Documents gt standard folder will be used automatically Default value is empty NULL or Specifies destination file name It supports macros for generic names See Name Generation Macros Objects Operations SummarizeAnnots Output Specifies output settings for RTF file format Contained Objects Name PageWidth PageHeight NewPageForEachGroup FolderName Type Double RWS Double RWS Integer String RWS String RWS Description Specifies output RTF page width in points Default value is 595 pt 210 mm Specifies output PDF page height in points Default value is 842 pt 297 mm Create new page for each annotation group For possible named values see the Booleans Default value is 1 Specifies destination folder name If this value is empty then the lt My Documents gt standard folder 207 208 PDF XChange Viewer ActiveX SDK FileName String RWS See Also will be used automatically Default value is empty NULL or Specifies destination file name It supports macros for generic names See Name Generation Macros Objects Operations SummarizeAnnots Output Specifies output settings for
53. Sreo t AAA AAA AAA AA A a eh Bian AAA AAA 287 Part Ill How To Use 288 1 How to Open a Document 1 20 cece eeeece cece ener ee ee ener eeee rn rre rre 288 2 How to Print a Document aiii dans 289 3 How to Save a Document sasssssnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnn cial nnmnnn 290 4 How to Close a Document c csccececnececncceeeecucuseeeeeaecuseeeesaenususeeeeuaegesaeeesaenegusseseuangasaesens 291 5 How to Disable a Command csccccsceececceeucecucnseecueeeuseeeeeaenecseesaeaegsaueusaeaeceseenanaegesansens 292 6 How to Enumerate Characters in Document 0 cceceeececeeeceeeeeceeeneceeeneceeeaeceseaeceesaeeeees 293 7 How to Extract Text from Document noccoccncnnnncoconcnnnncnconcncnnnnnanoncannnnaronnar nana narnarannannrnanasa 295 8 How to Summarize Annotations from Document c ceccecsecscesceneeescuseeeesaeaeeuseesenaneusaeaans 296 Part IV Tracker Software Products 297 1 Contact US AE EEA E E EE E ASEE E E EEE E E EE 298 2 ed A TAE TE T E A T T 298 Index 300 Important Please Read 1 Important Please Read The PDF XChange Viewer SDK Version 2 x Please note This is V2 x of the Viewer SDK and your existing V1 x License codes need to be replaced You will get a free upgrade if You purchased any Version 3 or 4 PDF XChange or Tools SDK on or After Jan 1st 2007 or if you purchased the PDF XChange Viewer SDK Version 1 x as a stand alone product You will need to pay
54. To obtain the text description of a received error code use GetTextFromResult 1 PDF XChange Viewer ActiveX SDK See Also IPDFXCview SaveSettings Operations LoadSettings 2 1 1 1 7 RunJavaScript RunJavaScript excutes a Java Script lt acts as a shortcut to the DoVerb main method Syntax HRESULT RunJavaScript ESTRES BSTR Result LONG ID LONG Flags i Parameters Script in BSTR that specifies the Java Script text For more information see Java Script Support Result out Pointer to a BSTR that receives result text of the executed Java Script specified by Script This argument can be NULL ID in LONG that specifies the unique identifier of the opened document This argument can be 0 for the active document The specified document will be used as the target for the script referred by this in the script For more information see Java Script Support Flags in LONG that specifies optional flags For more information see PXCVA_Flags This argument can be 0 Return Value Returns S_OK if successful or an error value otherwise To obtain the text description of a received error code use GetTextFromResult See Also Java Script Support Operations RunJavaScript 2 1 1 1 8 SaveSettings Save all control settings to an external storage method of your choosing such as an INI file or registry location etc Syntax HRESULT SaveSettings VARIANT DataInOut Reference 9 Para
55. XChange Viewer control IPDFXCsmartp This interface represents a special object Smart Point for simplification and access acceleration to any objects or properties IPDFXCview2 This interface is default based on the IPDFXCview and contains some additional features for simple usage of the control IPDFXCargs This interface represents an array of data objects Use it for simplification creation reading changing of data object which contains array of data SAFEARRAY Control Identificators CLSID FE36F0F3 F082 41B7 9EED 772505A7C054 ProgID PDFXCviewAx CoPDFXCview IPDFXCview This interface is the base interface of our ActiveX control Microsoft ActiveX control This interface is derived directly from IDispatch All methods properties of this interface could be separated into the following groups e General Methods e Document Methods e Auxiliary Methods e Properties ta PDF XChange Viewer ActiveX SDK Interface Identificator GUID IID_IPDFXCview 6BBDAD78 4AA9 40B1 977A 1D2A459B49C3 Requirements OS Versions Windows 2000 and later TypeLib PDFXCviewAx tlb 2 1 1 1 General Methods Methods Method Description ApplyAllCachedChanges Applies all cached settings that were passed with the PXCVA_NoApply flag DiscardAllCachedChanges Discards all cached settings that were passed with the PXCVA_NoApply flag DoVerb This is the main method in the library All other methods act as shortcuts
56. commenting style for this RWS tool See also Objects Commenting Polyline Styles KeepSelected Integer Defines if this tool still be selected after its String usage RWS For possible named values see the Booleans Default value is 1 See Also Objects Tools Objects Commenting 2 2 2 17 17 Rect Rectangle tool allows to draw a rectangle on the current displayed PDF document page Contained Objects Style Integer Defines ID of current commenting style for this RWS tool See also Objects Commenting Rect Styles KeepSelected Integer Defines if this tool still be selected after its String usage RWS For possible named values see the Booleans Default value is 1 See Also Objects Tools Objects Commenting 2 2 2 17 18 Snapshot This tool permits copying a rectangular area of a PDF page or the entire visible page area to the clipboard as a Bitmap Contained Objects UseResolution Integer If this value sets to O then screen resolution for String output image will be taken RWS For possible named values see the Booleans Default value is 0 Resolution Integer lf UseResolution is set to 1 then this parameter String specifies resolution for output image RWS Default value is 72 dpi Reference 233 AsGrayscale Integer Gets or sets grayscale mode for snapshot String For possible named values see the Booleans RWS Default value is 0 NoSounds Integer Disable snapshot sound String For possible nam
57. containing the Redistributables All restrictions prohibiting Licensee s use of the Software and intellectual property provisions relating to Software running to the benefit of TRACKER will survive termination of the license pursuant hereto Termination will not affect properly granted end user licenses of the Application Software distributed by Licensee prior to termination subject to the conditions further detailed in Clause15 below titled LICENSE EXPIRY 11 EXCLUSION OF WARRANTIES 10 PDF XChange Viewer ActiveX SDK TRACKER and its suppliers offer and Licensee accepts the Software AS IS TRACKER and its suppliers do not warrant the Software will meet Licensee s requirements or will operate uninterrupted or error free ALL WARRANTIES EXPRESS OR IMPLIED ARE EXCLUDED FROM THIS AGREEMENT AND SHALL NOT APPLY TO ANY SOFTWARE LICENSED UNDER THIS AGREEMENT INCLUDING BUT NOT LIMITED TO THE IMPLIED WARRANTIES OF MERCHANTABILITY FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT 12 LICENSEE S REMEDIES LIMITATIONS LICENSEE S SOLE AND EXCLUSIVE REMEDIES AGAINST TRACKER ON ANY AND ALL LEGAL OR EQUITABLE THEORIES OF RECOVERY SHALL BE AT TRACKER S SOLE DISCRETION A REPAIR OR REPLACEMENT OF DEFECTIVE SOFTWARE OR B REFUND OF THE LICENSE FEE PAID BY LICENSEE 13 NO LIABILITY FOR CONSEQUENTIAL DAMAGES In no event shall TRACKER or its suppliers be liable for any damages whatsoever including without limitation damages
58. first page DoVerb Documents 0 Pages 0 Text Chars Count get DataIn DataOut gets first char on the first page DoVerb Documents 0 Pages 0 Text Chars 0 Code get Dataln DataOut See Also 175 176 PDF XChange Viewer ActiveX SDK IPDFXCview DoVerb Objects Documents lt ltem gt Pages lt ltem gt Text Defines an item template for each character object Contained Objects Code Integer Represents Unicode code R Style Group Represents character style R Quad Group Contains character coordinates on page R See Also IPDFXCview DoVerb Objects Documents lt ltem gt Pages lt ltem gt Text Chars This object represents the character style Contained Objects Font Group Represents information about the font of this R character FontSize Double Font size R FColor Integer Fill color R SColor Integer Strike color R HScale Double Horizontal scaling R RMode Integer Rendering mode R Rise Double Base line offset text rise R See Also IPDFXCview DoVerb Objects Documents lt ltem gt Pages lt ltem gt Text Chars lt ltem gt This object represents the Font object for the specified character Contained Objects ID Integer Font s unique ID R Name String Font name R Ascent Double R Double R Integer String R Group R Descent Embedded BBox See Also IPDFXCview DoVerb Objects Documents lt ltem gt
59. for annotation String For possible named values see the Booleans RWS Default value is 1 ShowDate Integer Allows to add date information for annotation in String output RWS For possible named values see the Booleans Default value is 1 PDF Group Specifies output settings for PDF file format RWS RTE Group Specifies output settings for RTF file format RWS TXT Group Specifies output settings for TXT file format RWS HTML Group Specifies output settings for HTML file format RWS See Also Reference IPDFXCview DoVerb IPDFXCview GetProperty IPDFXCview SetProperty Objects Operations SummarizeAnnots Specifies output settings for PDF file format Contained Objects Name LayoutType SkipPagesWithoutAnnots NewPageForEachGroup PageWidth PageHeight SaveToFile FolderName FileName See Also Type Integer String RWS Integer String RWS Integer String RWS Double RWS Double RWS Integer String RWS String RWS String RWS Description Specifies layout type for new PDF document For possible named values see Summarize Annotations PDF Layouts Do not process PDF pages without annotations For possible named values see the Booleans Default value is 1 Create new page for each annotation group For possible named values see the Booleans Default value is 1 Specifies output PDF page width in points Default value is 595 pt 210 mm
60. for comment RWS This value will be used only if DefSubjMode is setto Custom DefSubjMode Integer Specifies mode for default subject String For possible named values see the Subject RWS Modes Default value is 0 Default See Also Objects Commenting IPDFXCview DoVerb IPDFXCview GetProperty IPDFXCview SetProperty 2 2 2 3 20 Typewriter Accesses the properties of the commenting Contained Objects 130 PDF XChange Viewer ActiveX SDK Styles Array Defines item style representation RWS See Also Objects Commenting 2 2 2 3 20 1 Styles This object represents array of all comments styles and provides additional operations with them Item Template lt ltem gt defines item template for each style representation Contained Objects Count Integer Contains number of all accessible styles R Remarks This object is an array of items where each item is represented as lt ltem gt For more information about object naming notation see Object Name Notation Examples for usage in pseudocode Enumerate all styles for typewriter comment GetProperty Commenting Typewriter Styles Count DataOut 0 Count DataOut for i 0 to Count 1 GetProperty Commenting Typewriter Styles i ID DataOut 0 See Also Objects Commenting IPDFXCview DoVerb IPDFXCview GetProperty IPDFXCview SetProperty Defines item template for each commenting typewriter style
61. for loss of business profits business interruption loss of business information or other pecuniary loss arising out of use of or inability to use the Software even if TRACKER or its dealer have been advised of the possibility of such damages Some states do not allow the exclusion or limitation of certain implied warranties or the exclusion or limitation of incidental or consequential damages in which case and to the extent such exclusion or limitation is not allowed some of the foregoing limitations and exclusions may not apply to Licensee 14 UPDATES AND UPGRADES From time to time Tracker at its sole discretion will release updates and upgrades incorporating bug fixes and new features during the first 12 months after purchase you will receive free of charge any Minor Releases issued relevant to the version purchased e g if you purchased Version 2 x then all version 2 x releases issued will be provided free and so on provided all other terms and conditions of this agreement have been compiled with Major Releases e g from Version 2 x to Version 3 x etc will be provided free of charge for no less than 3 months after the initial purchase after which time Tracker reserves the right to apply a fee for access to Major upgrades Further when issuing updates of any nature Tracker reserves the right to disable previous licensing codes from being useable in the new release to trigger a distribution statement from Developer s once the Di
62. function PXCVA_GetNamed When specified the property named value simple string will be returned in Data Out See Operations GetNamed also PXCVA_Sync In time of execution of some methods the control automatically simulates synchronous call to partially unlock the client during the long term call For example you start document printing By default the control shows the print dialogue and co operates with the user for some period of time after what it prints In this case the call of method PrintDocument will be executed for the indefinitely long period of time and if this method is really synchronous the client will be completely locked for the period of interaction among the user and the printing That is the user interface of the client will not be drawn To avoid it the control by default simulates synchronous call of such method by internal messages loop During this interactivity will be locked for the client but the drawing of client s user interface will be unlocked To disable automatic simulation of synchronous calls specify this flag PXCVA_OutArgs When specified the pointer to a new object with IPDFXCargs interface will be returned in DataOut Use this flag for simplify reading of a data array SAFEARRAY from the DataOut See Also IPDFXCview DoVerb IPDFXCview GetProperty IPDFXCview SetProperty IPDFXCview ApplyAllCachedChanges IPDFXCview DiscardAllCachedChanges 2 4 4 PXCVA_ViewObjectTypes The values shown in this
63. index of widget on the page R Remarks Example for usage in pseudocode function OnEvent Type Name DataIn DataOut Flags if Type PXCVA_OnNamedNotify and Name Notifications FieldChanged then GetProperty Notifications FieldChanged Name DataOut 0 if DataOut Text1 0 then 190 PDF XChange Viewer ActiveX SDK get actual value by special java script string js var f this getField DataOut if f nul string fieldValue clear RunJavaScript js out fieldValue See Also IPDFXCview DoVerb IPDFXCview GetProperty IPDFXCview SetProperty IPDFXCviewE vents OnEvent 2 2 2 10 7 Keyboard Allows to get information about keyboard events Contained Objects Name Type Description Filter Integer Specifies filter for receiving keyboard events For String possible named values see the Keyboard RWS Notifications Filter Flags You may use a combination of one or more of the following values Default value is 0 None Msg Integer Specifies Widows keyboard messages R WM_KEYDOWN WM_SYSKEYDOWN WM_CHAR Code Integer Specifies the virtual key code of the given key R RepCnt Integer Repeat count the number of times the keystroke is R repeated as a result of the user holding down the key Flags Integer Specifies the scan code key transition code R previous key state and context code Skip Integer Allows to deny processing current keyboard Str
64. information see Objects Documents Return Value Returns S_OK on success or an error value otherwise To obtain the text description of a received error code use IPDFXCview GetTextFromResult If successful DataOut contains 1 The unique identifier of detected document 2 The number of characters of the name that was parsed See Also IPDFXCview DoVerb IPDFXCview GetDocumentFromName Reference 2 2 1 17GetDocumentiD Returns the document unique identifier by order index Name GetDocument ID Arguments 1 Yes LONG The index of the document Return Value Returns S_OK on success or an error value otherwise To obtain the text description of a received error code use IPDFXCview GetTextFromResult If successful the unique identifier ID of the indexed document will be returned in Data Out See Also IPDFXCview DoVerb IPDFXCview GetDocumentID 2 2 1 18GetDocumentindex Returns the document order index by unique identifier or by full file name Name GetDocument Index Arguments 1 Yes LONG The unique identifier of the document or full file name of the document BSTR Return Value Returns S_OK on success or an error value otherwise To obtain the text description of a received error code use IPDFXCview GetTextFromResult If successful then the index of the opened document will be returned in Data Out See Also IPDFXCview DoVerb IPDFXCview GetDocumentID 2 2 1 19GetDocumentsCount Returns the
65. information about object naming notation see Object Name Notation Examples for usage in pseudocode Enumerate all styles for oval comment GetProperty Commenting Oval Styles Count DataOut 0 Count Data0ut for 1 0 to Count 1 GetProperty Commenting Oval Styles i ID DataOut 0 See Also Objects Commenting IPDFXCview DoVerb IPDFXCview GetProperty IPDFXCview SetProperty Defines item template for each commenting oval style Contained Objects Name Type Description ID Integer Specifies the unique ID of the comment style RS Name String Defines name of comment style RWS FColor Integer Specifies fill color for the comment String For possible named values see the Colors RWS Default value is 1 none SColor Integer Specifies stroke color for the comment String For possible named values see the Colors RWS Default value is RGB 255 0 0 red Opacity Double Specifies the opacity of the comment RWS Default value is 1 0 100 opacity BlendMode Integer Specifies the blend mode for the comment String For possible named values see the Blend RWS Modes Default value is 0 Normal Border Group Specifies border for the comment RWS DefSubj String Specifies default subject text for comment RWS This value will be used only if DefSubjMode is set to Custom DefSubjMode Integer Specifies mode for default subject String For possible named values see th
66. key must be held down when the accelerator key is pressed 128 The flag for default shortcuts If it present then shortcut is default See Also Objects Commands lt Item gt Shortcut 2 2 3 55Sticky Note Icon Types Supported Values Default 3 Comment Checkmark 1 Circle 2 Cross 4 Help 5 Insert 6 Key 7 NewParagraph 8 TextNote 9 Paragraph 10 RightArrow 11 RightPointer 12 Star 13 UpArrow 14 UpLeftArrow 15 See Also Objects Commenting 2 2 3 56 Summarize Annotations Group Types Supported Values Reference 267 Page 0 Type 1 Author 2 Date 3 Subject 4 See Also Objects Operations SummarizeAnnots 2 2 3 57 Summarize Annotations Output Types Supported Values PDF 0 RTF 1 TXT 2 HTML 3 See Also Objects Operations SummarizeAnnots Output 2 2 3 58Summarize Annotations PDF Layouts Supported Values CommentsOnly 0 Comments only DocAndCommentsWithConnectors Document and comments with connector lines on single page DocAndCommentsWithSeqNumbers Document and comments with sequence 5 numbers on single page DocAndComments 1 Document and comments on single page DocAndCommentsWithConnectorsOnTwo 411 Document and comments with connector Pages lines on separate pages DocAndCommentsWithSeqNumbersOnTw 13 Document and comments with sequence oPages numbers on separate pages DocAndCommentsOnTwoPages 9 Documents and comments on separate pages See Also Objects Operations SummarizeAnnot
67. lt ltem gt defines item template for each style representation Contained Objects Name Type Count Integer R Remarks Description Contains number of all accessible styles This object is an array of items where each item is represented as lt ltem gt For more information about object naming notation see Object Name Notation 125 PDF XChange Viewer ActiveX SDK Examples for usage in pseudocode Enumerate all styles for stickynote comment GetProperty Commenting StickyNote Styles Count DataOut 0 Count DataOut for i 0 to Count 1 GetProperty Commenting StickyNote Styles i ID DataOut 0 See Also Objects Commenting IPDFXCview DoVerb IPDFXCview GetProperty IPDFXCview SetProperty Defines item template for each commenting stickynote style Contained Objects Name Type Description ID Integer Specifies the unique ID of the comment style RS Name String Defines name of comment style RWS Type Integer Specifies ID of an icon to be used in displaying String the sticky note RWS For possible named values see the Sticky Note Icon Types Default value is 3 Comment FColor Integer Specifies fill color for the comment String For possible named values see the Colors RWS Default value is RGB 255 255 0 yellow Opacity Double Specifies the opacity of the comment RWS Default value is 1 0 100 opacity DefSubj String Specifies default subject text for comm
68. ly PES A A te tad asa 254 image Conversion Ty PES AAA ALA AAA AA 255 IMAGE SCAIE Ty POS COPA RP PRO E Un apa EEEE E Aa EE NNS EEE 255 Image Types A al Gia as cities deinen dida it 255 Keyboard Notifications Filter Fla asie narran anna rar nina A veis 256 Line Ending Link Highlight Mode MainiBars tieseieit SA MBAR a NASA Ba i real ae ao ah Ma ade M in Panes ic AA eae eee Mouse Notifications Filter Flags oononinnionionicnicnnonicaninnrnnanann cana no cacao narco nar nnr carr nannrnar nro arar narnia 258 Name Generation MacTOS mica A AS 259 Contents Vill New Paragraph MOd6S cos iii little Pages ay OUtS A den a anand aiid Pages Magnification Modes insine a nie Pages Magnifications a tt ta A O O O II hb AAA Paper Orientation PDF Specification Versions Print Notitications Fiter Flags iii ias 262 Print Scale TY POS iii A tdi tii 262 Print SPOClalS a A A N da 263 Print TEXAS Curves a a ees 263 Range EMOS cio A ie niin ea ees Range Types Registry Roots Rotation Directions mur A ae ee el S archi Modes ie GAM AA A BAe go sae She Selection Notifications Filter FlA9S cistitis can SNORICULK OY TY POS NAAA Se eee a at Ree ee ShOrtCut Modif Sisi AA eine eee Sticky Note COMTIPES is Aiea ahaa iralavn da ia Summarize Annotations Group Typ8S oocooccicnonononicnnnnonanncn nono rca nor Summarize Annotations Output Types Summarize Annotations PDF Layouts
69. modes See also IPDFXCview SaveDocument Syntax enum PXCVA_DocumentSaveFlags 262 PDF XChange Viewer ActiveX SDK PXCVA_DocumentSaveAs 0x00000001 PXCVA_DocumentSaveCopyAs 0x00000003 PXCVA_DocumentSavelnc 0x00000004 PXCVA_DocumentSaveForWeb 0x00000008 he Constants PXCVA_Document SaveAs The specified document may be saved with a new name and or to a new location If the operation succeeds then the original document will be closed and replaced by newly saved document in the Viewer PXCVA_DocumentSaveCopyAs The specified document will be saved to a new location as new copy The default name for the saved file is lt DocumentName gt copy lt Index gt pdf For example if original file is c test pdf then saved copy can be c test copy pdf c test copy 2 pdf c test copy 3 pdf PXCVA_DocumentSavelnc The original content will be written without any changes first and then al new or changed objects will be appended N B This flag MUST be used to save all digitally signed documents or the digital signature will be lost PXCVA_DocumentSaveForWeb The specified document will be saved in a special format that is adapted for fast Web view Not implemented See Also IPDFXCview SaveDocument 2 4 2 PXCVA_EventTypes The values shown in this enumeration allow you to identify different types of received events See also _IPDFXCviewEvents OnEvent Syntax enum PXCVA_EventTypes PXCVA_OnProp
70. non zero value to the UserChoice property You may also change the new folder name at run time For example in pseudocode function OnEvent Type Name Dataln DataOut Flags if Type PXCVA_OnDisplayPrompt if Name Prompts CreateFolderError get file writing error if need GetProperty Prompts CreateFolderError ErrorCode DataOut 0 analyse result in DataOut set another folder name SetProperty Prompts CreateFolderError FolderName DeatelIn C TestDir 0 Reference 221 skip original dialog and try folder creation for new path SetProperty Prompts CreateFolderError UserChoice Dataln Retry 0 See Also IPDFXCviewE vents OnEvent PXCVA EventTypes PXCVA OnDisplayPrompt IPDFXCview GetProperty IPDFXCview SetProperty 2 2 2 15 8 EnterDocumentPassword This is a special object for modifying the confirmation dialog when a password protected document requires a password You must implement a special event handler see _IPDFXCviewEvents OnEvent and match the type of the received event with the PXCVA_EventTypes PXCVA_OnDisplayPrompt constants and the name with the Prompts EnterDocumentPassword string Contained Objects Name Type Description FileName String Represents source file name of document R Password Integer Password for opening the document RW UserChoice Integer User s choice for this case String Initial value is O default processing
71. of passed value only Return Value Returns S_OK if successful or an error value otherwise To obtain the text description of a received error code use GetTextFromResult Remarks Unlike the SetProperty the name of document s property does not contain the document identification prefix Documents 4095 for example because the document is specified by TD argument already l e the call in pseudocode SetProperty Documents 4095 Title is equivalent to call SetDocumentProperty 4095 Title See Also IPDFXCview GetDocumentProperty IPDFXCview DoDocumentVerb Reference 31 IPDFXCview GetProperty IPDFXCview SetProperty Objects Documents 2 1 1 3 Auxiliary Methods Methods Method Description GetDocumentFromName This method is used to obtain unique identifier of document which is represented by input name string GetTextFromResult This method is used to obtain the text description of returned error codes by other methods GetViewObjectFromName This method is used to obtain type identifier proper name of view object which is represented by input name string See Also General Methods Document Methods 2 1 1 3 1 GetDocumentFromName This method is used to obtain the unique identifier of the open document which is represented by input name string This method is a simplified variant of a special call to the DoVerb method Syntax HRESULT GetDocumentF romName BSTR Name LONG
72. open documents CloseDocument Closes an open document CreateNewBlankDocument Creates new PDF document DeleteDocumentPages Delete pages from PDF document using parameters previously defined by Objects Operations DeletePages DiscardAllCachedChanges Discards all cached settings that were passed with the PXCVA_Flags PXCVA_NoApply flag ExecuteCommand Performs specified Ul command ExportDocument Exports a document to an image format with the previously defined parameters in Objects Export ExtractDocumentPages Extracts pages from PDF document using parameters previously defined by Objects Operations ExtractPages FlushDocument Flushes all of the user s cached changes for a document GetActiveDocument Returns the unique identifier ID of the active document GetDocumentFromName Obtains the unique identifier of the named document GetDocumentID Returns the document unique identifier ID for the specified index GetDocumentIndex Returns the document order index either by the unique identifier ID or by the full file name GetDocumentsCount Returns the number of all opened documents GetTextFromResult Obtains the text description of error codes returned by other operations GetViewObjectFromName Obtains type identifier and proper name of the view object Has VisibleBars Tests visibility of Ul bars menubar toolbars status bar etc InsertEmptyDocumentPage Inserts empty pages into document s InsertDocumentPages Inserts
73. options for search RWS AllowOpenExternalDoc Integer String Allow to open external pdf documents va results RWS list in Search panel For possible named values see the Booleans Default value is 1 true AllowSearchinFolders Integer String Allow to search text in folders Switches on off RWS the folders tree in the search pane For possible named values see the Booleans Default value is 1 true AllowSearchResBlinking Integer String Show blinking selection on the found text RWS For possible named values see the Booleans Default value is 1 true Remarks To start search you may execute StartFullSearch Ul command To stop search execute StopFullSearch See Also IPDFXCview DoVerb IPDFXCview GetProperty IPDFXCview SetProperty Commands List 2 2 2 16 1 Options Contains options for text search Contained Objects PDF XChange Viewer ActiveX SDK Name Type WholeWordsOnly Integer String RWS CaseSensitive Integer String RWS IncludeBookmarks Integer String RWS IncludeComments Integer String RWS LookInSubFolders Integer String RWS See Also Description Search only whole words For possible named values see the Booleans Default value is 0 Use case sensitive search For possible named values see the Booleans Default value is 0 Search in bookmarks For possible named values see the Booleans Default value is 0 Search in comments For possible named values see the B
74. otherwise To obtain the text description of a received error code use IPDFXCview GetTextFromResult See Also IPDFXCview DoVerb IPDFXCview CloseDocument 2 2 1 8 CreateNewBlankDocument Creates new PDF document using parameters previously defined by Objects Operations NewDocument FromBlank Name CreateNewBlankDocument or short NewBlankDocument Arguments Nothing Return Value Returns S_OK on success or an error value otherwise To obtain the text description of a received error code use IPDFXCview GetTextFromResult If successful it returns the unique identifier ID of the created blank document in DataOut See Also IPDFXCview DoVerb Objects Operations NewDocument FromBlank 2 2 1 9 DeleteDocumentPages Delete pages from PDF document using parameters previously defined by Objects Operations DeletePages Name DeleteDocumentPages Arguments Req Type Description 1 Yes LONG The unique identifier of the document or full file name of the document BSTR Return Value Returns S_OK on success or an error value otherwise To obtain the text description of a sa PDF XChange Viewer ActiveX SDK received error code use IPDFXCview GetTextFromResult See Also IPDFXCview DoVerb Objects Operations DeletePages Objects Documents lt ltem gt DeleteP ages 2 2 1 10DiscardAllCachedChanges Discards all cached settings that were passed with the PXCVA_Flags PXCVA_NoApply flag
75. pages from source document IsPDF Tests file or stream object for PDF format MsgToCommand Translates the standard windows message to an existing Ul command MsgToCommandAndExec Translates the standard windows message to an existing Ul command and executes it NewDocumentFromimages Creates new PDF document from the images NewDocumentFromText Creates new PDF document from the plain text NewDocumentFromRTE Creates new PDF document from the formatted text RTF LoadSettings Loads all saved control settings OpenDocument Opens a document PrintDocument Prints a document with the parameters defined earlier by so PDF XChange Viewer ActiveX SDK 2 2 1 1 2 2 1 2 Objects Print RemoveRecentltem This operation can be used to remove existing item from list of recent documents RotateDocumentPages Rotates document pages RunJavaScript Executes the supplied Java Script SaveDocument Saves a document SaveSettings Saves all control settings to external storage ShowStamps Collection Shows hides the specified stamps collection SummarizeDocumentAnnot Summarizes all comments from a document to a new document sS file using parameters previously defined by Objects Operations SummarizeAnnots Remarks Names of all operations are case independent i e the two names GetNamea and getNamea are considered identical for all operation input methods See Also IPDFXCview DoVerb IPDFXCview GetProperty IPDFXCview SetPr
76. pages only ge LastUsedView 0 Displays the last used view of the document See Also Objects PageDisplay Default View 2 2 3 15Document Interfaces Supported Values Multiple document interface MDI displays multiple documents 0 at the same time with each a displayed in its own Multiple window SDI Single document interface Single See Also Objects General DocumentInterface 2 2 3 16Document Panes Supported Document Panes Identifiers Bookmarks 32910 Specifies the document s Bookmarks pane Thumbnails 32912 Specifies the document s pages Thumbnails pane Layers 33006 Specifies the document s Layers pane Fields 33008 Specifies the document s Fields pane Comments 33204 Specifies the document s Comments list pane Remarks Examples for usage in pseudocode 1 get Thumbnails pane visibility GetDocumentProperty 4095 View Panes Thumbnails Visible DataOut 0 or GetDocumentProperty 4095 View Panes 32912 Visible DataOut 0 2 show Thumbnails pane 252 PDF XChange Viewer ActiveX SDK SetDocumentProperty 4095 View Panes Thumbnails Visible Dataln 1 0 or SetDocumentProperty 4095 View Panes 32912 Visible Dataln 1 0 See Also Objects Documents lt ltem gt View 2 2 3 17 Document Save Methods Supported Values FullOrlncrementalForDigSi Defines the full saving for regular documents or gn 0 incremental saving for digitally signed documents recommen
77. pl x pl y p2 x p2 y DataOut vl x DataOut 0 px vl y Data0ut 1 v2 x DataOut 2 v2 y Data0ut 3 double fTransformsIncludedAlready_optional 1 additional flag for ing DoVerb Documents 0 pages 2 PagePointsToViewPoints DataIn pl x pl y p2 x p2 y fTransformsIncludedAlready_optional DataOut 0 See Also IPDFXCview DoVerb Objects Documents lt tem gt Converts the screen coordinates in pixels of a specified point on the screen to document page coordinates in points Name TranslateScreenPoint Arguments 1 Yes LONG Specifies x coordinate of screen point in pixels relative to desktop 2 Yes LONG Specifies y coordinate of screen point in pixels relative to desktop Return Value Returns S_OK on success or an error value otherwise To obtain the text description of a received error code use IPDFXCview Get TextFromResult The DataOut receives SAFEARRAY which contain x and y coordinates on the document page in the points Remarks For example in pseudocode DoVerb Documents 0 pages 2 TranslateScreenPoint DataIn sx sy Datad0ut 0 px DataOut 0 Page x coordinate py DataOut 1 Page y coordinate See Also 167 168 PDF XChange Viewer ActiveX SDK IPDFXCview DoVerb Objects Documents lt ltem gt Translates the coordinates of points from pages view coordinate system to the page coordinate system Name ViewPointsToPagePoints Arguments Coo
78. possible named values see the Booleans Default value is 0 Description Line thickness in points Default value is 1 pt Line type Supported values S solid D dashed Default value is S Specifies line dash type Used if BType is equal to D For possible named values see the Dash Types Description Defines the type of page range for rotation For possible values see the Range Types Supports only All Selected Current and Exact values Default value is 1 all pages Specifies an additional filter for the page range For possible values see the Range Filters Default value is 1 all pages Specifies the exact pages for rotation The string should contain the page numbers and or page ranges separated by commas counting from the start of the document For example 1 3 5 12 Determines how to rotate the pages Reference 205 String For possible values see Rotation Direction RWS Default value is O Clockwise See Also IPDFXCview DoVerb IPDFXCview GetProperty IPDFXCview SetProperty Operations RotateDocumentPages Objects Documents lt ltem gt RotateP ages 2 2 2 11 7 SummarizeAnnots Allows to get a summary all the comments associated with a PDF to save view them as a new PDF Document Rich Text Format Plain Text or Web Page Contained Objects Name Type Description GroupBy Integer Defines the parameters by which the comments can String be grouped RWS For
79. possible named values see the Colors RWS Default value is RGB 255 0 0 red Opacity Double Specifies the opacity of the comment RWS Default value is 1 0 100 opacity BlendMode Integer Specifies the blend mode for the comment String For possible named values see the Blend RWS Modes Default value is 0 Normal Border Group Specifies border for the comment RWS DefSubj String Specifies default subject text for comment RWS This value will be used only if DefSubjMode is setto Custom DefSubjMode Integer Specifies mode for default subject String For possible named values see the Subject RWS Modes Default value is 0 Default See Also Objects Commenting IPDFXCview DoVerb IPDFXCview GetProperty IPDFXCview SetProperty 2 2 2 3 12 Perimeter Accesses the properties of the commenting Contained Objects Name Type Description Styles Array Defines item style representation RWS See Also Objects Commenting 2 2 2 3 12 1 Styles This object represents array of all comments styles and provides additional operations with them Item Template lt ltem gt defines item template for each style representation Contained Objects Name Type Description Count Integer Contains number of all accessible styles R Remarks 117 ns PDF XChange Viewer ActiveX SDK This object is an array of items where each item is represented as lt ltem gt For more information about object naming nota
80. possible values see Summarize Annotations Group Types Default value is 0 group by page SortBy Integer Defines the parameters by which the comments can String be sorted within a group RWS For possible values see Summarize Annotations Group Types Default value is 0 sort by page IncludelnvisibleAnnots Integer When specified the invisible comments are included String into the summary RWS For possible named values see the Booleans Default value is 0 ExcludeReplies Integer When specified the replies to the comments are not String included into the summary RWS For possible named values see the Booleans Default value is 0 SkipUndefinedAnnots Integer When specified the undefined comments are not String included into the summary Undefined comment is RWS comment without information which needed for specified grouping sorting modes For possible named values see the Booleans Default value is 0 RangeType Integer Allows to select the page s with the comments to String be summarized RWS For possible values see RangeTypes Default value is 1 all RangeFilter Integer Specifies range filter String For possible values see RangeFilters RWS Default value is 1 all RangeText String Specifies the exact pages to summarize The string RWS should contain the page numbers and or page ranges separated by commas counting from the start of the document For example 1 3 5 12 RangeReverse Integer Specifi
81. quadrilateral area Y coordinate of bottom left point of the first quadrilateral area X coordinate of bottom right point of the first quadrilateral area Y coordinate of bottom right point of the first quadrilateral area X coordinate of top right point of the first quadrilateral area Y coordinate of top right point of the first quadrilateral area X coordinate of top left point of the first quadrilateral area Y coordinate of top left point of the first quadrilateral area X coordinate of bottom left point of the second quadrilateral area 00 N DOA A O N O Y coordinate of bottom left point of the second quadrilateral area See Also Objects Documents lt ltem gt Pages lt ltem gt Text Chars lt ltem gt PXCVA_OutArgs Values This section represents a special named values tables Reference 245 Blend Modes Booleans Border Effects Border Types Code Pages Color Management Engines Colors Command States Comment Subject Modes Content Monitor States Context Menu User Choices Dash Types Document Bars Document Initial View Modes Document Interfaces Document Panes Document Save Methods Document Save Modes Document SaveAs Destination Types Duplex Printing Export Modes Export to Image Modes File Attachment Icon Types Highlight Form Fields Masks Image Align Types Image Conversion Types Image Scale Types Image Types Keyboard Notifications Filter Flags Line Ending Link Highlight Mode Main Bars Ma
82. requires a special numeric property in item structure with name ID which contains a unique identifier of the item in current array Examples of the item structure that contains property ID Objects Documents lt ltem gt Objects Bars lt ltem gt Objects Commands lt ltem gt See Also IPDFXCsmartp 2 1 5 1 3 GetltemPointBylndex If this smart point represents an object which contains an array of items you can create a new smart point object for the item which is specified by order index and obtain interface pointer to it Syntax HRESULT GetItemPointByIndex LONG Index IPDFXCsmartp ItemPointOut Parameters Index in LONG that specifies the order index of item ItemPointOut out Pointer to a IPDFXCsmartp interface that receives a new smart point object which depends on an item specified by Index PDF XChange Viewer ActiveX SDK Return Value Returns S_OK if successful or an error value otherwise To obtain the text description of a received error code use GetTextFromResult See Also IPDFXCsmartp 2 1 5 1 4 GetltemPointByNindex If this smart point represents an object which contains an array of items you can create a new smart point object for the item which is specified by a unique name if it is supported and obtain interface pointer to it Syntax HRESULT GetItemPointByNIndex BSTR NamedIndex IPDFXCsmartp ItemPointOut i Parameters NamedIndex in BSTR that specifi
83. styles and provides additional operations with them Item Template lt ltem gt defines item template for each style representation Contained Objects Name Type Description Count Integer Contains number of all accessible styles R 132 PDF XChange Viewer ActiveX SDK Remarks This object is an array of items where each item is represented as lt ltem gt For more information about object naming notation see Object Name Notation Examples for usage in pseudocode Enumerate all styles for underline comment GetProperty Commenting Underline Styles Count DataOut 0 Count Data0ut for i 0 to Count 1 GetProperty Commenting Underline Styles i ID DataOut 0 See Also Objects Commenting IPDFXCview DoVerb IPDF XCview GetProperty IPDFXCview SetProperty Defines item template for each commenting underline style Contained Objects Name Type Description ID Integer Specifies the unique ID of the comment style RS Name String Defines name of comment style RWS SColor Integer Specifies stroke color for the comment String For possible named values see the Colors RWS Default value is RGB 0 255 0 green Opacity Double Specifies the opacity of the comment RWS Default value is 1 0 100 opacity BlendMode Integer Specifies the blend mode for the comment String For possible named values see the Blend RWS Modes Default value is 0 Normal DefSubj
84. than one input arguments then you should pass them by DataIn through SAFEARRAY structure If you want to pass only the first argument to Dat arn no other arguments or optional then you can pass this argument directly without placing it into SAFEARRAY structure For example in pseudocode show open dialog DoVerb NULL OpenDocument Dataln DataOut 0 or open document directly DoVerb NULL OpenDocument DataIn C Test pdf DataOut 0 or if document is password protected DoVerb NULL OpenDocument DataIn SafeArray C Test pdf password DataOut 0 See Also IPDFXCview GetProperty IPDFXCview SetProperty IPDFXCview DoDocumentVerb Named Objects Named Operations 2 1 1 1 4 GetProperty This simplified method retrieves property values It acts as a shortcut to the DoVerb main method Syntax HRESULT GetProperty BSTR Name VARIANT DataOut LONG Flags Parameters Name in BSTR that specifies full name of the property as string identifier For more information see Named Objects DataOut out Pointer to a VARIANT structure that receives value of the property specified by Name Flags in LONG that specifies optional flags This argument can be 0 Also you can pass the PXCVA Flags PXCVA GetNamed to obtain the named value as a simple string of the property specified by Name Return Value Returns S_OK if successful or an error value otherwise To obtain the text descripti
85. the main view attributes visibility position layout for main document bars panes windows It also provides customizing of main menu and toolbars Contained Objects Name Type Description Bars Array Represents all Ul bars menu command status RWS bars For details about main bars see the Main Bars Colors Group Defines colors of the control s user interface RWS LockAllBars Integer Deny allow customization and reposition for all String command bars Default value is O all command bars RWS are unlocked For possible named values see Booleans Locked Integer Deny allow all Ul customization String Default value is 0 RWS For possible named values see Booleans Panes Array Represents all Ul panes named containers for RWS special views For details about main panes see the Main Panes ShowDocumentViewBorde Integer Enables disables 3D border for document view area r String pages view RWS For possible named values see Booleans ShowW orkspaceBorder Integer Enables disables 3D border for control s workspace String area RWS Note the effect can only be seen when there is no opened document For possible named values see Booleans ShowTooltipsOnToolbars Integer Enables disables tooltips for all toolbars menus String Default value is 1 RWS For possible named values see Booleans Show3DToolbars Integer Enables disables borders for all main toolbars 236 PDF XChange Viewer ActiveX SDK String
86. the property specified by Name Flags in LONG that specifies optional flags This argument can be 0 Also you can pass the PXCVA Flags PXCVA GetNamed to obtain named value as a simple string of the property specified by Name Return Value Returns S_OK if successful or an error value otherwise To obtain the text description of a received error code use GetTextFromResult Remarks Unlike the GetProperty the name of document s property does not contain the document identification prefix Documents 4095 for example because document is specified by rp argument already l e the call in pseudocode GetProperty Documents 4095 Title is equivalent to call GetDocumentProperty 4095 Title See Also IPDFXCview SetDocumentProperty IPDFXCview DoDocumentVerb IPDFXCview GetProperty IPDFXCview SetProperty Objects Documents 2 1 1 2 11 GetDocumentsCount Returns the number of all opened documents This method is a simplified variant of a special call to the DoVerb method Syntax HRESULT GetDocumentsCount LONG Count 7 Parameters Count out Pointer to a LONG that receives unique identifier of the active document Return Value Returns S_OK if successful or an error value otherwise To obtain the text description of a received error code use GetTextFromResult See Also IPDFXCview GetDocumentID IPDFXCview GetDocumentindex z PDF XChange Viewer ActiveX S
87. to some specific functionality of this method GetProperty Retrieves specified property GetVersionInfo This method returns the version of client and server portions of ActiveX control LoadSettings Loads all control settings saved to external storage RunJavaScript Performs Java script SaveSettings Saves all control settings to an external storage SetDevinfo This method allows you to enter license information Without this information wherever the document is visible a demo label will appear If you print export save the document the result will also contain the demo label SetProperty Sets specified property See Also Document Methods Auxiliary Methods 2 1 1 1 1 ApplyAllCachedChanges Apply all cached settings that were passed with the PXCVA_Flags PXCVA_NoApply flag Syntax HRESULT ApplyAllCachedChanges VOID Return Value Returns S_OK if successful or an error value otherwise To obtain the text description of a received error code use GetTextFromResult See Also PXCVA Flags PXCVA NoApply PDFXCview DiscardAllCachedChanges Operations ApplyAllCachedChanges Reference 15 2 1 1 1 2 DiscardAllCachedChanges Discard all cached settings that were passed with the PXCVA_Flags PXCVA_NoApply flag Syntax HRESULT DiscardAllCachedChanges VOID Return Value Returns S_OK if successful or an error value otherwise To obtain the text description of a received error code use GetTextFro
88. txt file Contained Objects FolderName String RWS FileName String RWS CodePage Integer String RWS See Also Specifies destination folder name If this value is empty then the lt My Documents gt standard folder will be used automatically Default value is empty NULL or Specifies destination file name It supports macros for generic names See Name Generation Macros Specifies code page for output text file For some possible named values see Code Pages Also you may specify any other code page identifier which supported in system Objects Operations SummarizeAnnots Output Specifies output settings for HTML file format Contained Objects FolderName String RWS FileName String RWS See Also Specifies destination folder name If this value is empty then the lt My Documents gt standard folder will be used automatically Default value is empty NULL or Specifies destination file name It supports macros for generic names See Name Generation Macros Objects Operations SummarizeAnnots Output 2 2 2 12PageDisplay Controls document level page display Contained Objects Reference 209 ArtBoxColor Integer Specifies the color of the Art Box String For possible named values see the Colors RWS Default value is RGB 255 0 0 red BleedBoxColor Integer Specifies the color of the Bleed Box String For possible named values see the Colors RWS Default value is R
89. which is specified by a unique name if it is supported and obtain interface pointer to it GetPointName Retrieves full name of this smart point GetProperty Retrieves value of specified sub property by relative name GetSubPoint Creates a new smart point object by specified relative name and retrieves interface pointer to him SetProperty Sets value of specified sub property by relative name See Also IPDFXCview IPDFXCargs 2 1 5 1 1 DoVerb This is a shortcut to the main method IPDFXCview DoVerb in the library but ObjectName if not NULL argument should mean relative name of any sub object or sub property The syntax of this method is identical to main IPDFXCview DoVerb Reference as 2 1 5 1 2 GetltemPointByID If this smart point represents an object which contains an array of items you can create a new smart point object for the item which is specified by a unique ID if it is supported and obtain interface pointer to it Syntax HRESULT GetItemPointByID LONG UniquelD IPDFXCsmartp ItemPointOut y Parameters UniquelD in LONG that specifies the unique ID if it is supported of item ItemPointOut out Pointer to a IPDFXCsmartp interface that receives new smart point object which depends on an item specified by UniqueID Return Value Returns S_OK if successful or an error value otherwise To obtain the text description of a received error code use GetTextFromResult Remarks This method
90. 153 Prints At Ia 154 REMOVESECUMITY uds AAA da 155 RotatePages a A Mili de AA AA A Maen aes 155 HN A a e eu 156 SaveAttachment iii A AA A eA 157 SOECES A A a 157 SelectAnnot E A A A id ere ite eee ete 157 SEC A a acco dit cae Selo a a A a rat 158 PDF XChange Viewer ActiveX SDK SUIMIMALIZEA MOS ia 159 PATOS NN A a 160 EMBINDISS Wi AAA ho a er en nee a 161 GetSelectedRanges s3 ivisiissciviah resraveaiari Ai 162 lt ltem gt lt Methods gt GetAnnotName GetAnnotRect GetANNOts COUNT cso dover A enn r eet GetAnnothy Per Nati MovePointToScreenPoint PagePoints ToView Points TranslateScreenPoint View Points ToPagePoints TER a MES a A Ae ie bn eae Addink ar A e Gets saeiveee ie A A OS ie eed GetQuads a A RG vee GetSelected ii A AAA Rail Aine ne in NI GetSelected Ranges iva novecieesesteecesesheeeesh drones bteecetlevast cele Aa tea Highlight Select StrikeOut E e EE avalanche ene A E UNAGErING iaa Ad Chars lt ltem gt Style Font Words lt ltem gt Lines lt ltem gt Form Highlight Fields i a ended thee ated View CO RA AA AAA Aa A AA aT Options ANN AA Ma aa aa a eee Ae FORMS tit A i denen denver ations AAA lt ION TECOS ti lt O International isa A A E E E A E E Notifications BeforeCloseDoc BeforeSaveDoc GontextMenu 22 r a N ee eA ela eis BDocGloseds it AA A pied een es eaten eile DocSaved gt a AR hed vee Min ee ee eed ee ve i ees e AA On veda e TE Ep r A a ara aa Ke
91. 3601 Refresh Bookmarks Tree y 3602 Rename 3 Rename the Selected Bookmark 3625 Show Bookmark Icons 6 Show Hide Bookmark Icons 3602 Wrap Long Bookmark Titles 5 3602 Set Current Appearance as Default 4 gt 3601 Go to Bookmark 0 3600 Ensure Visibility of Corresponding 9 Bookmark 3600 Delete Bookmarks 6 Delete Selected Book marks 3600 Bookmarks Properties 7 Show Properties of Selected Bookmarks 3630 Collapse All Bookmarks 7 3600 Zoom Out Bookmarks 5 Reduce Book marks 3600 Zoom In Bookmarks 4 Enlarge Bookmarks 3341 Zoom Out Thumbnails 4 Reduce Thumbnails 3654 Highlight Visible Area 8 Highlight Visible Area of the Current Page 3341 Zoom In Thumbnails 3 Enlarge Thumbnails 3303 Points 6 3303 Millimeters e PDF XChange Viewer ActiveX SDK 3303 3 3303 2 3626 3 3626 2 5771 8 3293 7 3325 5 3323 9 3324 y 3324 2 3323 6 3323 7 3323 5 3323 2 3324 3 3324 5 3324 4 3310 8 3648 9 3651 1 3650 0 3654 7 3651 3 3643 0 3643 2 Inches Centimeters 8 33 12 5 Scroll Left Close Active Tab Close All Tabs But This Previous Previous Comment Collapse All Collapse All Comments Expand All Expand All Comments By Color Group Comments by Color By Creation Date Group Comments by Creation Date By Modification Date Group Comments by Modification Date By Page Group Comment
92. 59 InsertEmpty DOCUMENTPAJES aci a E 60 ISPDE O ogi abevecanvevte A RE E AA A LoadSettings MsgToCommand Msg ToCommmeandAniGlx ei coc cas ex sovesva cock age hic vas eaa Aa araa Ea Spa o raa A O AN A 62 New BlankDoCumentisc vcsccisscevceusassussesscaceucacessascascevestguessssbevcausccecees EEA E aAA aA vs deasusdevecedgvascavendeuesaecbevcauuctevertess 63 New DOCUMENTEFOMIMAJES cinta ideario aire basin 63 New DoCcUMENtTETOMA TE E E A E E id 63 New Docume O OAT osado iia rata 64 m PDF XChange Viewer ActiveX SDK OpenDocument aiD otaa aa E A A E Ae a RemoveRecentl a Mieviiivirn a a a a a a e tada i aE 66 RotateDocumenthages 4 nis e A in ii a ARA 67 RUNAS AA DA A N 67 SaveDocument si SUE tii A o 69 Show Stamps Collect iii AS DA AT es ee aIz 69 SummarizeDoc umentA MotS iii vi est coed denice ives I a a 69 0 no Ann o A desu edeoeved cetersegcecestecbset ColorManagement lt ltem gt COMIMANGS tit ia Enan E a a A e e A a aaea daa a e a e ai Command List lt ltem gt Shortcut AAA ean E OO e a e a E aa A Area Styles lt ltem gt Arrow Styles lt ltem gt Callout Styles lt ltem gt Cloud Styles lt ltem gt Distance Styles lt ltem gt FileAttachment Styles lt ltem gt Highlight Styles lt ltem gt Line Styles lt ltem gt Link Styles lt ltem gt Oval Styles lt ltem gt Pencil Styles lt ltem gt Perimeter Styles lt ltem gt Polygon Styles lt ltem gt Polyline Styles lt ltem gt
93. 768 0 5760 1 3643 8 LastPage Annots Tool LineMenultem LoupeMenultem NextPage Open Annots OpenPopups 9 PDF XChange Viewer ActiveX SDK Show Java Script Options Keep Tool Selected Last Page Go to Last Page Line Tool Lock Unlock All Command Bars Loupe Tool Set Current Text Formatting as Default Save this Text Formatting Font Font Size Color Align etc to Current Comment Style Saved Text Formatting wil be used for each new comment as Default for Current Comment Style Delete Label Edit Label Export Measurements To CSV File Export Measurements Show Measure Info Window Restore Caption Placement Change Markup Label Change Scale Ratio From Blank Page From Image File From Rich Text Format RTF File From Scanner From Text File Next Page Go to Next Page Open Open an Existing Document Open All Pop Ups Reference oa OpenContainingFol 3325 Open Containing Folder der 8 Open the Source Folder of the Active Document OpenPopup 3312 Open Pop Up Note 2 OpenURL 3327 Open from URL 2 Open Document from URL Order BackOne 3654 Back One 6 Order ForwardOne 3654 Forward One 5 Order 3654 To Background ToBackground 4 Move to Background Order 3654 To Foreground ToForeground 3 Move to Foreground OvalToo 3312 Annots Tool Oval Tool 6 CircleMenultem PageNumber 3290 Display Current Page Number in this 9 Document PanAndZoomToo l 3310 P
94. 9L3R6 Canada and you the user Licensee and is effective the date Licensee opens the package containing the diskette s CD R s or otherwise uses the enclosed software product This Agreement covers all materials associated with Tracker s PDF XChange Viewer SDK developer s toolkit products both Simple DLL and ActiveX based options including the enclosed software product Software 1 GRANT OF DEVELOPMENT LICENSE TRACKER grants Licensee a non exclusive non transferable worldwide license for one 1 programmer to install the Software on a single personal computer and use the Software and one copy of the associated user documentation contained in the accompanying user manual online help and Acrobat files Documentation in the development of End User software application s as contemplated in section 2 below herein the Application Software If additional programming seats are needed Licensee should contact TRACKER for discounted license pricing The license granted hereunder applies only to the designated version of the enclosed Software If the Software is an upgrade or cross grade it and the product that was upgraded cross graded constitute a single copy of the Software for purposes hereof and the new version and product that was upgraded cross graded cannot be used by two people at the same time 2 END USER APPLICATION The Application Software developed by Licensee must be an End User Application An end
95. Also IPDFXCview RunJavaS cript JavaScript for Acrobat API Reference 2 3 3 Bookmark This object represents a node in the bookmark tree that appears in the bookmarks navigational panel see also Document Panes Bookmarks are typically used as a table of contents allowing the user to navigate quickly to topics of interest Supported Properties All are supported 2 3 4 2 3 5 Reference Supported Methods All are supported See Also IPDFXCview RunJavaS cript JavaScript for Acrobat API Reference console This object is a static object that enables access to the JavaScript console for executing JavaScript and displaying debug messages Supported Properties There are no properties for this object Supported Methods All are supported See Also IPDFXCview RunJavaS cript JavaScript for Acrobat API Reference Doc This object provides the interface between a PDF document open in the viewer and the JavaScript interpreter It provides methods and properties for accessing the PDF document Supported Properties author baseURL calculate creationDate ions alle ea dataObjects cleilratayy docID documentFileName external filesize innerAppWindowRect innerDocWindowRect keywords 275 276 PDF XChange Viewer ActiveX SDK layout modDate mousex mouseY numFields numPages outerAppWindowRect outerDocWindowRect pageNum path pageWindowRect permStatusReady producer securityHandl
96. By Type 3 Group Comments by Type 3323 By Author 4 Group Comments by Author 3323 Next 8 Next Comment 3633 Show Dates 7 Show Modification Dates of Comments 3645 Set Current Appearance as Default 9 Save this Appearance Colors Border Style Opacity etc to Current Comment Style Saved Appearance wil be used for each new comment as Default for Current Comment Style 3646 Locked y 3646 Apply Default Appearance 0 Apply Saved Appearance Colors Border Style Opacity etc from Current Comment Style 3313 Preview 3 3633 Show Colors 9 Show Color of Comments 3633 Show Text 8 Show Text of Comments 3633 Show Authors 6 Show Authors of Comments 3633 Show Subjects 5 Show Subjects of Comments 3325 Close This Tab 6 5771 Scroll Right 9 3341 Comment 0 3293 Show All Tabs 6 3653 Show All Opened Documents 9 Thumbnails View All Opened Documents as Thumbnails 3293 Show All Tabs Thumbnails 8 3341 Make Snapshot 2 3303 Picas PDF XChange Viewer ActiveX SDK 5 3654 Interactive Highlighted Area 9 Enable disable the Interactivity of the Highlighted Area 3630 Expand All Bookmarks 6 3600 New Bookmark 8 Create a New Bookmark 3602 Apply Default Appearance 6 Apply Default Appearance for Selected Bookmarks 3655 Set Initial Zoom Factor 1 Set Initial Zoom factor for new Go to a page in this document actions 3601 Add 2 Add a New Action gt 3649 Add
97. Can be downloaded from our Update s page at our Web site End User Retail Products You can Purchase Direct from our web site and be using any of our products the same day e PDF XChange Create fully native Adobe compatible PDF Files from virtually any Windows 32 Bit software application e PDF XChange Viewer Free and PRO Versions View Mark up and Manipulate PDF files and much more e PDF Tools Create and manipulate Adobe PDF Files and batch Convert Images to PDF Files and more Tracker Software Products 299 e Raster XChange Create and manipulate Image files from any Windows document or application e TIFF XChange Create and manipulate TIFF files from any Windows document or application Software Developers SDK s and other Products You can Purchase Developer SDK s from our web site and be using any of our products the same day e PDF XChange Create fully native Adobe compatible PDF Files from your application output e PDF Tools Create and manipulate Adobe PDF Files and batch Convert Images to PDF Files and more e PDF XChange Viewer SDK Embed PDF viewing directly within your software applications e Image XChange SDK Print Convert Scan and View Imaging formats Raster XChange SDK Create and manipulate Image files from any Windows document or application e TIFF XChange SDK Create and manipulate TIFF files from any Windows document or application e OCR XChange Add Optical Character Recognition functionality
98. Change Viewer ActiveX SDK 2 2 2 11 5 3 FromText Allows to set settings for creating new PDF document from plain text Contained Objects Name Paper Layout FileHeader NewParaMode FilePlaceMode CodePage See Also Type Group RWS Group RWS Group RWS Integer String RWS Integer String RWS Integer RWS Description Specifies new PDF page options Specifies layout of images on the each page Specifies format of text labels for images on the pages Specifies mode for detecting paragraphs For possible named values see the New Paragraph Modes Default value is 0 auto detect Specifies mode for placing files into the document For possible named values see the Text File Placing Modes Default value is 0 new file begins from new paragraph Specifies the standard code page identifier of the input text Default value is 0 auto detect IPDFXCview DoVerb IPDFXCview GetProperty IPDFXCview SetProperty Operations NewDocumentFromText Allows to set up of new PDF page Contained Objects Name PaperWidth PaperHeight PaperMode PaperName Orientation Type Double RWS Double RWS Integer String RWS String RWS Integer String RWS Description Specifies new PDF page width in points Default value is 595 pt 210 mm Specifies new PDF page height in points Default value is 842 pt 297 mm Specifies what paper size t
99. DF See Also Specification Versions Default value is O Auto IPDFXCview DoVerb IPDFXCview GetProperty IPDFXCview SetProperty 2 2 2 11 5 1 FromBlank Allows to set settings for creating new empty PDF document Contained Objects Name Type Description PaperWidth Double Specifies new PDF page width in points RWS Default value is 595 pt 210 mm PaperHeight Double Specifies new PDF page height in points RWS Default value is 842 pt 297 mm PaperMode Integer Specifies what paper size to use Can use String custom sizes from PaperWidth and RWS PaperHeight parameters or standard paper type Reference 199 specified by PaperName For possible named values see the Paper Modes Default value is 1 Standard PaperName String The name of the standard type of paper RWS Default value is A4 Orientation Integer Specifies landscape paper orientation for new String document RWS For possible named values see the Booleans Default value is 0 Count Integer Specifies pages count for new document RWS Default value is 1 See Also IPDFXCview DoVerb IPDFXCview GetProperty IPDFXCview SetProperty Operations CreateNewBlankDocument 2 2 2 11 5 2 Fromlmages Allows to set settings for creating new PDF document from images Contained Objects Name Type Description Paper Group Specifies new PDF page options RWS Layout Group Specifies layout of images on the each page RWS Graphics Group S
100. DK Operations GetDocumentsCount 2 1 1 2 12 OpenDocument Open a document by the specified local file name URL or by open file dialog This method is a simplified variant of a special call to the DoVerb method Syntax HRESULT OpenDocument BSTR SourceFileName BSTR OpenPassword LONG ID LONG Flags Parameters SourceFileName in BSTR that specifies the local file name or URL This argument can be NULL OpenPassword in BSTR that determines the password to open the document specified by SourceFileName This argument can be NULL ID out Pointer to a LONG that receives the unique identifier of the opened document This argument can be NULL Flags in LONG that specifies optional flags For more information see PXCVA Flags This argument can be 0 Return Value Returns S_OK if successful or an error value otherwise To obtain the text description of a received error code use GetTextFromResult Remarks To display standard open file dialog you should pass NULL to sourceFileName If you want to deny all Ul prompts alerts enter password dialog error dialog etc when calling this method you must specify the PXCVA_Flags PXCVA_NoUI flag into Flags See Also IPDFXCview CloseDocument Operations OpenDocument 2 1 1 2 13 PrintDocument Print the opened document with the parameters defined earlier by Objects Print names section This method is a simplified variant of a special call to the D
101. DK beginning of the leader lines Default value is 0 0 LeaderLength Double Specifies the length of leader lines in default RWS user space that extend from each endpoint of the line perpendicular to line itself Default value is 15 0 ShowCaption Integer Specifies visibility of caption String For possible named values see the Booleans RWS Default value is 1 true DefSubj String Specifies default subject text for comment RWS This value will be used only if DefSubjMode is setto Custom DefSubjMode Integer Specifies mode for default subject String For possible named values see the Subject RWS Modes Default value is 0 Default See Also Objects Commenting IPDFXCview DoVerb IPDFXCview GetProperty IPDFXCview SetProperty 2 2 2 3 6 FileAttachment Accesses the properties of the commenting Contained Objects Name Type Description Styles Array Defines item style representation RWS See Also Objects Commenting 2 2 2 3 6 1 Styles This object represents array of all comments styles and provides additional operations with them Item Template lt ltem gt defines item template for each style representation Contained Objects Name Type Description Count Integer Contains number of all accessible styles R Remarks This object is an array of items where each item is represented as lt ltem gt For more information about object naming notation see Object Name Notation Example
102. Default value is 0 RWS For possible named values see Booleans ShowSepBetweenToolbars Integer Enables disables horizontal 3D separators between String main toolbars Default value is 1 RWS For possible named values see Booleans ShowShortcutsInTooltips Integer Show hide shortcuts in tooltips String Default value is 1 RWS For possible named values see Booleans ShowShortcutsInMenus Integer Show hide shortcuts in menu items String Default value is 1 RWS For possible named values see Booleans ShowTabCloseButtons Integer Show hide close button in tabs of documens String Default value is 1 RWS For possible named values see Booleans HideTabBarForSingleDoc Integer If specified then control will hide documents tab bar if String only one document is opened RWS Default value is 0 For possible named values see Booleans ShowAppWorkspaceShad Integer Enables disables top bottom shadow on the main ow String background RWS Default value is 1 For possible named values see Booleans Remarks Examples for usage in pseudocode 1 1 get bars count same for panes DoVerb View Bars Count get Dataln DataOut 0 FL or GetProperty View Bars Count DataOut 0 1 2 get bar unique name by order index same for panes DoVerb View Bar 0 Name get DataIn DataOut 0 Vel Os GetProperty View Bar 0 Name DataOut 0 1 3 get menu bar visibility DoVerb View Bars Menu Visi
103. Description Defines initial form fields highlight settings IPDFXCview DoVerb IPDFXCview GetProperty IPDFXCview SetProperty 2 2 2 7 1 HighlightFields Allows to specify initial settings for form highlighting Contained Objects Name Type Integer String RWS Uselnitial Description When specified form highlight settings for every new opened document will be taken from initial highlight settings For possible named values see the Booleans Default value is 0 InitialMask Integer String RWS Specifies initial highlight mask to highlight selected form fields For possible named values see Highlight Form Fields Masks Initial RequiredOnly Integer String RWS FillColor Integer String RWS BorderColor Integer String RWS Remarks Highlight only required form fields For possible named values see the Booleans Default value is 0 Specifies fill color for the form highlight For possible named values see the Colors Default value is RGB 204 215 255 Specifies border color for the form highlight For possible named values see the Colors Default value is RGB 255 0 0 red To set form highlight settings for specified document see Objects Documents lt ltem gt Form HighlightFields See Also IPDFXCview GetProperty IPDFXCview SetProperty Objects Documents lt ltem gt Form HighlightFields Objects Forms 2 2 2 8 General Accesses the main propertie
104. Duncan BC V9L 3R6 Canada ALL RIGHTS RESERVED All Other Trademarks Copyrights acknowledged amp are the property of their respective owners including Zlib by Marl Adler amp Jean Loup Gailly Little CMS by Marti Maria and IPG C 1991 98 PDF XChange Templates amp Classes for Clarion for Windows PDF XChange API SDK customers only PDF XChange API SDK PDF XChange API SDK customers only PDF XChange SDK Printer Driver PDF XChange Print Driver customers only PDF Tools SDK Templates amp Classes for Clarion for Windows PDF Tools API SDK customers only Delphi Components for PDF XChange and or PDF Tools SDK products All Demo Evaluation components and examples for PDF XChange and or PDF Tools SDK products Image XChange SDK PDF XChange Viewer SDK This agreement allows the Licensee to utilise and distribute the PDF XChange Viewer SDK subject to the terms and conditions detailed above to the max number Client Distribution License Packs CDLP s specified see below for CDLP s provided each client desktop installed to shall count as 1 CDLP having been used after which additional CDLP License packs will be required to continue use and distribution of any application created distributed that contains the PDF XChange Viewer SDK functionality 1 4 12 PDF XChange Viewer ActiveX SDK Volume of CDLP s purchased and distributable CDLP Volume entitlement Please provided your Purchase receipt or Invoice number where you p
105. EXCview ActivateDocument 2 2 1 4 ApplyAllCachedChanges This operation can be used to apply all cached settings that were passed with the PXCVA_Flags PXCVA_NoApply flag Name ApplyAllCachedChanges Arguments Nothing Return Value Returns S_OK on success or an error value otherwise To obtain the text description of a received error code use IPDFXCview GetTextFromResult 52 PDF XChange Viewer ActiveX SDK 2 2 1 5 2 2 1 6 2 2 1 7 See Also IPDFXCview DoVerb IPDFXCview ApplyAllCachedChanges ClearRecentsList This operation can be used to clear list of recent documents Name ClearRecentsList Arguments Nothing Return Value Returns S_OK or an error value otherwise For obtaining text description of received error code you can use IPDFXCview GetTextFromResult See Also IPDFXCview DoVerb CloseAllDocuments This operation can be used to close all opened documents Name CloseAllDocuments Arguments Nothing Return Value Returns S_OK on success or an error value otherwise To obtain the text description of a received error code use IPDFXCview GetTextFromResult See Also IPDFXCview DoVerb IPDFXCview CloseAllDocuments CloseDocument Closes an opened document Name CloseDocument Arguments Req Type Description 1 Yes LONG The unique identifier of the document or full file name of the document Reference 53 BSTR Return Value Returns S_OK on success or an error value
106. File writing error code R UserChoice Integer User s choice for this case String Initial value is O default processing RW Supported named values for this prompt Default Abort Retry Ignore SaveAs See also User Choices Ul Group Special object for Ul customizing RW Remarks If you want to skip the original dialog you must pass a new non zero value to the UserChoice property You may also change the destination file name at run time For example in pseudocode function OnEvent Type Name Dataln DataOut Flags if Type PXCVA_OnDisplayPrompt if Name Prompts FileWriteError get file writing error if need GetProperty Prompts FileWriteError ErrorCode DataOut 0 analyse result in DataOut set another file name SetProperty Prompts FileWriteError FileName Reference 223 DataIn C Test2 pdf 0 skip original dialog and try to save document into C Test2 pdf SetProperty Prompts FileWriteError UserChoice DataIn Retry 0 See Also IPDFXCviewEvents OnEvent PXCVA EventTypes PXCVA OnDisplayPrompt IPDFXCview GetProperty IPDFXCview SetProperty 2 2 2 16Search Contains all supported properties for extended text searching using search panel in Viewer Contained Objects Name Type Description What Group Specifies text for search RWS Where Group Specifies options for place of search RWS Options Group Specifies
107. GB 0 0 255 blue BoxesAlpha Double Specifies the alpha placing coefficient RWS transparency for all page boxes at rendering time Default value is 1 0 100 opacity CreateLinksFromURLs Integer Specifies whether to automatically create URLs String from text content RWS For possible named values see the Booleans Default value is 1 DefaultLay out Integer Specifies the page layout in the pages view window String For possible values see the Pages Layouts RWS Default value is 1 auto DefaultRotation Integer Specifies page rotation angle for opening RWS documents Does not affect on already opened documents Can be set to 0 90 180 270 360 DefaultView Integer Specifies the default view of the document String For possible values see the Document Initial View RWS Modes Default value is 1 pages view only DefaultZoom Double Specifies the default zoom value for the page view String For possible values see the Pages Magnifications RWS Default value is O auto Resolution Integer Specifies the resolution for page display RWS Default value is O auto using the resolution of the current monitor ShowBoxes Integer Allows display of Art Trim or Bleed boxes String For possible named values see the Booleans RWS Default value is 0 ShowLargelmages Integer Allows display of large images String For possible named values see the Booleans RWS Default value is 1 ShowTransparency Grid Intege
108. Name Notifications ContextMenu then GetProperty Notifications ContextMenu MenuName DataOut 0 if DataOut Hand then SetProperty Notifications ContextMenu UserChoice 33135 0 See Also IPDFXCvuiew DoVerb IPDFXCview GetProperty IPDFXCview SetProperty IPDFXCviewEvents OnEvent 2 2 2 10 4 DocClosed Control sends this event after close of document Contained Objects Reference 189 DocID Integer Retrieves unique ID of the document which has been R closed See Also IPDFXCview DoVerb IPDFXCview GetProperty IPDFXCvew SetProperty IPDFXCviewEvents OnEvent 2 2 2 10 5 DocSaved Control sends this event after saving of document Contained Objects DocID Integer Retrieves unique ID of the document R SaveMode Integer Retrieves document save mode identifier String See Document Save Modes R DestFileName String Retrieves destination file name If document is saved R in a stream then this value will be empty See Also IPDFXCvuiew DoVerb IPDFXCview GetProperty IPDFXCview SetProperty IPDFXCviewEvents OnEvent 2 2 2 10 6 FieldChanged Informs you about changing value of form field Contained Objects DocID Integer Retrieves unique ID of document R Name String Retrieves name of the changed form field R Pagelndex Integer Retrieves index of page with the form filed R corresponding widget visual object of the form field IndexOnPage Integer Retrieves
109. Open a file 7 3601 Test All 8 Test All Actions 3294 Document Title 8 3295 File Name 2 3295 Day 6 3296 Second 0 3627 Note Icon 6 3629 Create from Clipboard 3 Create Stamp from Clipboard Image 3629 Rename Stamp 8 Rename Selected Stamp 3629 Rename Collection 9 Rename Selected Collection 2 3651 Signing 5 gt 3381 Edit Description 4 Edit Description 3630 Reset this Toolbar 9 Reset this Toolbar to Defaults 3632 Choose Image 4 3632 Show Image 9 3633 Insert Separator After 2 3634 Clear Find List Reference 3625 Highlight Style 0 3635 Ratio Unit From 7 3635 Ratio Value To 6 3342 Align Bottom Edges 4 3342 Distribute Vertically 8 3343 Make Same Size y 3636 Redo 7 3637 Delete y 3647 Zoom Out 3 3647 Rotate 90 CW 8 3654 Blend Mode 2 3648 Copy Link Location y 3648 Delete Comment Styles 7 Delete Selected Comment Styles 3648 Reset Comment Styles 8 Reset Selected Comment Styles 3625 Edit Subject 7 Edit Initial Subject for Selected Comment Style 3648 Clone Comment Style 6 Clone Selected Comment Style 3648 Reset Comment 5 Reset Selected Comment All custom styles for selected comment type will be removed and only default style will be leaved 3650 Open URL in New Browsers Window 2 3650 Open URL in New Browser s Tab y 3648 Open URL in Browser 2 3647
110. Out 0 Pf O DoVerb Documents C Test pdf Title get Dataln DataOut 0 del ore Reference 135 GetProperty Documents 4095 Title DataOut 0 or GetDocumentProperty 4095 Title DataOut 0 2 1 set active document use simple operation DoVerb NULL ActivateDocument Dataln 4095 DataOut 0 or use property object DoVerb Documents Active set Dataln 4095 DataOut 0 dd oe SetProperty Documents Active DataIn 4095 0 or use method of interface ActivateDocument 4095 2 2 set document title DoVerb Documents 4095 Title set Dataln Sample Title DataOut El Oe SetProperty Documents 4095 Title Dataln Sample Title 0 or SetDocumentProperty 4095 Title Dataln Sample Title 0 2 3 close document use simple operation DoVerb NULL CloseDocument Dataln 4095 DataOut 0 or use object depended operation DoVerb Documents 4095 close Dataln DataOut 0 PL ori DoDocumentVerb 4095 NULL close Dataln DataOut 0 or use method of interface CloseDocument 4095 See Also IPDFXCview DoVerb IPDFXCview DoDocumentVerb IPDFXCview GetProperty IPDFXCview SetProperty IPDFXCview GetDocumentProperty IPDFXCview SetDocumentProperty IPDFXCview SaveDocument 2 2 2 4 1 lt ltem gt Defines item template for each opened document representation Contained Objects Name Type Descripti
111. PDF XChange Viewer ActiveX SDK 2001 2012 Tracker Software Products Canada Ltd PO Box 79 9622 Chemainus Rd Chemainus BC VOR 1K0 Canada http www tracker software com Mailto Sales tracker software com PDF XChange Viewer ActiveX SDK Table of Contents Foreword 0 Part Important Please Read 1 Redistribution Information ccoccccnnccococnconoconnconncnnnenanennnonnnnnnnnnnnnnnrnnrnnnrrnnrnnnrnanrnanenanenanenananes 3 2 ActiveX Control Installation cccccceeeceeeceeeeeeee ees eeseeeeneeenseeesenesoneseneseseaueesessoeesseesenssenenes 3 A enti sosecescccedcni secede taceqazsscotdaezencsdetijecsadesieceqertesceeaaseeceearzaceudnesteeades 5 LICONS OY TO XU A ia 5 4 Requesting your V2 x Upgrade license ccceececceeeeeeeeeeeeeeeeeeeeseeeeeeeseeeeeeeseeeaeeeseeeeeeeseeeseees 12 Part Il Reference 13 1 Interfaces iia clsteceteeds ee he 13 IPDFXCview _ 13 General Melodia 14 Apply AllGachedGnanges is ii pi fa i vars 14 DiscardAlICached Changes ssccccccceesccececessteesenseaenceteceygdedcnevedeusehagesucnauedeanechvncetsdestecseteetenanedscdegdpeedeneiavers 15 DOM eri gt A EE EEA E AT ETE E TAE A TATT 15 GetProperty A E 16 EIA IES ONAL AAE E ESTAT T EEEE o AT A E ETETE 17 LoadSettings RunJavaScript SaveSettings SetDevinfo SetProperty Document Methods cccccccccceceseeceneeeeeeeeeneeceaeeeeaeesesaeesaaeeseaaeseaaeesaaeeseaeesceeeesaeeseaeeseeeeesaeeseaeeseeeeeseeese
112. Pages lt ltem gt Text Chars lt ltem gt Style Reference Font ascent Font descent The font embedded flag For possible values see the Booleans Represents the bound box of the font Has the Objects RectangleF structure This object represents the array for all words on the page Item Template lt ltem gt defines item template for each word Contained Objects Count Integer R Remarks For example in pseudocode Contains the number count of all words on the page gets words count on the first page DoVerb Documents 0 Pages 0 Text Words Count get DataIn DataOut C gets first word on the first page DoVerb Documents 0 Pages 0 Text Words 0 String See Also IPDEXCview DoVerb Objects Documents lt ltem gt Pages lt ltem gt Text get Dataln DataOu Defines an item template for each word Contained Objects String String R Offset Integer R Length Integer R Quads Group R Represents word text Represents the word offset position on the page index of first character Represents the word length character count Contains word coordinates on page 177 178 PDF XChange Viewer ActiveX SDK See Also Objects Documents Objects Documents lt Item gt Pages lt ltem gt Text Words This object represents the array for all text lines on the page Item Template lt ltem gt defines item template for each line Cont
113. Panes This object is an array of items each item representing a UI pane or named container for special view window Item Template lt ltem gt defines item template for each pane representation Contained Objects Count Integer Contains the number of panes R See Also Objects View Objects Documents lt tem gt View 2 2 2 19 3 1 lt item gt Defines item template for each Ul pane 240 PDF XChange Viewer ActiveX SDK Contained Objects Integer Defines the unique identifier of the pane RS Name String Defines the unique name of the pane RS Visible Integer Determines the visibility of the pane String RWS See Also Objects View Objects Documents lt Item gt View 2 2 2 19 4 RectangleF This object represents rectangle structure Contained Objects Left Double Specifies the x coordinate of the upper left corner of RWS the rectangle Top Double Specifies the y coordinate of the upper left corner of RWS the rectangle Right Double Specifies the x coordinate of the lower right corner RWS of the rectangle Bottom Double Specifies the y coordinate of the lower right corner RWS of the rectangle See Also IPDFXCview DoVerb IPDFXCview GetProperty IPDFXCview SetProperty 2 2 2 19 5 Text Format This object represents text format structure for comment Contained Objects Chal Group Specifies character format for text RWS Para Group Specifies paragraph form
114. Print 2 2 3 21 Export Modes Supported Values Tolmage Defines the export of document to images with the parameters defined earlier by Objects Export Image See Also Objects Export Image 2 2 3 22 Export to Image Modes Supported Values AllToOneMultilmage Exports all pages to one multi page image file EachRangeToOneMultilm 4 Exports each page range to one multi page image file age EachToOnelmage 2 Exports each page to a separate image file See Also Objects Export Image 254 PDF XChange Viewer ActiveX SDK Objects Export Image Mode 2 2 3 23File Attachment Icon Types Supported Values Default Attachment Graph 1 PaperClip Tag See Also Objects Commenting 2 2 3 24Highlight Form Fields Masks Supported Values All OxFFFFFFFF None 0x00000000 Default 0x000000FC ComboBoxes 0x00000020 CheckBoxes 0x00000008 ListBoxes 0x00000040 TextBoxes 0x00000010 PushButtons 0x00000002 RadioButtons 0x00000004 Signatures 0x00000080 See Also Objects Forms HighlightFields Objects Documents lt ltem gt Form HighlightFields 2 2 3 25lmage Align Types Image Scale TypesSupported Values LeftTop Specifies to fit proportionally of image in the cell and align it to top left corner of the cell Center 1 Specifies to fit proportionally of image and center it in the cell RightBottom 2 Specifies to fit proportionally of image in the cell and align it to bottom right corner of the cell Fit 3 Specifies to full fi
115. RWS This value will be used only if DefSubjMode is set to Custom DefSubjMode Integer Specifies mode for default subject String For possible named values see the Subject RWS Modes Default value is 0 Default See Also Objects Commenting IPDFXCview DoVerb IPDFXCview GetProperty IPDFXCview SetProperty 2 2 2 3 16 Stamp Accesses the properties of the commenting Contained Objects 14 PDF XChange Viewer ActiveX SDK Styles Array Defines item style representation RWS See Also Objects Commenting 2 2 2 3 16 1 Styles This object represents array of all comments styles and provides additional operations with them Item Template lt ltem gt defines item template for each style representation Contained Objects Count Integer Contains number of all accessible styles R Remarks This object is an array of items where each item is represented as lt ltem gt For more information about object naming notation see Object Name Notation Examples for usage in pseudocode Enumerate all styles for stickynote comment GetProperty Commenting StickyNote Styles Count DataOut 0 Count DataOut for i 0 to Count 1 GetProperty Commenting Stamp Styles i ID DataOut 0 See Also Objects Commenting IPDFXCview DoVerb IPDFXCview GetProperty IPDFXCview SetProperty Defines item template for each commenting text box style Contained Objects Integer Sp
116. S Integer String RWS Description Specifies the unique ID of the comment style Defines name of comment style Specifies line ending style For possible named values see the Line Ending Specifies fill color for the comment For possible named values see the Colors Default value is RGB 255 255 255 black Specifies stroke color for the comment For possible named values see the Colors Default value is RGB 255 0 0 red Specifies the opacity of the comment Default value is 1 0 100 opacity Specifies the blend mode for the comment For possible named values see the Blend Modes Default value is 0 Normal Specifies border for the comment Specifies text format for the comment Specifies default subject text for comment This value will be used only if DefSubjMode is setto Custom Specifies mode for default subject For possible named values see the Subject Modes Default value is 0 Default IPDFXCview DoVerb IPDFXCview GetProperty IPDFXCview SetProperty 2 2 2 3 4 Cloud Accesses the properties of the commenting Contained Objects Name Type Description Reference 105 Styles Array Defines item style representation RWS See Also Objects Commenting 2 2 2 3 4 1 Styles This object represents array of all comments styles and provides additional operations with them Item Template lt ltem gt defines item template for each style representation Con
117. S_OK or an error value otherwise To obtain the text description of a received error code use IPDFXCview GetTextFromResult See Also IPDFXCview DoDocumentVerb Gets name of the attachment Name GetAttachmentSize Arguments 1 Yes LONG The zero based index of the attachment in the attachments list or name of BSTR the attachment Outputs 1 LONGLONG The uncompressed size of the attachment in bytes INT64 Return Value Returns S_OK or an error value otherwise To obtain the text description of a received error code use IPDFXCview GetTextFromResult See Also IPDEXCview DoDocumentVerb Reference Gets identification info of the selected annotation Name GetSelectedAnnot Arguments None Outputs Type Description 1 LONG The zero based index of page with the selected annotation But if no selected annotation then control will return 1 as page index and result of method calling will be S FALSE 2 LONG The zero based index of annotation on the page Return Value Returns S_OK if is selected annotation S FALSE instead or an error value otherwise To obtain the text description of a received error code use IPDFXCview GetTextFromResult Remarks For example in pseudocode DoDocumentVerb docID NULL GetSelectedAnnot NULL DataOut 0 int pageIndex DataOut 0 if pageIndex gt 0 we have selected focused annotation indexOnPage DataOut 1 Note exists special property of do
118. Specifies border for the comment RWS DefSubj String Specifies default subject text for comment RWS This value will be used only if DefSubjMode is setto Custom DefSubjMode Integer Specifies mode for default subject Reference no String For possible named values see the Subject RWS Modes Default value is 0 Default See Also Objects Commenting IPDFXCview DoVerb IPDFXCview GetProperty IPDFXCview SetProperty 2 2 2 3 13 Polygon Accesses the properties of the commenting Contained Objects Styles Array Defines item style representation RWS See Also Objects Commenting 2 2 2 3 13 1 Styles This object represents array of all comments styles and provides additional operations with them Item Template lt ltem gt defines item template for each style representation Contained Objects Count Integer Contains number of all accessible styles R Remarks This object is an array of items where each item is represented as lt ltem gt For more information about object naming notation see Object Name Notation Examples for usage in pseudocode Enumerate all styles for polygon comment GetProperty Commenting Polygon Styles Count DataOut 0 Count Data0ut for i 0 te Count 1 GetProperty Commenting Polygon Styles i ID DataOut 0 See Also Objects Commenting IPDFXCview DoVerb IPDFXCview GetProperty IPDFXCview SetProperty 120 PDF
119. String Specifies default subject text for comment RWS This value will be used only if DefSubjMode is set to Custom DefSubjMode Integer Specifies mode for default subject String For possible named values see the Subject RWS Modes Default value is 0 Default See Also Objects Commenting IPDFXCview DoVerb IPDFXCview GetProperty IPDFXCview SetProperty Reference 133 2 2 2 4 Documents This object represents array of all opened documents and provides additional operations with them Item Template lt ltem gt defines item template for each opened document representation Contained Objects Name Type Description Count Integer Contains number of all opened documents R Active Integer Contains the unique identifier of the active RW document ContentMonitor Integer String Controls a special monitor that watches the display RWS completeness of the page content For possible named values see the Content Monitor States Default value is 0 Off UseStreams Directly Integer String Specifies using passed Stream Object directly for RWS opening without placing content to disk Also if it means 1 that passed stream object will be captured by the control to have possibility to write into this stream object in the future The control will release the stream object after document closing For possible named values see the Booleans Default value is 0 while opening from stream all document s content wil
120. TextEditor Document DataOut 0 See Also IPDFXCview DoVerb IPDFXCview GetProperty IPDFXCview SetProperty IPDFXCviewE vents OnEvent 2 2 2 11 Operations Allows to specify settings for operations Contained Objects Name Type Description DeletePages Group Allows to specify settings for pages deletion from RWS PDF document ExtractPages Group Allows to extract selected pages from the current RWS PDF to one or more PDF files InsertEmptyPages Group Allows to specify settings for insertion of empty RWS pages to PDF document InsertPages Group Allows to specify settings for inserting pages from RWS the source document into the current document NewDocument Group Allows to create new PDF Document RWS RotatePages Group Allows to specify settings for page rotation RWS SummarizeAnnots Group Allows to get a summary all the comments RWS associated with a PDF to view them as a new PDF Document Rich Text Format Plain Text or Web Page See Also IPDFXCview GetProperty IPDFXCview SetProperty 2 2 2 11 1 DeletePages Allows to specify settings for pages deletion from PDF document Contained Objects Name Type Description RangeType Integer Defines the type of page range for page deletion String For possible values see the Range Types Supports RW only Selected Current and Exact values Default value is 1 all pages RangeFilter Integer Specifies an additional filter for the page range Str
121. ToCommand Name MsgToCommandAndExec Arguments Req Type Description Yes LONG The windows message identifier Yes LONG The message wParam parameter No LONG The message IParam parameter Bb UU N No LONG Alternate modifier flags set Can contains one or more standard flags FCONTROL 8 FSHIFT 4 FALT 16 If not specified then control will obtain these flags from system automatically Return Value Returns S_OK on success or an error value otherwise To obtain the text description of a received error code use IPDFXCview GetTextFromResult If successful it returns in DataOut the non zero or zero otherwise Remarks For example in pseudocode Translates Ctr 0 to the Open Ul command and executes it DoVerb NULL MsgToCommandAndExec DataIn WM_KEYDOWN 0O 0 FCONTROL DataOut 0 See Also IPDFXCview DoVerb Reference e 2 2 1 29NewBlankDocument See the Operations CreateNewBlankDocument 2 2 1 30 NewDocumentFromimages Creates new PDF document from the images using parameters previously defined by Objects Operations NewDocument FromImages Name NewDocumentFromImages Arguments Req Type Description 1 Yes BSTR Image file name 2 No BSTR Next image file name Return Value Returns S_OK on success or an error value otherwise To obtain the text description of a received error code use IPDFXCview GetTextFromResult If successful it returns the unique identifier ID of the c
122. Val ueln in Return Value BSTR that specifies source URL of the document Returns S_OK if successful or an error value otherwise To obtain the text description of a received error code use GetTextFromResult See Also IPDFXCview OpenDocument Operations OpenDocument How To Use This topic contains the following sections How to Open a Document How to Print a Document How to Save a Document How to Close a Document How to Disable a Command How to Enumerate Characters in Document How to Extract Text from Document How to Summarize Annotations from Document How to Open a Document To use examples below you must add the ActiveX control to your project and obtain a pointer to a IPDEXCview interface C with ATL CComPtr lt IPDFXCview gt spViewer CCOmBel CCOmBSl TR bsFileName L C Test pdf ERM SP ais won Isi LONG nDocumentID 0 HR C ESUL hRes spViewer gt OpenDocument bsFileName m_str bsPassword m_str amp nDocumentID 0 int nDocument ID int nRes By axCoPDFXCviewl OpenDocument C Test pdf 123 out nDocumentID 0 3 2 How To Use 289 catch Exception ex nRes System Runtime InteropServices Marshal GetHRForException ex VB NET Dim nDocumentID As Integer Dim nRes As Integer Tey AxCoPDFXCviewl OpenDocument C Test pdf 123 nDocumentID 0 Catch ex As Exception nRe
123. XCVA_Flags PXCVA_ GetNamed to obtain the named value as a simple string of the property specified by Name Return Value Returns S_OK if successful or an error value otherwise To obtain the text description of a received error code use GetTextFromResult See Also IPDFXCview GetProperty IPDFXCview SetProperty 2 1 2 IPDFXCview2 This interface is the default interface of our ActiveX control Microsoft ActiveX control This interface is derived directly from IPDFXCview e Properties Interface Identificator GUID IID_IPDFXCview2 See Also IPDFXCview 2 1 2 1 Properties Properties Property Name AllowAccelerators LockedView ReadOnly SettingsURL Src See Also IPDFXCview2 2 1 2 1 1 AllowAccelerators 53D68C77 20E5 455b AABE 2F071530FE67 Description Allows or denies all control s accelerators Allows or denies all Ul customization Allows or denies all modification operations for all documents Sets or gets the URL to the settings file for control customizing Sets gets the source URL of the document for open Allows or denies all control s accelerators Syntax HRESULT get_AllowAccelerators VARIANT_BOOL Value0ut HRESULT put_AllowAccelerators VARIANT_BOOL Valueln Reference 35 Parameters ValueOut out Pointer to a VARIANT_BOOL that receives flag for accelerators usage Valueln in BSTR that specifies flag for accelerators usage Retur
124. XChange Viewer ActiveX SDK Defines item template for each commenting polygon style Contained Objects Name ID Name FColor SColor Opacity BlendMode Border DefSubj DefSubjMode See Also Objects Commenting Type Integer RS String RWS Integer String RWS Integer String RWS Double RWS Integer String RWS Group RWS String RWS Integer String RWS Description Specifies the unique ID of the comment style Defines name of comment style Specifies fill color for the comment For possible named values see the Colors Default value is 1 none Specifies stroke color for the comment For possible named values see the Colors Default value is RGB 255 0 0 red Specifies the opacity of the comment Default value is 1 0 100 opacity Specifies the blend mode for the comment For possible named values see the Blend Modes Default value is 0 Normal Specifies border for the comment Specifies default subject text for comment This value will be used only if DefSubjMode is setto Custom Specifies mode for default subject For possible named values see the Subject Modes Default value is 0 Default IPDFXCview DoVerb IPDFXCview GetProperty IPDFXCview SetProperty 2 2 2 3 14 Polyline Accesses the properties of the commenting Contained Objects Name Styles See Also Objects Commenting 2 2 2 3 14 1 Styles
125. XCview GetProperty IPDFXCview SetProperty 2 2 2 17 Tools Contains all supported tools and operations with them Contained Objects Name Type Description Active Integer Specifies which tool is active String RWS For possible values see Tools rea Group This tool allows to measure the area within the RWS line segments Arrow Group This tool allows to draw a arrow on the current RWS displayed PDF document page Callout Group This tool allows to add a text box with an arrow RWS pointing to a selected location on the page Cloud Group This tool draws a cloud outline around selected RWS parts of the PDF page Distance Group This tool permits measuring the distance RWS between two points Eraser Group This tool allows to erase any part of a pencil RWS drawn annotation FileAttachment Group This tool allows to add file attachment annotation RWS in any place of PDF document Highlight Group This tool permits to highlight text within the PDF RWS document and works like the select tool Line Group This tool allows to draw a line on the current RWS displayed PDF document page Link Group This tool allows to create a link in order to jump RWS to other locations in the same document or websites Loupe Group This tool opens a special dialog window that is RWS linked to a scrollable resizable rectangular are that acts as a cursor and permits the selection of a portion of the PDF page file Ova
126. aeeeeaees 20 AGtiVateDOCUIMe it eE sseceteuctcecicsvesiadeas RE an A 21 CIOS SAIIDOC UTE NUS s 55 fs eet see e ce Sen Beata aS a VSR a eee eg tab Seehof eee cae 21 CIOS EDOCUMENT Ra 22 DoDocumentVerb 23 EXPIDO CUM iaa 24 FIUS ADOCUME dd O O dcdentetusadiieteminulentenese 24 G tActiveDocUmMEnt aee aE aa 25 GetDocumentiD AE ETA T EE E 25 GetDOCUMENTINGOX Ss cesses e EEE A E EE EEA E 26 G tD c mentPrope riyen anaana an os eaer Eae AE dilatado Dadas 26 GetDocuments Count va OpenDocument eratan na a A AA a a RA A A aa PrINtDOGUIMOENKE a A EA E T A T SAVE DOCUMENT EE PEETA TE AT EREE STE TOE EE SetDoc UEO E A E E E E AA N 30 Auxiliary Meth OOS szi A OE 31 GetDocumentFroMNA ME rrara a anneanne ein caves caveaessscsacbereasauensdescsvescosenecesctevsereadeccueistduvetcavateeds 31 EARD AONA m EE AEEA T ART E E E E nd es 32 COSO AN 32 Properties o Property AAA ET E E E E E T AREA E E T E T A S Allow ACCelerators cccccccececcecceceneeeeaeeeeeneeceaeeseaeeeeaeeecsaeeeeaaeceaaeecaaeeseaaesceaeeseaeescaaesseaeeseaeesseeeseaeesseeeeaaes 34 LockedV iew ReadOnly Settings URL Src Contents 1 SIPDEXCVie Wi N T CPE T E E E E E T E TT T 37 OnEvent IPDFXCargs Methods Add Clear Init Remove ANA iaa 41 POPE OS ici A A a ia 41 NEWER ata AAA A AAA AA A rea ne 41 Count Data tem IPDFXCsmartp Methods escent ater sence anh A ies teres eo aetna dee DoVerbs O ee aah ONO 44 GetitemPointBy ID kanne a a
127. aid for the product to allow us to expedite validation of your license entitlement Date on which this payment was made Accepted for and on Behalf of Licensor Accepted for and on Behalf of Licensee Tracker Software products Ltd Company Name Name Name Tel Fax 001 250 597 1621 001 250 897 1623 Tel Fax Email sales tracker software com Email Position Position 466 Trans Canada Highway Duncan BC V L Address 3R6 Canada Authorised Signatory Authorised Signatory Date Date Please ensure you provide us with contact info that is robust and durable particularly your email address as this will be our primary means of advising you of updates and changes to your license and your license codes using email addresses provided by FREE providers such as Hotmail and Yahoo is not recommended and we may even reject such use in the interests of serving you better The License becomes effective and valid as soon as the agreed license fee is paid and this document is duly completed and signed by both parties Please return once duly signed and completed to Tracker Software Products limited by Facsimile email as an attachment or by mail for completion by Tracker Fax 001 250 597 1623 or sales tracker software com Requesting your V2 x Upgrade license The PDF XChange Viewer SDK Version 2 0 0042 7 Please note This is V2 0042 of the Viewer SDK and your existing PDF XChange V1 x License
128. ained Objects Count Integer Contains the number count of all text lines on the R page Remarks For example in pseudocode gets lines count on the first page DoDocumentVerb docld Pages 0 Text Lines Count get Dataln DataOut gets first line offset length DoDocumentVerb docld Pages 0 T offs DataOut DoDocumentVerb docld Pages 0 len DataOut gets text of first line DoDocumentVerb docld Pages 0 str DataOut ext Lines 0 Offset get Dataln Date ext Lines 0 Length get Dataln Date Text get Dataln offs len DataOut gets quad s of line DoDocumentVerb docld Pages 0 Text Lines 0 Quads Value get Dataln bottom left point of first quad q 0 x DataOut 0 q 0 y DataOut 1 bottom right point of first quad g 1 x DataOut 2 al1 y DataOut 3 top right point of first quad g 2 x DataOut 4 g 2 y DataOut 5 top left point of first quad g 3 x Data0ut g 3 y DataOut 7 See Also IPDFXCview DoVerb Objects Documents lt Item gt Pages lt Item gt Text Defines an item template for each text line Contained Objects Type String Represents type of text line Possible values R 0 simple text line all characters are on one line 1 composite text line all characters are on one Reference curve Offset Integer Represents the line offset position on
129. all confirmations and prompt notifications you need to implement a special event handler see _IPDFXCviewEvents OnE vent and match the types of all received events with the PXCVA_EventTypes PXCVA_OnDisplayPrompt constants Contained Objects Reference 213 Name Type Description ConfirmDocumentincSave Group ls raised before saving if document contains the RW digital signature ConfirmDocumentSave Group ls raised if document was changed before closing RW ConfirmDropFile Group ls raised when detected opening file by drag and RW drop ConfirmFileReplace Group ls raised if destination file already exists RW ConfirmOpenSite Group ls raised when detected click on URL RW CreateFolderError Group ls raised if an error occurs during creation of a new RW folder appearance EnterDocumentPassword Group ls raised during opening of the document if is RW protected by a password FileWriteError Group ls raised if file writing error appears RW Remarks For all specified objects above you can override the behaviour and appearance of standard Ul notifications For example in pseudocode function OnEvent Type Name Dataln DataOut Flags if Type PXCVA_OnDisplayPrompt if Name Prompts ConfirmFileReplace modify dialog caption SetProperty Prompts ConfirmFileReplace Ul Title Dataln Sample Title 0 modify text of first label SetProperty Prompts ConfirmFileReplace Ul Labels 0 Text D
130. alog DoVerb Documents 0 DeletePages NULL NULL 0 2 Delete 1 5 10 pages from current PDF document SetProperty Operations DeletePages RangeType Exact SetProperty Operations DeletePages RangeText 1 5 10 pages DoVerb Documents 0 DeletePages NULL NULL PXCVA_NoUI See Also IPDFXCview DoVerb Operations DeleteDocumentPages Objects Operations DeletePages Exports a document to an image file s with the format parameters previously defined by Objects Export Name Export Arguments None Return Value Returns S_OK on success or an error value otherwise To obtain the text description of a received error code use IPDFXCview GetTextFromResult Remarks For example in pseudocode 12 PDF XChange Viewer ActiveX SDK Print the first document DoVerb Documents 0 Export NULL NULL 0 See Also IPDFXCview DoVerb IPDFXCview ExportDocument Objects Documents lt ltem gt Extracts pages from PDF document using parameters previously defined by Objects Operations ExtractPages Name ERRE ages Arguments None Return Value Returns S_OK on success or an error value otherwise To obtain the text description of a received error code use IPDFXCview GetTextFromResult Remarks For example in pseudocode 1 Show extract pages dialog DoVerb Documents 0 ExtractPages NULL NULL 0 2 Extract 1 5 10 pages from current PDF document
131. alue Returns S_OK if successful or an error value otherwise To obtain the text description of a received error code use GetTextFromResult See Also IPDFXCview SaveDocument Operations FlushDocument 2 1 1 2 7 GetActiveDocument Returns the unique identifier of the active document This method is a simplified variant of a special call to the DoVerb method Syntax HRESULT GetActiveDocument LONG ID YE Parameters ID out Pointer to a LONG that receives unique identifier of the active document Return Value Returns S_OK if successful or an error value otherwise To obtain the text description of a received error code use GetTextFromResult See Also IPDEXCview ActivateDocument IPDFXCview GetDocumentsCount Operations GetActiveDocument 2 1 1 2 8 GetDocumentiD Returns the unique identifier of the opened document which is specified by order index This method is a simplified variant of a special call to the DoVerb method Syntax HRESULT GetDocumentID LONG Index LONG ID Parameters Index in LONG that specifies the order index of the opened document PDF XChange Viewer ActiveX SDK ID out Pointer to a LONG that receives unique identifier of the document specified by Index Return Value Returns S_OK if successful or an error value otherwise To obtain the text description of a received error code use GetTextFromResult See Also IPDFXCview GetDocumenti
132. ame InsertEmptyDocumentPages Arguments 1 Yes LONG The unique identifier of the document or full file name of the document BSTR Return Value Returns S_OK on success or an error value otherwise To obtain the text description of a received error code use IPDFXCview GetTextFromResult See Also IPDFXCview DoVerb Objects Operations InsertEmptyP ages Objects Documents lt ltem gt InsertEmptyP ages 2 2 1 25ISPDF Tests file or stream object for PDF format Name IsPDF Arguments 1 Yes BSTR Source file name or valid URL or Stream Object IStrea Some examples m http www mysite com test paf file C test pdf C test pdf Return Value Returns S_OK on success or an error value otherwise To obtain the text description of a received error code use IPDFXCview GetTextFromResult If successful it returns in DataOut the non zero number when the input source is PDF document or zero otherwise Remarks For example in pseudocode DoVerb NULL IsPDF DataIn C Test pdf DataOut 0 test result in DataOut Reference st See Also IPDFXCview DoVerb IPDFXCview OpenDocument Objects Documents lt ltem gt PDFA 2 2 1 26LoadSettings Loads all control settings from an external storage Name LoadSettings Arguments Req Type Description 1 Yes BSTR Specifies a valid source storage source file name or pointer to a IStream IStrea interface m Return Value Retu
133. ame or valid URL or Stream Object The source URL can IStrea contains some special open actions see PDF Open Parameters m Some examples http www mysite com test pdf page 2 amp z00m 150 file C test pdf C test pdf 2 No BSTR Open password string 3 No BSTR Name of document for display in control s Ul Return Value Returns S_OK on success or an error value otherwise To obtain the text description of a received error code use IPDFXCview GetTextFromResult If successful it returns the unique identifier ID of the opened document in DataOut Remarks PDF XChange Viewer ActiveX SDK If Flags contains the PXCVA_Flags PXCVA_NoUI flag then the argument 1 should be a valid source name or URL or Stream Object For example in pseudocode show open dialog DoVerb NULL OpenDocument Dataln DataOut 0 or open document directly DoVerb NULL OpenDocument DataIn C Test pdf Data0ut 0 or if document is password protected DoVerb NULL OpenDocument n t DataIn SafeArray C Test pdf password DataOut 0 also open from URL DoVerb NULL OpenDocument Dataln http www adobe com test pdf Data0ut 0 also open from Stream DoVerb NULL OpenDocument DataIn StreamObj DataOut 0 Note the Stream Object can be asynchronous any remote source By default all document s content from stream will be placed into temporary file befor
134. anAndZoomMenultem Pan and Zoom Tool 3 Paste 5763 Paste Paste 7 Insert Clipboard Contents Pencil Too 3312 Annots Tool InkMenultem Pencil Tool 9 PerimeterTool 3634 MeasurePolylineMenultem Perimeter Tool 7 Perimeter tool to measure perimeter of an object PlaceSignature 3651 DIGSIG PlaceSigPullRight Place Signature 7 PolyCancel 3313 Cancel 9 PolyComplete 3314 Complete 0 PolygonTool 3312 Annots Tool Polygon Tool 7 PolygonMenultem PolyLineTool 3312 Annots Tool Polygon Line Tool 8 PolyLineMenultem Preferences 3290 GeneralPrefs Preferences 6 Display Application Preferences PrevPage 3288 PrevPage Previous Page 6 Go to Previous Page PreWindow 5768 1 Print 5760 Print Print 7 Print the Active Document ProblemReport 3314 Report a Problem 6 QuadLinkTool 3634 Quadrilateral Link Tool 4 2 PDF XChange Viewer ActiveX SDK Quit 5766 5 Recents List 3326 8 RectangleTool 3312 5 RectLink Tool 3634 3 Redo 5764 4 ReplacePages 3603 9 ReplaceSelText 3321 0 ResetAllSettings 3637 4 ResetPopupLocatio 3312 n 1 RotateCCW 3307 9 RotateCW 3307 8 RotatePages 3308 0 RotateSelectedPag 3381 es180 7 RotateSelectedPag 3381 es270 8 RotateSelectedPag 3381 es90 6 Save 5760 3 SaveAs 5760 4 SaveCopyAs 5761 1 SelectAll 5764 2 SelectTool 3262 0 SendMail 5761 2 SetPropertiesAsDe 3311 fault 8 Quit Annots Tool SquareMenultem Redo ReplacePages RotateCCW RotateCW RotatePages Save SaveA
135. ans Default value is 0 Integer Forbids the inserting new pages into the document String For possible named values see Booleans RW Default value is 0 Integer Forbids the deleting of existing pages from the String document RW For possible named values see Booleans Default value is 0 Integer Controls the behavior of String Objects Documents lt ltem gt GetSelectedAnnot RW function Per Adobe s PDF Reference each document may contain certain info tags Some of these tags are represented by marked properties above Contained Methods Name AddAttachment ClearSelection Close DeletePages Export ExtractP ages Flush GetAllSelectedText GetAllText GetSelectedPage Thumbnail S GetSelectionState HighlightSelection InsertEmpty Pages InsertPages IsOperationGranted Print RotatePages Save SelectAllText SummarizeAnnots GetSelectedAnnot GetSelectedField GetSelectedWidget SelectAnnot SelectField Description Attaches a file to the document Clears selection for document Closes document Delete pages from PDF document Exports document to an other formats Extracts pages from PDF document Flush document to an other formats Get all selected text from document Get all text from document Gets selected page thumbnails in the thumbnails view of the document Get selection state for document Highlights entire selection Inserts empty pages to PDF document Inserts pages from source docume
136. ariant Dim spDoc As IPDFXCsmartp dataln 0 Dim objName As String objName Documents LTrim Str iDocID Call CoPDFXCviewl DoVerb objName SP dataln dataOut 0 Set spDoc dataOut Call spDoc GetProperty Pages Count dataOut 0 gets pages count for sr a PDF XChange Viewer ActiveX SDK var spDoc IPDFXCsmartp dataln dataOut OleVariant iDocID integer CoPDFXCviewl DoVerb Documents inttostr iDocID SP dataln dat spDoc IDispatch dataOut as IPDFXCsmartp spDoc GetProperty Pages Count dataOut 0 gets pages count for spec Interface Identificator GUID IID_IPDFXCsmartp 256342AE 1477 4722 BA9D 4A2AE6984494 See Also IPDFXCview DoVerb Operations SP 2 1 5 1 Methods Methods Method Description DoVerb Provides any supported functionality for the smart point object GetltemPointBylD If this smart point represents an object which contains an array of items you can create a new smart point object for the item which is specified by a unique ID if it is supported and obtain interface pointer to it GetltemPointBy Index If this smart point represents an object which contains an array of items you can create a new smart point object for the item which is specified by order index and obtain interface pointer to it GetltemPointByNindex If this smart point represents an object which contains an array of items you can create a new smart point object for the item
137. ase String Initial value is O default processing RW Supported named values for this prompt Default Yes No Cancel See also User Choices Ul Group Special object for Ul customizing RW Remarks If you want to skip the original dialog you must pass a new non zero value to the UserChoice property You may also change the destination file name at run time For example in pseudocode function OnEvent Type Name Dataln DataOut Flags if Type PXCVA_OnDisplayPrompt if Name Prompts ConfirmDocumentSave set another file name SetProperty Prompts ConfirmDocumentSave FileName DataIn C Test2 pdf 0 skip original dialog and try to save document into C Test2 pdf SetProperty Prompts ConfirmDocumentSave UserChoice Dataln Yes 0 See Also IPDFXCviewEvents OnEvent PXCVA_EventTypes PXCVA_OnDisplayPrompt IPDFXCview SaveDocument IPDFXCview GetProperty IPDFXCview SetProperty 2 2 2 15 3 ConfirmDropFile This is a special object for modifying the file drag and drop operation You must implement a special event handler see _IPDFXCviewEvents OnEvent and match the type of 216 PDF XChange Viewer ActiveX SDK the received event with the PXCVA_EventTypes PXCVA_OnDisplayPrompt constants and the name with the Prompts ConfirmDropFile string Contained Objects Name Type Description FileName String Represents path to file which was drop
138. assword CoPDFXCviewl DoVerb OpenDocument args dataOut 0 Interface Identificator GUID IID_IPDFXCargs C7F70A09 F3F8 4344 A688 6BC747A694B6 See Also IPDFXCview IPDFXCsmartp Operations ARGS PXCVA_Flags PXCVA_OutArgs 4 PDF XChange Viewer ActiveX SDK 2 1 4 1 Methods Methods Method Description Add Appends a new item to the collection Clear Removes all items from the collection Init Creates new collection with the specified size Remove Removes the item at the specified index from the collection See Also IPDFXCview IPDFXCsmartp 2 1 4 1 1 Add Appends a new item to the collection Syntax HRESULT Add VARIANT Valueln Parameters Valueln in VARIANT that specifies the value of the new collection item Return Value Returns S_OK if successful or an error value otherwise To obtain the text description of received error code you can use GetTextFromResult 2 1 4 1 2 Clear Removes all items from the collection Syntax HRESULT Clear Return Value Returns S_OK if successful or an error value otherwise To obtain the text description of received error code you can use GetTextFromResult 2 1 4 1 3 Init Creates new collection with the specified size Syntax HRESULT Init LONG CountIn Parameters CountIn in LONG that specifies the count of items in the new collection Reference a Return Value Returns S_OK if successful or an
139. at Digital Negative File Format Standard Windows Metafile Placeable Aldus Metafile Enhanced Windows Metafile items represent formats which are available for read write unmarked items represent formats available for read only See Also Objects Export Image Objects Export Image Type 2 2 3 29 Keyboard Notifications Filter Flags Supported Values String Integer Value Value None 0 All 1 Down 1 Up 2 See Also Objects Notifications Keyboard 2 2 3 30Line Ending Supported Values String Integer Description Value Value None 0 No line ending Square 1 A square filled with the annotations fill color Circle 2 A circle filled with the annotations fill color Diamond 3 A diamond shape filled with the annotations fill color OpenArrow 4 Two short lines meeting in an acute angle to form an open arrowhead ClosedArrow Two short lines meeting in an acute angle as in the 5 OpenArrow style and connected by a third line to form a triangular closed arrowhead filled with the annotations fill color Butt 6 A short line at the endpoint perpendicular to the line itself ROpenArrow 7 RClosedArrow 8 Slash See Also Objects Commenting 2 2 3 31 Link Highlight Mode Supported Values Reference Two short lines in the reverse direction from OpenArrow A triangular closed arrowhead in the reverse direction from ClosedArrow A short line at the endpoint approximately 30 degrees clockwise from perpendicular to the line
140. at for the text RWS See Also Objects Commenting 2 2 2 19 5 1 Char Reference This object represents char format structure for comment Contained Objects Name Bold FColor FontName FontSize HScale Italic RMode SColor Strikeout Underline See Also Objects Commenting 2 2 2 19 5 2 Para Type Integer String RWS Integer String RWS String RWS Double RWS Double RWS Integer String RWS Integer String RWS Integer String RWS Integer String RWS Integer String RWS Description Specifies text bold style For possible named values see the Booleans Default value is O false Specifies fill color for the text For possible named values see the Colors Default value is RGB 0 0 0 black Specifies font name Default value is Arial Specifies font size Default value is 12 0 pt Specifies horizontal scale for the text Default value is 100 percents Specifies text italic style For possible named values see the Booleans Default value is 0 false Specifies text rendering mode For possible values see the Text Rendering Mode Default value is O Fill Specifies stroke color for the text For possible named values see the Colors Default value is RGB 0 0 0 black Specifies text strikeout style For possible named values see the Booleans Default value is 0 false Specifies text underline style For po
141. ataln Sample Text 0 skip original dialog display and deny file replace SetProperty Prompts ConfirmFileReplace UserChoice Dataln No 0 Also you may replace the original prompt dialog by your own To do this you should display your custom dialog in the matching _IPDFXCviewEvents OnEvent call and send the dialog result to the UserChoice property see User Choices may not be 0 See Also IPDFXCviewEvents OnEvent PXCVA EventTypes PXCVA OnDisplayPrompt IPDFXCview GetProperty IPDFXCview SetProperty 2 2 2 15 1 ConfirmDocumentincSave This is a special object for modifying the confirmation dialog when the digitally signed document was changed with incrementally saved changes before closing See also PXCVA_DocumentSaveFlags 24 PDF XChange Viewer ActiveX SDK PXCVA_DocumentSavelnc You must implement a special event handler see _IPDFXCviewEvents OnEvent and match the type of the received event with the PXCVA_EventTypes PXCVA_OnDisplayPrompt constants and the name with the Prompts ConfirmDocumentincSave string Contained Objects Name Type Description ID Integer Specifies the unique ID of the document R FileName String Represents destination file name for specified RW document UserChoice Integer User s choice for this case String Initial value is O default processing RW Supported named values for this prompt Default Yes No Cancel See also User Choices
142. ate Offline 0 See Also Command List Objects Commands Objects Commands lt ltem gt How to Enumerate Characters in Document To use examples below you should open a document and obtain the unique identifier of the opened document C with ATL csi SAS Sir Colas ig MURO Saa Siese cial Sier CComPtr lt IPDFXCview gt spView CComPtr lt IPDFXCsmartp gt spDoc CString str str Format L Documents d iDocID CComVariant dataln dataOut ANEMIA SE ABS clean EcleiraQuie 0 y ATLASSERT dataOut vt VI_DISPATCH spDoc static_cast lt IPDFXCsmartp gt dataOut punkVal dataOut OL spDoc gt GetProperty __S2BS L Pages Count amp dataOut 0 const LONG pagesCount dataOut 1Val for LONG i 0 i lt pagesCount i CComPtr lt IPDFXCsmartp gt spPageChars str Format Pages d Chars 1 dataOut OL spDoc gt GetProperty __S2BS str amp dataOut 0 const LONG charsCount dataOut 1Val toe WONG J Of 3 lt Chere Lounes aera CComPtr lt IPDFXCsmartp gt spChar spPageChars gt GetItemPointByIndex j spChar p spChar gt GetProperty __S2BS L Code amp dataOut 0 WCHAR ch WCHAR dataOut 1Val C PDFXCviewAxLib IPDFXCsmartp spDoc object dataIn null object dataOut null axCoPDFXCviewl DoVerb Documents iDocID ToString SP datalh out data0ut 0 5 spDoc PDFXCviewAxLib IPDFXCsmartp dataOut dataOut 0
143. ate New Collection 7 Create New Stamps Collection 3630 Create from Image 4 Create Stamp from Image File 3630 Create from PDF 3 Create Stamp from PDF Document 3629 Delete Stamp 4 Delete Selected Stamp 3629 Zoom Out 2 Reduce Thumbnails 3629 Zoom In 1 Enlarge Thumbnails 3326 Text Color 1 3628 Line Starting Style 9 2 3628 Line Ending Style 7 3337 Opacity 8 Opacity Level ez PDF XChange Viewer ActiveX SDK 3323 1 3628 1 3645 7 3627 9 3627 7 3627 4 3627 3 3604 8 3626 4 3604 9 3296 y 3295 9 3295 8 3295 7 3295 5 3295 4 3295 3 3295 1 3295 0 3294 9 3294 7 3294 6 3601 9 3601 3601 Font Size Border Width Underline Style Border Style Zoom Stroke Color Fill Color Set Destination Zoom Font Auto Number Minute Hour Time HH MM SS Month Year Date MM DD YYYY PAGES PAGE Page Number Document Number Document Name Reset Reset List of Actions and Lost Changes Test Selected Test Selected Actions Delete Reference es 3 Delete Selected Actions 3601 Edit 6 Edit Properties of Selected Action 3636 Add Open a web link 3 3649 Add Go to a page in another 6 document 3636 Add Go to a page in this document 2 3601 Down 5 Move Selected Items Down in the Runtime Order 3601 Up 4 Move Selected Items Up in the Runtime Order
144. ate of key is XOQXCXXXXX 00OKX 0QX0QOOX OOK XOX Code in BSTR that specifies the private developer s string code For example For Developer Return Value Returns S_OK if successful or an error value otherwise To obtain the text description of a received error code you can use GetTextFromResult See Also PDF XChange Viewer ActiveX SDK IPDFXCview GetVersionInfo 2 1 1 1 10 SetProperty This simplified method allows you to set property values It acts as a shortcut to the DoVerb main method Syntax HRESULT SetProperty BSTR Name VARIANT Dataln LONG Flags y Parameters Name in BSTR that specifies full name of the property as string identifier For more information see Named Objects Dataln in VARIANT that specifies the new value of the property specified by Name Flags in LONG that specifies optional flags This argument can be 0 Also you can pass the PXCVA_Flags PXCVA_ NoApply to cache the passed value only Return Value Returns S_OK if successful or an error value otherwise To obtain the text description of a received error code use GetTextFromResult See Also PXCVA Flags PXCVA_ NoApply IPDFXCview GetProperty 2 1 1 2 Document Methods Document Methods that apply to individual documents Method Description ActivateDocument Activate the document CloseAllDocuments Close all opened documents CloseDocument Close the opened document DoDocumentVerb This method is
145. be displayed in the Attachments Pane Return Value Returns S_OK on success or an error value otherwise To obtain the text description of a received error code use IPDFXCview GetTextFromResult Remarks For example in pseudocode DoDocumentVerb docId NULL AddAttachment DataIn C TestCopy pdf MyAttachment This is my attachment See Also IPDFXCview DoVerb Objects Documents lt ltem gt IPDFXCargs Clears the operations history for the document The special operations history is used for Undo Redo feature Name Reference 130 ClearOperationsHistory Arguments None Return Value Returns S_OK on success or an error value otherwise To obtain the text description of a received error code use IPDFXCview GetTextFromResult Remarks For example in pseudocode DoDocumentVerb docID NULL ClearOperationsHistory NULL NULL 0 See Also IPDFXCview DoDocumentVerb Clears selection for current document Name ClearSelection Return Value Returns S_OK on success or an error value otherwise To obtain the text description of a received error code use IPDFXCview GetTextFromResult Remarks For example in pseudocode Clears selection for first document DoVerb Documents 0 ClearSelection NULL NULL 0 See Also IPDFXCview DoVerb Objects Documents lt Item gt Closes the document Name Close Arguments None Return Value 190 PDF XCha
146. bjects Prompts CreateFolderError 2 2 2 19 1 Bars This object is an array of items each item representing a UI bar menu toolbar status bar etc Item Template lt ltem gt defines item template for each bar representation Contained Objects Count Integer Contains the number of bars R See Also Objects View Objects Documents lt Item gt View 2 2 2 19 1 1 lt item gt Defines the item template for each Ul bar Contained Objects ID Integer Defines the unique identifier of the bar RS Name String Defines the unique name of the bar RS Visible Integer Determines the visibility of the bar String RWS Reference 2 See Also Objects View Objects Documents lt Item gt View 2 2 2 19 2 Border This object represents border structure for comment Contained Objects Width Double Specifies the width of the border RWS Default value is 1 0 Type Integer Specifies the type of border String For possible named values see the Border RWS Types Default value is 0 Solid Effect Integer Specifies the effect of the border String For possible named values see the Border RWS Effects Default value is 0 None DashType Integer Specifies dash type of the border String For possible named values see the Dash Types RWS Default value is 0 Cloudy Level Double Specifies cloudy level for border RWS Default value is 2 0 See Also Objects Commenting 2 2 2 19 3
147. ble get DataIn DataOut 0 if GES GetProperty View Bars Menu Visible DataOut 0 1 4 get full search pane visibility DoVerb View Panes Search Visible get DataIn DataOut 0 if Ors GetProperty View Panes Search Visible DataOut 0 2 1 show file toolbar DoVerb View Bar File Visible set DataIn 1 DataOut 0 bdo On SetProperty View Bar File Visible Dataln 1 0 2 2 show full search pane Reference DoVerb View Panes Search Visible set Dataln 1 DataOut 0 Lf ori SetProperty View Panes Search Visible Dataln 1 0 See Also Object Name Notation Objects Documents lt ltem gt View 2 2 2 18 1 Colors Defines colors of the control s user interface Contained Objects Name Back Face Highlight Mark Text Window Type Integer String RWS Integer String RWS Integer String RWS Integer String RWS Integer String RWS Integer String RWS Description Background shadow color for three dimensional display elements For possible named values see the Colors Face color for three dimensional display elements For possible named values see the Colors Color for highlighted by selection items For possible named values see the Colors Mark color for selected items For possible named values see the Colors Color for text Ul elements For possible named values see the Co
148. cation to the file and the control will load and use these stored settings Example http www mysite com settings dat file C settings dat C settings dat Syntax HRESULT get_SettingsURL BSTR ValueOut HRESULT put_SettingsURL BSTR Valueln Parameters ValueOut out Pointer to a BSTR that receives source URL of the file with control s settings Valueln in BSTR that specifies source URL of the file with control s settings Return Value Returns S_OK if successful or an error value otherwise To obtain the text description of a received error code use GetTextFromResult See Also IPDFXCview LoadSettings Operations LoadSettings 2 1 2 1 5 Src Sets or gets the source URL of a document Simply specify correct path to a document and the control will open the required file The source URL may contain some specific open actions see PDF Open Parameters reference for example http www mysite com test pdf page 2 amp zo0om 150 file C test paf C test pdf Syntax HRESULT get_Src BSTR ValueOut Reference HRESULT put_Src BSTR ValueIn Parameters ValueOut out Pointer to a BSTR that receives source URL of the document Valueln in BSTR that specifies source URL of the document Return Value Returns S_OK if successful or an error value otherwise To obtain the text description of a received error code use GetTextFromResult See Also IPDFXCview OpenDocu
149. cheba a iia 230 Perimeter ai A A ti 231 Polygon A a Ni id 231 PolyLi ne A a aii 232 Rect aoo ARRAS A AAA eee i ee hee ieee 232 Snapshot saves ane a 232 Vil PDF XChange Viewer ActiveX SDK Stamp it At e elie 233 StICKYNO S Ea NAAA ANA TES 233 SUTIL A A A tea a ie 233 TextBox ca A AAA AA Aia 234 Tp WI A td ia 234 Underline ME rs Colors Multiply Ref erred ObjECTS lt lt lt cimiiiii a ac daa ici 238 Bars lt ltem gt Border Panes lt ltem gt RectangleF iii AA A te 240 TeXUROrmat A ae ea ee ee 240 Ghar Ast ores A vest cael ie ee eee 241 Paral NA ileal eee nn eet aires 241 Whi SRpAWEGaen A ie ea 242 Kabels sai T a a a a a A inane AE r an ee 243 A E 243 Quad Quads Values E A I E a E ENEE O RO T EE NEE ATAT COTS a A ene eee ee a A ee Command Statesiit sii A Ae re as Gee a Comment Subject Modes cauca e a a amnesia Content Monitor States oi ides leew hid dan Neva ies nie ee Context Menu Us er ChoiteSise stint edie avi die ieee ee eevee eee A DISTA PES a di ao Document Bars riinan a A N Document Initial View Modes Document Inter acs ui rs BocumentP aE E E E EA ado Document Save Method varios A di tica Document Save Modes rt A AA Ee eee Document SaveAs Destination Typ8S ocooocononnnnnnnnnnnennnnancnincnnn rre rara 252 DUPONT Export Modes Export to Image Modes FileAttachment Con Ty PES a dd a csi 254 Highlight FormFields MaskS coi a a ia did 254 Image Align
150. cific files Server X manifest and Client exe manifest both files are XML formatted files The Server X manifest contains information about the external COM component s to be used by the Client exe application The Client exe manifest contains a brief description about your Client exe assembly and any dependency between the Client and Server architecture In the PDF XChange Viewer ActiveX SDK example folder Registration Free COM you will find examples of this method of use PDFXCviewAx X manifest file for the Server side and Client exe manifest a template manifest for any client application Client side So to use this method you should 1 Copy both files from this SDK folder to your program folder 2 Rename the Client exe manifest to lt YourProgramName gt exe manifest 3 Open the lt YourProgramName gt exe manifest replace name Client to name lt YourProgramName gt and save changes 4 Check your program folder it should contain lt YourProgramName gt exe lt YourProgramName gt exe manifest PDFXCviewAx X manifest PDFXCviewAx dll PDFXCview exe resource dat Having followed the above instructions lt YourProgramName gt exe application will be able to load and use the Viewer control without the usual standard COM integration on a target system Tips When developing your application before adding our control to your form temporarily install using our standard method rather than the registration free it s d
151. codes need to be replaced they will not function in this release You will get a free upgrade if You purchased any Version 3 or 4 PDF XChange or Tools SDK on or After Jan 1st 2007 or if you purchased the PDF XChange Viewer SDK Version 1 x as a stand alone product You will need to pay for his upgrade if Your PDF XChange Viewer SDK license was issued as a result of you owning any Version 3 PDF 2 1 Important Please Read 13 XChange or Tools SDK purchased before Jan 1st 2007 You will need to sign a distribution statement Before any new Version 2 Licenses are issued you will need to sign a statement stating how many PDF XChange Viewer SDK Client Distribution License Packs CDLP s have been issued as a result of use of the Viewer SDK in your end user applications There are 3 distinct products available for the inclusion of PDF Viewing within the developer s Software application either of the below maybe purchased individually or a PRO SDK containing both items below as a bundled option Reference This reference contains the following sections e Interfaces e Named Items e JavaScript Support e Enumerations e Simple ActiveX Control Interfaces The ActiveX control supports the following interfaces IPDFXCview This interface allows applications to implement an instance of the PDF XChange Viewer control IPDFXCviewEvents This interface allows applications to receive extended event notifications from the PDF
152. corresponding form field Name GetSelectedWidget Arguments None Outputs 1 LONG The zero based index of page with the selected widget But if no selected widget then control will return 1 as page index and result of method calling will be S_FALSE 2 LONG The zero based index of widget on the page Return Value Returns S_OK if is selected widget S_FALSE instead or an error value otherwise To obtain the text description of a received error code use IPDFXCview GetTextFromResult Remarks For example in pseudocode DoDocumentVerb docID NULL GetSelectedWidget NULL DataOut 0 int wgPageIndex DataOut 0 if wgPageIndex gt 0 we have selected focused widget wgIndexOnPage DataOut 1 See Also IPDFXCview DoDocumentVerb Objects Documents lt ltem gt GetSelectedField Gets text selection state for the document Name GetSelectionState Outputs 1 Boolean if false 0 then document doesn t have any selection 150 PDF XChange Viewer ActiveX SDK if true 1 then some text in document is selected Selected text may be obtain by using GetAllSelectedText method Return Value Returns S_OK on success or an error value otherwise To obtain the text description of a received error code use IPDFXCview GetTextFromResult Remarks For example in pseudocode Gets selection state for the first opened document DoVerb Documents 0 GetSelectionState Dataln DataOut 0
153. cument which can some change behawor of this function SetSocumentProperty docID GetSelMarkupsOnly true next code will return selection info only if selected annotation is mar this behaviour is same as in Java Script function Doc getAnnots DoDocumentVerb docID NULL GetSelectedAnnot NULL DataOut 0 See Also IPDFXCview DoDocumentVerb Objects Documents lt ltem gt SelectAnnot Gets full name of the selected form field The form field in PDF is not a visual object but each form field in the document may have one or more corresponding visual objects on page s which are called widgets Widget is a visual object for form field text box for text field check button for on off field etc So each form field can have a list of widgets which can be located at different places of page or on different pages may have different visual attributes colors borders fonts etc Name Get Se lecteclh iele Arguments 147 148 PDF XChange Viewer ActiveX SDK None Outputs Type Description 1 BSTR The full name of selected with input focus form field widget If no selected field the control will return empty string and result of method calling will be S FALSE Return Value Returns S_OK if is selected form field S FALSE instead or an error value otherwise To obtain the text description of a received error code use IPDFXCview GetTextFromResult Remarks For example in pseudocode DoDocumen
154. d only if DefSubjMode is set to Custom DefSubjMode Integer Specifies mode for default subject String For possible named values see the Subject RWS Modes Default value is 0 Default See Also Objects Commenting IPDFXCview DoVerb IPDFXCview GetProperty IPDFXCview SetProperty 2 2 2 3 2 Arrow Accesses the properties of the commenting Contained Objects Name Type Description Styles Array Defines item style representation RWS See Also Objects Commenting 2 2 2 3 2 1 Styles This object represents array of all comments styles and provides additional operations with them Item Template lt ltem gt defines item template for each style representation Contained Objects Name Type Description Count Integer Contains number of all accessible styles R 12 PDF XChange Viewer ActiveX SDK Remarks This object is an array of items where each item is represented as lt ltem gt For more information about object naming notation see Object Name Notation Examples for usage in pseudocode Enumerate all styles for arrow comment GetProperty Commenting Arrow Styles Count DataOut 0 Count for i 0 to Count 1 GetProperty Commenting Arrow Styles i ID DataOut 0 See Also Objects Commenting IPDFXCview DoVerb IPDFXCview GetProperty IPDFXCview SetProperty Defines item template for each commenting arrow style Contained Objects Name ID Name Start
155. dd C Test3 rtf create new document from the formatted text files DoVerb NULL NewDocumentFromRTF dataln dataOut 0 newDocID dataOut See Also IPDFXCview DoVerb 2 2 1 32NewDocumentFromText Creates new PDF document from the plain text using parameters previously defined by Objects Operations NewDocument FromText Name NewDocumentFromText Arguments 1 Yes BSTR Text file name 2 No BSTR Next text file name Return Value Reference e Returns S_OK on success or an error value otherwise To obtain the text description of a received error code use IPDFXCview GetTextFromResult If successful it returns the unique identifier ID of the created document in Data Out Remarks You may use the object with IPDFXCargs interface to create the text files list as input data For example in pseudocode create empty IPDFXCargs object IPDFXCargs args DoVerb NULL ARGS dataln dataOut 0 args IPDFXCargs data0ut dataOut NULL create input files list args Add C TextASCII txt args Add C TextUnicode log args Add C TextUTF8 ini create new document from the plain text files DoVerb NULL NewDocumentFromText dataIn dataOut 0 newDocID dataOut See Also IPDFXCview DoVerb Objects Operations NewDocument FromText 2 2 1 330penDocument Opens the specified document Name OpenDocument Arguments Req Type Description 1 No BSTR Source file n
156. ded Full Specifies the full saving for all documents always Note digital signature will be lost when this method is used Incremental Specifies the incremental saving for all documents always See Also Objects Documents SaveMethod 2 2 3 18 Document Save Modes Supported Values SaveToSource Document is being saved to source file SaveAs Document is being saved to another file control 1 will reopen the source document to newly saved document SaveCopyAs 2 Document is being saved to another file SaveToStream 3 Document is being saved to stream SaveToSourceStream Document is being saved to source stream 4 See also Objects Documents UseStreams Directly See Also Objects Notifications BeforeSaveDoc Objects Notifications DocSaved 2 2 3 19 Document SaveAs Destination Types Supported Values Reference 253 LastUsed 0 Specify it to use the last target directory in the Save As dialog Original 4 Specify it to use the current directory of the opened document in the Save As dialog Custom 2 Specify it to use the custom directory in the Save As dialog See Also Objects Documents SaveAsDestType 2 2 3 20 Duplex Printing Supported Values Default Default printer duplex settings None 0 Normal nonduplex printing Vertical 4 Long edge binding that is the long edge of the page is vertical Horizontal 2 Short edge binding that is the long edge of the page is horizontal See Also Objects
157. der any circumstances create a competing software Important Please Read 7 application to Trackers own PDF XChange Viewer for End users or for which a significant intended purpose is the viewing or manipulation of PDF format files without first requesting Tracker to specifically agreeing to the creation and distribution of such a product If Licensee wishes to develop a product outside the scope of this license Licensee should contact TRACKER S OEM Sales department to see if a special license is available 3 GRANT OF DUPLICATION AND DISTRIBUTION LICENSE The Software includes certain runtime libraries and files intended for duplication and distribution by Licensee within the Application Software to the user of Application Software Redistributables The Redistributable components of the Software are those files specifically designated as being distributable in the Files to be Included with Your Application section of the Online Help file the terms of which are hereby incorporated herein by reference Licensee should refer to the Documentation and specifically the Online Help file for additional information regarding the Redistributables Under TRACKER S copyright and subject to all the restrictions and conditions set forth in this Agreement and the Documentation TRACKER hereby grants Licensee and only Licensee a non exclusive non transferable worldwide license to reproduce exact copies of the Redistributables and include s
158. descriptive text about the code specified by Result Return Value Returns S_OK if successful or an error value otherwise See Also IPDFXCview DoVerb IPDFXCview DoDocumentVerb Operations GetTextFromResult 2 1 1 3 3 GetViewObjectFromName This method is used to obtain the type identifier and proper name of a view object which is represented by the input name string This method is a simplified variant of a special call to the DoVerb method Syntax HRESULT GetViewObjectFromName BSTR Name LONG Type LONG ID BSTR ProperName LONG Eaten 7 Parameters Name in BSTR that specifies the name of view object For more information see Objects View Objects Documents lt Item gt View Type out Pointer to a LONG value that receives the type of detected view object For more information see PXCVA ViewObjectTypes If your application does not need this Reference 33 information set it to NULL ID out Pointer to a LONG value that receives the unique identifier if any of the detected view object If your application does not need this information set it to NULL ProperName out Pointer to a BSTR value that receives the proper name of detected view object If your application does not need this information set it to NULL Eaten out Pointer to a LONG value that receives the number of characters of the name that was parsed If your application does not need this information set it to NULL
159. document Print Group Informs about printing of the document RWS TextEditor Keyboard FieldChanged BeforeSaveDoc DocSaved BeforeCloseDoc DocClosed See Also Group RWS Group RWS Group R Group RW Group R Group RW Group R Reference Informs about text editing in the document Allows to get information about keyboard events Informs you about changing value of form field Control sends this event before saving of document Control sends this event after saving of document Control sends this event before closing of document Control sends this event when document is closed IPDFXCview DoVerb IPDFXCview GetProperty IPDFXCview SetProperty 2 2 2 10 1 BeforeCloseDoc Control sends this event before closing of document Contained Objects Name DocID CancelAllowed Cancel See Also Type Integer R Integer String R Integer RW Description Retrieves unique ID of the document Means 1 if canceling of closing document is allowed For possible named values see the Booleans Allows to stop closing of the document depends of CancelAllowed For possible named values see the Booleans Default value is 0 false IPDFXCview DoVerb IPDFXCview GetProperty IPDFXCview SetProperty IPDFXCviewEvents OnEvent 2 2 2 10 2 BeforeSaveDoc Control sends this event before saving of document Contained Objects Name DocID SaveMode DestFileName
160. document view attributes visibility positions layouts for bars panes windows It also provides customizing of toolbars Represents an array of all existing pages of the document and provides additional operations with them Allows to specify PDF form settings for the document The purpose of this feature is to forbid the user to change the document Default value is O allow user to change the document For possible named values see Booleans Flag that signals about the completeness of displaying the content of all visible pages This flag depends on Objects Documents ContentMonitor property If Content Monitor is enabled then value of this property can be changed asynchronously Notification about each change of this property can be received through IPDEXCviewE vents OnE vent For possible named values see Booleans Marks the document as temporary For end user if it is 1 then Save operation displays the Save As dialog and sets it to 0 automatically when save operation was succeeded This flag will be ignored if save operation is called by developer For possible named values see Booleans Default value is 0 If it means 1 true then document has PDF A DenyMovePages DenyInsertPages DenyDeletePages GetSelMarkups Reference String specific R For possible named values see Booleans Integer Forbids the moving pages inside document or String outside RW For possible named values see Boole
161. ds HilightAllTextBoxes 3646 Text Boxes 9 Click Here to Highlight All Text Boxes HilightFormFields 3301 Highlight Form Fields 8 This Document Contains Form Click Here to Highlight Form Fields by Filter HilightRequiedField 3647 Required Fields Only sOnly 1 Click Here to Highlight Required Fields Only ImportAllSettings 3640 Import All Settings from Data File 8 Import All Application s Settings from Data File ImportComments 3650 Import Comments 3 ImportFormData 3307 AcroForm Import Data to Form 4 Forms_ImportData InsertEmptyPages 3630 Insert Empty Pages 5 InsertPages 3603 InsertPages Insert Pages 7 JSConsole Clear 3602 Clear 8 Clear Console Output JSConsole GoTo 3603 Go to line 5 JSConsole 3602 Run RunScript 7 Run Script JSConsole 3603 Java Script Options ShowOptions KeepToolSelected LastPage LineTool LockAllCmdBars LoupeTool MakeTextFormattin gAsDefault MeasureDeleteLab el MeasureEditLabel MeasureExportToC SV MeasurelnfoW indo WwW MeasureRestoreCa ptionPos MeasureSetLabel MeasureSetScale NewBlankDocumen t NewDocumentFro mlimage NewDocumentFro mRTF NewDocumentFro mScanner NewDocumentFro mText NextPage NextWindow Open OpenAllPopups 6 3322 9 3288 8 3312 4 3637 3 3260 9 3325 9 3380 1 3380 2 3381 y 3380 7 3380 0 3380 6 3380 5 3636 4 3637 5 3649 3 3646 2 3636 5 3288 7 5
162. e use GetTextFromResult 2 1 5 IPDFXCsmartp This interface represents special object Smart Point for simplification and access acceleration to any objects or properties which are described in the section Named Objects e Methods e Properties Remarks To obtain a primary smart point object you should call main method IPDFXCview DoVerb with special named operation Operations SP For example CString str CComPtr lt IPDFXCview gt spView CComPtr lt IPDFXCsmartp gt spDoc str Format L Documents d iDocID CComBSTR ob jName LPCWSTR str CComBSTR opName L SP CComVariant dataln dataOut spView gt DoVerb objName opName dataln amp dataOut 0 spDoc static_cast lt IPDFXCsmartp gt dataOut punkVal objName L Pages Count spDoc gt GetProperty objName amp dataOut 0 gets pages count for specifie PDFXCviewAxLib IPDFXCsmartp spDoc object dataIn null object dataOut null axCoPDFXCviewl DoVerb Documents iDocID ToString SP date spDoc PDFXCviewAxLib IPDFXCsmartp dataOut spDoc GetProperty Pages Count out dataOut 0 gets pages count for Dim spDoc As PDFXCviewAxLib IPDFXCsmartp Dim dataIn As Object Nothing Dim dataOut As Object Nothing AxCoPDFXCviewl DoVerb Documents iDocID ToString J SP date spDoc dataOut spDoc GetProperty Pages Count dataOut 0 gets pages count for specif VEG Dim dataln As Variant Dim dataOut As V
163. e Subject RWS Modes Default value is 0 Default See Also Objects Commenting IPDFXCview DoVerb IPDFXCview GetProperty IPDFXCview SetProperty ne PDF XChange Viewer ActiveX SDK 2 2 2 3 11 Pencil Accesses the properties of the commenting Contained Objects Styles Array Defines item style representation RWS See Also Objects Commenting 2 2 2 3 11 1 Styles This object represents array of all comments styles and provides additional operations with them Item Template lt ltem gt defines item template for each style representation Contained Objects Count Integer Contains number of all accessible styles R Remarks This object is an array of items where each item is represented as lt ltem gt For more information about object naming notation see Object Name Notation Examples for usage in pseudocode Enumerate all styles for pencil comment GetProperty Commenting Pencil Styles Count DataOut 0 Count DataOut for i 0 to Count 1 GetProperty Commenting Pencil Styles i ID DataOut 0 See Also Objects Commenting IPDFXCview DoVerb IPDFXCview GetProperty IPDFXCview SetProperty Defines item template for each commenting pencil style Contained Objects ID Integer Specifies the unique ID of the comment style RS Reference Name String Defines name of comment style RWS SColor Integer Specifies stroke color for the comment String For
164. e occurrence of each event you can access this object to get and possibly manipulate information about the current state of the event This object represents a PDF form field In the same manner that a form author can modify an existing field s properties such as border color or font the JavaScript user can use the Field object to perform the same modifications The interface to fullscreen presentation mode preferences and properties This is a static JavaScript object that allows you to share data between documents and to have data be persistent across sessions Such data is called persistent global data Global data sharing and notification across documents is done through a subscription mechanism which allows you to monitor global data variables and report their value changes across documents 2 3 1 2 3 2 Reference identity This is a static object that identifies the current user of the application Link This object is used to set and get the properties and to set the JavaScript action of a link CG An OGG object represents an optional content group in a PDF file Content in the file can belong to one or more optional content groups Content belonging to one or more OCGs is referred to as optional content and its visibility is determined by the states ON or OFF of the OCGs to which it belongs In the simplest case optional content belongs to a single OCG with the content being visible when the OCG is on and hidden when
165. e opening but you can change this behaviour see Objects Documents UseStreamsDirectly See Also IPDFXCview DoVerb IPDFXCview OpenDocument 2 2 1 34PrintDocument Prints a document using parameters previously defined by Objects Print Name PrintDocument Arguments Req Type Description 1 Yes LONG The unique identifier of the document or full file name of the document BSTR Return Value Returns S_OK on success or an error value otherwise To obtain the text description of a received error code use IPDFXCview GetTextFromResult See Also IPDFXCview DoVerb IPDFXCview PrintDocument 2 2 1 35 RemoveRecentltem This operation can be used to remove existing item from list of recent documents Name RemoveRecentitem Reference Arguments 1 Yes LONG The unique identifier of opened document or full file name BSTR Return Value Returns S_OK or an error value otherwise For obtaining text description of received error code you can use IPDFXCview GetTextFromResult See Also IPDFXCview DoVerb 2 2 1 36 RotateDocumentPages Rotates pages in document using parameters previously defined by Objects Operations RotatePages Name RotateDocumentPages Arguments 1 Yes LONG The unique identifier of the document or full file name of the document BSTR Return Value Returns S_OK on success or an error value otherwise To obtain the text description of a received error code use IPDFXCview GetTextFr
166. e unique ID of the comment style RS Name String Defines name of comment style RWS SColor Integer Specifies stroke color for the comment String For possible named values see the Colors RWS Default value is RGB 0 0 0 black Border Group Specifies border for the comment RWS HighlightMode Integer Specifies highlight mode for links String For possible named values see the Link RWS Highlight Mode Default value is 1 invert DefSubj String Specifies default subject text for comment RWS This value will be used only if DefSubjMode is set to Custom DefSubjMode Integer Specifies mode for default subject String For possible named values see the Subject RWS Modes Default value is 0 Default See Also Objects Commenting IPDFXCview DoVerb IPDFXCview GetProperty IPDFXCview SetProperty 2 2 2 3 10 Oval Accesses the properties of the commenting Contained Objects Name Type Description Styles Array Defines item style representation RWS See Also Objects Commenting 2 2 2 3 10 1 Styles This object represents array of all comments styles and provides additional operations with them Item Template lt ltem gt defines item template for each style representation Contained Objects Name Type Description Count Integer Contains number of all accessible styles R Remarks Reference 115 This object is an array of items where each item is represented as lt ltem gt For more
167. e with the PDFXCviewAx dll and u parameters To install manually under x64 systems for 32 bit clients PDFXCview exe 32 RegServer regsvr32 PDFXCviewAx dll 32 s or PDFXCview exe 64 RegServer the PDFXCview tbl 32 should be in the same folder as PDFXCview exe 64 regsvr32 PDFXCviewAx dll 32 s for 64 bit clients PDFXCview exe 64 RegServer regsvr32 PDFXCviewAx dll 64 s for 64 bit and 32 bit clients both PDFXCview exe 64 RegServer the PDFXCview tbl 32 should be in the same folder as PDFXCview exe 64 regsvr32 PDFXCviewAx dll 32 s regsvr32 PDFXCviewAx dll 64 s To install automatically use our exe installer in silent mode optionally PDF XChange Viewer ActiveX SDK Distribution 4 PDF XChange Viewer ActiveX SDK for MSI Installers you may use special MSM module to include our PDF XChange Viewer ActiveX into your installation process MSM for 32 bit clients MSM for 64 32 bit clients Registration Free Deployment You may use the PDF XChange Viewer ActiveX control without the standard COM integration usually required on a target system e g without registering an ActiveX To briefly explain on Windows XP and later any client application can use any external COM component even if it is not registered on the target system i e without the requirement to enter basic info about the COM component in the system registry To achieve this you are required by Windows to specify as a substitute 2 spe
168. eX SDK select all characters on first page DoVerb Documents 0 Pages 0 Text Select Dataln 0 1 DataOut 0 deselect all characters on first page DoVerb Documents 0 Pages 0 Text Select Dataln 0 0 DataOut 0 See Also IPDFXCview DoVerb Objects Documents lt ltem gt Pages lt ltem gt Text Strikes out all characters from specified range on the page Name Strikeout Arguments Req Type Description 1 Yes LONG The index of the first character to strike out 2 Yes LONG The count of characters to strike out 3 No LONG The color COLORREF of the strike out comment By default is set to 0000FF red 4 No Doubl The opacity of the strike out comment By default is set to 1 0 opaque e 5 No BSTR The name of the new annotation object may be used for identification of annotation on the page in the future Return Value Returns S_OK on success or an error value otherwise To obtain the text description of a received error code use IPDFXCview GetTextFromResult Remarks For example in pseudocode strike out first 10 characters on first page violet 65 opacity DoVerb Documents 0 Pages 0 Text StrikeOut Dataln 0 10 800080 0 65 DataOut 0 strike out all characters on first page DoVerb Documents 0 Pages 0 Text StrikeOut Dataln 0 1 DataOut See Also IPDFXCview DoVerb Objects Documents lt ltem gt Pages lt ltem gt Text Underlin
169. eamObj NULL PXCVA_NoU_ The Stream Object can be asynchronous See Also IPDFXCview DoVerb IPDFXCview SaveDocument Objects Notifications BeforeSaveDoc Objects Notifications DocSaved Objects Documents UseStreams Directly Reference Saves document s attachment to a file or to stream object Name SaveAttachment Arguments 1 Yes LONG The zero based index of the attachment in the attachments list or name of BSTR the attachment 2 No BSTR The destination local file name or stream object if isn t specified or is NULL IStrea then control will display the Ul for select destination m Return Value Returns S_OK on success or an error value otherwise To obtain the text description of a received error code use IPDFXCview GetTextFromResult See Also IPDFXCview DoDocumentVerb IPDFXCargs Selects text in entire document Name SelectAllText Return Value Returns S_OK on success or an error value otherwise To obtain the text description of a received error code use IPDFXCview GetTextFromResult Remarks For example in pseudocode Selects all text in the first document DoVerb Documents 0 SelectAllText NULL NULL 0 See Also IPDFXCview DoVerb Objects Documents lt ltem gt Selects an annotation on the page and sets input focus for it Name SelectAnnot Arguments 157 158 PDF XChange Viewer ActiveX SDK 1 Yes BSTR The annotation name In this case the control
170. eans 00FFFF yellow 4 No Doubl The opacity of the highlight comment By default set to 1 0 opaque e 5 No BSTR The name of the new annotation object may be used for identification of annotation on the page in the future Return Value Returns S_OK on success or an error value otherwise To obtain the text description of a received error code use IPDFXCview GetTextFromResult Remarks For example in pseudocode highlight first 10 characters on first page violet 65 opacity DoVerb Documents 0 Pages 0 Text Highlight DataIn 0 10 800080 0 65 DataOut 0 highlight all characters on first page DoVerb Documents 0 Pages 0 Text Highlight Dataln 0 1 DataOut See Also IPDFXCview DoVerb Objects Documents lt ltem gt Pages lt ltem gt Text Selects all characters from a specified range on the page Name Select Arguments 1 Yes LONG The index of the first character to select 2 Yes LONG The count of characters to select 3 No LONG The flag to ensure visibility of this selection By default set to 0 Return Value Returns S_OK on success or an error value otherwise To obtain the text description of a received error code use IPDFXCview GetTextFromResult Remarks For example in pseudocode select first 10 characters on first page and make visible new selectic DoVerb Documents 0 Pages 0 Text Select DataIn 0 10 1 DataOut 173 PDF XChange Viewer Activ
171. ecifies the unique ID of the comment style RS Name String Defines name of comment style RWS Type String Specifies type of the stamp comment RWS For possible values see remarks SColor Integer Specifies stroke color for the comment Reference 125 String RWS Opacity Double RWS Border Group RWS DefSubj String RWS DefSubjMode Integer String RWS Remarks Next stamp types is possible For possible named values see the Colors Default value is RGB 255 0 0 red Specifies the opacity of the comment Default value is 1 0 100 opacity Specifies border for the comment Specifies default subject text for comment This value will be used only if DefSubjMode is setto Custom Specifies mode for default subject For possible named values see the Subject Modes Default value is 0 Default Approved Asls Confidential Departmental Draft Experimental Expired Final ForComment ForPublicRelease NotApproved NotForPublicRelease Sold TopSecret See Also Objects Commenting IPDFXCview DoVerb IPDF XCview GetProperty IPDFXCview SetProperty 2 2 2 3 17 StickyNote Accesses the properties of the commenting Contained Objects Name Type Styles Array RWS See Also Objects Commenting 2 2 2 3 17 1 Styles Description Defines item style representation This object represents array of all comments styles and provides additional operations with them Item Template
172. ed Integer Allow deny open PDF document with drag and DenyOpenDocumentsWhenDro String drop p RWS For possible named values see the Booleans Default value is 0 open document with Drag amp Drop allowed DenyProgressDisplaying Integer Allow deny progress dialog displaying String For possible named values see the Booleans RWS Default value is 0 progress displaying allowed DocumentInterface Integer Defines the Ul interface of documents String For possible values see the Document Interfaces RWS gt Default value is 1 Single Document Interface ProcessID Integer Retrieves the server process identifier process String ID of PDFXCview exe module R ProcessName String Retrieves the server process name name of R PDFXCview exe module See Also IPDFXCview DoVerb IPDFXCview GetProperty IPDFXCview SetProperty 2 2 2 9 International Controls Ul localization Contained Objects Name Type Description LocalelD Integer Defines the standard locale identifier LCID The String specified language will be used in all Ul elements in RWS menu toolbars panes dialogs messages etc 186 PDF XChange Viewer ActiveX SDK For possible named values see the User Interface Languages Default value is 1 Default selects the default control s language For select the control s built in language exactly you should specify the 2 BuiltIn value DefaultLocalelD Integer By default the control s buil
173. ed values see the Booleans RWS Default value is 0 See Also Objects Tools 2 2 2 17 19 Stamp This tool allows to apply standard stamps to the currently displayed PDF document page Contained Objects Name Type Description Style Integer Defines ID of current commenting style for this RWS tool See also Objects Commenting Stamp Styles KeepSelected Integer Defines if this tool still be selected after its String usage RWS For possible named values see the Booleans Default value is 1 See Also Objects Tools Objects Commenting 2 2 2 17 20 StickyNote This tool allows to add sticky note in any place of PDF document Contained Objects Name Type Description Style Integer Defines ID of current commenting style for this RWS tool See also Objects Commenting StickyNote Styles KeepSelected Integer Defines if this tool still be selected after its String usage RWS For possible named values see the Booleans Default value is 1 See Also Objects Tools Objects Commenting 2 2 2 17 21 StrikeOut The StrikeOut tool permits to cross out selected text Contained Objects 234 PDF XChange Viewer ActiveX SDK Style Integer RWS KeepSelected Integer String RWS See Also Objects Tools Objects Commenting 2 2 2 17 22 TextBox This tool allows to add text on a page in a text box Contained Objects Defines ID of current commenting style for this tool See also Objects Commenti
174. eference 111 RWS BlendMode String RWS DefSubj String RWS DefSubjMode String RWS See Also Objects Commentina Integer Integer Default value is 1 0 100 opacity Specifies the blend mode for the comment For possible named values see the Blend Modes Default value is 1 Multiply Specifies default subject text for comment This value will be used only if DefSubjMode is set to Custom Specifies mode for default subject For possible named values see the Subject Modes Default value is 0 Default IPDFXCview DoVerb IPDFXCview GetProperty IPDFXCview SetProperty 2 2 2 3 8 Line Accesses the properties of the commenting Contained Objects Name Type Styles Array RWS See Also Objects Commenting 2 2 2 3 8 1 Styles Description Defines item style representation This object represents array of all comments styles and provides additional operations with them Item Template lt ltem gt defines item template for each style representation Contained Objects Name Type Count Integer R Remarks Description Contains number of all accessible styles This object is an array of items where each item is represented as lt ltem gt For more information about object naming notation see Object Name Notation Examples for usage in pseudocode Enumerate all styles for line comment GetProperty Commenting Line Styles Count DataOut 0 Count
175. efines item template for each commenting distance style Contained Objects Name Type Description ID Integer Specifies the unique ID of the comment style RS Name String Defines name of comment style RWS Start Integer Specifies line starting style String For possible named values see the Line Ending RWS Default value is 5 ClosedArrow End Integer Specifies line endings style String For possible named values see the Line Ending RWS Default value is 5 ClosedArrow FColor Integer Specifies fill color for the comment String For possible named values see the Colors RWS Default value is RGB 255 0 0 rea SColor Integer Specifies stroke color for the comment String For possible named values see the Colors RWS Default value is RGB 255 0 0 red Opacity Double Specifies the opacity of the comment RWS Default value is 1 0 100 opacity BlendMode Integer Specifies the blend mode for the comment String For possible named values see the Blend RWS Modes Default value is 0 Normal Border Group Specifies border for the comment RWS LeaderExtended Double Specifies the length of the leader line RWS extensions that expend from the line proper 180 degrees from the leader lines Default value is 5 0 LeaderOffs et Double Specifies the length of the leader line offset RWS which is the amount of empty space between the endpoint s of the annotation and the 107 108 PDF XChange Viewer ActiveX S
176. ems for more operations the items can represent pages of document Print Export etc See Also Objects Print RangeType Objects Export Image RangeType Objects Operations SummarizeAnnots 2 2 3 49 Registry Roots Supported Values HKCR Defines the HKEY_CLASSES_ROOT registry root HKEY_CLASSES_ROOT HKCU Defines the HKEY_CURRENT_USER registry root HKEY_CURRENT_USER HKLM Defines the HKEY_LOCAL_MACHINE registry root HKEY_LOCAL_MACHINE See Also Operations LoadSettings Operations SaveSettings Reference 265 2 2 3 50 Rotation Direction Supported Values Clockwise Clockwise 90 degrees CounterClockwi 4 Counterclockwise 90 degrees se 180 2 180 degrees See Also Objects Operations RotateP ages 2 2 3 51 Search Modes Supported Values InActive 0 Search in active PDF document InOpened 1 Search in all opened documents InFolder 2 Search in folder See Also Objects Search Where 2 2 3 52Selection Notifications Filter Flags Supported Values None All 1 Annotations 1 Text 2 See Also Objects Notifications Selection 2 2 3 53Shortcut Key Types Supported Values Virt 1 ASCII 0 See Also 266 PDF XChange Viewer ActiveX SDK Objects Commands lt Item gt Shortcut 2 2 3 54 Shortcut Modifiers Supported Values The ALT key must be held down when the accelerator key is pressed 8 The CTRL key must be held down when the accelerator key is pressed 4 The SHIFT
177. ensee may not incorporate the PDF XChange Viewer SDK functionality in evaluation versions of their software applications without accounting for each installation towards the total license count allowed under the terms of this license 7 PROPRIETARY RIGHTS COPYRIGHT NOTICES Except for the limited license granted herein TRACKER and its suppliers retains exclusive ownership of all intellectual and proprietary rights including all ownership rights title and interest in and to the Software Licensee agrees not to represent that TRACKER is affiliated with or approves of Licensee s Application Software in any way Except as required hereby Licensee shall not use TRACKER S name trademarks or any TRACKER designation in association with Licensee s Application Software The Application Software should contain the following copyright notice in the About box or if not the About box as aminimum Developers License as provided with the End User Application Portions of this product were created using PDF XChange Image XChange SDK s From Tracker Software Products Ltd 2001 9 ALL RIGHTS RESERVED 8 EXPORT LAW Licensee acknowledges and agrees that the Software and Application Software may be subject to restrictions and controls imposed by the United States Export Administration Act as amended the ACT and the regulations there under Licensee agrees and certifies that neither the Software nor any direct product thereof e g the Ap
178. ent RWS This value will be used only if DefSubjMode is set to Custom DefSubjMode Integer Specifies mode for default subject String For possible named values see the Subject RWS Modes Default value is 0 Default See Also Objects Commenting IPDFXCview DoVerb IPDFXCview GetProperty IPDFXCview SetProperty 2 2 2 3 18 StrikeOut Accesses the properties of the commenting Contained Objects Reference Styles Array Defines item style representation RWS See Also Objects Commenting 2 2 2 3 18 1 Styles This object represents array of all comments styles and provides additional operations with them Item Template lt ltem gt defines item template for each style representation Contained Objects Count Integer Contains number of all accessible styles R Remarks This object is an array of items where each item is represented as lt ltem gt For more information about object naming notation see Object Name Notation Examples for usage in pseudocode Enumerate all styles for strikeout comment GetProperty Commenting Strike0ut Styles Count DataOut 0 Count Data0ut for i 0 to Count 1 GetProperty Commenting Strikeout Styles i ID DataOut 0 See Also Objects Commenting IPDFXCview DoVerb IPDFXCview GetProperty IPDFXCview SetProperty Defines item template for each commenting strikeout style Contained Objects ID Integer Specifies t
179. ents lt ltem gt Pages Layout 2 2 3 38 Pages Magnification Modes Supported Values Percent 0 Set zoom level in percents ActualSize 1 Displays pages in actual size 100 FitWidth 2 Specifies fitting page width in the window FitPage 3 Fits total page content in the window FitVisible 4 Not yet available See Also Objects Documents lt Item gt Pages ZoomMode 2 2 3 39 Pages Magnifications Supported Values Reference 261 Automatic 0 Selects page zoom automatically Auto ActualSize 100 Displays pages in actual size 100 FitPage 1 Fits total page content in the window FitWidth 2 Specifies fitting page width in the window FitVisible 3 Not yet available Remarks These values are basic only You can use custom values also For example you can specify the string values 99 9 99 9 or corresponding numeric values See Also Objects PageDisplay DefaultZoom Objects Documents lt Item gt Pages Zoom 2 2 3 40 Paper Modes Supported Values Custom 0 Use custom paper sizes Standard 1 Use standard paper sizes See Also Objects Operations NewDocument FromBlank Objects Operations InsertEmptyP ages 2 2 3 41 Paper Orientation Supported Values Default Default printers paper orientation settings Portrait 1 Normal paper orientation portrait Landscape 2 Landscape paper orientation See Also Objects Print 2 2 3 42PDF Specification Versions Supported Values Auto 0 1 4 0
180. enumeration allow you to determine different types of view objects See also IPDFXCview GetViewObjectFromName 2 5 2 5 1 PDF XChange Viewer ActiveX SDK Syntax enum PXCVA_ViewObjectTypes PXCVA_Bar 0x00000000 PXCVA_Pane 0x00000001 y Constants PXCVA_Bar Signalled if detected view object is a command bar toolbar menu bar status bar PXCVA_Pane Signalled if detected view object is a pane special Ul container which contains another advanced view See Also IPDFXCviewEvents OnEvent IPDFXCview GetViewObjectFromName Objects View Objects Documents lt ltem gt View Simple ActiveX Control This ActiveX control has been specially developed for fast and simple usage does not require the developer s licence but has the limited functionality Note this control does not require the developer s licence and also works with the end user s pro licence which can be installed on end user s computer So if the end user uses the pro licence the control will work in a pro mode on his computer if the user has no pro licence the control will work in free mode on his computer The Simple ActiveX control supports the following interfaces IPDFXCpreview This interface allows applications to implement an instance of the Simple PDF XChange Viewer control Control Identificators CLSID DFC89414 E8E7 49c0 B14E EB61245D3A5D ProgID PDFXCviewAx CoPDFXCpreview IPDFXCpreview This interface is the default
181. er selectedAnnots subject templates title URL viewState xfa XFAForeground zoom zoomType Supported Methods addAnnot addLink calculateNow closeDoc deletePages exportAsFDF CXPOBEASE DE Ses EXPOETASAFDE exportAsXEFDFSt exportDataObject ExXtracLr ages flattenPages getAnnots 2 3 6 getAnnots3D getField getLinks getNthFieldNam getOCGs getPageBox getPageNthWord getPageNthWordQuads getPageNumWords getPageRotation getPrintParams gotoNamedDest flattenPages importAnFDF importAnXFDF importDataObject insertPages movePage newPage print removeDataObject removeLinks Pesetl orm Seron selectPageNthWord setAction setPageRotations spawnPageFromTemplate submitForm syncAnnotScan See Also IPDFXCview RunJavaScript JavaScript for Acrobat API Reference event All JavaScript scripts are executed as the result of a particular event For each of these events JavaScript creates an event object During the occurrence of each event you can access this object to get and possibly manipulate information about the current state of the event Supported Properties Reference 277 278 PDF XChange Viewer ActiveX SDK All are supported Supported Methods All are supported See Also IPDFXCview RunJavaScript JavaScript for Acrobat API Reference 2 3 7 Field This object represents a PDF form field In the same manner that a form author can modif
182. eral Deny AllModify Operations 2 5 1 2 4 SettingsURL Sets or gets the URL to the settings dat file with all stored settings for the control Simply specify the correct path location to the file and the control will load and use these stored settings Example http www mysite com settings dat file C settings dat C settings dat Syntax HRESULT get_SettingsURL BSTR ValueOut HRESULT put_SettingsURL BSTR Valueln Parameters ValueOut out Pointer to a BSTR that receives source URL of the file with control s settings Valueln in BSTR that specifies source URL of the file with control s settings Return Value Returns S_OK if successful or an error value otherwise To obtain the text description of a received error code use GetTextFromResult See Also IPDFXCview LoadSettings Operations LoadSettings 2 5 1 2 5 Src Sets or gets the source URL of a document Simply specify correct path to a document and the control will open the required file The source URL may contain some specific open actions see PDF Open Parameters reference for example http www mysite com test pdf page 2 amp zo0om 150 file C test paf C test pdf Syntax 287 3 1 288 PDF XChange Viewer ActiveX SDK HRE SUL get_Src BSTR ValueOut HRE SUL Parameters put_Src BSTR Valueln Value0ut out Pointer to a BSTR that receives source URL of the document
183. eras heat danas vee eee a ete tee det 45 GetltemPointBy dex So eee ree eee ek A eee eek 45 Getlt mPointBy NINd ex sence 2 coc ieer et ened tierra MA ee 46 GetPointName a Slade nie Meda aii od re ne a 46 GetProperty GetSubPoint SetProperty PROPeMrieS aici Siete AIA AD Reeves A isa Property 2 eante Mirea E E on Simple Operations ARGS SP ACTIVADO CUM di di diia 51 e eA Eo Oea E EEEE s 51 ClearRec ents List ii zas 52 CIN ISS Enst n EEn SEAEEEASEEAE EES EEAEEASEEAEEEESEEEE EEES EEAE EESE EA REESE En EEEE 52 CLOSEDOCUIME dic AE AE E ES A E A E AT 52 ECIN AAA ole Aa 1n ANAE EEE AE ETAST TT A TAT TE T R 53 D lete Document Page S iener A E NA A AAA E E ias 53 DiscardAllCachedChanges ai 1 54 Ex Gute Command ii cincect chee Aedes bees acu ave sce thaws sduceussuvascavealcvvnancbevsavtccecveese 54 EXPOrtDOC UMM Mb g s Aces s vec dass ceca scacys a A A a ie 54 EXtractDOCUMENtPAgQes a thaveaguedseeuras 55 ElushDoOCUMENE i e 25 teessncthasecahshcasisansusceosSecesastesdeenddahde oneasactdvandedvecctaubesdunbesbadsnvadcasbicnedagatedisaueceddaanedsaveastreeteteds 55 GetActiVE DOCUIME Mia size E A A ia 56 GetDocumentErOMNaME isaac tirada tdi id 56 GetDocumentiD sia stol GetDoc menthdex niiz aa tun a sr dd der cre ec co ee Lo ol e aE 57 GolDO CUENCA ib isis 57 GetTextEromResull ETA E ETAT E T t E T TTA 58 GetView Object OMAN ci a 58 E A AN 59 INS EFLDOCUMENTPAGES bi a A a aateurtebeld
184. erline comment popups RWS automatically For possible named values see the Booleans Default value is O false ShowTextIndicators Integer Specifies to show special text indicators for String comments RWS For possible named values see the Booleans Default value is 1 true ShowTooltips Integer Specifies to show tooltips for comments String For possible named values see the Booleans RWS Default value is 1 true AnnotCommonSubj String Common subject text for styles where RWS DefSubjMode property is set to Common SimpleFocusApp Integer Toggles between animated and simple appearance String offocus rectangle for annotations and form fields RWS For possible named values see the Booleans Default value is 0 false HideStdStampsCollections Integer Hides Shows all standard built in stamps String collections RWS For possible named values see the Booleans Default value is 0 false See Also IPDFXCview DoVerb IPDFXCview GetProperty IPDFXCview SetProperty 100 PDF XChange Viewer ActiveX SDK 2 2 2 3 1 Area Accesses the properties of the commenting Contained Objects Styles Array Defines item style representation RWS See Also Objects Commenting 2 2 2 3 1 1 Styles This object represents array of all comments styles and provides additional operations with them Item Template lt ltem gt defines item template for each style representation Contained Objects Count Intege
185. error value otherwise To obtain the text description of received error code you can use GetTextFromResult 2 1 4 1 4 Remove Removes the item at the specified index from the collection Syntax HRESULT Remove LONG Index Parameters Index in LONG that specifies the index 0 based of the item to be removed Return Value Returns S_OK if successful or an error value otherwise To obtain the text description of received error code you can use GetTextFromResult 2 1 4 2 Properties Properties Property Name Description NewEnum Returns an IEnumVARIANT interface that can be used to enumerate the collection Count Indicates the number of items contained in the collection Data Gets sets collection data i e the variant object VARIANT which can contain a SAFEARRAY Ite Gets sets value of an collection item variant object by index See Also IPDFXCview IPDFXCsmartp 2 1 4 2 1 _NewEnum Returns an IEnumVARIANT interface that can be used to enumerate the collection Syntax HRESULT get__NewEnum IUnknown ppUnkOut Parameters ppUnkOut out Double pointer to a lUnknown that receives an IEnumVARIANT interface which can be used to enumerate the collection Return Value Returns S_OK if successful or an error value otherwise To obtain the text description of a received error code use GetTextFromResult 42 PDF XChange Viewer ActiveX SDK 2 1 4 2 2 Count Indicates the number of elements c
186. erty Documents 4095 View Bars Count DataOut 0 or GetDocumentProperty 4095 View Bars Count DataOut 0 1 2 get bar unique name by order index Same as panes DoVerb Documents 4095 View Bar 0 Name get Dataln DataOut 0 or GetProperty Documents 4095 View Bar 0 Name DataOut 0 or GetDocumentProperty 4095 View Bar 0 Name DataOut 0 1 3 get options bar visibility DoVerb Documents 4095 View Bars Options Visible get Dataln DataOut 0 or Reference Kum GetProperty Documents 4095 View Bars Options Visible DataOut 0 1 Of GetDocumentProperty 4095 View Bars Options Visible DataOut 0 1 4 get thumbnails pane visibility DoVerb Documents 4095 View Panes Thumbnails Visible get DataIn DataOut 0 E Of GetProperty Documents 4095 View Panes Thumbnails Visible DataOut 0 or GetDocumentProperty 4095 View Panes Thumbnails Visible DataOut 0 2 1 show options toolbar DoVerb Documents 4095 View Bars Options Visible set Dataln 1 DataOut 0 or SetProperty Documents 4095 View Bars Options Visible Datalnt1 0 or SetDocumentProperty 4095 View Bars Options Visible DataIn 1 0 2 2 show thumbnails pane DoVerb Documents 4095 View Panes Thumbnails Visible set DataIn 1 DataOut 0 El ors SetProperty D
187. ertyChanged 0x00000001 PXCVA_OnDisplayPrompt 0x00000003 PXCVA_OnNamedNotify 0x00000004 y Constants PXCVA_OnPropertyChanged Signalled if the property just changed to obtain actual value of the property call IPDFXCview GetProperty method PXCVA_OnDisplayPrompt Used for confirmation and customize of Ul prompt dialog before display For more information see Objects Prompts PXCVA_OnNamedNotify Used for notification about more common special events For more information see Objects Notifications See Also Reference 263 IPDFXCviewEvents OnEvent 2 43 PXCVA_Flags The flags shown in this enumeration allow you to condition the behaviour of the various actions Combinations of these flags are usually passed in the last Flags argument Syntax enum PXCVA_Flags PXCVA_NoApply 0x00000001 PXCVA_NoUI 0x00000002 PXCVA_Get Named 0x00000004 PXCVA_Sync 0x00000008 PXCVA_OutArgs 0x00000010 be Constants PXCVA_NoApply The changes should not be applied immediately Changes are to be accumulated before any action will run or the IPDFXCview ApplyAllCachedChanges method call is used See Operations SetNoApply also PXCVA_NoUI This flag disables the Ul For example when opening a corrupted document the ActiveX control will normally display a dialog to announce this fact When this flag is set then no messages will be displayed In this case the error could be detected by checking the return result of the
188. es ID of current commenting style for this RWS tool See also Objects Commenting Pencil Styles KeepSelected Integer Defines if this tool still be selected after its String usage RWS For possible named values see the Booleans Default value is 1 See Also Objects Tools Objects Commenting 2 2 2 17 14 Perimeter Perimeter tool allows to measure a set of distances between multiple points Contained Objects Style Integer Defines ID of current commenting style for this RWS tool See also Objects Commenting Perimeter Styles KeepSelected Integer Defines if this tool still be selected after its String usage RWS For possible named values see the Booleans Default value is 1 See Also Objects Tools Objects Commenting 2 2 2 17 15 Polygon The Polygon Tool draws a polygon outline around selected parts of the PDF page Contained Objects Style Integer Defines ID of current commenting style for this RWS tool See also Objects Commenting Polygon Styles KeepSelected Integer Defines if this tool still be selected after its String usage RWS For possible named values see the Booleans Default value is 1 See Also Objects Tools Objects Commenting 232 PDF XChange Viewer ActiveX SDK 2 2 2 17 16 PolyLine The Polygon Line Tool is an extension of the basic Line Tool that allows you to draw multiple connected line segments Contained Objects Style Integer Defines ID of current
189. es all characters from the specified range on the page Name Underline Arguments Reference 1 Yes LONG The index of the first character to underline 2 Yes LONG The count of characters to underline 3 No LONG The color COLORREF of the underlined comment By default means 00FF00 green 4 No Doubl The opacity of the underlined comment By default is set to 1 0 opaque e No LONG The squiggly underline type By default means 0 No BSTR The name of the new annotation object may be used for identification of annotation on the page in the future Return Value Returns S_OK on success or an error value otherwise To obtain the text description of a received error code use IPDFXCview GetTextFromResult Remarks For example in pseudocode underline first 10 characters on first page violet 65 opacity squic DoVerb Documents 0 Pages 0 Text Underline DataIn 0 10 800080 0 65 1 DataOut 0 underline all characters on first page DoVerb Documents 0 Pages 0 Text Underline Dataln 0 1 DataOut See Also IPDFXCview DoVerb Objects Documents lt ltem gt Pages lt ltem gt Text This object represents an array of all characters on the page Item Template lt ltem gt defines item template for each character Contained Objects Count Integer Contains the total number of all characters on the R page Remarks For example in pseudocode gets chars count on the
190. es arranged on sheets of Book 7 paper so that they are in the correct order when the paper is collated folded and stapled See Also Objects Print ScaleType 2 2 3 45Print Specials Supported Values Default 33550369 Print document content and all markups DocumentAndMarkups 0x01FFF021 Document 33 Print document content only 0x00000021 DocumentAndStamps 4194337 Print document content and stamps 0x00400021 FieldsDataOnly 2 Print field data only See Also Objects Print PrintSpec 2 2 3 46Print Text as Curves Supported Values Auto With this option PDF XChange Viewer decides what text should be printed as curves ForEmbeddedFon 4 Only embedded fonts will be printed as curves ts Always 2 Text will always be printed as curves See Also Objects Print TextAsCurves 2 2 3 47 Range Filters Supported Values 1 All items 264 PDF XChange Viewer ActiveX SDK Odd 4 Odd items Even 5 Even items for more operations the items can represent pages of document Print Export etc See Also Objects Print RangeFilter Objects Export Image RangeFilter Objects Operations SummarizeAnnots 2 2 3 48 Range Types Supported Values None 0 No items All 1 All items First 2 First item Last 3 Last item Odd 4 Odd items Even 5 Even items Exact 6 Items specified by the range specification in RangeText for example 1 3 5 7 9 Current 7 Use current item Selected 9 Use selected it
191. es the unique name if it is supported of the item ItemPointOut out Pointer to a IPDFXCsmartp interface that receives new smart point object which depends on an item specified by NamedIndex Return Value Returns S_OK if successful or an error value otherwise To obtain the text description of a received error code use GetTextFromResult Remarks This method requires a special string property in item structure with name Name which contains a unique identifier of the item in current array Examples of the item structure that contains property Name Objects Documents lt ltem gt Objects Bars lt ltem gt See Also IPDFXCsmartp 2 1 5 1 5 GetPointName Retrieves full name of this smart point Syntax HRESULT GetPointName BSTR PointNameOut Reference Parameters PointNameOut out Pointer to a BSTR that receives full name of this smart point Return Value Returns S_OK if successful or an error value otherwise To obtain the text description of a received error code use GetTextFromResult See Also IPDFXCsmartp 2 1 5 1 6 GetProperty Retrieves value of specified sub property by relative name The syntax of this method is identical to main IPDFXCview GetProperty 2 1 5 1 7 GetSubPoint Creates a new smart point object by specified relative name and retrieves interface pointer to him Syntax HRESULT GetSubPoint BSTR SubName IPDFXCsmartp SubPointOut Parameters SubName i
192. es whether to use selected pages in reverse String order For possible named values see the Booleans RW Default value is 0 206 PDF XChange Viewer ActiveX SDK Output Group Allows to chose output format and settings for it RWS See Also IPDFXCview DoVerb IPDFXCview GetProperty IPDFXCview SetProperty Operations SummarizeDocumentAnnots Objects Documents lt ltem gt SummarizeAnnots 2 2 2 11 7 1 Output Allows to chose output format and settings for it Contained Objects Name Type Description Type Integer Specifies output file type String For possible named values see Summarize RWS Annotation Output Types AutoView Integer View new document after creation String For possible named values see the Booleans RWS Default value is 1 ShowPageNumber Integer Allows to add page number for annotation in String output RWS For possible named values see the Booleans Default value is 1 ShowTypeName Integer Allows to add annotation type information in String output RWS For possible named values see the Booleans Default value is 0 ShowTypelcon Integer Allows to add annotation type icon information in String output RWS For possible named values see the Booleans Default value is 1 ShowSubject Integer Allows to add subject information for annotation String in output RWS For possible named values see the Booleans Default value is 1 ShowAuthor Integer Allows to add author information
193. escribed above for example you can do so by running command line switches PDFXCview exe RegServer regsw32 PDFXCviewAx dll s Once done you can simply add our ActiveX control to your form like any other COM component Having done the above specify the manifests as described and uninstall our control from your system PDFXCview exe UnRegServer regsw32 PDFXCviewAx dll u s our control will now continue to function using the specified manifests Now when installing on your end users systems your installer can specify the required manifests only and the standard COM installation is no longer a requirement Important Please Read 5 For details about this technology http msdn microsoft com en us library ms973913 aspx See Also IPDFXCview SetDevinfo 13 Licensing The PDF XChange Viewer SDK Understanding the License types available Allows the developer to incorporate PDF viewing Capabilities within their software applications Supports PDF format specifications up to 1 7 Adobe 8 The Simple DLL SDK provides the developer with set of functions to create a means to View Print PDF files within a window embedded in their software application Both the GUI design and means of employing the provided functionality is very much left in the developer s hands and no Tracker branding is visible within the Developer s product The ActiveX SDK option is a fully featured ready to incorporate facsimile of the End User PDF XC
194. ew SaveDocument How to Close a Document To use examples below you should open a document and obtain the unique identifier of the opened document before closing see How to Open a Document C with ATL LONG nDocumentID 3 5 292 PDF XChange Viewer ActiveX SDK HRESULT hRes spViewer gt CloseDocument nDocumentID 0 C int nDocument ID int nRes us axCoPDFXCviewl CloseDocument nDocument ID 0 catch Exception ex nRes System Runtime InteropServices Marshal GetHRForException ex VB NET Dim nDocumentID As Integer Dim nRes As Integer Ley AxCoPDFXCviewl CloseDocument nDocumentID 0 Catch ex As Exception nRes System Runtime InteropServices Marshal GetHRForException ex End Try VB 6 0 Dim nDocumentID As Long Call CoPDFXCviewl CloseDocument nDocumentID 0 Delphi 7 0 var nDocumentID integer nRes integer try CoPDFXCviewl CloseDocument nDocumentID 0 EZEC pE on ex Exception do begin nRes EOleException ex ErrorCode end end See Also IPDFXCview CloseDocument IPDFXCview CloseAllDocuments How to Disable a Command Most commands in the Viewer may be accessed to enable or disable them by changing their State to Online or Offline To Disable the Print command to prevent any printing from the Viewer set the command as 3 6 How To Use 23 SetProperty Commands Print St
195. ex of the corresponding widget in the widgets list of the form field If widget isn t specified then first widget of the field will be selected automatically or to select widget exactly 1 Yes LONG The zero based index of page with the widget 2 Yes LONG The unique zero based index of the widget object on the page Return Value Reference 159 Returns S_OK on success or an error value otherwise To obtain the text description of a received error code use IPDFXCview GetTextFromResult Remarks Simple examples in pseudocode select field widget by name DoDocumentVerb docld NULL SelectField Dataln Text1 NULL PXCVA_Nc DoDocumentVerb docId NULL SelectField Dataln Text1 0 NULL PXCVA_ DoDocumentVerb docId NULL SelectField Dataln Text1 2 NULL PXCVA_ select field by widget indexes DoDocumentVerb docId NULL SelectField Dataln wgPagelndex wgIndexOnP NULL PXCVA_NoUT or identical DoDocumentVerb docId NULL SelectAnnot DataIn wgPageIndex wgIndexOnP NULL PXCVA_NoUT See Also IPDFXCview DoDocumentVerb Objects Documents lt ltem gt GetSelectedField Summarizes all comments from a document to a new document file using parameters previously defined by Objects Operations SummarizeAnnots Name SummarizeAnnots Arguments None Return Value Returns S_OK on success or an error value otherwise To obtain the text description of a
196. for his upgrade if If your PDF XChange Viewer SDK license was issued as a result of you owning any Version 3 PDF XChange or Tools SDK purchased before Jan 1st 2007 You will need to sign a distribution statement Before any new Version 2 Licenses are issued you will need to sign a statement stating how many PDF XChange Viewer SDK Client Distribution License Packs CDLP s have been issued as a result of use of the Viewer SDK in your end user applications no license codes will be issued without this General Info The PDF XChange Viewer SDK is available as both a simple DLL library to rasterize PDF pages and display them within a developer s application or as a fully featured ActiveX representation of our highly popular and advanced End User PDF XChange Viewer which allows developers to embed extensive viewing and manipulation functionality directly in their application Windows This file document deals with the ActiveX Version and its properties and methods please see the help file PXCView36SSDK_Help chm included in this installation for details on the PDF XChange Simple DLL Viewer SDK As with all of our products the evaluation version of the PDF XChange Viewer is fully functional and also the version you should use in your developed applications all that distinguishes live use from evaluation use is that for live use you must provide your purchased license strings in your project code when compiling your application this ensure
197. fter which time you are entitled to all minor updates free of charge up to but excluding the next Major version update During 2008 9 we will also be introducing a maintenance option payable annually which will entitle subscribers to all ongoing updates irrespective of whether they are Major or Minor in nature during the currency of their subscription we will make all clients aware when this is introduced and any changes to our upgrade policy this may result in at that time however naturally no purchasers will be deprived of the minimum 12 months of free upgrades irrespective of how our T amp C s may subsequently alter Support All support is provided free whether you are using an evaluation or licensed release of our products As any developer will recognize email is increasingly an issue with regards the huge volumes of spam being circulated and the resulting problems this causes with antivirus anti spam filtering etc We are no different and receive 10 000 s of emails each day unrelated to our business for this reason we request that all support issues are made via our User Forums whenever possible you will need to register free and acknowledge the email sent to your inbox before you can View messages or Post Our forums are monitored and all posts answered by our own technical support staff and also provide a useful historic repository of previous Q amp A s and FAQ s There are also Forums specifically created for t
198. hange Viewer again embedded within a Window of the application the developer is able to hide and disable most of the controls and functions within the SDK and some GUI tailoring is possible but Tracker Software branding is present and required from the About Window of the embedded viewer The ActiveXis also more feature rich than the Simple DLL method Developer s owning existing PDF XChange or Tools Developer SDK s are provided with the following free distribution rights to end users of their software applications PDF XChange Tools SDK Type Viewer Client Distribution Licenses Included PDF XChange Viewer Base SDK 25 000 PDF XChange PRO SDK 7 500 PDF XChange Drivers API SDK 2 500 PDF Tools SDK 2 500 Once the licenses provided with any of the above Developers SDK s have been used prior to continuing to distribute an application utilising the PDF XChange Viewer the Developer must purchase an additional client distribution License Pack CDLP available in 50K 100K 250K or 1 Million Client License pack s For information regarding Royalty free licensing please contact oemsales tracker software com If a developer does not own any of the above SDK s the purchase of a PDF XChange Base Viewer SDK is required prior to purchasing an Client Distribution License packs The PDF XChange Viewer SDK is not a Royalty Free product as standard however special rates may be negotiated for large Client Distribution License packs Important either a
199. he page in the selection range These numbers will be obtained through SAFEARRAY Return Value Returns S_OK on success or an error value otherwise To obtain the text description of a received error code use IPDFXCview GetTextFromResult Remarks For example in pseudocode DoDocumentVerb docId Pages GetSelectedRanges Dataln DataOut 0 we have selection which contains two blocks int firstPageWithSell DataOut 0 int countPagesWithSell DataOut 1 int firstPageWithSel2 DataOut 2 int countPagesWithSel2 DataOut 3 For simplify in out operations with SAFEARRAY you can use the IPDFXCaras object obtain a new IPDFXCargs object with array of numbers DoDocumentVerb docId Pages GetSelectedRanges Dataln IPDFXCargsObj args DataOut DataOut PXCV2 int firstPageWithSell args 0 int countPagesWithSell args 1 int firstPageWithSel2 args 2 int countPagesWithSel2 args 3 See Also IPDFXCview DoVerb Objects Documents lt ltem gt Pages Defines item template for each opened document representation Contained Objects Name Type Description Width Double Width of page in points 1 point is 1 72 inch This R value shows the width of rectangle which is calculated as intersection of Media and Crop boxes with applying of Rotation and UserUnit values see Adobe s PDF Reference Height Double Height of page in points 1 point is 1 72 inch This R value shows the height of recta
200. he posting of your wish list should you have any comments or ideas you wish to share with us If you do need to email us for any reason please see our Contacts page for the relevant contact info Important Any attachment sent by email or posted to our forums MUST be wrapped in either a ZIP 7z or RAR archive failure to do so will result in your message being stripped of its attachment and we will not receive Important Please Read 3 1 1 Redistribution Information To redistribute your own application to your end users the following components should be included in your installation and you must also register the components as outlined below PDFXCview exe PDFXCviewAx dll Resource dat Note There are both 32 and 64 bit versions of the PDF XChange Viewer control and you should accommodate both in your distribution please see the appropriate SDK installation folder to locate the 32 64 bit versions provided For details about this see ActiveX Control Installation Important The PDF XChange Viewer SDK requires Windows 2000 or later See Also IPDFXCview GetVersionInfo 1 2 ActiveX Control Installation To install the PDF XChange Viewer ActiveX manually or via your applications installer To install manually e Run PDFXCview exe with the RegServer parameter e Run regsvr32 exe with the PDFXCviewAx dll parameter To uninstall manually e Run PDFXCview exe with the UnregServer parameter e Run regsvr32 ex
201. he unique ID of the comment style RS Name String Defines name of comment style RWS SColor Integer Specifies stroke color for the comment String For possible named values see the Colors RWS Default value is RGB 255 0 0 Red 127 128 PDF XChange Viewer ActiveX SDK Opacity Double Specifies the opacity of the comment RWS Default value is 1 0 100 opacity BlendMode Integer Specifies the blend mode for the comment String For possible named values see the Blend RWS Modes Default value is 0 Normal DefSubj String Specifies default subject text for comment RWS This value will be used only if DefSubjMode is set to Custom DefSubjMode Integer Specifies mode for default subject String For possible named values see the Subject RWS Modes Default value is 0 Default See Also Objects Commenting IPDFXCview DoVerb IPDFXCview GetProperty IPDFXCview SetProperty 2 2 2 3 19 TextBox Accesses the properties of the commenting Contained Objects Name Type Description Styles Array Defines item style representation RWS See Also Objects Commenting 2 2 2 3 19 1 Styles This object represents array of all comments styles and provides additional operations with them Item Template lt ltem gt defines item template for each style representation Contained Objects Name Type Description Count Integer Contains number of all accessible styles R Remarks This object is a
202. hole Words Only Find Whole Words Only First Page Go to First Page Fit Page Fit Page by Current View Fit Visible Fit Page by Visible Content Fit Width Fit Page Width by Current View Flatten Comments Flip Line Full Screen Maximizes Window to Full Screen Full Screen Exit Restores Window from Full Screen Search ShowHide Full Search Pane Back Previous View Go To Previous View Previous Document Forward Next View Go To Next View Next Document Home Page Go to Next Search Occurrence Page Go to Previous Search Occurrence Hand Tool Contents Hide All Bars Hide all bars from user s set Reference e HideAllComments 3643 Annots Hide All Hide All Comments 5 Comments HighlightSelText 3320 Highlight Text 6 HighlightTextTool 3322 Annots Tool Highlight Text Tool 1 HighlightMenultem Highlight the Selected Text HilightAllCheckBox 3646 Check Boxes es 5 Click Here to Highlight All Check Boxes HiligntAllComboBo 3646 Combo Boxes xes 4 Click Here to Highlight All Combo Boxes HilightAllFormField 3646 All Fields s 3 Click Here to Highlight All Form Fields HilightAllListBoxes 3646 List Boxes 6 Click Here to Highlight All List Boxes HilightAllPushButto 3646 Push Buttons ns 7 Click Here to Highlight All Push Buttons HilightAllRadioButt 3646 Radio Buttons ons 8 Click Here to Highlight All Radio Buttons HilightAllSignatures 3647 Signature Fields 0 Click Here to Highlight All Signature Fiel
203. ibute We sell our products directly via Distributors Resellers and OEM partners in some cases with our products and larger partners these products are sold under different labels and names than those we sell directly this is to allow our partners to build a following for their own brand and protect their future However no matter how our products reach you we want you to experience the best results possible please do contact us if for any reason you are dissatisfied or have a suggestion how we can improve our product offerings You may also be interested in related products available from us in the following brief topics you will find details of how to contact us request support and summary details of the products available from us for both End Users and Software Development tools for other Software developers to utilise in their product offerings Please do contact us if you cannot find the information you require within this manual help file 4 1 4 2 298 PDF XChange Viewer ActiveX SDK Contact Us How to Contact Us North South America Australia Asia Tracker Software Products Canada Ltd 3 466 Trans Canada Highway Duncan BC V9L 3R6 Canada Sales amp Admin Tel Canada 00 1 250 597 1621 Fax Canada 00 1 250 597 1623 European Office 7 Beech Gardens Crawley Down RH10 4JB Sussex United Kingdom Sales Tel 44 0 20 8555 1122 Fax 001 250 597 1623 Our Web Site http www
204. ide Zoom Toolbar Properties More Properties Typewriter Tool Underline Text Underline Text Tool Underline the Selected Text Undo Undo the Last Action Validate All Signatures 100 1200 150 1600 200 2400 25 3200 400 Reference 9 Zoom50 3306 50 4 Zoom6400 3305 6400 4 Zoom75 3306 75 3 Zoom800 3305 800 8 Zoomin 3290 ZoomViewln Zoom In 4 ZoomInTool 3261 ZoomlnMenultem Zoom In Tool 0 ZoomOut 3290 ZoomViewOut Zoom Out 5 ZoomOutTool 3261 ZoomOutMenultem Zoom Out Tool 1 ZoomTo 3289 ZoomTo Zoom To 9 Select Magnification Level for Active Document 2 2 2 2 2 lt ltem gt Defines item template for each named Ul command representation Contained Objects Name Type Description ID Integer Defines special unique identifier of the command R Name String Defines special unique name of the command R Can be empty Title String Contains current Ul title of the command R Tooltip String Contains current Ul tooltip of the command R State String Determines the state of the command For RWS supported values see Command States AdobeName String Defines special unique Adobe name of the R command Can be empty Shortcut Group Controls keyboard shortcut accelerator for the RWS command ShortcutText String Returns the shortcut string for displaying in Ul such R as Ctrl O Ctrl Alt S Ctrl P See Also Objects Commands 2 2 2 2 2 1 Shortcut Control
205. ies area commenting preferences Specifies arrow commenting preferences Specifies callout commenting preferences Specifies cloudy commenting preferences Specifies distance commenting preferences Specifies file attachment commenting preferences Specifies highlight commenting preferences Specifies line commenting preferences Specifies link commenting preferences Specifies oval commenting preferences Reference 9 Pencil Group Specifies pencil commenting preferences RWS Perimeter Group Specifies perimeter commenting preferences RWS Polygon Group Specifies polygon commenting preferences RWS Polyline Group Specifies polyline commenting preferences RWS Rect Group Specifies rectangle commenting preferences RWS Stamp Group Specifies stamp commenting preferences RWS StickyNote Group Specifies stickynote commenting preferences RWS StrikeOut Group Specifies strikeout commenting preferences RWS TextBox Group Specifies textbox commenting preferences RWS Typewriter Group Specifies typewriter commenting preferences RWS Underline Group Specifies underline commenting preferences RWS CopySelTextToDrawingPopup Integer Specifies to copy encircled text into Drawing String comment popups automatically RWS For possible named values see the Booleans Default value is 0 false Copy SelTextToHilight Popup Integer Specifies to copy selected text into Highlight String Cross Out and Und
206. ifies border for the comment Specifies default subject text for comment This value will be used only if DefSubjMode is set to Custom Specifies mode for default subject For possible named values see the Subject Modes Default value is 0 Default Reference 113 IPDFXCview DoVerb IPDFXCview GetProperty IPDFXCview SetProperty 2 2 2 3 9 Link Accesses the properties of the commenting Contained Objects Styles Array Defines item style representation RWS See Also Objects Commenting 2 2 2 3 9 1 Styles This object represents array of all comments styles and provides additional operations with them Item Template lt ltem gt defines item template for each style representation Contained Objects Count Integer Contains number of all accessible styles R Remarks This object is an array of items where each item is represented as lt ltem gt For more information about object naming notation see Object Name Notation Examples for usage in pseudocode Enumerate all styles for link comment GetProperty Commenting Link Styles Count DataOut 0 Count Data0ut for i 0 to Count 1 GetProperty Commenting Link Styles i ID DataOut 0 See Also Objects Commenting IPDFXCview DoVerb IPDFXCview GetProperty IPDFXCview SetProperty Defines item template for each commenting link style Contained Objects PDF XChange Viewer ActiveX SDK ID Integer Specifies th
207. ightens the backdrop color to reflect the source color Painting with black produces no changes ColorBurn 7 Darkens the backdrop color to reflect the source color Painting with white produces no change HardLight Multiplies or screens the colors depending on the source 8 color value The effect is similar to shining a harsh spotlight on the backdrop SoftLight Darkens or lightens the colors depending on the source color 9 value The effect is similar to shining a diffused spotlight on the backdrop Difference Subtracts the darker of the two constituent colors from the 10 lighter color Painting with white inverts the backdrop color painting with black produces no change Exclusion Produces an effect similar to that of the Difference mode but 11 lower in contrast Painting with white inverts the backdrop color painting with black produces no change Hue 12 Creates a color with the hue of the source color and the saturation and luminosity of the backdrop color Saturation Creates a color with the saturation of the source color and the hue and luminosity of the backdrop color Painting with this 13 mode in an area of the backdrop that is a pure gray no saturation produces no change Color Creates a color with the hue and saturation of the source color and the luminosity of the backdrop color This preserves the 14 gray levels of the backdrop and is useful for coloring monochrome images or tinting color images Luminosity Creates a col
208. ile Created Date is lt Date gt Time is lt Time gt For example in pseudocode set special macros list to generate unique image files during export process for document C Test pdf SetProperty Export Image FileName Dataln lt File Name gt _ lt Date gt _ lt Auto Number gt 0 newly created files for example C XTest_09 17 2007_01 3pg C Test_09 17 2007_02 4pg C Test_09 17 2007_03 4pg See Also Objects Export Image 2 2 3 36 New Paragraph Modes Supported Values Auto Auto detect paragraphs One2NP 1 Each newline character starts a new paragraph 260 PDF XChange Viewer ActiveX SDK Double2NP 2 Double newline character starts a new paragraph singles ignored Double2NPOne2Spac 3 Double newline character starts a new paragraph single e converted to space See Also Objects Operations NewDocument FromText 2 2 3 37Pages Layouts Supported Values Automatic Specifies the selection of page layout automatically Auto l Continuous Specifies the displaying of one page at a time in continuous 1 mode when scrolling down shows the beginning of the next page under the end of the current Continuous Facing 7 Specifies the displaying of pages by two in continuous mode Continuous Facing Facing 6 Specifies the displaying of two pages at a time SinglePage Specifies the displaying of just one page at a time Single 0 See Also Objects PageDisplay DefaultLayout Objects Docum
209. in Panes Mouse Notifications Filter Flags Name Generation Macros New Paragraph Modes Pages Layouts Pages Magnifications Paper Modes Paper Orientation PDF Specification Versions Print Notifications Filter Flags Print Scale Types Print Specials Print Text as Curves Range Filters Range Types Registry Roots Rotation Direction Search Modes Selection Notifications Filter Flags Shortcut Key Types Shortcut Modifiers Sticky Note Icon Types Summarize Annotations Group Types Summarize Annotations Output Types Summarize Annotations PDF Layouts Text Align 246 PDF XChange Viewer ActiveX SDK e Text Editor Notifications Filter Flags e Text File Placing Modes e Text Rendering Mode e Tools e User Choices e User Interface Languages 2 2 3 1 Blend Modes Supported Values String Integer Description Value Value Normal 0 Selects the source color ignoring the backdrop Multiply 1 Multiplies the backdrop and source color values Screen 2 Multiplies the complements of the backdrop and source color values Overlay Multiplies or screens the colors depending on the backdrop color value Source colors overlay the backdrop while 3 preserving its highlights and shadows The backdrop color is not replaced but is mixed with the source color to reflect the lightness or darkness of the backdrop Darken 4 Selects the darker of the backdrop and source colors Lighten 5 Selects the lighter of the backdrop and source colors ColorDodge 6 Br
210. in pseudocode 1 get Search pane visibility GetProperty View Panes Search Visible DataOut 0 or GetProperty View Panes 32982 Visible DataOut 0 2 show Search pane SetProperty View Panes Search Visible Dataln 1 0 If ers SetProperty View Panes 32982 Visible Dataln 1 0 See Also Objects View 2 2 3 34Mouse Notifications Filter Flags Supported Values None 0 All 1 Move 4 Down 2 Up 4 Wheel 8 See Also Objects Notifications Mouse Reference 259 2 2 3 35Name Generation Macros Supported Macros Document Title Specifies Ul title of the current document Page Number Specifies index 1 based of the current page PAGE The same as Page Number macro PAGES Specifies pages number of the current document File Name Specifies file title of the current document Date Specifies current date in format MM DD YYYY Year Specifies current year Month Specifies current month Day Specifies current day of month Time Specifies current time in format HH MM SS Hour Specifies current hour Minute Specifies current minute Second Specifies current second Auto Number Specifies inserting of a special numerical string to guarantee a unique result name Remarks In string expression each macros should be bracketed by lt and gt symbols Some examples lt Document Title gt _ lt PAGE gt _of_ lt PAGES gt lt File Name gt lt Date gt lt Auto Number gt MyF
211. inal dialog displaying For example in pseudocode caption and all text labels for some prompts will be changed function OnEvent Type Name Dataln DataOut Flags if Type PXCVA_OnDisplayPrompt if Name Prompts CreateFolderError OR Name Prompts ConfirmFileReplace OR Name Prompts ConfirmDocumentSave OR Name Prompts ConfirmDocumentIncSave OR Name Prompts FileWriteError OR Name Prompts EnterDocumentPassword modify dialog caption SetProperty Name UI Title DataIn Sample Title 0 get count of text labels GetProperty Name UI Labels Count DataOut 0 Count DataOut modify text of all labels for i 0 to Count 1 SetProperty Name Ul Labels i Text DataIn Sample Text 0 Reference 23 See Also Objects Prompts IPDFXCviewE vents OnEvent PXCVA EventTypes PXCVA OnDisplayPrompt 2 2 2 19 6 1 Labels This is a special object for the customization of prompts confirmations and messages It allows changing captions text labels See also Objects Prompts Item Template lt ltem gt defines item template for each text label representation Contained Objects Count Integer Contains the number of all text labels R See Also Objects Prompts Defines the item template for each text label representation Contained Objects Integer Defines a special unique identifier of text label R Text String Contains tex
212. ing For possible values see the Range Filters RW Default value is 1 all pages RangeText String Specifies the exact pages for deletion The string 196 PDF XChange Viewer ActiveX SDK See Also RW should contain the page numbers and or page ranges separated by commas counting from the start of the document For example 1 3 5 12 IPDFXCview DoVerb IPDFXCview GetProperty IPDFXCview SetProperty Operations DeleteDocumentPages Objects Documents lt ltem gt DeletePages 2 2 2 11 2 ExtractPages Allows to specify settings for extracting pages from PDF document Contained Objects Name RangeType RangeFilter RangeText ExtractToFiles ToOneFile DestFolder DestFileName DeleteAfterExtract See Also Type Integer String RW Integer String RW String RW Integer String RWS Integer String RWS String RWS String RWS Integer String RWS Description Defines the type of page range for extraction For possible values see the Range Types Supports only All Selected Current and Exact values Default value is 1 all pages Specifies an additional filter for the page range For possible values see the Range Filters Default value is 1 all pages Specifies the exact pages for extraction The string should contain the page numbers and or page ranges separated by commas counting from the start of the document For example 1 3 5 12
213. ing message by Viewer RW For possible named values see the Booleans Default value is 0 false Remarks Example for usage in pseudocode 1 enable receiving all keyboard events SetProperty Notifications Keyboard Filter Al1 0 2 ignore Enter pressed event function OnEvent Type Name Dataln DataOut Flags if Type PXCVA_OnNamedNotify and Name Notifications Keyboard then Reference n Get keyboard event message GetProperty Notifications Keyboard Code vDataOut 0 if vData0ut 13 then Ignore this message SetProperty Notifications Keyboard Skip true 0 2 2 2 10 8 Mouse Allows to get information about mouse events Contained Objects Name Type Description Filter Integer Specifies filter for receiving mouse events For String possible named values see the Mouse Notifications RWS Filter Flags You may use a combination of one or more of the following values Default value is 0 None Xx Integer Retrieves x position of the cursor in screen R coordinates y Integer Retrieves y position of the cursor in screen R coordinates Msg Integer Retrieves mouse event message R TargetName String Retrieves Ul component name under mouse cursor R Skip Integer Allows to deny processing current mouse message String by Viewer RW For possible named values see the Booleans Default value is 0 false WheelDelta Integer If mouse wheel was rotated then thi
214. inks Editor Toolbar Measuring Toolbar Show Hide Measuring Toolbar Menu Bar Show Hide Menu Bar Navigation Tabs Show Hide Navigation Tabs 96 PDF XChange Viewer ActiveX SDK TogglePagesLayou 3326 tBar 4 TogglePagesNaviga 3326 tionBar 3 TogglePropertiesBa 3322 r 5 ToggleRotateViewB 3292 ar 9 ToggleStandardBar 3292 4 ToggleStatusBar 5939 3 ToggleTextFormatti 3338 ngBar 2 ToggleThumbnailsP 3291 ane 2 ToggleXFAPane 3301 0 ToggleZoomBar 3292 5 ToolProperties 3311 6 TypewriterTool 3322 6 UnderlineSelText 3320 8 UnderlineTextTool 3322 2 Undo 5764 3 ValidateAllSignatur 3651 es 8 Zoom100 3306 2 Zoom1200 3305 Y Zoom150 3306 1 Zoom1600 3626 0 Zoom200 3306 0 Zoom2400 3305 6 Zoom25 3306 5 Zoom3200 3305 5 Zoom400 3305 ShowHideToolbarPageDis play ShowHideToolbarNavigatio n Property Toolbar ShowHideToolbarRotateVi ew ShowHideThumbnails ShowHideXFA Annots Tool FreeTextTypewriterMenult em Annots Tool UnderlineMenultem Undo DIGSIG ValidateAll Pages Layout Toolbar Show Hide Pages Layout Toolbar Pages Navigation Toolbar Show Hide Pages Navigation Toolbar Properties Toolbar Show Hide Properties Toolbar Rotate View Toolbar Show Hide Rotate View Toolbar Standard Toolbar Show Hide Standard Toolbar Status Bar ShowWHide Status Bar Show Hide Text Formatting Toolbar Pages Thumbnails Show Hide Pages Thumbnails Pane XFA Structure ShowHide XFA Pane Zoom Toolbar ShowH
215. interface of our Simple ActiveX control Microsoft ActiveX control This interface is derived directly from IDispatch e Methods e Properties Interface Identificator GUID IID_IPDFXCpreview C7BCFEOA B521 4181 A722 904DBF9427D8 Requirements OS Versions Windows 2000 and later TypeLib PDFXCviewAx tlb Reference 285 2 5 1 1 Methods Methods Print Prints the opened document See Also IPDFXCview PrintDocument 2 5 1 1 1 Print Prints the opened document Syntax HRESULT Print VARIANT_BOOL fSilent Parameters fSilent in VARIANT_BOOL that specifies special flag for print without displaying of Ul dialog Return Value Returns S_OK if successful or an error value otherwise To obtain the text description of a received error code use GetTextFromResult See Also IPDFXCview PrintDocument 2 5 1 2 Properties Properties AllowAccelerators Allows or denies all control s accelerators LockedView Allows or denies all Ul customization ReadOnly Allows or denies all modification operations for all documents SettingsURL Sets or gets the URL to the settings file for control customizing Src Sets gets the source URL of the document for open See Also IPDFXCview2 2 5 1 2 1 AllowAccelerators Allows or denies all control s accelerators Syntax HRESULT get_AllowAccelerators VARIANT_BOOL ValueOut HRESULT put_AllowAccelerators VARIANT_BOOL Valueln
216. iption Contains number of all accessible styles This object is an array of items where each item is represented as lt ltem gt For more information about object naming notation see Object Name Notation Examples for usage in pseudocode Enumerate all styles for rect comment GetProperty Commenting Rect Styles Count DataOut 0 Reference 123 Count DataOut for i 0 to Count 1 GetProperty Commenting Rect Styles i ID DataOut 0 See Also Objects Commenting IPDFXCview DoVerb IPDFXCview GetProperty IPDFXCview SetProperty Defines item template for each commenting rectangle style Contained Objects Name Type Description ID Integer Specifies the unique ID of the comment style RS Name String Defines name of comment style RWS FColor Integer Specifies fill color for the comment String For possible named values see the Colors RWS Default value is 1 none SColor Integer Specifies stroke color for the comment String For possible named values see the Colors RWS Default value is RGB 255 0 0 red Opacity Double Specifies the opacity of the comment RWS Default value is 1 0 100 opacity BlendMode Integer Specifies the blend mode for the comment String For possible named values see the Blend RWS Modes Default value is 0 Normal Border Group Specifies border for the comment RWS DefSubj String Specifies default subject text for comment
217. ique identifier of the document or full file name of the document BSTR Return Value Returns S_OK on success or an error value otherwise To obtain the text description of a received error code use IPDFXCview GetTextFromResult See Also IPDFXCview DoVerb Objects Operations ExtractPages Objects Documents lt ltem gt ExtractPages 2 2 1 14FlushDocument Flushes all of the user s cached changes for a document stops editing and updates document s structure Can be used before saving of the document Name FlushDocument Arguments Nothing s PDF XChange Viewer ActiveX SDK Return Value Returns S_OK on success or an error value otherwise To obtain the text description of a received error code use IPDFXCview GetTextFromResult See Also IPDFXCview DoVerb IPDFXCview FlushDocument 2 2 1 15GetActiveDocument Returns the unique identifier of the active document Name GetActiveDocument Arguments Nothing Return Value Returns S_OK on success or an error value otherwise To obtain the text description of a received error code use IPDFXCview GetTextFromResult If successful then returns the unique identifier of the active document in DataOut See Also IPDFXCview DoVerb IPDFXCview GetActiveDocument 2 2 1 16GetDocumentFromName Obtains unique identifier of document Name GetDocumentFromName Arguments Req Type Description 1 Yes BSTR Specifies the name of document object For more
218. ith the PXCVA_EventTypes PXCVA_OnDisplayPrompt constants and the name with the Prompts ConfirmFileReplace string Contained Objects Name Type Description FileName String Represents full file name RW UserChoice Integer User s choice for this case String Initial value is O default processing RW Supported named values for this prompt Default Yes YesToAll No NoToAII Cancel Automatic SaveAs See also User Choices Ul Group Special object for Ul customizing RW Remarks If you want to skip the original dialog you must pass a new non zero value to the UserChoice property You may also change the destination file name at run time For example in pseudocode function OnEvent Type Name Dataln DataOut Flags if Type PXCVA_OnDisplayPrompt if Name Prompts ConfirmFileReplace set another file name SetProperty Prompts ConfirmFileReplace FileName DataIn C Test2 pdf 0 skip original dialog and try to save document into C Test2 pdf SetProperty Prompts ConfirmFileReplace UserChoice DataIn Yes 0 See Also IPDFXCviewEvents OnEvent PXCVA_EventTypes PXCVA_OnDisplayPrompt IPDFXCview GetProperty IPDFXCview SetProperty 217 28 PDF XChange Viewer ActiveX SDK 2 2 2 15 5 ConfirmLaunchFile This is a special object for modifying the confirmation dialog when detected click on file link in PDF docume
219. itself None 0 Invert 1 Outline 2 Push 3 See Also Objects Commenting 2 2 3 32Main Bars Supported Main Bars Identifiers No highlighting Invert the contents of the link rectangle Invert the link s border Displays the link s down appearance Menu 33009 Tab 32940 Status 59393 File 32908 RotateView 32929 Standard 32924 Zoom 32925 Find 33000 on mentAndMark 33138 Promoting 32913 Properties 33225 Links 36342 Measuring 36345 Remarks Specifies the main Menu bar Specifies the documents navigation Tab bar Specifies the main Status bar Specifies the File toolbar Specifies the Rotate View toolbar Specifies the Standard toolbar Specifies the Zoom pages magnification toolbar Specifies the Find toolbar Specifies the Comment And Markup toolbar Specifies the Promotion bar Specifies the Properties toolbar Specifies the Links toolbar Specifies the Measuring toolbar Examples for usage in pseudocode 1 get File toolbar visibility GetProperty View Bars File Visible DataOut 0 257 258 PDF XChange Viewer ActiveX SDK or GetProperty View Bars 32908 Visible DataOut 0 2 show File toolbar SetProperty View Bars File Visible Dataln 1 0 or SetProperty View Bars 32982 Visible Dataln 1 0 See Also Objects View 2 2 3 3 Main Panes Supported Main Panes Identifiers Search 32982 Specifies the full Search pane Remarks Examples for usage
220. l Group This tool allows you to draw ovals and circles on RWS the currently displayed PDF document page Pencil Group This tool allows to draw a freehand shape on the RWS document Perimeter Group This tool allows to measure a set of distances 226 PDF XChange Viewer ActiveX SDK RWS between multiple points Polygon Group This tool draws a polygon outline around selected RWS parts of the PDF page PolyLine Group This tool is an extension of the basic Line Tool RWS that allows you to draw multiple connected line segments Rect Group This tool allows to draw a rectangle on the RWS current displayed PDF document page Snapshot Group This tool permits copying a rectangular area of a RWS PDF page or the entire visible page area to the clipboard as a Bitmap Stamp Group This tool allows to apply standard stamps to the RWS currently displayed PDF document page StickyNote Group This tool allows to add sticky note in any place of RWS PDF document StrikeOut Group This tool permits to strike out selected text RWS TextBox Group This tool allows to add text on a page in a text RWS box TypeWriter Group This tool allows to enter text comments into PDF RWS page Underline Group This tool permits to underline selected text RWS Remarks Examples for usage in pseudocode 1 set line as active tool SetPropert yin roois Active Line 2 change fill color for current style of line tool CetProperty ivec
221. l be placed into temporary file at first after opening stream object will be released immediately Change this property before opening any of the documents RestoreLastPageDisp Integer String Specifies restoring latest page display settings RWS pages zoom pages layout view position from corresponding recent item when opening For possible named values see the Booleans Default value is 1 RestoreLastView Integer String Specifies restoring latest document s view panes RWS layout visibility from corresponding recent item when opening For possible named values see the Booleans Default value is 0 SaveMethod Integer String Specifies the method which will be used for saving RWS any documents by default For possible named values see the Document Save Methods Default value is O full save or incremental save for digitally signed documents SaveAsDestType Integer String Specifies what default folder will be used in Save RWS As dialog For possible named values see the Document SaveAs Destination Types Default value is 0 Open last used directory SaveAsDestLast Integer String Contain path to directory of last saved document 134 PDF XChange Viewer ActiveX SDK RS SaveAsDestCustom Integer String Specifies custom default directory for Save As RWS dialog Works only when Save AsDestType is set to Custom AllowSaveCustomProducer Integer String Allows to save custom Producer name into a RWS docume
222. le named values see the Booleans Default value is 1 This tool allows to add file attachment in any place of PDF document Contained Objects Style Integer Defines ID of current commenting style for this Reference 229 RWS tool See also Objects Commenting FileAttachment Styles KeepSelected Integer Defines if this tool still be selected after its String usage RWS For possible named values see the Booleans Default value is 1 See Also Objects Tools Objects Commenting 2 2 2 17 8 Highlight The highlight tool permits to highlight text within the PDF document and works like the select tool Contained Objects Name Type Description Style Integer Defines ID of current commenting style for this RWS tool See also Objects Commenting Highlight Styles KeepSelected Integer Defines if this tool still be selected after its String usage RWS For possible named values see the Booleans Default value is 1 See Also Objects Tools Objects Commenting 2 2 2 17 9 Line This tool allows to draw a line on the current displayed PDF document page Contained Objects Name Type Description Style Integer Defines ID of current commenting style for this RWS tool See also Objects Commenting Line Styles KeepSelected Integer Defines if this tool still be selected after its String usage RWS For possible named values see the Booleans Default value is 1 See Also Objects Tools Objects Co
223. lors Background color for window elements For possible named values see the Colors Next properties controls overriding colors of some Ul elements AppWorkspace PagesBack Remarks Integer String RWS Integer String RWS Color for the application workspace Can be seen when no opened document in control or in MDI mode For possible named values see the Colors Background color of the document s pages view For possible named values see the Colors If color value is set to 1 then it means that default system color for specified Ul element will be taken Example for usage in pseudocode SetProperty View Colors PagesBack RGB 0 0 255 0 GetProperty View Colors Face DataOut 0 See Also Objects View 237 238 PDF XChange Viewer ActiveX SDK 2 2 2 19 Multiply Referred Objects These objects are multiply referred from other instances Objects Bars Array Represents an array of Ul bars For example see Objects View Border Group Represents border structure for comment For example Objects Commenting Panes Array Represents an array of Ul panes For example see Objects View RectangleF Group Represents a rectangle structure For example Objects Documents lt ltem gt Pages lt ltem gt Text Format Group Represents text format structure for comment For example Objects Commenting Ul Group Special object for Ul customization For example see O
224. ls SDK Version 4 max distribution included 2500 Single user Licenses PDF XChange Viewer SDK extended License packs CDLP s are available for a variety of volume requirements and on a Royalty Free basis please see our web site or contact sales tracker software com for more detailed information e PDF XChange Viewer ActiveX SDK No duplication or distribution rights are granted hereunder with respect to the Royalty Bearing Versions to enable live use and distribution of your application s using this software until Tracker have received from you a copy of this agreement with each page initialled and the last page signed acknowledging your understanding and acceptance of all the terms of this agreement only then will you receive your license unlock codes enabling use other than for evaluation purposes Licensee agrees to account on request by TRACKER for all applications sold or distributed by Licensee or its subsidiaries incorporating the software since its first inclusion in the products of the Licensee within 28 days of such request having been received from Tracker to the Licensee s contact information as provided either by post or email In the event the licensee does not respond has exceeded the limits detailed within this agreement or any dispute regarding license volumes amp payment Tracker Software Products Ltd may appoint a qualified Auditor to authenticate the records of the Licensee to establish the validity and the
225. ls dane Bie DataOut StyleID DataOut SetProperty Commenting Line Styles StyleID FColor blue See Also IPDFXCview DoVerb IPDFXCview GetProperty IPDFXCview SetProperty Objects Commenting 2 2 2 17 1 Area Area tool allows to measure the area within the line segments Contained Objects Name Type Description Style Integer Defines ID of current commenting style for this RWS tool See also Objects Commenting Area Styles KeepSelected Integer Defines if this tool still be selected after its Reference String usage RWS For possible named values see the Booleans Default value is 1 See Also Objects Tools Objects Commenting 2 2 2 17 2 Arrow This tool allows to draw a arrow on the current displayed PDF document page Contained Objects Style Integer Defines ID of current commenting style for this RWS tool See also Objects Commenting Arrow Styles KeepSelected Integer Defines if this tool still be selected after its String usage RWS For possible named values see the Booleans Default value is 1 See Also Objects Tools Objects Commenting 2 2 2 17 3 Callout The Callout tool allows to add a text box with an arrow pointing to a selected location on the page Contained Objects Style Integer Defines ID of current commenting style for this RWS tool See also Objects Commenting Callout Styles KeepSelected Integer Defines if this tool still be selec
226. lso to the Pages ScreenX Pages ScreenY 4 Yes LONG Specifies y coordinate of screen point relative to desktop Return Value Returns S_OK on success or an error value otherwise To obtain the text description of a received error code use IPDFXCview GetTextFromResult Remarks For example in pseudocode DoVerb Documents 0 pages 2 MovePointToScreenPoint DataIn px py sx sy NULL 0 See Also IPDFXCview DoVerb Objects Documents lt ltem gt Translates the coordinates of points from page coordinate system to the pages view coordinate system Name PagePointsToViewPoints Arguments Coordinates of input points are stored in an array of doubles where each pair specifies the X and Y coordinates of one point Also you can specify one last additional nonzero value to notify function that input coordinates already include the page view transformations crop offset page rotation Return Value Returns S_OK on success or an error value otherwise To obtain the text description of a received error code use IPDFXCview GetTextFromResult The DataOut receives SAFEARRAY which contain x and y coordinates of the translated input points all output points are relative to the top left corner of the pages view window Reference Remarks For example in pseudocode pl x 0 0 pt 1 72 inch pl y 0 0 p2 x 100 0 p2 y 200 0 DoVerb Documents 0 pages 2 PagePointsToViewPoints DataIn
227. lues see the Blend Modes Default value is 0 Normal Specifies border for the comment Specifies default subject text for comment This value will be used only if DefSubjMode is setto Custom Specifies mode for default subject For possible named values see the Subject Modes Default value is 0 Default IPDFXCview DoVerb IPDFXCview GetProperty IPDFXCview SetProperty 2 2 2 3 5 Distance Accesses the properties of the commenting Contained Objects Name Type Styles Array RWS See Also Objects Commenting 2 2 2 3 5 1 Styles Description Defines item style representation This object represents array of all comments styles and provides additional operations with them Item Template lt ltem gt defines item template for each style representation Contained Objects Name Type Count Integer R Remarks Description Contains number of all accessible styles This object is an array of items where each item is represented as lt ltem gt For more information about object naming notation see Object Name Notation Reference Examples for usage in pseudocode Enumerate all styles for distance comment GetProperty Commenting Distance Styles Count DataOut 0 Count DataOut for i 0 to Count 1 GetProperty Commenting Distance Styles i ID DataOut See Also Objects Commenting IPDFXCview DoVerb IPDF XCview GetProperty IPDFXCview SetProperty D
228. mResult See Also PXCVA Flags PXCVA NoApply IPDFXCview ApplyAllCachedChanges Operations DiscardAllCachedChanges 2 1 1 1 3 DoVerb DoVerb is the main method in the library Other existing methods act as shortcuts to some specific functionality of this method Syntax HRESULT DoVerb BSTR ObjectName BSTR OperationName VARIANT Dataln VARIANT DataOut LONG Flags Parameters ObjectName in BSTR that specifies the object name as string identifier For more information see Named Objects This argument can be NULL OperationName in BSTR that specifies the necessary command action for object specified by ObjectName For more information see Named Operations This argument can be NULL if ObjectName is not NULL Dataln in VARIANT that specifies the necessary input data depending on the object specified by ObjectName and operation specified by OperationName This argument may be empty DataOut out Pointer to a VARIANT structure that receives output data depending on the object specified by ObjectName and operation specified by operat ionName This argument can be NULL Flags in LONG that specifies optional flags For more information see PXCVA_Flags This argument can be 0 Return Value 16 PDF XChange Viewer ActiveX SDK Returns S_OK if successful or an error value otherwise To obtain the text description of received error code you can use GetTextFromResult Remarks If you want to pass more
229. mands Remarks This object is an array of items each item is represented by lt ltem gt For more information about object names notation see Object Name Notation Example for usage in pseudocode for enumerate and turn off of all commands get commands count GetProperty Commands Count DataOut 0 Count DataOut for i 0 to Count 1 GetProperty Commands i ID DataOut 0 re GetProperty Commands i Name DataOut 0 Tf ices turn off of command SetProperty Commands i State Dataln Offline 0 See Also IPDFXCview DoVerb IPDFXCview GetProperty IPDFXCview SetProperty Operations ExecuteCommand Command List 2 2 2 2 1 Command List This is a list of the Ul items Ul commands or other toolbar menu items current as of 14 January 2010 e Name is the unique name of the command e ID is the corresponding unique ID e Adobe Name is the corresponding Adobe name of the command Reference 3294 Export 4 3326 Form Data 9 3641 Exit 7 3328 Edit 0 3641 About 6 3329 Toolbars y 3329 View 0 3641 Show 5 3653 Delete 6 Delete Selected Attachments 3329 Other Panes 2 3651 Show Tabs Thumbnails 9 3329 Page Layout 3 3307 Rotate View 5 3288 Go To 4 3330 Document 0 3634 Comments 9 3643 Show Comments 4 3649 Override Document Colors 8 Toggle Override Document Colors option
230. ment Operations OpenDocument 2 13 _IPDFXCviewEvents This interface designates an event sink interface that an application must implement in order to receive event notifications from a control Method Description OnEvent Fires when property of object is changed notifies about some prompts actions Interface Identificator GUID DIID__IPDFXCviewEvents C5EA83BB 986F 4F32 AD38 E47C3970A357 See Also PXCVA EventTypes IPDFXCview GetViewObjectFromName IPDFXCview GetDocumentFromName Named Objects Objects Prompts Objects Notifications 2 1 3 1 OnEvent Fires when a control property is changed or notifies for some prompts and other object changes Syntax HRESULT OnEvent LONG Type BSTR Name VARIANT Dataln VARIANT DataOut LONG Flags y Parameters Type 3 PDF XChange Viewer ActiveX SDK in LONG that specifies the event type For more information see PXCVA_EventTypes Name in BSTR that specifies the unique event name Usually it contains full name of object initiator or other special name of the event dependent on Type See also Named Objects Objects Notifications Dataln in VARIANT that specifies the necessary input data dependent with Type and Name arguments This argument may be empty DataOut out Pointer to a VARIANT structure that receives output data dependent with Type and Name arguments This argument can be NULL Flags in LONG that specifie
231. meters DataInOut in out Pointer to a VARIANT that specifies a valid storage destination Return Value Returns S_OK if successful or an error value otherwise To obtain the text description of a received error code use GetTextFromResult See Also IPDFXCview LoadSettings Operations SaveSettings 2 1 1 1 9 SetDevinfo SetDevinfo allows you to enter PDF XChange ActiveX license information for the evaluation limitations to be removed Without this information wherever the document is visible a demo label will appear If you print export save the document the result will also contain the Tracker Software PDF XChange demo label until your application is recompiled with the License Key your serial number and the Developer s Code Your Devcode embedded appropriately in your project code Please note these License strings are unique to the PDF XChange Viewer SDK and are not common to any other License strings provided for our PDF XChange Drivers API PDF Tools SDK or PDF XChange PRO SDK This is because in most instances the Viewer SDK is not a Royalty FREE tool and requires you to read complete and return your license to Tracker Software Products prior to Your License strings being provided For more information on licensing see this page _see this page and or Contact us Syntax HRESULT SetDevInfo BSTR Key BSTR Code Parameters Key in BSTR that specifies the private developer s string key The templ
232. mmenting 2 2 2 17 10 Link Link tool allows to create a link in order to jump to other locations in the same document or websites Contained Objects 230 PDF XChange Viewer ActiveX SDK Style Integer Defines ID of current commenting style for this RWS tool See also Objects Commenting Link Styles KeepSelected Integer Defines if this tool still be selected after its String usage RWS For possible named values see the Booleans Default value is 1 See Also Objects Tools Objects Commenting 2 2 2 17 11 Loupe This tool opens a special dialog window that is linked to a scrollable resizable rectangular are that acts as a cursor and permits the selection of a portion of the PDF page file Contained Objects ZoomLevel Double Defines zoom level RS Default value is 200 percent See Also Objects Tools 2 2 2 17 12 Oval The Oval Circle tool allows you to draw ovals and circles on the currently displayed PDF document page Contained Objects Style Integer Defines ID of current commenting style for this RWS tool See also Objects Commenting Oval Styles KeepSelected Integer Defines if this tool still be selected after its String usage RWS For possible named values see the Booleans Default value is 1 See Also Objects Tools Objects Commenting 2 2 2 17 13 Pencil The Pencil Tool allows to draw a freehand shape on the document Contained Objects Reference 231 Style Integer Defin
233. more pairs of numbers in a format the first number is an index 0 basea of the first character in the selection range the second number is count of the characters in the selection range These numbers will be obtained through SAFEARRAY Return Value Returns S_OK on success or an error value otherwise To obtain the text description of a received error code use IPDFXCview GetTextFromResult Remarks For example in pseudocode DoDocumentVerb docId Pages 0 Text GetSelectedRanges Dataln DataOu we have selection which contains two blocks int firstSelCharl Data0ut 0 int countSelCharsl DataOut 1 int firstSelChar2 DataOut 2 int countSelChars2 DataOut 3 For simplify in out operations with SAFEARRAY you can use the IPDFXCargs obtain a new IPDFXCargs object with array of numbers DoDocumentVerb docId Pages 0 Text GetSelectedRanges Dataln DataOut PXCVA_OutArgs IPDFXCargsObj args DataOut int firstSelCharl args 0 int countSelCharsl args 1 int firstSelChar2 args 2 int countSelChars2 args 3 See Also IPDFXCview DoVerb Objects Documents lt ltem gt Pages lt ltem gt Text Highlights all characters from the specified range on the page Name Highlight Arguments Reference 1 Yes LONG The index of the first character to highlight 2 Yes LONG The count of characters to highlight 3 No LONG The color COLORREF of the highlighted comment By default m
234. mplate lt ltem gt defines item template for each supported color settings profile representation Contained Objects Name Type Description Count Integer Contains number of all supported color settings R profiles Current String Contains the unique name of the current color RWS settings profile Can contain two standard values Off or Custom Off the default color settings which will be used from predefined read only item named as ColorManagement Off Custom the custom color settings which will be used from the predefined editable item named as ColorManagement Custom Engine Integer String RWS UseBPC Integer String RWS Remarks Reference Specifies the color management engine For possible named values see the Color Management Engines Default value is 0 Little CMS Specifies whether to use black point compensation For possible named values see the Booleans Default value is 0 Default value is Off This object is the array of items each item is represented by lt ltem gt For more information about object names notation see Object Name Notation Example for usage in pseudocode 1 get custom RGB working space DoVerb ColorManagement Custom RGB Dataln EJ Ori DataOut 0 GetProperty ColorManagement Custom RGB 2 set custom RGB working space DoVerb ColorManagement Custom RGB Dataln sRGB IEC61966 2 1 or get
235. ms stipulations or conditions not expressed in the Agreement All previous representations and agreements if any either verbal or written referring to the subject matter of this Agreement are void If any portion of this Agreement is determined to be legally invalid or unenforceable such portion will be severed from this Agreement and the remainder of the Agreement will continue to be fully enforceable and valid This Agreement and the rights hereunder may not be assigned by Licensee whether by oral or written assignment sale of assets merger consolidation or otherwise without the express written consent of TRACKER Licensee agrees to be responsible for any and all losses or damages arising out of or incurred in connection with the Application Software Licensee agrees to defend indemnify and hold TRACKER harmless from any such loss or damage including attorney s fees arising from the use operation or performance of the Application Software or Licensee s breach of any terms of this Agreement Licensee shall be responsible for paying all state and federal use sales or value added taxes duties or governmental charges whether presently in force or which come into force in the future related to the distribution and sale of the Application Software and will indemnify TRACKER against any claim made against TRACKER relating to any such taxes or assessments Copyright 2001 9 Tracker Software Products Canada Ltd 466 Trans Canada Highway
236. n BSTR that specifies the relative name of any sub object SubPointOut out Pointer to a IPDFXCsmartp interface that receives a new smart point object which depends on an object specified by SubName Return Value Returns S_OK if successful or an error value otherwise To obtain the text description of a received error code use GetTextFromResult See Also IPDFXCsmartp 2 1 5 1 8 SetProperty Sets value of specified sub property by relative name The syntax of this method is identical to main IPDFXCview SetProperty 2 1 5 2 Properties Properties Property Name Description as PDF XChange Viewer ActiveX SDK Property The common property accessor parameterized by relative name Sets Gets value of specified sub property by relative name See Also IPDFXCview IPDFXCargs 2 1 5 2 1 Property 2 2 2 2 1 The common property accessor parameterized by relative name Sets Gets value of specified sub property by relative name The syntax of this method is identical to main IPDFXCview Property Named Items In order to assist the developer in developing applications using our PDF XChange Viewer ActiveX shortcuts have been created for some operations objects and values collectively called Named Items This section consists of the following sections e Simple Operations e Objects e Values e Simple Notifications Simple Operations Some of our methods require a special named operation as input st
237. n see PXCVA Flags This argument can be 0 Return Value Returns S_OK if successful or an error value otherwise To obtain the text description of a received error code use GetTextFromResult Remarks Call for close the opened document specified by 1D If you want to deny all Ul prompts alerts confirm save changes dialog write error dialog etc when calling this method you must specify the PXCVA Flags PXCVA NoUl flag into Flags See Also IPDEXCview OpenDocument Operations CloseDocument Reference 23 2 1 1 2 4 DoDocumentVerb This method is the simplified version of the DoVerb method for working with open documents Syntax HRESULT DoDocumentVerb LONG ID BSTR ObjectName BSTR OperationName VARIANT Dataln VARIANT DataOut LONG Flags Y Parameters ID in LONG that specifies the unique identifier of the opened document This argument can be 0 for the active document ObjectName in BSTR that specifies the name of the specific object contained within or associated to the specified document as string identifier For more information see Objects Documents OperationName in BSTR that specifies the necessary command action for the document object specified by ObjectName For more information see Named Operations This argument can be NULL if objectName is not NULL Datain in VARIANT that specifies the necessary input data dependent on the object specified by ObjectName and operation specified b
238. n Value Returns S_OK if successful or an error value otherwise To obtain the text description of a received error code use GetTextFromResult See Also Objects General AllowAllAccelerators 2 1 2 1 2 LockedView Allows or denies all Ul customization Syntax HRESULT get_LockedView VARIANT_BOOL Valueout HRESULT put_LockedView VARIANT_BOOL Valueln Parameters Value0ut out Pointer to a VARIANT_BOOL that receives flag for view locking Valueln in BSTR that specifies flag for view locking Return Value Returns S_OK if successful or an error value otherwise To obtain the text description of a received error code use GetTextFromResult See Also Objects View Locked 2 1 2 1 3 ReadOnly Allows or denies all modification operations for all documents Syntax HRESULT get_ReadOnly VARIANT_BOOL value0ut HRESULT put_ReadOnly VARIANT_BOOL Valueln Parameters Value0ut out Pointer to a VARIANT_BOOL that receives read only flag Valueln in BSTR that specifies read only flag 36 PDF XChange Viewer ActiveX SDK Return Value Returns S_OK if successful or an error value otherwise To obtain the text description of a received error code use GetTextFromResult See Also Objects General DenyAllModifyOperations 2 1 2 1 4 SettingsURL Sets or gets the URL to the settings dat file with all stored settings for the control Simply specify the correct path lo
239. n array of items where each item is represented as lt ltem gt For more information about object naming notation see Object Name Notation Examples for usage in pseudocode Enumerate all styles for text box comment GetProperty Commenting TextBox Styles Count DataOut 0 Count DataOut Reference 120 for i 0 to Count 1 GetProperty Commenting TextBox Styles i ID DataOut 0 See Also Objects Commenting IPDFXCview DoVerb IPDFXCview GetProperty IPDFXCview SetProperty Defines item template for each commenting text box style Contained Objects Name Type Description ID Integer Specifies the unique ID of the comment style RS Name String Defines name of comment style RWS FColor Integer Specifies fill color for the comment String For possible named values see the Colors RWS Default value is RGB 255 255 255 white SColor Integer Specifies stroke color for the comment String For possible named values see the Colors RWS Default value is RGB 255 0 0 red Opacity Double Specifies the opacity of the comment RWS Default value is 1 0 100 opacity BlendMode Integer Specifies the blend mode for the comment String For possible named values see the Blend RWS Modes Default value is 0 Normal Border Group Specifies border for the comment RWS TextFormat Group Specifies text format for the comment RWS DefSubj String Specifies default subject text
240. nd try to open specified file SetProperty Prompts ConfirmLaunchFile UserChoice Dataln Yes 0 Reference 29 See Also IPDFXCviewE vents OnEvent PXCVA EventTypes PXCVA OnDisplayPrompt IPDFXCview GetProperty IPDFXCview SetProperty 2 2 2 15 6 ConfirmOpenSite This is a special object for modifying the confirmation dialog when detected click on hyperlink in PDF document You must implement a special event handler see _IPDFXCviewEvents OnEvent and match the type of the received event with the PXCVA_EventTypes PXCVA_OnDisplayPrompt constants and the name with the Prompts ConfirmOpenSite string Contained Objects Name Type Description Name String Represents URL Can be replaced by other URL on RW processing this event UserChoice Integer User s choice for this case String Initial value is O default processing RW Supported named values for this prompt Default Yes OK No Cancel See also User Choices KeepUserChoice Integer Keep current choice for this site If it means 1 then String user s choice will be saved into internal control s RW database For possible named values see the Booleans Remarks If you want to skip the original dialog you must pass a new non zero value to the UserChoice property You may also change the URL at run time For example in pseudocode function OnEvent Type Name Dataln DataOut Flags if Type
241. ndex IPDFXCvuew GetDocumentsCount Operations GetDocumentID 2 1 1 2 9 GetDocumentindex Returns the unique identifier of the opened document which is specified by order index This method is a simplified variant of a special call to the DoVerb method Syntax HRESULT GetDocument Index LONG ID LONG Index y Parameters ID in LONG that specifies the unique identifier of the opened document This argument can be 0 for the active document Index out Pointer to a LONG that receives order index document specified by 1D Return Value Returns S_OK if successful or an error value otherwise To obtain the text description of a received error code use GetTextFromResult See Also IPDFXCview GetDocumentID IPDFXCview GetDocumentsCount Operations GetDocumentIndex 2 1 1 2 10 GetDocumentProperty This method allows you to get property values for the specified document This method is a simplified variant of a special call to the DoVerb method Syntax HRESULT GetDocumentProperty LONG ID BSTR Name VARIANT DataOut LONG Flags Parameters Reference ID in LONG that specifies the unique identifier of the opened document This argument can be 0 for the active document Name in BSTR that specifies the full name of the document s property as string identifier For more information see Objects Documents DataOut out Pointer to a VARIANT structure that receives value of
242. ng StrikeOut Styles Defines if this tool still be selected after its usage For possible named values see the Booleans Default value is 1 Style Integer RWS KeepSelected Integer String RWS See Also Objects Tools Objects Commenting 2 2 2 17 23 TypeWriter Defines ID of current commenting style for this tool See also Objects Commenting TextBox Styles Defines if this tool still be selected after its usage For possible named values see the Booleans Default value is 1 The typewriter tool allows to enter text comments into PDF page Contained Objects Style Integer RWS KeepSelected Integer String RWS See Also Objects Tools Objects Commenting Defines ID of current commenting style for this tool See also Objects Commenting TypeWriter Styles Defines if this tool still be selected after its usage For possible named values see the Booleans Default value is 1 Reference 235 2 2 2 17 24 Underline The underline tool permits to underline selected text Contained Objects Name Type Description Style Integer Defines ID of current commenting style for this RWS tool See also Objects Commenting Underline Styles KeepSelected Integer Defines if this tool still be selected after its String usage RWS For possible named values see the Booleans Default value is 1 See Also Objects Tools Objects Commenting 2 2 2 18 View This is the object for controlling
243. nge Viewer ActiveX SDK Returns S_OK on success or an error value otherwise To obtain the text description of a received error code use IPDFXCview GetTextFromResult Remarks For example in pseudocode Close the first document DoVerb Documents 0 Close NULL NULL 0 See Also IPDFXCview DoVerb IPDFXCview CloseDocument Objects Documents lt ltem gt Removes all attachments from the document Name DeleteAllAttachments Arguments None Return Value Returns S_OK or an error value otherwise To obtain the text description of a received error code use IPDFXCview GetTextFromResult See Also IPDFXCview DoDocumentVerb Removes the attachment from the document Name DeleteAttachment Arguments Req Type Description 1 Yes LONG The zero based index of the attachment in the attachments list or name of BSTR the attachment Return Value Returns S_OK or an error value otherwise To obtain the text description of a received error code use IPDFXCview GetTextFromResult See Also IPDFXCview DoDocumentVerb Reference Kum Delete pages from PDF document using parameters previously defined by Objects Operations DeletePages Name DeletePages Arguments None Return Value Returns S_OK on success or an error value otherwise To obtain the text description of a received error code use IPDFXCview GetTextFromResult Remarks For example in pseudocode 1 Show delete pages di
244. ngle which is calculated as intersection of Media and Crop boxes with applying of Rotation and UserUnit values see Adobe s PDF Reference Reference 163 Rotation Integer Represents rotation angle of the page R MediaBox Group Represents the Media box of the page Has the R Objects RectangleF structure CropBox Group Represents the Crop box of the page Has the R Objects RectangleF structure Text Group R Contained Methods GetAnnotName Gets name of the annotation object specified by index GetAnnotRect Gets rectangle of the annotation object specified by index GetAnnots Count Gets count of annotations on the page GetAnnotType Gets type identifier of the annotation object MovePointToScreenPoint Moves the page point to the specified screen point PagePointsToViewPoints Translates the coordinates of points from page coordinate system to the pages view coordinate system TranslateScreenPoint Converts the screen coordinates in pixels of a specified point on the screen to document page coordinates in points ViewPointsToPagePoints Translates the coordinates of points from pages view coordinate system to the page coordinate system See Also IPDFXCview DoVerb Objects Documents lt ltem gt Pages See Objects Documents lt ltem gt Pages lt ltem gt Methods Gets name of the annotation object Name GetAnnotName Arguments 1 Yes LONG The zero based index of the annotation object on the page Ou
245. nt You must implement a special event handler see _IPDFXCviewEvents OnEvent and match the type of the received event with the PXCVA_EventTypes PXCVA_OnDisplayPrompt constants and the name with the Prompts ConfirmLaunchFile string Contained Objects Name Type Description FileName String Represents file name Can be replaced by other file RW name on processing this event UserChoice Integer User s choice for this case String Initial value is O default processing RW Supported named values for this prompt Default Yes OK No Cancel See also User Choices Action String Specifies the action to be performed Possible RW values is open or print DefDirectory String Specifies the default working directory for the RW action Parameters String Specifies the parameters to be passed to the RW application Remarks If you want to skip the original dialog you must pass a new non zero value to the UserChoice property You may also change the FileName at run time For example in pseudocode function OnEvent Type Name Dataln DataOut Flags if Type PXCVA_OnDisplayPrompt if Name Prompts ConfirmLaunchFile get current url GetProperty Prompts ConfirmLaunchFile FileName DataOut 0 if DataOut c my pdf set another FileName SetProperty Prompts ConfirmLaunchFile FileName DataIn c myNew pdf 0 skip original dialog a
246. nt into current document Returns the permission for operation with the document Prints document Rotates pages in document Saves document Selects all text in document Summarizes all comments from a document Gets identification info of the selected annotation Gets full name of the selected form field Gets identification info of the selected widget Selects an annotation on the page and sets input focus for it Selects an field widget on the page and sets input focus for it 137 138 PDF XChange Viewer ActiveX SDK GetAttachmentsCount Gets count of the document s attachments GetAttachmentName Gets name of the attachment GetAttachmentDesc Gets description of the attachment GetAttachmentSize Gets size of the attachment GetAttachmentModDate Gets the last modification date of the attachment SaveAttachment Saves document s attachment to a file or to an stream object DeleteAttachment Removes attachment from the document DeleteAllAttachments Removes all attachments from the document See Also IPDFXCview DoDocumentVerb Objects Documents 2 2 2 4 1 1 lt Methods gt See Objects Documents lt Item gt Methods Attaches a file to the document Name AddAttachment Arguments Req Type Description 1 Yes BSTR The source local file name URL or an stream object IStrea m 2 No BSTR Name of the new attachment will be displayed in the Attachments Pane 3 No BSTR Description of the new attachment will
247. nt when saving For possible named values see the Booleans Default value is 0 The default producer name will be saved like as PDF XChange DownloadFolder String The folder for all downloaded documents Used by RWS Open from URL feature Remarks This object is an array of items where each item is represented as lt ltem gt For more information about object naming notation see Object Name Notation Examples for usage in pseudocode 1 1 get documents count DoVerb Documents Count get DataIn DataOut 0 or GetProperty Documents Count DataOut 0 1 2 get unique ID of active document DoVerb Documents Active get Dataln DataOut 0 or GetProperty Documents Active DataOut 0 Ef or GetActiveDocument 1D 1 3 get document unique ID by order index 0 DoVerb Documents 0 ID get Dataln DataOut 0 or GetProperty Documents 0 ID DataOut 0 or GetDocumentID 0 ID 1 4 get document file name by unique ID 4095 DoVerb Documents 4095 FileName get Dataln DataOut 0 or GetProperty Documents 4095 FileName DataOut 0 or GetDocumentProperty 4095 FileName DataOut 0 1 5 get document file name by order index 0 DoVerb Documents 0 FileName get DataIn DataOut 0 or GetProperty Documents 0 FileName DataOut 0 1 6 get document title DoVerb Documents 4095 Title get Dataln Data
248. number of all opened documents Name GetDocumentsCount s PDF XChange Viewer ActiveX SDK Arguments Nothing Return Value Returns S_OK on success on success or an error value otherwise To obtain the text description of a received error code use IPDFXCview GetTextFromResult If successful then puts the number of all opened documents into the DataOut See Also IPDFXCview DoVerb IPDFXCview GetDocuments Count 2 2 1 20 GetTextFromResult Obtains the text description of returned error codes by other operations Name GetTextFromResult Arguments Req Type Description 1 Yes LONG Specifies the result code which is returned by other operations Return Value Returns S_OK on success or an error value otherwise If successful then DataOut contains the description text for the Result code See Also IPDFXCview DoVerb IPDFXCview GetTextFromResult 2 2 1 21 GetViewObjectFromName Obtains type identifier proper name of view object Name GetViewObjectFromName Arguments Req Type Description 1 Yes BSTR Specifies the name of view object For more information see Objects View Objects Documents lt ltem gt View Return Value Returns S_OK on success or an error value otherwise To obtain the text description of a received error code use IPDFXCview GetTextFromResult If successful DataOut contains 1 The type of detected view object For more information see PXCVA _ViewObjectTypes Reference
249. o use Can use custom sizes from PaperWidth and PaperHeight parameters or standard paper type specified by PaperName For possible named values see the Paper Modes Default value is 1 Standard The name of the standard type of paper Default value is A4 Specifies landscape paper orientation for new document For possible named values see the Booleans Reference Default value is 0 MarginLeft Double Specifies the page left margin in points RWS MarginTop Double Specifies the page top margin in points RWS MarginRight Double Specifies the page right margin in points RWS MarginBottom Double Specifies the page bottom margin in points RWS Specifies the layout of text on the each PDF page Contained Objects ColCount Integer Count columns on the page RWS Default value is 1 ColSpace Double Space between columns in points RWS Default value is 5 pt UseColSep Integer Enables column separator String For possible named values see the Booleans RWS Default value is 0 ColSep Group Defines column separator style RWS ColSepColor Integer Specifies column separator color String For possible named values see the Colors RWS Default value is RGB 0 0 0 black Defines column separator style Contained Objects Width Double Separator line thickness in points RWS Default value is 1 pt BType String Line type Supported values RWS S solid D dashed Default value is S
250. oVerb method Syntax HRESULT PrintDocument LONG ID LONG Flags Parameters Reference ID in LONG that specifies unique identifier of the opened document This argument can be 0 for the active document Flags in LONG that specifies optional flags For more information see PXCVA_Flags This argument can be 0 Return Value Returns S_OK if successful or an error value otherwise To obtain the text description of a received error code use GetTextFromResult Remarks Call for print the opened document specified by rp If you want to skip the print dialog then you must specify the PXCVA Flags PXCVA_ NoUI flag into Flags See Also IPDFXCview ExportDocument Objects Print Operations PrintDocument 2 1 1 2 14 SaveDocument Save the opened document This method is a simplified variant of a special call to the DoVerb method Syntax HRESULT SaveDocument LONG 1D BSTR DestFileName LONG SaveMode LONG Flags Parameters ID in LONG that identifies the opened document This argument can be 0 for the active document DestFileName in BSTR that specifies destination file name This argument can be NULL SaveMode in LONG that specifies special save flags of document For more information see PXCVA_DocumentSaveFlags This argument can be 0 Flags in LONG that specifies optional flags For more information see PXCVA Flags This argument can be 0 Return Val
251. ocuments 4095 View Panes Thumbnails Visible Dataln 1 0 or SetDocumentProperty 4095 View Panes Thumbnails Visible Dataln 1 0 See Also Object Name Notation Objects Documents Objects View 2 2 2 5 Export Contains all supported properties for exporting documents to an external image and text formats See also IPDFXCview ExportDocument Contained Objects Mode Integer Defines the document export mode String For possible values see the Export Modes RWS Default value is O export document pages to images Image Group Defines document exporting to image s options RWS 182 PDF XChange Viewer ActiveX SDK See Also IPDFXCview ExportDocument IPDFXCview DoVerb IPDFXCview GetProperty IPDFXCview SetProperty 2 2 2 5 1 Image Defines options for exporting document pages to images Contained Objects Name Type Mode RangeType RangeFilter RangeReverse RangeText Resolution Background FolderName FileName See Also Type Integer String RWS Integer String RWS Integer String RWS Integer String RWS Integer String RWS String RWS Integer RWS Integer String RWS String RWS String RWS Description Specifies the exported image type For possible values see the Image Types Default value is 0x424D5020 BMP Specifies how to combine pages into an image file For possible values see the Expo
252. of an array object R Reference 169 Words Group Represents info for words in an array object R Lines Group Represents info for text lines in an array object R Contained Methods Name Description AddLink Place link over text range on the page Get Gets text from a specified range on the page GetSelected Gets selected text on the page GetSelectedRanges Gets text selection ranges on the page GetQuads Gets text coordinates Highlight Highlights all characters from a specified range on the page Select Selects all characters from a specified range on the page StrikeOut Strikes out all characters from a specified range on the page Underline Underlines all characters from a specified range on the page See Also IPDFXCview DoVerb Objects Documents lt Item gt Pages lt Item gt How to Enumerate Characters in Document See Objects Documents lt ltem gt Pages lt ltem gt Text Methods Place link over text range on the page Name AddLink Arguments Req Type Description 1 Yes LONG The index of the first character 2 Yes LONG The count of characters 3 Yes LONG The target page index zero based or target URL String 4 No LONG Specify non zero number to make rectangular link instead control will create quadrilateral link by default Return Value Returns S_OK on success or an error value otherwise To obtain the text description of a received error code use IPDFXCview GetTex
253. of the Software Except for the Redistributables Licensee shall not distribute any files contained in the Software including without limitation EXE DLL CLW INC TPL CHM DRV LIB H MAK DEF TXT PDF or HLP files Licensee shall not reproduce copy or transfer any Documentation except Licensee may use the sample source code examples contained in the Documentation for the purpose of developing the Application Software Upon TRACKER S request Licensee agrees to send TRACKER one demonstration copy of the Application Software for evaluation and assessment Any distributor or reseller of Application Software appointed by Licensee must be subject to a binding agreement that includes provisions no less protective of TRACKER S intellectual property rights in the Software as it is protective of Licensee s rights in its own software Licensee acknowledges that the Software in source code form remains a confidential trade secret of TRACKER and or its suppliers and therefore Licensee agrees that it shall not modify decompile disassemble or reverse engineer the Software or attempt to do so except as permitted by applicable legislation Licensee agrees to refrain from disclosing the Software and to take reasonable measures with its employees to ensure they do not disclose the Software to any person firm or entity except as expressly permitted herein Specifically Licensee will not disclose or publish any license or unlock codes or instructi
254. omResult See Also IPDFXCview DoVerb Objects Operations RotateP ages Objects Documents lt ltem gt RotateP ages 2 2 1 37RunJavaScript Executes the supplied Java Script Name RunJavaScript Arguments 1 Yes BSTR Specifies the text of Java Script For more information see Java Script Support 2 No LONG Specifies the unique identifier of the opened document This argument can be O for the active document The specified document will be used as the target for the script referred by this in the script e PDF XChange Viewer ActiveX SDK Return Value Returns S_OK on success or an error value otherwise To obtain the text description of a received error code use IPDFXCview GetTextFromResult If successful then puts the result text of the executed Java Script into the DataOut See Also IPDFXCview DoVerb IPDFXCview RunJavaScript 2 2 1 38SaveDocument Saves a document in a number of different ways depending on the Flags parameter Name SaveDocument Arguments Req Type Description 1 Yes LONG The unique identifier ID or full file name of the document BSTR 2 No BSTR The destination file name or Stream Object IStrea m 3 No LONG The save flags For more information see PXCVA_DocumentSaveFlags Return Value Returns S_OK on success or an error value otherwise To obtain the text description of a received error code use IPDFXCview GetTextFromResult Remarks Use this operation to
255. on ID Integer Defines the unique identifier of the document This R is not the same as the document index which may change as documents are opened or closed Name String Contains full file name of the document Defines the R unique string identifier of the document FileName String Same as Name R DispFileName String Specifies any custom name for displaying in the Ul RW Can be empty Title String Document title RW Subject String Document subject Author Keywords Producer Creator CreationDate ModificationDate Version Modified NoClose ReadOnly ContentReady Temp PDFA RW String RW String RW String RW String RW String RW String RW String RW Integer String RW Integer String RW Group RW Array RW Group RW Integer String RW Integer String R Integer String RW Integer 136 PDF XChange Viewer ActiveX SDK Document author Document keywords Document producer Document creator Document creation date Document modification date Document PDF version Document modification flag Check this value for detection if the document is modified or set this value to 0 to discard changes on closing or set to 1 to effect the document modification For possible named values see Booleans Specifies restrict for closing PDF document For possible named values see Booleans Default value is O false Controls
256. on of a received error code use GetTextFromResult See Also PXCVA_Flags PXCVA_GetNamed Reference IPDFXCview SetProperty 2 1 1 1 5 GetVersionInfo This method returns the version of client and server portions of ActiveX control Syntax HRESULT GetVersionInfo BSTR ClientVersion BSTR ServerVersion Parameters ClientVersion out Pointer to a BSTR that lets you receive the string which represents a client s portion of version info version of PDFXCviewAx dll module ServerVersion out Pointer to a BSTR that lets you receive the string which represents a server s portion of version info version of PDFXCview exe module Return Value Returns S_OK if successful or an error value otherwise To obtain the text description of a received error code use GetTextFromResult Remarks If ClientVersion is not equal to ServerVersion then you have a dangerous and unstable mismatch of module versions on your system In this case please re register of AcitveX control see ActiveX Control Registration See Also ActiveX Control Registration IPDFXCview SetDevinfo 2 1 1 1 6 LoadSettings Load all control settings from an external storage method of your choosing such as an INI file or registry location etc Syntax HRESULT LoadSettings VARIANT Dataln i Parameters Datain in VARIANT that specifies a valid storage source Return Value Returns S_OK if successful or an error value otherwise
257. on sets provided by TRACKER relating to the Software If Licensee wishes to use the Software in a manner specifically or generally prohibited by this Agreement Licensee should contact TRACKER S OEM department to determine whether a special license may be required obtained 6 Use in Evaluation versions of Licensee Developer s End User Applications Where the Licensee provides a limited use evaluation version of their End User software distribution of the PDF XChange Viewer SDK redistributable components shall not count towards the licensee s allowed limited redistribution totals provided that 1 The functionality provided by the PDF XChange Viewer SDK will cease on expiry of the evaluation period Important Please Read 9 2 The evaluation period is no longer than 90 days otherwise it must count towards the overall limited redistribution rights provided by the clients purchased license and may not be provided under the umbrella of this evaluation concession 3 In the event that the Licensee allows some functionality of their application to continue after the evaluation period expires this will not include the PDF XChange Viewer SDK functions otherwise it must count towards the overall limited redistribution rights provided by the clients purchased license and may not be provided under the umbrella of this evaluation concession If the Licensee is unable to ensure the above limited use restrictions are adhered to Lic
258. ong Call CoPDFXCviewl PrintDocument nDocumentID PXCVA_Flags PXCVA_NoUT Delphi 7 0 var nDocumentID integer nRes integer Ey CoPDFXCviewl PrintDocument nDocumentID PXCVA_NoUT except on ex Exception do begin nRes EOleException ex ErrorCode end end See Also IPDFXCview PrintDocument How to Save a Document To use examples below you should open a document and obtain the unique identifier of the opened document before saving see How to Open a Document C with ATL CH LONG nDocumentID HRESULT hRes spViewer gt SaveDocument nDocumentID NULL 0 0 How To Use 251 int nDocument ID int nRes ey axCoPDFXCviewl SaveDocument nDocumentID null 0 0 catch Exception ex nRes System Runtime InteropServices Marshal GetHRForException ex VB NET Dim nDocumentID As Integer Dim nRes As Integer Try AxCoPDFXCviewl SaveDocument nDocument ID Nothing 0 0 Catch ex As Exception nRes System Runtime InteropServices Marshal GetHRForException ex End Try VB 6 0 Dim nDocumentID As Long Call CoPDFXCviewl SaveDocument nDocumentID 0 0 Delphi 7 0 var nDocumentID integer nRes integer ay CoPDFXCviewl SaveDocument nDocumentID 0 0 except on ex Exception do begin nRes EOleException ex ErrorCode end end See Also IPDFXCvi
259. ontained in the collection Syntax HRESULT get_Count LONG CountOut Parameters CountOut out Pointer to a LONG that receives the number of elements contained in the collection Return Value Returns S_OK if successful or an error value otherwise To obtain the text description of a received error code use GetTextFromResult 2 1 4 2 3 Data Provides get set collection data i e the variant object VARIANT which can contain a SAFEARRAY Syntax HRESULT get_Data VARIANT ValueOut HRESULT put_Data VARIANT Valueln Parameters ValueOut out Pointer to a VARIANT that receives collection data Valueln in BSTR that specifies a new collection data Return Value Returns S_OK if successful or an error value otherwise To obtain the text description of a received error code use GetTextFromResult 2 1 4 2 4 Item Provides get set value of an collection item variant object by index Syntax HRESULT get_Item LONG Index VARIANT ValueOut HRESULT put_Item LONG Index VARIANT Valueln Parameters Index in LONG that specifies a position O based of collection item to get set ValueOut out Pointer to a VARIANT that receives collection item value Valueln in BSTR that specifies a new collection item value Reference as Return Value Returns S_OK if successful or an error value otherwise To obtain the text description of a received error cod
260. ooleans Default value is 0 Search in sub folders if search in folder mode specified For possible named values see the Booleans Default value is 1 IPDFXCview DoVerb IPDFXCview GetProperty IPDFXCview SetProperty 2 2 2 16 2 What Specifies text for searching Contained Objects Name Type Text String RWS See Also Description Specifies text for search in PDF documents Text may contains some boolean operators AND OR NOT For examples PDF Reference PDF AND Reference identical to PDF Reference PDF OR Reference PDF NOT Reference If search results should contain some words which are logical operators please quote these words in the input search text for example if you want to search the text Service is not available please fix it before to Service is not available IPDFXCview DoVerb IPDFXCview GetProperty IPDFXCview SetProperty 2 2 2 16 3 Where Specifies setting for destination search place Contained Objects Name Type Description Reference 225 Mode Integer String Specifies place to search RWS For possible named values see the Search Modes Default value is 0 InActive FolderName String Specifies folder path for searching in it RW This parameter is used only if Mode is set to InFolder Disabled Integer String Disables the Search Pane Where combo box RWS For possible named values see the Booleans Default value is 0 See Also IPDFXCview DoVerb IPDF
261. operty IPDFXCview DoDocumentVerb ARGS This operation can be used to obtain a new object with IPDFXCaras interface Name ARGS Arguments None Return Value Returns S_OK or an error value otherwise For obtaining text description of received error code you can use IPDFXCview GetTextFromResult If successful it returns in DataOut an address of a pointer to IDispatch interface that receives the new arguments object See Also IPDFXCview DoVerb PXCVA_Flags PXCVA_OutArgs SP This operation can be used to obtain a primary smart point object by specified object name Name SP Arguments Reference 51 1 Yes BSTR The full name of any object which is described in section Objects For more information see IPDFXCsmartp interface Return Value Returns S_OK or an error value otherwise For obtaining text description of received error code you can use IPDFXCview GetTextFromResult If successful it returns in DataOut an address of a pointer to IDispatch interface that receives the new smart point object See Also IPDFXCview DoVerb 2 2 1 3 ActivateDocument Activates an open document Name ActivateDocument Arguments 1 Yes LONG The unique identifier of the document or full file name of the document BSTR Return Value Returns S_OK on success or an error value otherwise To obtain the text description of a received error code use IPDFXCview GetTextFromResult See Also IPDFXCview DoVerb IPDF
262. or with the luminosity of the source color and the 15 hue and saturation of the backdrop color This produces an inverse effect to that of the Color mode Reference 247 2 2 3 2 Booleans Supported Values True Yes Ok On False No Cancel Off 1 Defines TRUE boolean value 0 Defines FALSE boolean value See Also Named Objects 2 2 3 3 Border Effects Supported Values None No effect Cloudy 1 Cloudy line effect See Also Objects Border 2 2 3 4 Border Types Supported Values Solid 0 Solid line type Dashed 1 Dashed line type See Also Objects Border 2 2 3 5 Code Pages Supported Values Unicode Dos 1 Windows 0 2 PDF XChange Viewer ActiveX SDK UTF8 65001 See Also Objects Operations SummarizeAnnots Output TXT 2 2 3 6 Color Management Engines Supported Values LittleCMS Little CMS engine will be used for color management MicrosoftICM 1 Microsoft ICM engine will be used for color management See Also Objects ColorManagement 2 2 3 7 Colors Supported Values White a White color Black 0 Black color Red RGB 255 0 0 Red color Green RGB 0 255 0 Green color Blue RGB 0 0 255 Blue color Gray RGB Grey color 192 192 192 Grey RGB Grey color 192 192 192 Note this table can be expanded in future See Also Objects PageDisplay Objects Export Image 2 2 3 8 Command States Supported Values Enabled This command is enabled currently and available for execu
263. our applications Please also note that the features marked as PRO and charged for in the end user release when used within a developers application and a license has been paid for function without limitations or impediment it is only if used externally of the developer s application that the PRO features woudl revert to evaluation mode and not be freely useable without dispalying printing the evaluation watermarks etc This is available for download and may be freely distributed if you wish directly from this link click here Upgrade Information We constantly strive to improve and extend the functionality available for our all of our products and tend not to wait for major version upgrades before releasing improvements these are released incrementally as they become available Typically we release new versions with bug fixes and functionality improvements approx every 1 2 months and recommend that all our clients check our web site frequently for updates if not monthly then at least quarterly particularly if you discover a problem Please check for a new release before contacting us for assistance with many many millions of active users the chances are we are aware of problems before you locate them and whenever possible will issue a fix without delay Upgrade Policy When you purchase any of our products your are currently entitled to all major and minor upgrades for a minimum of 12 months after the purchase date a
264. owsHorizo ntal TileWindowsV ertic al TipAttachmentsCo ntains 3653 2 3338 3 3338 4 3261 4 3652 9 3653 0 3653 1 5765 3 3313 1 3297 7 3313 2 3297 6 3635 0 3314 7 3320 2 3310 4 3310 5 3310 7 3317 1 3317 0 3310 6 5765 1 5765 2 3653 8 SelectGraphicsMenultem SnapToGrid SnapToGuides SnapToObjects SplitWindow Annots Tool StampMenultem Annots Tool TextMenultem AccessOnline Annots Tool FreeTextMenultem TileHorizontal TileVertical Snap Snap On Off Copy Page Selection Select Entire Page Snapshot Tool Snap to Grid Snap To Guides Snap To Objects Split Split the Active Window into Panes Stamp Tool Start Full Search Sticky Note Tool Stop Full Search Summarize Comments Support Forum Text Box Tool Bold Italic Strikeout Subscript Superscript Underline Tile Horizontally Arrange Windows as Non Overlapping tiles Tile Vertically Arrange Windows as Non Overlapping tiles Show Attachments Pane This Document Contains the File Reference os 3337 2 TipFieldsContains TipLayersContains 3337 1 ToggleAllBars 3301 5 ToggleAllToolbars 3301 6 ToggleAnnotLockSt 3600 ate 1 ToggleAttachments 3320 Pane 5 ToggleBookmarksP 3291 ane 0 ToggleCommenting 3333 Bar 9 ToggleCommenting 3313 Bar 8 ToggleCommentsP 3334 ane 0 ToggleCommentsP 3320 ane 4 ToggleDocumentO 3326 ptionsBar 2 ToggleField
265. pecifies scaling conversion options for images RWS Labels Group Specifies appearance of text labels for images on RWS the pages See Also IPDFXCview DoVerb IPDFXCview GetProperty IPDFXCview SetProperty Operations NewDocumentFromlmages Allows to set up of new PDF page Contained Objects Name Type Description PaperWidth Double Specifies new PDF page width in points RWS Default value is 595 pt 210 mm PaperHeight Double Specifies new PDF page height in points RWS Default value is 842 pt 297 mm PaperMode Integer Specifies what paper size to use Can use String custom sizes from PaperWidth and RWS PaperHeight parameters or standard paper type specified by PaperName For possible named values see the Paper Modes 200 PDF XChange Viewer ActiveX SDK PaperName String RWS Orientation Integer String RWS MarginLeft Double RWS MarginTop Double RWS MarginRight Double RWS MarginBottom Double RWS Specifies the layout of images on the each PDF page Contained Objects Name Type HorCount Integer RWS HorSpace Double RWS VerCount Integer RWS VerSpace Double RWS HorAlign Integer String RWS VerAlign Integer String RWS Specifies scaling conversion options of images Contained Objects Name Type Colorlmg Group RWS Indexedimg Group RWS Monolmg Group RWS ColorDithering Integer String RWS Default value is 1 Standard The name of the standard
266. ped in to the RW Viewer Activex UserChoice Integer User s choice for this case String Initial value is 1 default processing RW Supported named values for this prompt OK Cancel Abort Ignore Yes No YesToAll NoTOAI See also User Choices Remarks You may also change the dropped file name at the run time Drag and Drop may be disabled enabled For more information see Objects General DenyOpenDocumentsWhenDrop For example in pseudocode function OnEvent Type Name Dataln DataOut Flags if Type PXCVA_OnDisplayPrompt if Name Prompts ConfirmDropFile get current file path GetProperty Prompts ConfirmDropFile FileName DataOut 0 if DataOut c unknownfile pdf change file path SetProperty Prompts ConfirmDropFile FileName DataIn c MyFile pdf 0 else ignore if DataOut c ignorefile pdf ignore opening SetProperty Prompts ConfirmDropFile UserChoice Dataln No 0 See Also IPDFXCviewEvents OnEvent PXCVA_EventTypes PXCVA_OnDisplayPrompt IPDFXCview GetProperty IPDFXCview SetProperty Reference 2 2 2 15 4 ConfirmFileReplace This is a special object for modifying the confirmation dialog when an error occurs when the specified destination file already exists You must implement a special event handler see _IPDFXCviewEvents OnEvent and match the type of the received event w
267. plication Software is being or will be acquired shipped transferred or re exported directly or indirectly into any country prohibited by the ACT and the regulations there under or will be used for any purpose prohibited by the same Licensee acknowledges that the Software may include technical data subject to export and re export restrictions imposed by U S law Licensee bears all responsibility for export law compliance and will indemnify TRACKER against all claims based on Licensee s exporting of the Application Software 9 U S GOVERNMENT RESTRICTED RIGHTS LEGEND Use duplication or disclosure by the Government is subject to restrictions as set forth in subparagraph c 1 ii of the Rights in Technical Data and Computer Software clause at DFARS 252 227 7013 and FAR 52 227 19 as applicable Manufacturer Contractor is Tracker Software Products Canada Ltd 466 Trans Canada Highway Duncan BC V9L3R6 Canada 10 TERM The license granted hereby is effective until terminated Licensee may terminate the license by returning the Software and Documentation to TRACKER without refund and destroying all copies thereof in any form TRACKER may terminate the licenses if Licensee fails to comply with any term or condition of this Agreement or any corresponding duplication and distribution agreement for Printer Driver Products Upon such termination Licensee shall cease using the Software and cease using or distributing the Application Software
268. r Allows display of the transparency grid String For possible named values see the Booleans RWS Default value is 0 Smoothlmages Integer Specifies whether to smooth images String For possible named values see the Booleans RWS Default value is 1 SmoothLineArt Integer Specifies whether to smooth line art images String For possible named values see the Booleans RWS Default value is 1 SmoothText Integer Specifies whether to smooth text String For possible named values see the Booleans RWS Default value is 1 TrimBoxColor Integer Specifies the color of the Trim Box String For possible named values see the Colors RWS Default value is RGB 0 255 0 green See Also 210 PDF XChange Viewer ActiveX SDK IPDFXCview DoVerb IPDFXCview GetProperty IPDFXCview SetProperty 2 2 2 13Performance Controls the performance of the control Contained Objects Name Max Threads MemUsage RenderThreads ThumbThreads SyncRendering UseMemExact MemExact See Also Type Integer RWS Integer String RWS Integer RWS Integer RWS Integer String RWS Integer String RWS Integer RWS Description Contains maximum number of all special working threads Default value is 0 automatic mode Represents the number of percents of actual RAM which will be used by control at working in peak Possible string values for example 10 25 50 etc Default val
269. r Contains number of all accessible styles R Remarks This object is an array of items where each item is represented as lt ltem gt For more information about object naming notation see Object Name Notation Examples for usage in pseudocode Enumerate all styles for area comment GetProperty Commenting Area Styles Count DataOut 0 Count Data0ut for i 0 to Count 1 GetProperty Commenting Area Styles i ID DataOut 0 See Also Objects Commenting IPDFXCview DoVerb IPDFXCview GetProperty IPDFXCview SetProperty Defines item template for each commenting area style Contained Objects ID Integer Specifies the unique ID of the comment style RS Reference 101 Name String Defines name of comment style RWS FColor Integer Specifies fill color for the comment String For possible named values see the Colors RWS Default value is 1 none SColor Integer Specifies stroke color for the comment String For possible named values see the Colors RWS Default value is RGB 255 0 0 red Opacity Double Specifies the opacity of the comment RWS Default value is 1 0 100 opacity BlendMode Integer Specifies the blend mode for the comment String For possible named values see the Blend RWS Modes Default value is 0 Normal Border Group Specifies border for the comment RWS DefSubj String Specifies default subject text for comment RWS This value will be use
270. r possible named values see the Colors RWS Default value is 1 none SColor Integer Specifies stroke color for the comment String For possible named values see the Colors RWS Default value is RGB 255 0 0 red Opacity Double Specifies the opacity of the comment 122 PDF XChange Viewer ActiveX SDK RWS BlendMode Integer String RWS Border Group RWS DefSubj String RWS DefSubjMode Integer String RWS See Also Objects Commenting Default value is 1 0 100 opacity Specifies the blend mode for the comment For possible named values see the Blend Modes Default value is 0 Normal Specifies border for the comment Specifies default subject text for comment This value will be used only if DefSubjMode is set to Custom Specifies mode for default subject For possible named values see the Subject Modes Default value is 0 Default IPDFXCview DoVerb IPDFXCview GetProperty IPDFXCview SetProperty 2 2 2 3 15 Rect Accesses the properties of the commenting Contained Objects Name Type Styles Array RWS See Also Objects Commenting 2 2 2 3 15 1 Styles Description Defines item style representation This object represents array of all comments styles and provides additional operations with them Item Template lt ltem gt defines item template for each style representation Contained Objects Name Type Count Integer R Remarks Descr
271. rdinates of input points are stored in an array of doubles integers where each pair specifies the X and Y coordinates of one point Also you can specify one last additional nonzero value to notify function that output coordinates should include the page view transformations crop offset page rotation if it is not specified then function will remove these transformations automatically i e will translate to the normal page coordinates system Return Value Returns S_OK on success or an error value otherwise To obtain the text description of a received error code use IPDFXCview GetTextFromResult The DataOut receives SAFEARRAY which contain x and y coordinates of the translated input points Remarks For example in pseudocode pl x 0 0 pt 1 72 inch pl y 0 0 p2 x 100 0 p2 y 200 0 DoVerb Documents 0 pages 2 ViewPointsToPagePoints DataIn pl x pl y p2 x p2 y DataOut vl x DataOut 0 px vl y Data0ut 1 v2 x DataOut 2 v2 y DataOut 3 double fIncludeTransformsToOutput_optional 1 additional flag for out DoVerb Documents 0 pages 2 ViewPointsToPagePoints DataIn pl x pl y p2 x p2 y fIncludeTransformsToO0utput_optional DataOut 0 See Also IPDFXCview DoVerb Objects Documents lt ltem gt This object represents operations with text on a specific page of the document Contained Objects Name Type Description Chars Group Represents info for characters
272. reated document in Data Out Remarks You may use the object with IPDFXCargs interface to create the image files list as input data For example in pseudocode create empty IPDFXCargs object IPDFXCargs args DoVerb NULL ARGS dataln dataOut 0 args IPDFXCargs data0ut dataOut NULL create input files list args Add C imagel jpg args Add C image2 png args Add C image3 tiff create new document from the images DoVerb NULL NewDocumentFromImages dataln dataOut 0 newDocID dataOut See Also IPDFXCview DoVerb Objects Operations NewDocument Fromimages 2 2 1 31 NewDocumentFromRTF Creates new PDF document from the formatted text RTF Name NewDocumentFromRTF e PDF XChange Viewer ActiveX SDK Arguments 1 Yes BSTR RTF file name 2 No BSTR Next RTF file name Return Value Returns S_OK on success or an error value otherwise To obtain the text description of a received error code use IPDFXCview GetTextFromResult If successful it returns the unique identifier ID of the created document in DataOut Remarks You may use the object with IPDFXCargs interface to create the text files list as input data For example in pseudocode create empty IPDFXCargs object IPDFXCargs args DoVerb NULL ARGS dataln dataOut 0 args IPDFXCargs dataOut dataOut NULL create input files list args Add C Testl rtf args Add C Test2 rtf args A
273. received error code use IPDFXCview GetTextFromResult Remarks For example in pseudocode 1 Show summarize annotations dialog DoVerb Documents 0 SummarizeAnnots NULL NULL 0 2 Save all comments from 1 5 10 pages to text file SetProperty Operations SummarizeAnnots Output Type txt SetProperty Operations SummarizeAnnots RangeType Exact SetProperty Operations SummarizeAnnots RangeText 1 5 10 pages SetProperty Operations SummarizeAnnots Output AutoView false SetProperty Operations SummarizeAnnots Output TXT CodePage UTF8 SetProperty Operations SummarizeAnnots Output TXT FolderName C SetProperty Operations SummarizeAnnots Outpu All Comments From lt File Name gt TXT FileName DoVerb Documents 0 SummarizeAnnots NULL NULL PXCVA_NoUI 160 PDF XChange Viewer ActiveX SDK See Also IPDFXCview DoVerb Operations SummarizeDocumentAnnots Objects Operations SummarizeAnnots 2 2 2 4 1 2 Pages This object represents an array of all pages of the document and provides additional operations with them Item Template lt ltem gt defines item template for each page representation Contained Objects Name Count Current Zoom ZoomMode Layout Width Height ScreenX ScreenY Display Rotation Contained Methods Name GetSelectedRanges Remarks Type Integer R Integer RW Double String RW
274. rgs gt put_Item 1 mypassword dataln spArgs OpName L OpenDocument spView gt DoVerb objName opName dataln amp dataOut 0 Reference PDFXCviewAxLib IPDFXCargs args object dataOut dataln dataln null axCoPDFXCviewl DoVerb ARGS dataIn out dataOut 0 args PDFXCviewAxLib IPDFXCargs dataOut args Init 2 args 0 http www mysite com test pdftpage 28zoom 150 args 1 mypassword axCoPDFXCviewl DoVerb OpenDocument args out dataOut Dim args As PDFXCviewAxLib IPDFXCargs Dim dataOut dataln As Object dataln Nothing data0ut Nothing AxCoPDFXCviewl DoVerb ARGS dataln dataOut 0 args CType data0ut PDFXCviewAxLib IPDFXCargs args Init 2 args 0 http www mysite com test pdf page 2 amp zoom 150 args 1 mypassword AxCoPDFXCviewl DoVerb OpenDocument PDFXCargs dataOut Dim args As PDFXCviewAxLibCtl IPDFXCargs Dim dataIn dataOut As Variant Call CoPDFXCviewl DoVerb ARGS dataln dataOut 0 Set args dataOut Call args Init 2 args 0 http www mysite com test pdf page 2 amp zoom 150 args 1 mypassword Call CoPDFXCviewl DoVerb OpenDocument args dataOut var args IPDFXCargs dataln dataOut OleVariant dataIn CoPDFXCviewl DoVerb ARGS dataln dataOut 0 args IDispatch dataOut as IPDFXCargs args Init 2 args 0 http www mysite com test pdftpage 28zoom 150 args 1 myp
275. rguments Reference 165 None Outputs 1 LONG The count of annotations on the page Return Value Returns S_OK on success or an error value otherwise To obtain the text description of a received error code use IPDFXCview GetTextFromResult Remarks For example in pseudocode DoVerb Documents 0 Pages 2 GetAnnotsCount Dataln DataOut 0 int annotsCountOnThePage2 DataOut See Also IPDFXCview DoVerb Objects Documents lt ltem gt Gets type identifier of the annotation object Name GetAnnotType Arguments 1 Yes LONG The zero based index of the annotation object on the page Outputs 1 LONG The type of the annotation object Return Value Returns S_OK on success or an error value otherwise To obtain the text description of a received error code use IPDFXCview GetTextFromResult Remarks For example in pseudocode Dataln 1 to second annotation on the page DoVerb Documents 0 Pages 2 GetAnnotType Dataln DataOut 0 int annotType DataOut 166 PDF XChange Viewer ActiveX SDK See Also IPDFXCview DoVerb Objects Documents lt ltem gt Moves the page point to the specified screen point Name MovePointToScreenPoint Arguments Req Type Description 1 Yes double Specifies x coordinate of the page point in points 2 Yes double Specifies y coordinate of the page point in points 3 Yes LONG Specifies x coordinate of screen point relative to desktop See a
276. ring argument OperationName argument in IPDFXCview DoVerb IPDFXCview DoDocumentVerb Common Object Dependent Operations These operations can be used to obtain or set values of properties Name Description Get Obtains current values from properties GetNamed Obtains current named values from properties The same effect with PXCVA_Flags PXCVA_GetNamed flag usage GetN The same as GetNamed operation Set Sets new values to properties SetNoApply Caches new values to properties instead of applying them immediately The same effect with PXCVA_Flags PXCVA_NoApply flag usage SetNA The same as SetNoApply operation These operations can be used to obtain some new auxiliary objects Name Description ARGS This operation can be used to obtain a new object with IPDFXCargs interface SE This operation can be used to obtain a primary smart point object object with IPDFXCsmartp interface by specified object name Reference Note for all operations below the input argument ObjectName see IPDFXCview DoVerb is not needed and should be set to NULL For these operations the IPDFXCview DoDocumentVerb method cannot be used Name Description General Operations ActivateDocument Activates an open document ApplyAllCachedChanges Applies all cached settings that were passed with the PXCVA_Flags PXCVA_NoApply flag ClearRecentsList This operation can be used to clear list of recent documents CloseAllDocuments Closes all
277. rns S_OK on success or an error value otherwise To obtain the text description of a received error code use IPDFXCview GetTextFromResult See Also IPDFXCview DoVerb IPDFXCview LoadSettings 2 2 1 27MsgToCommand Translates the standard windows message WM_KEYDOWN WM_SYSKEYDOWN to an existing Ul command Name MsgToCommand Arguments Req Type Description 1 Yes LONG The windows message identifier 2 Yes LONG The message wParam parameter 3 No LONG The message IParam parameter 4 No LONG Alternate modifier flags set Can contains one or more standard flags FCONTROL 8 FSHIFT 4 FALT 16 If not specified then control will obtain these flags from system automatically Return Value Returns S_OK on success or an error value otherwise To obtain the text description of a received error code use IPDFXCview GetTextFromResult If successful it returns in DataOut the unique identifier ID of the existing Ul command or zero 62 PDF XChange Viewer ActiveX SDK otherwise Remarks For example in pseudocode translates the Ctrl1 0 key combination DoVerb NULL MsgToCommand Dataln WM_KEYDOWN 0O 0 FCONTROL DataOut 0 Data0ut 57601 The Open Ul command See Also IPDFXCview DoVerb 2 2 1 28Msg ToCommandAndExec Translates the standard windows message WM_KEYDOWN WM_SYSKEYDOWN to an existing Ul command and if successful executes it This operation is similar to the Operations Msg
278. rowser plugins standalone PDF Viewer Name HighlightTextByFile Arguments Req Type Description 1 Yes BSTR The local file name URL or an stream object with information for text IStrea highlighting m Return Value Returns S_OK on success or an error value otherwise To obtain the text description of a received error code use IPDFXCview GetTextFromResult Remarks For example in pseudocode DoDocumentVerb docId NULL HighlightTextByFile DataIn C HighlightText xml NULL See Also IPDFXCview DoDocumentVerb Inserts empty pages to PDF document using parameters previously defined by Objects Operations InsertEmptyPages Name InsertEmptyPages Arguments None Return Value Returns S_OK on success or an error value otherwise To obtain the text description of a received error code use IPDFXCview GetTextFromResult 152 PDF XChange Viewer ActiveX SDK Remarks For example in pseudocode 1 Show Insert Empty pages dialog DoVerb Documents 0 InsertEmptyPages NULL NULL 0 2 Insert 5 empty A4 pages to the begin of current PDF document SetProperty Operations InsertEmptyPages Count 5 SetProperty Operations InsertEmptyPages InsertBefore 0 SetProperty Operations InsertEmptyPages PaperMode Standard SetProperty Operations InsertEmptyPages PaperName A4 DoVerb Documents 0 InsertEmptyPages NULL NULL PXCVA_NoUI See Also IPDFXCview DoVerb
279. rt to Image Modes Default value is O all pages into one multipage image file Defines the type of pages range For possible values see the Range Types Default value is 1 all pages Specifies additional filter for the pages range For possible values see the Range Filters Default value is 1 all pages Specifies whether to export selected pages in reverse order For possible named values see the Booleans Default value is 0 Specifies the exact pages to export The string should contain the page numbers and or page ranges separated by commas counting from the start of the document For example 1 3 5 12 Specifies the resolution of the exported pages in dots per inch Default value is 300 dpi Specifies the background color for the exported pages as a COLORREF value If highest byte of this value is equal to 0 then the background is transparent For possible named values see the Colors Default value is OxFFFFFFFF white Specifies image export folder name When multiple image files are produced by the export operation this folder receives all exported image files and image file names are automatically generated If this value is empty then the lt My Documents gt standard folder will be used automatically Default value is empty NULL or Specifies image export file name It supports macros for generic names See Name Generation Macros Reference 183 Image Types Export to Image Modes
280. rtion The string should contain the page numbers and or page ranges separated by commas counting from the start of the document For example 1 3 5 12 If set to true then external document will be used as 197 1 PDF XChange Viewer ActiveX SDK String source Path to this document is specified in File RW property If set to false then pages will be inserted from already opened document ID of source document is specified in DocID property For possible named values see the Booleans Default value is 1 true File String Specifies the path to source document This path RW will be taken only if FromExternal is set to true DocID String Specifies already opened document ID from which RW pages will be inserted This will work only when FromExternal is set to false This parameter cannot be equal to current document ID InsertBefore Integer Specifies zero based index of the page to insert the RWS source document pages before See Also IPDFXCview DoVerb IPDFXCview GetProperty IPDFXCview SetProperty Operations InsertDocumentPages Objects Documents lt ltem gt InsertPages 2 2 2 11 5 NewDocument Allows to specify settings for creation of new PDF document Contained Objects Name Type Description FromBlank Group Specifies options for creating new empty document RWS SpecVersion Integer Specifies version of PDF Specification for creating String new document RWS For possible named values see the P
281. s SelectAll SelectMenultem AcroSendMail SendMail Exit Quit and Prompt to Save any Changed Documents Recent Files Rectangle Tool Rectangle Link Tool Redo Redo the Previously Undone Action Replace Pages Replace Text Reset All Settings to Defaults Reset All Application s Settings to Defaults Reset Pop Up Note Location Counterclockwise CCW Rotate View Counterclock wise CCW Clockwise CW Rotate View Clock wise CW Rotate Pages Rotate Selected Pages 180 Rotate Selected Pages 270 Rotate Selected Pages 90 Save Save the Active Document Save As Save the Active Document wth a New Name Save Copy As Save the Active Document to a New File Select All Select Tool Select Text Objects Tool Send by E mail Attach the Active Document to a New E mail Message Set Current Appearance as Default Save this Appearance Colors Border Style Opacity etc to Current Comment Style Saved Appearance Reference os SetTransitions 3604 0 SetupMeasurement 3652 7 ShowAllBars 3655 6 ShowAllComments 3643 6 ShowAllTypes 3644 0 ShowAttachments 3644 5 ShowBrokenlnfo 3336 9 ShowCmdCustomi 3600 zeDialog 0 ShowCommentsBy 3643 Type 7 ShowCommentStyl 3642 esPalette 0 ShowDrawings 3644 2 ShowGrid 3652 0 ShowGuides 3652 1 ShowNotes 3644 1 ShowPDFAInfo 3337 4 ShowRulers 3652 2 ShowStamps 3644 4 ShowStampsPalett 3322 e 8 ShowTexts 3644 3 ShowXFA Info 3337 5 SignDoc
282. s Used for checking to see if all operations are allowed Create Delete Modify Copy Use Accessibility Select ON Oa FR ON Open document o Change Security Settings for document o High Quality Printing for document k k Low Quality Printing for document N Form fill in or sign the existing field i o Rotate pages Crop pages z Rh 154 PDF XChange Viewer ActiveX SDK 15 Summarize annotations 16 Insert pages 17 Replace pages 18 Reorder pages 19 Full Save document 20 Import form data annotations 21 Export form data annotations images 22 Used for checking to see if any operation is allowed 24 Submit forms outside of the browser 25 Allow the form to spawn template pages Return Value Returns S_OK on success or an error value otherwise To obtain the text description of a received error code use IPDFXCview GetTextFromResult Remarks For example in pseudocode 1 Check if is possible to insert pages DoDocumentVerb docId NULL IsOperationGranted dataln 2 16 NULL 0 2 Check if is possible to hight quality print DoDocumentVerb docId NULL IsOperationGranted dataIn 1 10 NULL 0 See Also IPDFXCview DoDocumentVerb Prints document pages using parameters previously defined by Objects Print Name ER Arguments None Return Value Returns S_OK on success or an error value otherwise To obtain the text description of a
283. s System Runtime InteropServices Marshal GetHRForException ex End Try VB 6 0 Dim nDocumentID As Long Call CoPDFXCviewl OpenDocument C Test pdf 123 nDocumentID 0 Delphi 7 0 var nDocumentID integer nRes integer try CoPDFXCviewl OpenDocument C Test pdf 123 nDocumentID 0 except on ex Exception do begin nRes EOleException ex ErrorCode end end See Also IPDFXCview OpenDocument How to Print a Document To use examples below you should open a document and obtain the unique identifier of the opened document before printing see How to Open a Document To print directly without standard print dialog displaying you should specify the PXCVA_Flags PXCVA_NOoUI flag in last Flags argument of the method C with ATL LONG nDocumentID HRESULT hRes spViewer gt PrintDocument nDocumentID PXCVA_ NOUI C int nDocument ID int nRes 200 PDF XChange Viewer ActiveX SDK VB NET VB 6 0 TEY axCoPDFXCviewl PrintDocument nDocumentID PXCVA Flags PXCVA_NOUI catch Exception ex nRes System Runtime InteropServices Marshal GetHRForException ex Dim nDocumentID As Integer Dim nRes As Integer Tey AxCoPDFXCviewl PrintDocument nDocumentID PXCVA_Flags PXCVA_NoUT Catch ex As Exception nRes System Runtime InteropServices Marshal GetHRForException ex End Try Dim nDocumentID As L
284. s 595 pt 210 mm Specifies new pages height in points Default value is 842 pt 297 mm Specifies what paper size to use Can use custom sizes from PaperWidth and PaperHeight parameters or standard paper type specified by PaperName For possible named values see the Paper Modes Default value is 1 Standard The name of the standard type of paper Default value is A4 Specifies landscape paper orientation for new document For possible named values see the Booleans Default value is 0 Specifies pages count for new document Default value is 1 Specifies the zero based index of the page to insert the empty pages before IPDFXCview DoVerb IPDFXCview GetProperty IPDFXCvew SetProperty Operations InsertEmptyDocumentPages Objects Documents lt ltem gt InsertEmptyPages 2 2 2 11 4 InsertPages Allows to specify settings for inserting pages from the source document into the current document Contained Objects Name RangeType RangeFilter RangeText FromExternal Type Integer String RW Integer String RW String RW Integer Description Defines the type of page range for insertion For possible values see the Range Types Supports only All and Exact values Default value is 1 all pages Specifies an additional filter for the page range For possible values see the Range Filters Default value is 1 all pages Specifies the exact pages of source document for inse
285. s Output PDF 2 2 3 59 Text Align Supported Values 268 PDF XChange Viewer ActiveX SDK 0 Left text align Center 1 Center text align Right 2 Right text align Justify 3 Justify text align See Also Objects Text Format 2 2 3 60 Text Editor Notifications Filter Flags Supported Values None 0 All 1 Begin 1 End 2 See Also Objects Notifications Print 2 2 3 61 Text File Placing Modes Supported Values NewPara Start each file from new paragraph NewPage 1 Start each file from new page See Also Objects Operations NewDocument FromText 2 2 3 62 Text Rendering Mode Supported Values Fill Fill text Stroke 1 Stroke text FillStroke 2 Fill then stroke text See Also Objects Text Format Reference 269 2 2 3 63 Tools Supported Tools Identifiers Name ID Hand 32613 Select 32620 Snapshot 32614 Zoomin 32610 ZoomOut 32611 Loupe 32609 StickyNote 33132 TypeWriter 33226 Callout 33201 TextBox 33202 Highlight 33221 StrikeOut 33223 Underline 33222 Arrow 33123 Line 33124 Rect 33125 Oval 33126 PolyLine 33128 Polygon 33127 Cloud 33130 Pencil 33129 Eraser 36300 Stamp 33131 Distance 36346 Perimeter 36347 Area 36348 Link 36343 QuadLink 36344 See Also Objects Tools 2 2 3 64User Choices Supported Values Default 0 Continue default processing OK 1 Okay 1 270 PDF XChange Viewer ActiveX SDK Cancel 2 Abort 3 Retry 4 Ignore 5 Yes 6 No 7 Yes TOAIl 100
286. s by Page Group By Add Reply Add Reply to Comment Properties Comment Properties Align Left Rename Comment Style Rename Selected Comment Style Search By Search text by provider Manage Recents List Order Manage Search Providers Test 1 Test 3 Reference es 3642 Development 9 3643 Test 2 1 3651 Online Search 4 Search specified text using internet search provider 3300 Pages Properties 3 Show Properties of Selected Pages 3326 File 7 About 5766 About About PDF XChange Viewer 4 Display Program Information Version Number and Copyright ActualSize 3290 ActualSize Actual Size 0 Show Actual Page Size 100 AddBookmark 3341 Add Bookmark 6 AddFileAttachment 3381 AddFileAttachment Attach a File 5 Attach a File AddLink 3342 Add Link 0 AddNewPageGuide 3652 Add New Page Guide s S 3 AddNote 3313 Add Note 5 AddNoteToSelText 3320 Add Note to Text Y AddReply 3317 Add Reply 4 ApplyDefaultProper 3313 Apply Default Appearance ties 4 Apply Saved Appearance Colors Border Style Opacity etc from Current Comment Style ApplyDefaultTextFo 3326 Apply Default Text Formatting rmatting 0 Apply Saved Text Formatting Font Font Size Color Align etc from Current Comment Style AreaTool 3634 MeasurePolygonMenulte Area Tool 8 m Area tool to measure area of an object ArrangeWindowlco 5764 Arrange Icons ns 9 Arrange Icons at the Bottom of the Window Arro
287. s for usage in pseudocode Reference 109 Enumerate all styles for attachment comment GetProperty Commenting FileAttachment Styles Count DataOut 0 Count DataOut for 1 0 to Count 1 GetProperty Commenting FileAttachment Styles i ID DataOut C See Also Objects Commenting IPDFXCview DoVerb IPDFXCview GetProperty IPDFXCview SetProperty Defines item template for each commenting file attachment style Contained Objects Name Type Description ID Integer Specifies the unique ID of the comment style RS Name String Defines name of comment style RWS Type Integer Specifies ID of an icon to be used in displaying String the file attachment RWS For possible named values see the File Attachment Icon Types Default value is 3 Comment FColor Integer Specifies fill color for the comment String For possible named values see the Colors RWS Default value is RGB 64 85 255 Opacity Double Specifies the opacity of the comment RWS Default value is 1 0 100 opacity DefSubj String Specifies default subject text for comment RWS This value will be used only if DefSubjMode is set to Custom DefSubjMode Integer Specifies mode for default subject String For possible named values see the Subject RWS Modes Default value is 0 Default See Also Objects Commenting IPDFXCview DoVerb IPDFXCview GetProperty IPDFXCview SetProperty 2 2 2 3 7 Highlight
288. s keyboard shortcut accelerator for the Ulcommand os PDF XChange Viewer ActiveX SDK Contained Objects Name Modifiers Key Type Use See Also Objects Commands lt ltem gt 2 2 2 3 Commenting Controls for commenting Contained Objects Name Area Distance FileAttachment Highlight E D In Link o 5 Type Integer RWS Integer RWS Integer String RWS Integer String RWS Type Group RWS Group RWS Group RWS Group RWS Group RWS Group RWS Group RWS Group RWS Group RWS Group RWS Description Defines accelerator flags It can be a combination of the following values from the Shortcut Modifiers Put 1 or 128 to reset the shortcut to defaults If returned value contains the 128 flag then shortcut is default Note in previous versions control returned the 1 for all the default shortcuts But in this case you couldn t obtain the real default shortcut key key type modifiers therefore in the new version it has been changed Please update your code in this case Defines code depended with Type member For example A S C 0x21 VK_PRIOR Specifies the Key type virtual key code or ASCII code For possible named values see the Shortcut Key Types Determines shortcut usage for the command Put O false for disable the shortcut For possible named values see the Booleans Description Specif
289. s of the ActiveX control Contained Objects Name Type AllowAllAccelerators Integer String RWS Description Enables disables keyboard accelerators For possible named values see the Booleans Default value is 0 all accelerators denied Reference 185 ApplicationModulePath String Contains the full file name of exe module RW PDFXCview exe of our ActiveX control ApplicationTitle String Contains the application title This string will be RW displayed in more titles dialogs messages etc Default value is PDF XChange Viewer Control DenyAllContextMenus Integer Allow deny displaying of context menus String displaying RWS For possible named values see the Booleans Default value is 0 all context menus allowed Deny AllExportOperations Integer Enables disables export ability String For possible named values see the Booleans RWS Default value is 0 all export operations allowed Deny AllModify Operations Integer Allow deny all modify operations for all String documents RWS For possible named values see the Booleans Default value is 0 modifications allowed DenyAllPrintOperations Integer Allow deny all print operations for all documents String For possible named values see the Booleans RWS Default value is 0 printing allowed DenyAllSaveOperations Integer Allow deny all save operations for all documents String For possible named values see the Booleans RWS Default value is 0 saving allow
290. s optional flags For more information see PXCVA Flags This argument can be 0 Return Value Returns S_OK if successful or an error value otherwise To obtain the text description of a received error code use GetTextFromResult See Also IPDFXCview GetViewObjectFromName IPDFXCview GetDocumentFromName Named Objects Objects Prompts Objects Notifications IPDFXCargs This interface represents an array of data objects Use it for simplification creation reading changing of data object which contains array of data SAFEARRAY pass filled args object as input data to any other methods through Dataln obtain new args object as output data through DataOut This interface is derived directly from IDispatch e Methods e Properties Remarks To obtain a arguments object you should call main method IPDFXCview DoVerb with special named operationOperations ARGS Or you may obtain new args object as output data from any method like as IPDEXCview DoVerb if you have specified PXCVA_Flags PXCVA_OutArgs flag into Flags argument before For example C AT CComPtr lt IPDFXCview gt spView CComPtr lt IPDFXCargs gt spArgs CComBSTR objName L CComBSTR opName L ARGS CComVariant dataln dataOut spView gt DoVerb objName opName dataln amp dataOut 0 spArgs static_cast lt IPDFXCargs gt dataOut punkVal spArgs gt Init 2 spArgs gt put_Item 0 http www mysite com test pdf page 2 amp zo0om 150 spA
291. s our trial watermarks do not appear in the top corners of all pages from being displayed or printed when used Please do not buy immediately We are confident that all of our products offer unrivalled value and functionality We offer fully functional no timeout versions of all our Tools for download and evaluation we therefore strongly recommend that developer s not only use the evaluation to test out the functionality available before buying but even once they have decided to purchase in principle wait until they have fully completed integrating the desired functionality into their first production application ready to deliver to their first client before purchasing and only then should you buy By doing so we mutually ensure your 100 satisfaction before parting with any money and that we have only contented and happy developer clients For this reason we do not offer refunds as you are able to use the evaluation version without timeout or restriction save the trial watermarks previously mentioned on all output and there should be no dissatisfaction with the product purchased We also recommend that developers install the general and FREE End user release of the PDF XChange Viewer including help files and localised language files to familiarise themselves with the functionality available to them and their clients by using the PDF XChange Viewer both within and if you 2 PDF XChange Viewer ActiveX SDK wish external to y
292. s parameter R indicates the distance the wheel was rotated A positive value indicates that the wheel was rotated forward away from user A negative value indicates that the wheel was rotated backward toward the user Document Integer Retrieves document ID under mouse cursor R Page Integer Retrieves page number under mouse cursor R Remarks Example for usage in pseudocode 1 enable receiving all mouse events SetProperty Notifications Mouse Filter A11 0 2 ignore left mouse button down event function OnEvent Type Name Dataln Data0ut Flags 192 PDF XChange Viewer ActiveX SDK T See Also Type PXCVA_OnNamedNotify and Name Notifications Mouse then Get mouse event message GetProperty Notifications Mouse msg vDataOut 0 if vDataOut WM_LBUTTONDOWN then Ignore this message SetProperty Notifications Mouse Skip true 0 IPDFXCview DoVerb IPDFXCview GetProperty IPDFXCview SetProperty IPDFXCviewE vents OnEvent Objects Documents lt ltem gt Pages lt ltem gt TranslateScreenPoint 2 2 2 10 9 Print Informs about printing of the document Contained Objects Name Filter Type PrinterName Document Sheet SheetsCount Page PagesCount Copies Collate Cancel Type Integer String RWS Integer String R String R Integer R Integer R Integer R Integer R Integer R In
293. s will be obtained through SAFEARRAY Coordinates are stored in an array of doubles where each pair specifies the X and Y coordinates of one point each eight doubles four points specifies the quadrilateral area Order of points is displayed in the Quads Return Value Returns S_OK on success or an error value otherwise To obtain the text description of a received error code use IPDFXCview GetTextFromResult Remarks For example in pseudocode Gets coordinates of first 10 characters on the page DoVerb Documents 0 Pages 0 Text GetQuads DataIn 0 10 DataOut See Also IPDFXCview DoVerb Objects Documents lt ltem gt Pages lt ltem gt Text PXCVA OutArgs Gets selected text on page Name GetSelected Arguments 1 No Boolea Exclude new line characters from output CR LF Default value is false n Outputs 1 BSTR Output text Return Value Returns S_OK on success or an error value otherwise To obtain the text description of a received error code use IPDFXCview GetTextFromResult Remarks For example in pseudocode Gets selected text on the page without CR LF 171 172 PDF XChange Viewer ActiveX SDK DoVerb Documents 0 Pages 0 Text GetSelected Dataln 1 DataOut 0 See Also IPDFXCview DoVerb Objects Documents lt ltem gt Pages lt ltem gt Text Gets text selection ranges on the page Name cerselecredranges Outputs Can contains one or
294. sPane 3300 8 ToggleFileBar 3290 8 ToggleFindBar 3300 0 ToggleJSConsole 3318 7 ToggleLaunchBar 3326 5 ToggleLayersPane 3300 6 ToggleLinksBar 3634 2 ToggleMeasuringB 3634 ar 5 ToggleMenuBar 3300 9 ToggleNavigationTa 3294 bsBar 0 ShowHideFileAttachment ShowHideBookmarks CommentingMainToolBar ShowHideToolbarCommen ting ShowHideAnnotManager ShowHideAnnotManager ShowHideFields ShowHideToolbarFile ShowHideToolbarFind ShowHideOptCont MeasuringMainToolBar Attachments Click Here to Show Hide Attachments Pane Show Fields Pane This Document Contains the Form Click Here to ShowHide Form Fields Pane Show Layers Pane This Document Contains Layers Click Here to Show Hide Layers Pane Show Hide All Bars Show Hide All Bars from user s set Show Hide All Toobars ShowWHide All Toobars from user s set Locked Attachments Show Hide Attachments Pane Bookmarks Show Hide Bookmarks Pane Show Comment And Markup Toolbar Comment And Markup Toolbar Show Hide Comments And Mark up Toolbar Show Comments List ShowHide Comments List Comments ShowHide Comments Pane Document Options Toolbar Show Hide Document Options Toolbar Fields Show Hide Fields Pane File Toolbar Show Hide File Toolbar Find Toolbar Show Hide Find Toolbar Java Script Console Show Hide Java Script Console Launch Toolbar Show Hide Launch Applications Toolbar Layers Show Hide Layers Pane Links Editor Toolbar Show Hide L
295. sa CString Sich Lest y CComVariant dataln dataOut CString Stry str Format L Documents d iDocID m_spView gt DoVerb __S2BS str __S2BS L GetAllText dataln amp dataOut 0 sPdfText dataOut bstrVal 3 8 296 PDF XChange Viewer ActiveX SDK CH String sPdfText object data0ut null axCoPDFXCviewl DoVerb Documents iDocID ToString GetAllText null our data0ur 0 sPdfText String dataOut VB 6 0 Dim sPdfText As String Dim dataOut As Variant Call CoPDFXCviewl DoVerb Documents amp iDocID amp GetAllText Nothing dataOut 0 sPdfText dataOut Delphi var dataIn dataOut OleVariant iDocID integer sPdfText string begin CoPDFXCviewl DoVerb Documents IntToStr iDocID GetAllText dataIn dataOut 0 sPdfText dataOut end See Also IPDFXCview DoVerb Objects Documents lt ltem gt GetAllText How to Summarize Annotations from Document This example shows how you can easily save all comments from PDF document to the text file without showing prompt dialog To use this example you should open document first CH VB 6 0 object dataln dataOut dataln null axCoPDFXCviewl SetProperty Operations SummarizeAnnots Output 1 ype txt axCoPDFXCviewl SetProperty Operations SummarizeAnnots Output AutoView false axCoPDFXCviewl SetProperty Operations SummarizeAnnots Output TX FolderName C axCoPDFXCviewl SetProperty
296. save or copy the specified document To display the standard Save File dialog pass NULL as the Destination file name If you want to skip possible error dialogs then you must set the PXCVA_Flags PXCVA_NoUI flag in the Flags argument For example in pseudocode show save dialog for document C Test pdf DoVerb NULL SaveDocument DataIn C Test pdf DataOut 0 show save dialog for document with ID 4095 DoVerb NULL SaveDocument Dataln 4095 DataOut 0 save document directly to C TestCopy pdf file without UI dialogs DoVerb NULL SaveDocument DataIn SafeArray 4095 C TestCopy pdf DataOut PXCVA_NoUI save to Stream DoVerb NULL SaveDocument DataIn SafeArray 4095 StreamObj DataOut PXCVA_ NOUI The Stream Object can be asynchronous Reference e See Also IPDFXCview DoVerb IPDFXCview SaveDocument Objects Notifications BeforeSaveDoc Objects Notifications DocSaved Objects Documents UseStreamsDirectly 2 2 1 39SaveSettings Loads all control settings from an external storage Name Seavesett Lines Arguments Req Type Description 1 Yes BSTR Specifies a valid destination storage destination file name or pointer to a IStrea IStream interface m Return Value Returns S_OK on success or an error value otherwise To obtain the text description of a received error code use IPDFXCview GetTextFromResult See Also IPDFXCview DoVerb IPDFXCview Sa
297. selection changes and check selection state for the document function OnEvent Type Name Dataln DataOut Flags if Type PXCVA_OnNamedNotify and Name Notifications Print then obtain notifications type print stage GetProperty Notifications Print Type DataOut PXCVA_GetNamed if DataOut EndDocument obtain printed document GetProperty Notifications Print Document DataOut 0 See Also IPDFXCview DoVerb IPDFXCview GetProperty IPDFXCview SetProperty IPDFXCviewEvents OnEvent 2 2 2 10 10 Selection Informs about any selection in the document Contained Objects Name Type Description Filter Integer Specifies filter for receiving selection changes String events RWS For possible named values see the Selection Notifications Filter Flags You may use a combination of one or more of the following values Default value is 0 None Document Integer Contains the ID of the document in which selection R was changed Remarks Example for usage in pseudocode 1 enable receiving all selection events SetProperty Notifications Selection Filter Al11 0 194 PDF XChange Viewer ActiveX SDK 2 catch selection changes and check selection state for the document function OnEvent Type Name Dataln DataOut Flags if Type PXCVA_OnNamedNotify and Name Notifications Selection then GetProperty Notifications Selection Document DataOut 0 int docID
298. sented as the following Syntax lt ObjectName gt lt Sectionl gt lt Section2 gt lt Section3 gt lt SectionN gt lt Section gt lt Name gt lt Index gt lt Index gt lt Number gt lt lt String gt gt In the above notation and enclose optional portions is the logical OR lt Name gt is a String value lt Number gt is an integer number value represents a unique identifier without symbol represents a simple order index zero based of item in array which is named as lt Name gt lt String gt is an string value represents a unique identifier of item in array which is named as lt Name gt Some real names by notation for example General ApplicationTitle Print ScaleSimple AutoRotate ColorManagement Custom RGB View Bars File Visible Documents 0 Author Documents C Test pdf Title Documents 4095 View Panes Thumbnails Visible Named values are supported by get set operations for many numerical properties lt Numeric gt String indication in Type column of tables For these properties you can set get predefined named values string instead of numeric values Reference For example in pseudocode the property with name General AllowAllAccelerators supports named values specified in Booleans 1 1 get value DoVerb General AllowAllAccelerators get Dataln DataOut 0 or GetProperty General Allo
299. ssible named values see the Booleans Default value is 0 false This object represents paragraph format structure for comment Contained Objects Name FirstLinelndent LineSpacing Type Double RWS Double RWS Description Specifies indent for first line Default value is 0 Specifies line spacing If value is positive number then its specifies line spacing in percents If this value is negative it specifies line spacing in points Default value is 100 percent 241 2 PDF XChange Viewer ActiveX SDK Margins Group Specifies paragraph margins RWS TextAlign Integer Specifies text align for paragraph String For possible named values see TextAlign RWS Default value is 0 Left align See Also Objects Commenting 2 2 2 19 6 Ul This object is used for customizing prompts confirmations and messages See also Objects Prompts Contained Objects Name Type Description Title String Represents the caption text of dialog RW Labels Array Represents all customizable text labels on dialog RW Remarks To customize prompts declared in Objects Prompts section you must implement a special event handler see _IPDFXCviewEvents OnEvent and match the event s needing overrides If necessary event was matched then you can to customize UI change dialog caption text labels by object UI but do not change the UserChoice value in the received prompt object this value must be 0 to allow the orig
300. stribution Statement and any revised license has been returned and always providing the Developers distribution entitlements have not been exceeded new license codes will be released An example distribution statement is provided as an attachment to this document Failure to provide a distribution statement when required is a material breach of this Agreement and renders the Developer liable to the remedies detailed under section 4 of this agreement 15 LICENSE EXPIRY This Expiry condition is only relevant where the licensee is using the PDF XChange Viewer SDK functionality as a result of the purchase of PDF XChange PRO SDK PDF XChange Drivers API SDK or PDF Tools SDK and the distribution limit is specified as being 7500 CDLP s or less IT DOES NOT IN ANY WAY AFFECT any licensee using the PDF XChange Viewer SDK if that Licensee has specifically purchased the PDF XChange Viewer SDK and 25 000 or more CDLP s for distribution to end user client desktops On the event of a Major version Upgrade release to the PDF XChange Viewer SDK PDF XChange PRO SDK PDF XChange Drivers API SDK or PDF Tools SDK all rights to continue to distribute applications using the PDF XChange Viewer SDK functionality within developed application shall cease such rights having been deemed expired and terminated as a consequence of the new Major release Important Please Read 11 event Should the developer wish to continue to distribute and utilise the functionalit
301. t with the parameters defined earlier by Export names section This method is a simplified variant of a special call to the DoVerb method Syntax HRESULT ExportDocument LONG HD LONG Flags Parameters ID in LONG that specifies unique identifier of the opened document This argument can be 0 for the active document Flags in LONG that specifies optional flags For more information see PXCVA Flags This argument can be 0 Return Value Returns S_OK if successful or an error value otherwise To obtain the text description of a received error code use GetTextFromResult Remarks Call for export the opened document specified by rp If you wanted to skip the export dialog then you must specify the PXCVA_Flags PXCVA_NoUI flag into Flags See Also IPDFXCview PrintDocument Objects Export Operations ExportDocument 2 1 1 2 6 FlushDocument Flush all of the user s changes for specified opened document Call this method to finish editing of a document s objects and apply new changes This method is a simplified variant of a special call to the DoVerb method Syntax HRESULT FlushDocument LONG ID LONG Flags Parameters Reference 25 ID in LONG that specifies unique identifier of the opened document This argument can be 0 for the active document Flags in LONG that specifies optional flags For more information see PXCVA_Flags This argument can be 0 Return V
302. t in language is default String This property specifies overrides the control s RWS default language If it is equal to any of supported locale identifiers then it sets a new default language which differs from control s built in language For possible named values see the User Interface Languages Default value is 2 BuiltIn In this case the control selects the built in language English US when LocalelD is equal to 1 Default Remarks This possibility can be used for supported languages only To find all currently supported languages examine the contents of lt FolderOfExeModule gt Languages folder See also Objects General ApplicationModulePath Example for usage in pseudocode 1 get current UI language ID GetProperty International LocaleID DataOut 0 result DataOut 0x0409 i e current language is English US 2 set new UI language SetProperty International LocaleID DataIn French FR 0 or SetProperty International LocaleID DataIn 0x040C 0 See Also IPDFXCview DoVerb IPDFXCview GetProperty IPDFXCview SetProperty 2 2 2 10Notifications Allows to receive and modify control s events Contained Objects Name Type Description Mouse Group Allows to get information about mouse events RWS ContextMenu Group Used for confirmation and customization of context RWS menu before it displaying Selection Group Informs about any selection changes in the RWS
303. t of image in the cell unproportional fit Reference 255 See Also Objects Operations NewDocument Fromlmages Layout 2 2 3 26Image Conversion Types Supported Values None 0 No conversion Grayscale 1 To Grayscale Monochrome 2 To Monochrome BlackWhite 3 To Black amp White See Also Objects Operations NewDocument Fromlmages Graphics 2 2 3 27 Image Scale Types Supported Values None 0 No scale Linear 1 Linear scale Bilinear 2 Bilinear scale Bicubic 3 Bicubic scale See Also Objects Operations NewDocument FromImages Layout 2 2 3 28lmage Types Supported Image Types BMP 1112363040 Windows Bitmap File Format GIF 1195984416 Compuserve GIF PNG 1347307296 Portable Network Graphic JNG 1246644000 JPEG Network Graphic JPEG 1246774599 Joint Photographic Experts Group ICO 1229147936 Icon Image File Format PBM 1346522400 Portable Bitmap File Format PGM 1346850080 Portable Graymap PPM 1347439904 Portable Pixelmap JBIG 1245858119 Joint Bi level Image experts Group JBIG2 1245857586 Joint Bi level Image experts Group v2 JPEG2K JPEG2000 WBMP PCX DCX TGA TIFF DNG WMF AMF EMF 1246769739 1246769739 1463962960 1346590752 1145264160 1413955872 1414088262 1145980704 1464682016 1095583264 1162692128 256 PDF XChange Viewer ActiveX SDK JPEG 2000 JPEG 2000 Wireless Mono Bitmap File Format PC Paintbrush File Format Multipage PCX Truevision Targa Tag Image File Form
304. t of label RW See Also Objects Prompts 2 2 2 19 7 Quad This object represents the coordinates of a quadrilateral area on a PDF page Coordinates is stored in points Contained Objects Value Array of Double Contains an array of numbers eight which R specify the coordinates of the one quadrilateral area Remarks Coordinates are stored in an array of doubles where each pair specifies the X and Y coordinates 2a PDF XChange Viewer ActiveX SDK of one point Array index Description X coordinate of bottom left point Y coordinate of bottom left point X coordinate of bottom right point Y coordinate of bottom right point X coordinate of top right point Y coordinate of top right point X coordinate of top left point N Of OND CO Y coordinate of top left point See Also Objects Documents lt ltem gt Pages lt Item gt Text Chars lt ltem gt PXCVA OutArgs 2 2 2 19 8 Quads 2 2 3 This object represents the coordinates of a quadrilateral area s on a PDF page Coordinates is stored in points Contained Objects Name Type Description Value Array of Double Contains an array of numbers which specify the R coordinates of the quadrilateral area s Remarks Coordinates are stored in an array of doubles where each pair specifies the X and Y coordinates of one point each eight doubles four points specifies the quadrilateral area Array index Description X coordinate of bottom left point of the first
305. tFromResult Remarks For example in pseudocode 170 PDF XChange Viewer ActiveX SDK place web link over first 10 characters on first page DoVerb Documents 0 Pages 0 Text AddLink Dataln 0 10 www server place go to page link to 10th page over first 10 characters on first DoVerb Documents 0 Pages 0 Text AddLink Dataln 0 10 9 NULL 0 See Also IPDFXCview DoVerb Objects Documents lt ltem gt Pages lt ltem gt Text Gets text from a specified range on the page Name Get Arguments 1 Yes LONG The index of the first character of the get range 2 Yes LONG The count of characters to get 3 No Boolea Exclude new line characters from output CR LF Default value is false n Outputs 1 BSTR Output text Return Value Returns S_OK on success or an error value otherwise To obtain the text description of a received error code use IPDFXCview GetTextFromResult Remarks For example in pseudocode Gets first 10 characters on the page DoVerb Documents 0 Pages 0 Text Get Dataln 0 10 DataOut 0 See Also IPDFXCview DoVerb Objects Documents lt ltem gt Pages lt ltem gt Text Gets text coordinates from a specified character range on the page Name GetQuads Arguments Reference 1 Yes LONG The index of the first character of the range 2 Yes LONG The count of characters in range Outputs Can contains four or more pairs of numbers These number
306. tVerb docID NULL GetSelectedField NULL DataOut 0 string fieldName DataOut if fieldName Forml Groupl TextBox1 0 To obtain the selected widget exactly use the additional Objects Documents lt ltem gt GetSelectedWidget See Also IPDFEXCview DoDocumentVerb Objects Documents lt Item gt SelectField Gets selected page thumbnails in the thumbnails view of the document Name GetSelectedPageThumbnails Outputs Can contains one or more integer numbers which represents the indexes 0 based of the selected page thumbnails in the thumbnails view of the document These numbers will be obtained through SAFEARRAY Return Value Returns S_OK on success or an error value otherwise To obtain the text description of a received error code use IPDFXCview GetTextFromResult Remarks For example in pseudocode DoDocumentVerb docId GetSelectedPageThumbnails Dataln DataOut 0 int firstPageThumbSel DataOut 0 int secondPageThumbSel DataOut 1 For simplify in out operations with SAFEARRAY you can use the IPDFXCaras object obtain a new IPDFXCargs object with array of numbers Reference 1 DoDocumentVerb docId GetSelectedPageThumbnails Dataln DataOut PXCVA_ IPDFXCargsObj args DataOut int firstPageThumbSel args 0 int secondPageThumbSel args 1 r See Also IPDFXCview DoVerb IPDFXCview DoDocumentVerb Gets identification info of the selected widget visual object for
307. tained Objects Count Integer Contains number of all accessible styles R Remarks This object is an array of items where each item is represented as lt ltem gt For more information about object naming notation see Object Name Notation Examples for usage in pseudocode Enumerate all styles for cloudy comment GetProperty Commenting Cloud Styles Count DataOut 0 Count DataOut for i 0 to Count 1 GetProperty Commenting Cloud Styles i ID DataOut 0 See Also Objects Commenting IPDFXCview DoVerb IPDFXCview GetProperty IPDFXCview SetProperty Defines item template for each commenting cloudy style Contained Objects ID Integer Specifies the unique ID of the comment style RS Name String Defines name of comment style RWS FColor Integer Specifies fill color for the comment String For possible named values see the Colors RWS Default value is 1 none SColor Integer Specifies stroke color for the comment 106 PDF XChange Viewer ActiveX SDK String RWS Opacity Double RWS BlendMode Integer String RWS Border Group RWS DefSubj String RWS DefSubjMode Integer String RWS See Also Objects Commenting For possible named values see the Colors Default value is RGB 255 0 0 red Specifies the opacity of the comment Default value is 1 0 100 opacity Specifies the blend mode for the comment For possible named va
308. ted after its String usage RWS For possible named values see the Booleans Default value is 1 See Also Objects Tools Objects Commenting 2 2 2 17 4 Cloud The Cloud Tool draws a cloud outline around selected parts of the PDF page Contained Objects Style Integer Defines ID of current commenting style for this RWS tool 227 228 PDF XChange Viewer ActiveX SDK KeepSelected String RWS See Also Objects Tools Objects Commenting 2 2 2 17 5 Distance Integer See also Objects Commenting Cloud Styles Defines if this tool still be selected after its usage For possible named values see the Booleans Default value is 1 Distance tool permits measuring the distance between two points Contained Objects Style Integer RWS KeepSelected Integer String RWS See Also Objects Tools Objects Commenting 2 2 2 17 6 Eraser Defines ID of current commenting style for this tool See also Objects Commenting Distance Styles Defines if this tool still be selected after its usage For possible named values see the Booleans Default value is 1 This tool allows to erase any part of a pencil drawn annotation Contained Objects Diameter Double RWS KeepSelected Integer String RWS See Also Objects Tools 2 2 2 17 7 FileAttachment Defines diameter for the eraser tool Default value is 10 pt Defines if this tool still be selected after its usage For possib
309. teger RW Integer String RW Integer Description Specifies filter for receiving selection changes events For possible named values see the Print Notifications Filter Flags You may use a combination of one or more of the following values Default value is 0 None Represents type of the print notification Contains one value from the Print Notifications Filter Flags enumeration except None and All values Public name of the printer which is being used for printing of the document Contains the ID of the document which is being printed Contains the index 0 based of the sheet which is printed now Can be undefined 1 for some print notifications Contains the exact quantity of sheets which will be printed out Contains the index 0 based of the document s page which is printed now Can be undefined 1 for some print notifications Contains the exact quantity of the document s pages which will be printed out Number of copies Can be changed at Type Prepare stage only Flag to collate copies Can be changed at Type Prepare stage only For possible named values see the Booleans Default value is 0 false Allows to break printing process Reference 193 String For possible named values see the Booleans RW Default value is 0 false Remarks Example for usage in pseudocode 1 enable receiving all printing events SetProperty Notifications Print Filter A11 0 2 catch
310. the OCG is off More advanced visibility behavior can be achieved by using multiple OCGs and different visibility mappings Template Template objects are named pages within the document These pages may be hidden or visible and can be copied or spawned They are typically used to dynamically create content for example to add pages to an invoice on overflow util A static JavaScript object that defines a number of utility methods and convenience functions for string and date formatting and parsing See Also IPDFXCview RunJavaScript Annotation This object represents an PDF annotation Supported Properties All are supported Supported Methods destroy getProps SOLE EOS See Also IPDFXCview RunJavaScript JavaScript for Acrobat API Reference app A static JavaScript object that represents the PDF XChange Viewer control It defines a number of document specific functions plus a variety of utility routines and convenience functions Supported Properties activeDocs calculate 273 PDF XChange Viewer ActiveX SDK formsVersion fs fullscreen language numPlugIns platform plugins printColorProfiles printerNames thermometer toolbar toolbarHorizontal toolbarVertical viewerType viewerVariation viewerVersion Supported Methods alert beep execMenultem getPath mailMsg newDoc openDoc popUpMenu eal xX popUpMenu responce clearInterval clearTimeOut setIterval setTimeOut See
311. the page R index of first character Length Integer Represents the line length character count R Quads Group Contains line coordinates on page R See Also Objects Documents Objects Documents lt ltem gt Pages lt ltem gt Text Lines 2 2 2 4 1 3 Form Allows to specify settings for PDF form for the document Contained Objects Name Type Description HighlightFields Group Defines form fields highlight settings RW See Also IPDFXCview DoVerb IPDFXCview GetProperty IPDFXCview SetProperty Allows to specify form fields highlight settings for the document Contained Objects Name Type Description Visible Integer Specifies visibility of the form highlight String For possible named values see the Booleans RW Default value is 0 Mask Integer Specifies initial highlight mask to highlight selected String form fields RW For possible named values see Highlight Form Fields Masks This value can be a combination of the mask integer values RequiredOnly Integer Highlight only required form fields String For possible named values see the Booleans RW Default value is 0 Remarks To set color of the highlight see Objects Forms HighlightFields Examples for usage in pseudocode 1 Set highlight color SetProperty Forms HighlightFields FillColor Blue 0 SetProperty Forms HighlightFields BorderColor Red 0 SetProperty Documents 4095 Form HighlightFields Visible true 0
312. the simplified version of the DoVerb method for working with open documents ExportDocument Export the opened document with the parameters defined earlier b e names section FlushDocument Flush all of the user s changes for opened document GetActiveDocument Returns the unique identifier of the active document GetDocumentID Returns the unique identifier of the opened document which is specified by order index GetDocumentIndex Returns the order index of the opened document which is Reference 21 specified by unique identifier GetDocumentProperty This method returns property values of the specified document GetDocumentsCount Returns number of all opened documents OpenDocument Open a document by the specified URL local file name or by the open file dialog PrintDocument Print the opened document with the parameters defined earlier by Objects Print names section SaveDocument Save the document SetDocumentProperty This method sets property values of the specified document See Also Document Methods Auxiliary Methods 2 1 1 2 1 ActivateDocument Activates the opened document This method is a simplified variant of a special call to the DoVerb method Syntax HRESULT ActivateDocument LONG ID LONG Flags i Parameters ID in LONG that specifies unique identifier of the opened document Flags in LONG that specifies optional flags For more information see PXCVA Flags This argument can be 0
313. tion Disabled 0 This command is disabled currently and cannot be executed Offline Turns off the command in control s UI All Ul locations of the Off 1 command will be disabled This state can be removed only by the external application by setting the state into Online value Reference 2 Online o Turns on the command in control s Ul i e to remove Offline state On only See Also Objects Commands lt ltem gt 2 2 3 9 Comment Subject Modes Supported Values Default 0 Use default subject Custom Use custom subject text which is specified in DefSubj property 1 of specific comment style See for example Objects Commenting Line Styles lt ltem gt DefSubj Common 2 Use common subject text which is specified in the Objects Commenting AnnotCommonSub j property 2 2 3 10 Content Monitor States Supported Values Disables the Content Monitor The document s property 0 Objects Documents lt ltem gt ContentReady will be undefined and non actual always On Enables the Content Monitor The document s property 1 Objects Documents lt ltem gt ContentReady will be actual Notification about each change of this property can be received through _IPDEXCviewE vents OnE vent Once Enables the Content Monitor for the first change of the 2 Objects Documents lt ltem gt ContentReady only and disables after See Also Objects Documents ContentMonitor Objects Documents lt ltem gt ContentReady 2 2 3 11 Context Men
314. tion see Object Name Notation Examples for usage in pseudocode Enumerate all styles for perimeter comment GetProperty Commenting Perimeter Styles Count DataOut 0 Count Data0ut for i 0 to Count 1 GetProperty Commenting Perimeter Styles i ID DataOut 0 See Also Objects Commenting IPDFXCview DoVerb IPDFXCview GetProperty IPDFXCview SetProperty Defines item template for each commenting perimeter style Contained Objects Name Type Description ID Integer Specifies the unique ID of the comment style RS Name String Defines name of comment style RWS Start Integer Specifies line starting style String For possible named values see the Line Ending RWS Default value is 5 ClosedArrow End Integer Specifies line endings style String For possible named values see the Line Ending RWS Default value is 5 ClosedArrow FColor Integer Specifies fill color for the comment String For possible named values see the Colors RWS Default value is RGB 255 0 0 red SColor Integer Specifies stroke color for the comment String For possible named values see the Colors RWS Default value is RGB 255 0 0 red Opacity Double Specifies the opacity of the comment RWS Default value is 1 0 100 opacity BlendMode Integer Specifies the blend mode for the comment String For possible named values see the Blend RWS Modes Default value is 0 Normal Border Group
315. to one sheet ScaleType Integer String Type of scaling to apply during printing RWS For possible values see the Print Scale Types Default value is 0 TextAsCurves Integer String Allows the text to be printed as curves RWS For possible values see the Print Text as Curves Default value is 1 ForEmbeddedFonts ToFile Integer String Specifies printing to file RW For possible named values see the Booleans Default value is 0 See Also IPDFXCview PrintDocument IP DFXCview DoVerb IPDFXCview GetProperty IPDFXCview SetProperty 2 2 2 14 1 ScaleSimple Represents advanced options for some simple print scale types such as one PDF page to one sheet of paper See also Print Scale Types Contained Objects Name Type AutoRotate Integer String RWS AutoCentre Integer String RWS PaperByPage Integer String RW See Also Description Auto rotate pages to match selected paper orientation during printing For possible values see the Booleans Default value is 0 Auto center pages to match selected paper type during printing For possible values see the Booleans Default value is 0 If selected then the appropriate paper will be chosen from list of available papers Print margins are ignored For possible values see the Booleans Default value is 0 Print Scale Types IPDFXCview PrintDocument 2 2 2 15Prompts Controls and overrides UI confirmations prompts and messages To receive
316. to your applications coming late 2008 Trial Versions All of our products are available as fully functional evaluation downloads for you to try before you buy usually printing a demo watermark stamp to differentiate between output created with the evaluation or licensed versions We recommend that all users test the product they wish to buy first thus ensuring you only buy when you are satisfied that the product meets your needs Trial versions are available from our web site For more details visit our web site or contact us by email 300 PDF XChange Viewer ActiveX SDK Commands List 59 Contact 298 Contact Us 298 0 Other Products 298 STE Tracker Software Products 298
317. tputs 1 String The name of the annotation object Return Value Returns S_OK on success or an error value otherwise To obtain the text description of a received error code use IPDFXCview GetTextFromResult 164 PDF XChange Viewer ActiveX SDK Remarks For example in pseudocode Dataln 1 to second annotation on the page DoVerb Documents 0 Pages 2 GetAnnotName Dataln DataOut 0 string annotName DataOut See Also IPDFXCview DoVerb Objects Documents lt ltem gt Gets rectangle of the annotation object on the page Name GetAnnotRect Arguments Req Type Description 1 Yes LONG The zero based index of the annotation object on the page Outputs If successful then DataOut will contain the SAFEARRAY with four numbers in order left top right bottom the rectangle of the annotation on the page in normal page coordinate system Return Value Returns S_OK on success or an error value otherwise To obtain the text description of a received error code use IPDFXCview GetTextFromResult Remarks For example in pseudocode Dataln 1 to second annotation on the page DoVerb Documents 0 Pages 2 GetAnnotRect Dataln DataOut 0 double left DataOut 0 double top Data0ut 1 double right DataOut 2 double bottom DataOut 3 See Also IPDFXCview DoVerb Objects Documents lt ltem gt Gets count of annotations on the page Name GetAnnotsCount A
318. tracker software com We also have offices and representatives in several other locations including United States France Germany and Ukraine in some instances after an initial contact with our UK office you may be referred to one of these locations if appropriate To contact us for support related issues Please see this FAQ page before contacting our support department it may save you the task We recommend you use our Web Based User Support Forums and scan the existing library of questions and answers if you don t find a suitable response then feel free to post your own all questions receive an answer within 1 business day at worst If for any reason you have difficulty linking to the forum or feel it is inappropriate for your needs then please email sales tracker software com we regret we cannot answer support requests via telephone without a valid support contract The number above is answered by administration staff who are not trained to assist with technical problems To Contact us for Sales Administration related issues sales Otracker software com End User Developer and OEM admin tracker software com All this information and a good deal more is available via our web site and the links provided Magazine reviews and press requests We are keen to assist in any way possible please contact our sales department for any information or help you may require Products Products Offered By Tracker Software Products Updates
319. type of paper Default value is A4 Specifies landscape paper orientation for new document For possible named values see the Booleans Default value is 0 Specifies the page left margin in points Specifies the page top margin in points Specifies the page right margin in points Specifies the page bottom margin in points Description Count columns on the page Default value is 1 Space between columns in points Default value is 5 mm 14 2 pt Count rows on the page Default value is 1 Space between rows in points Default value is 5 mm 14 2 pt Aligning in the column See the Image Align Types Default value is Center 1 Aligning in the row See the Image Align Types Default value is Center 1 Description Scaling conversion options for colored images Scaling conversion options for indexed images Scaling conversation options for monochrome images Enables dithering for colored images when conversion to black amp white or monochrome is specified For possible named values see the Booleans Reference 201 Default value is 1 IndexedDithering Integer Enables dithering for indexed images when String conversion to black amp white or monochrome is RWS specified For possible named values see the Booleans Default value is 1 MonoThreshold Integer Specifies threshold for monochrome images RWS when conversion to black amp white is specified Should be between 1 and 255
320. u User Choices Supported Values Default 0 Deny 1 Skip 1 See Also 250 PDF XChange Viewer ActiveX SDK Objects Notifications ContextMenu 2 2 3 12Dash Types Supported Values Default Dot 2 units off 2 units on Dot3 2 3 off 2 on Dot4 3 4 off 4 on DashDot 4 A off 3 on 2 off 3 on DotDash 5 4 off 3 on 16 off 3 on DashDot2 6 8 off 4 on 4 off 4 on See Also Objects Border 2 2 3 13 Document Bars Supported Document Bars Identifiers Options 33262 Specifies the document s Options toolbar PagesNavgation 33263 Specifies the document s Pages Navigation toolbar PagesLayout 33264 Specifies the document s Pages Layout toolbar Launch 33265 Specifies the document s Launch toolbar Remarks Examples for usage in pseudocode 1 get Options toolbar visibility Cerpoeumentproperty 4o95 View Bars Options Visible DataOut 0 or GetDocumentProperty 4095 View Bars 33262 Visible DataOut 0 2 show Options toolbar SetDoc nentPr perty anes View Bars Options Visible Dataln 1 0 or SetDocumentProperty 4095 View Bars 33262 Visible Dataln 1 0 See Also Objects Documents lt Item gt View 2 2 3 14Document Initial View Modes Supported Values Reference 251 Automatic 4 Selects view of the document automatically Auto PageOnly 1 Displays pages view only BookmarksAndPa 3 Displays bookmarks and pages only ge ThumbnailsAndPa 5 Displays thumbnails and
321. uch files in the Application Software and to deploy the Application Software internally and or distribute the Application Software directly or through customary distribution channels to end users to the limits prescribed below in Section 4 Duplication and Distribution of Royalty Bearing Versions below If Licensee wishes to use an OEM who will modify the Application Software and copy it Licensee must first obtain an OEM distribution license from TRACKER or must require the OEM to obtain a license from TRACKER Duplication or Redistribution of the Application Software or any portion thereof by the users of the Application Software without a separate written redistribution license from TRACKER is prohibited If the enclosed Software is packaged For Evaluation Only no right to copy and or distribute the Redistributables is granted No rights to copy or redistribute the Application Software are granted until such time as Licensee has properly licensed and registered the Software with TRACKER and otherwise complied with this Agreement Unless otherwise agreed in writing by Tracker 4 DUPLICATION AND DISTRIBUTION OF ROYALTY BEARING VERSIONS OF THE SOFTWARE The enclosed software is a Royalty Bearing software development kit and may not be distributed Free of Royalties your initial purchase of one of the software products detailed below includes the right Subject to your acceptance of the terms and conditions of this agreement to embed within yo
322. ue Returns S_OK if successful or an error value otherwise To obtain the text description of a received error code use GetTextFromResult Remarks 30 PDF XChange Viewer ActiveX SDK Call to save or copy the opened document specified by rp To display the standard save file dialog you should pass NULL to Dest FileName If you want to skip possible error dialogs then you must specify the PXCVA_Flags PXCVA_NoUI flag in Flags See Also IPDFXCview OpenDocument IPDFXCview FlushDocument Objects Documents lt ltem gt Save Objects Notifications BeforeSaveDoc Objects Notifications DocSaved Objects Documents UseStreams Directly 2 1 1 2 15 SetDocumentProperty This method allows you to set property values for the specified document This method is a simplified variant of a special call to the DoVerb method Syntax HRESULT SetDocumentProperty LONG ID BSTR Name VARIANT Dataln LONG Flags y Parameters ID in LONG that specifies the unique identifier of the opened document This argument can be 0 for the active document Name in BSTR that specifies the full name of the document s property as string identifier For more information see Objects Documents Dataln in VARIANT that specifies the new value of the document s property specified by Name Flags in LONG that specifies optional flags This argument can be 0 Also you can pass the PXCVA Flags PXCVA NoApply to instruct caching
323. ue is 0 automatic mode Contains maximum number of special threads for rendering of pages contents in all opened documents Default value is 0 automatic mode Contains maximum number of special threads for pages thumbnails creation in all opened documents Default value is 0 automatic mode Allows to enable the synchronous mode of PDF content rendering For possible named values see the Booleans Default value is 0 asynchronous rendering Specifies to use the MemExact property For possible named values see the Booleans Default value is 0 control will use the MemUsage Contains maximum number megabytes MB of RAM which can be used by control in peak Default value is 250 MB IPDFXCview DoVerb IPDFXCview GetProperty IPDFXCview SetProperty 2 2 2 14Print Contains all supported properties for document printing See also IPDFXCview PrintDocument Contained Objects Name AsGrayscale Aslmages AslmagesMaxResol Type Description Integer String Causes all color information to be converted to RWS grayscale image during printing For possible named values see the Booleans Default value is 0 Integer String Converts all pages to images when printing RWS For possible named values see the Booleans Default value is 0 Integer Sets or gets the maximum page resolution in pixels RWS per inch DPI for Print as Images Valid values are 50 72 96 100 150 300 400 600 DPI Default value is
324. ument 3651 6 SinglePage 3289 SetTransitions Annots Show All Comments Annots Show all Types Amnots Attachments Annots Show Types Annots Drawing ShowGrid ShowGuides Annots Comments ShowRulers Amnots Stamp Amnots ShowStampsPalette Annots Markup DIGSIG NextSigPullRight SinglePage wil be used for each new comment as Default for Current Comment Style Pages Transitions Setup Measurement Show All Bars Show all bars from users set Show All Comments All Types Attachments Show Broken Info This Document is Broken Click Here to Show Details Customize Display Dialog allowing Bar Customization Show by Type Show Comments Styles Palette Drawing Markups Show Grid Show Guides Notes Show PDF A Info This Document is a PDF A compliant file Click Here to Show Details Show Rulers Stamps Show Stamps Palette Text Editing Markups Show XFA Info This Document contains an XFA Form Click Here to Show Details Sign Document Digitally Sign a Document Single Page o PDF XChange Viewer ActiveX SDK SnapOnOff Snapshot Copy PageSelectio n Snapshot SelectEntirePage SnapshotToo SnapToGrid SnapToGuides SnapToObjects SplitWindow StampTool StartFullSearch StickyNoteTool StopFullSearch SummarizeAnnots SuportForum TextBoxTool TextEditor Bold TextEditor Italic TextEditor Strikeout TextEditor Subscript TextEditor Superscript TextEditor Underline TileWind
325. ur software application the PDF XChange Viewer SDK by accessing either the DLL or ActiveX based versions of the PDF XChange Viewer SDK subject to an appropriate purchase and distribute a specified number of user licenses to your end user software application clients When this limit is reached you must purchase additional distribution licenses prior to any further distribution or remove the software from your application prior to further distribution of your application When calculating your distribution of licenses each user having access to use of your application incorporating this software must be accounted for individually Server Concurrent and Site licensing models are not acceptable or applicable for this purpose The following Tracker developer kits include limited distribution rights to the software for an initial specified number of Client Desktop License Packs CDLP s as detailed below this is an indication only and the actual specified and agreed number of licenses may be different and is detailed and accepted by the parties when signed on the final page of this document PDF XChange Viewer Basic SDK Pack Initial max distribution included 25 000 Single user Licenses available in a variety of predetermined or negotiated license packs PDF XChange PRO SDK Version 4 max distribution included 7500 Single user Licenses PDF XChange Drivers API SDK Version 4 max distribution included 2500 Single user Licenses PDF XChange Too
326. user application is a specific application program that is licensed to a person or firm for business or personal use and not with a view toward redistributing the application or any part of the application and may be either an application that is used by Licensee internally or an application that is commercially distributed to end users for their use A user of an end user application may not modify or redistribute the application and may not copy it other than for archival purposes Licensee s license agreement covering the Application Software must contain restrictions prohibiting redistribution modification and copying of the Application Software The license rights hereunder do not apply to development and deployment of software products such as Printer Drivers ActiveX controls plug ins authoring tools development toolkits compilers operating systems and also software products where a significant function is to generate PDF format files as defined by ISO Standards body and other file formats from 3rd party software applications not developed by the licensee indirectly or otherwise such as Microsofts Office suite and component applications other than for the purpose of creating and then storing such files within a structured application for the archival and management of documents that is developed by the licensee and any other software not falling within the definition of an end user application Further Licensee may not un
327. veSettings 2 2 1 40ShowStampsCollection Shows hides the specified stamps collection Name ShowStampsCollection Arguments Req Type Description 1 Yes BSTR Name of stamps collection 2 No LONG Specify non zero value to show or zero to hide Return Value Returns S_OK on success or an error value otherwise To obtain the text description of a received error code use IPDFXCview GetTextFromResult See Also IPDFXCview DoVerb Objects Commenting HideStdStamps Collections 2 2 1 41 SummarizeDocumentAnnots Summarizes all comments from a document to a new document file using parameters previously defined by Objects Operations SummarizeAnnots PDF XChange Viewer ActiveX SDK Name SummarizeDocumentAnnots Arguments Req Type Description 1 Yes LONG The unique identifier of the document or full file name of the document BSTR Return Value Returns S_OK on success or an error value otherwise To obtain the text description of a received error code use IPDFXCview GetTextFromResult See Also IPDFXCview DoVerb Objects Operations SummarizeAnnots 2 2 2 Objects Many methods of the interface require a special name as input string argument ObjectName or Name argument see IPDFXCview DoVerb IPDFXCview GetProperty IPDFXCview SetProperty for example This argument represents the unique abstract named object simple property group of objects array of items The common syntax of these strings may be repre
328. wAllAccelerators DataOut 0 result DataOut 1 i e all key accelerators are allowed 1 2 get named value DoVerb General AllowAllAccelerators getNamed Dataln DataOut 0 or GetProperty General AllowAllAccelerators DataOut PXCVA_GetNamed result Data0ut True i e all key accelerators are allowed 2 1 set value DoVerb General AllowAllAccelerators set Dataln 1 DataOut 0 ES or SetProperty General AllowAllAccelerators Dataln 1 0 2 2 set named value DoVerb General AllowAllAccelerators set Dataln True DataOut 0 or SetProperty General AllowAllAccelerators Dataln True 0 Attributes of named objects R readable W writable S storable i e can be saved restored from to an external storage file memory stream etc Top Level Objects Top Object Name Type Description ColorManagement Array Controls the colors of the displayed documents RWS Commands Array Represents an array of all supported named UI RWS commands Commenting Group Controls for commenting RWS Documents Array Represents an array of all opened documents and RW provides more operations with them Export Group Represents all supported properties for export of RWS documents to an external formats images text See also IPDFXCview ExportDocument Find Group Contains all supported properties for simple text RWS searching in active document
329. wTool 3312 Annots Tool Arrow Tool 3 LineArrowMenultem CalloutToo 3320 Annots Tool Callout Tool 1 FreeTextCalloutMenultem CascadeWindows 5765 Cascade Cascade 0 Arrange Windows so they Overlap CheckForUpdates 3317 Updates Check for Updates 9 s PDF XChange Viewer ActiveX SDK Clear 5763 2 ClearTextFormattin 3316 g 8 Close 5760 2 CloseAll 3303 8 CloseAllPopups 3643 9 CloseAllWindows 3294 2 CloseWindow 5768 2 CloudTool 3313 0 Continuous 3289 6 ContinuousFacing 3289 8 Copy 5763 4 CopyAsFormattedT 3318 ext 3 CopyAsPlainText 3318 2 CopyAsRichConten 3318 t 4 CopyFullFileName 3325 7 CropPages 3308 2 CrossOutSelText 3320 9 CrossOutTextTool 3322 3 Cut 5763 5 Delete 3313 6 DeleteAllPageGuid 3652 es 5 DeleteGuidesOnCu 3652 rrentPage 4 DeletePages 3308 4 3317 6 DeleteReply Clear Close CloseAll Annots ClosePopups CloseAll Annots Tool PolygonCloudMenultem OneColumn TwoColumns Copy CropPages Annots Tool StrikeOutMenultem Cut Delete DeletePages Clear Erase the Selection Clear Text Formatting Close Close the Active Document Close All Close All Opened Documents Close All Pop Ups Close All Documents Cloud Tool Continuous Continuous Facing Copy Copy the Selection and Place on the Clipboard Copy As Formatted Text Copy As Plain Text Copy As Rich Content Copy Full File Name Copy Full File Name of the Active Document to Clipboard Crop
330. will lookup all annotations in document for the specified name and stop on first match or 1 Yes LONG The zero based index of page with the annotation 2 Yes LONG The zero based index of annotation object on the page Return Value Returns S_OK on success or an error value otherwise To obtain the text description of a received error code use IPDFXCview GetTextFromResult Remarks Simple examples in pseudocode select annotation by name DoDocumentVerb docId NULL SelectAnnot DataIn myFineComment NULL select annotation by indexes DoDocumentVerb docId NULL SelectAnnot NULL PXCVA_NoUI Dataln pagelndex indexOnPage See Also IPDFXCview DoDocumentVerb Objects Documents lt ltem gt GetSelectedAnnot Selects a form field on the page and sets input focus for it The form field in PDF is not a visual object but each form field in the document may have one or more corresponding visual objects on page s which are called widgets Widget is a visual object for form field text box for text field check button for on off field etc So each form field can have a list of widgets which can be located at different places of page or on different pages may have different visual attributes colors borders fonts etc Name SelectField Arguments 1 Yes BSTR The full form field name Examples TextBox1 TextBox1 0 TextBox1 1 The suffixes 0 1 means the zero based ind
331. x14 262 PDF XChange Viewer ActiveX SDK AS 1 6 1 7 See Also 0x15 0x16 0x17 Objects Operations NewDocument 2 2 3 43Print Notifications Filter Flags Supported Values None All BeginDocument EndDocument BeginSheet EndSheet BeginPage EndPage Prepare Remarks The Prepare notify called once before start of printing At this stage you also can change Notifications Print Copies and Notifications Print Collate properties See Also Objects Notifications Print 2 2 3 44Print Scale Types Supported Values None No FitToMargins ReduceToMargins TileLarge No page scaling Print as original When printing a page may not fit in a chosen paper If a page appears to be too big for the given paper it will be reduced If a page appears to be too small for the given paper it will be increased In both cases printer margins for chosen paper are taken into account The size of a page will be reduced if the page is too big for the given paper If the page fits the paper its size will not be changed The printer margins for chosen paper are taken into account Allows to print PDF page onto multiple sheets of paper if the Reference 263 page is larger than the page sizes available on your printer TileAll 5 Allows to print all PDF pages onto multiple sheets of paper Mult 6 Multiple pages can be printed on the same sheet of paper Multiple Booklet Allows to create a booklet with pag
332. y OperationName This argument may be empty DataOut out Pointer to a VARIANT structure that receives output data dependent with the object specified by ObjectName and operation specified by OperationName This argument can be NULL Flags in LONG that specifies optional flags For more information see PXCVA_Flags This argument can be 0 Return Value Returns S_OK if successful or an error value otherwise To obtain the text description of a received error code use GetTextFromResult Remarks lf you want to pass only one argument to DataZn with no additional arguments or all other arguments are optional then you can pass this argument directly However if you want to pass more than one input argument then you should pass them by Datarn using a SAFEARRAY structure Unlike the DoVerb the name of object does not contain the document identification prefix Documents 4095 for example because the document is specified by ID argument already l e the call in pseudocode DoVerb Documents 4095 Title is equivalent to call DoDocumentVerb 4095 Title 2 PDF XChange Viewer ActiveX SDK See Also IPDFXCview OpenDocument IPDFXCview PrintDocument IPDFXCview ExportDocument IPDFXCview FlushDocument IPDFXCview SaveDocument IPDFXCview CloseDocument IPDFXCview GetDocumentProperty IPDFXCview SetDocumentProperty Objects Documents 2 1 1 2 5 ExportDocument Export the opened documen
333. y an existing field s properties such as border color or font the JavaScript user can use the Field object to perform the same modifications Supported Properties All are supported Supported Methods browseForFileToSubmit buttonGetCaption buttonSetCaption clearItems getArray getItemAt insertItemAt celeste een isBoxChecked isDefaultChecked checkThisBox defaultIsChecked Scenes setAction secrocus See Also IPDFXCview RunJavaScript JavaScript for Acrobat API Reference 2 3 8 FullScreen The interface to fullscreen presentation mode preferences and properties Supported Properties All are supported 2 3 9 2 3 10 2 3 11 Reference Supported Methods There are no methods for this object See Also IPDFXCview RunJavaS cript JavaScript for Acrobat API Reference global This is a static JavaScript object that allows you to share data between documents and to have data be persistent across sessions Such data is called persistent global data Global data sharing and notification across documents is done through a subscription mechanism which allows you to monitor global data variables and report their value changes across documents Supported Properties All are supported Supported Methods All are supported See Also IPDFXCview RunJavaScript JavaScript for Acrobat API Reference identity This is a static object that identifies the current user of the application Supported Properties
334. y within developed applications the purchase of an appropriate upgrade allowing the continued use and distribution of Viewer SDK enabled applications is required should the developer not wish to purchase such an upgrade the functionality provided must be removed from the developers published applications within 28 days of such a release and further distribution of any products containing the provided functionality halted immediately Existing end user installations of the Developers applications shall not be affected Until such time as the developer chooses to release updated versions of their own application to such end user installations upon which any updated application the developer may provide to clients must also be provided excluding any PDF XChange Viewer SDK functionality unless a paid for appropriate upgrade has been purchased which would allow this 16 GENERAL This Agreement shall be interpreted construed and enforced according to the laws of Canada In the event of any action under this Agreement the parties agree that courts located in Canada will have exclusive jurisdiction and that a suit may only be brought in Canada and Licensee submits itself for the jurisdiction and venue of the courts located in Canada This Agreement constitutes the entire agreement and understanding of the parties and may be modified only in writing signed by both parties No officer salesman or agent has any authority to obligate TRACKER by any ter
335. yboard ii ENA A A RA E A E E N N E Sines Mouse Print Selection TEXIEJIIOT CO a E eee ean anata are OPEr tONS i vesien An e O EE SEvak Sre EE Nie eS DeletePages a NS atte es ee es ee eels ExtractPages iu A eel Sree cae erate er tine an abet ates Contents InsertEmpty Pages INS6rtPageS A A A Carnie New Documents a at asas FromBlank Fromimages Paper Layout Graphics Labels FromText Paper Layout ColSep FileHeader Line RotatePages SUMMANIZ CANNOTS 22 62 22 oer IA recast eran e A On A s 205 Output a ean ee ae i ER a ORO 206 PDF RTF TXT HIME sxe dati Abd oda AA hide ea ieee a a ae 208 PageDIs ii taa 208 PONCE ala ee en EET 210 Pinte Zoe Greene A AR eet eae A ee a eet ee es 210 Scale SINP AAA ge evi Mee eee 212 PROMPIS SARE E AE E E wtveebanundebscvecaeenscbewviidavedivewesresentt A E E E 212 Conf rmDocumenthe Save sinin nn A A AA et 213 ContitmMDoCuUumMentSav enera r e e dda pai A data 214 ContirmDropkile e LA AA AAA ContirmhleReplaca cirio ea ConfirmLaunchFile CONTI MOP Site acini eer Ai ire reine Createrol derrita A ee hae ei ers EnterDocumentPas Sw Ordino is ctbetivs ales 221 FileWriteError tia 222 Search eeeeeeeeeeeees Options What Where TOOS A A tE AAA AAA taa Area Arrow Callout Cloud Distance Eraser FileAttachment Sta 228 Highlight irrita A EA e 229 Line Link A iiarntinnianii Alin aan dade Sind 230 Oval Aae a a a Ate Goainte yn ada ned sb iereshen usin need 230 A A

PDF-XChange Viewer ActiveX SDK - Tracker Software Products Ltd

Contents

Download Pdf Manuals

Related Search

Related Contents