Knowledgebase

Back to Articles List

Can I use the PDF-Tools SDK to create a summary of annotations contained in a document?

Question:

 Can I use the PDF-Tools SDK to create a summary of annotations contained in a document?

Answer:

Yes, there are several methods through which the PDF-Tools SDK can be used to achieve this goal:

Firstly, the PDF_XChange Viewer ActiveX SDK can be used in conjunction with JavaScript to return the required information. JavaScript extensions can be used to expose the Viewer application and its plugins to document authors, form designers and plug-in developers. The document below details the JavaScript for Acrobat API. All objects, properties and methods and documented and extensive code examples are presented:

JavaScript For Acrobat API Reference, Version 8 (PDF)

Secondly, the low-level API of the PRO SDK can be used to idenfity /Annots in documents, which avoids the need for the PDF_XChange Viewer ActiveX SDK. (This process identifies only annotations, and not widgets, which are the equivalent item for form fields). Please note that the low-level API is a powerful set of functions that enables developers to make changes at the most fundamental level of PDF files. Whilst this is very useful from a developmental perspective, indiscriminate use will undoubtedly lead to file corruption and other issues. Tracker Software will not accept any responsibility, should such problems arise, and we advise emphatically that developers exercise caution and patience when the low-level API is utilized. 

If you request support in relation to the low-level API then we will expect you to have a thorough working knowledge of PDF and the associated Adobe documentation. The best references for this are: 

The Adobe PDF Reference, Sixth Edition and

Document Management – Portable Document Format – Part 1: PDF 1.7

These documents provide a comprehensive description/analysis of PDF and are intended for developers of PDF-related software. They contain sufficient information to enable developers to write applications that read PDF files and/or modify their content. 

JavaScript can also be employed to manipulate PDF files. Authors, form designers and plug-in developers can utilize JavaScript extensions in order to expose most of the functionality of the Viewer application and its plug-ins. The following document describes the JavaScript for Acrobat API. All objects, properties and methods are documented and extensive code examples are included:

JavaScript for Acrobat API Reference, Version 8

Alternatively, the built-in "Summarize Comments" feature can be used for this purpose. It is available in the Comments tab.

Was this article helpful?
Yes No Somewhat