Toolkit Release Notes Build 2016.1.0.16340
Build 2016.1.0.16340
This is the initial release for Toolkit 2016 (Build 2016.1.0.16340). It includes bug fixes and new features.
- Software Requirements
- Hardware Requirements
- New Features
- Bug Fixes
- Additional Solutions
- Known Bugs
- Installation and Getting Started
- API Reference
Software Requirements
The following software is required to successfully use Toolkit.
Server
- Windows Server® 2008 (32- or 64-bit edition) OR
- Windows Server® 2012 R2
- Microsoft® .NET Framework is required to use Toolkit's .NET component
(1.1 or 2.0 minimum — if .NET is not detected during installation, you are offered the option to have .NET installed for you.)
Desktop
(32- or 64-bit editions)
- Microsoft Windows® 8.1; 8; 7; OR
- Microsoft Windows VistaTM OR
- Microsoft Windows XP®
- Microsoft .NET Framework is required to use Toolkit's .NET component
(1.1 or 2.0 minimum — if .NET is not detected during installation, you are offered the option to have .NET installed for you.)
Hardware Requirements
The minimum hardware requirements for Toolkit are:
Server and desktop
- 125 MB of RAM
- 25 MB of hard disk space (for application)
New Features
- XMP Management
Toolkit now provides a system of calls to directly manage XMP metadata. Use XMP metadata to tag your PDFs for categorizing; searching and retrieving; and distributing your documents. Includes support for adding Dublin Core properties.
- PDF Compression
Make compact and efficient documents. The SetPDFCompression method utilizes object streams and cross reference streams to reduce the size of your output PDF.
- GetTextHeight method
When placing text within a PDF document, developers need to know the size of the text block. The existing GetTextWidth currently returns the width of the text block, the new GetTextHeight method also provides the height.
- ClearPDFSecurity
After using SetOutputSecurity method to encrypt a file, you may need to duplicate the file without the security settings. ClearPDFSecurity strips out any passwords and permissions configured in the API settings.
- AES 256 Encryption
The new SetPDFSecurity and EncryptPDF methods provide the Advanced Encryption Standard (AES) 256 security option, which is the accepted standard algorithm of the U.S. and Canadian governments.
Enhancements
- CopyForm and MergeFile now include any attachments or embedded files.
Toolkit previously required attached files to be re-embedded after merging. Now embedded files remain attached to the merged output file.
- CopyForm returns a warning code when the the page number setting exceeds the number of pages.
When extracting pages from one PDF and adding them to another, a -1 is returned if the pages requested for extraction exceed the actual number of pages in the input file.
- The functions of the three SetOutputSecurity methods are now combined into one method—SetPDFSecurity—which uses parameters to select the encryption method.
Toolkit previously provided three methods, one for each type of encryption. Now AES-256 encryption is also available, and all security options are available from the SetPDFSecruity method.
- The functions of the three EncryptFile methods are now combined into one method—EncryptPDF—which uses parameters to select the encryption method.
Toolkit previously provided three methods for applying security when it will be the only operation performed, one method for each type of encryption. Now AES-256 encryption is also available, and all security options are available from the EncryptPDF method.
- New fields created with AddField can now be manipulated right away.
After adding a form field, you can immediately start to manipulate it. You no longer need to save, close, and open the PDF before performing other operations.
Bug Fixes
The following bugs were resolved since the last Toolkit release.
ID # | Description | Resolution |
3005 | Windows 2008, 64 bit, using .NET: calling MergeFile or CopyForm resulted in a StackOverflowException error. | After updates to the code base, the issue was resolved. |
3663 | File specific: After using CopyForm, the page tabs in the output PDF changed from red/orange to blue. | After updates to the code base, the issue was resolved. |
3953 | When the Arial Unicode MS fonts are not embedded, the fields in the output have truncated text. Cause: The rendering supplies a substitute font, and uses metrics that truncate the last character. | Select Use Local Fonts, and embed the fonts used in the original document. |
4495 | File specific: When a PDF was locked with a 128-bit encrypted user password, Toolkit could not open it using the password. | After updates to the code base, the issue was resolved. |
4683 | File specific: After calling CopyForm, the process failed with a Window's c0000005 error. | After updates to the code base, the issue was resolved. |
4690 | File specific: After calling MergeFile, the process failed without sending an error message. | After updates to the code base, the issue was resolved. |
4721 | File specific: After using MergeFile multiple times, the process failed with a runtime error. | After updates to the code base, the issue was resolved. |
10008 | File specific: After using EncryptFile128, the bookmarks in the output PDF contained garbled text. | After updates to the code base, the issue was resolved. |
10026 | After calling NumPages with one PDF, if CloseInputFile was not called before calling MergeFile to merge with another PDF, the output PDF file had garbled font. | After updates to the code base, the issue was resolved. |
10032 | File specific: When calling CopyForm using a PDF created from an older version of Adobe® Acrobat® (2.x), the process failed. | After updates to the code base, the issue was resolved. |
10039 | File specific: Unless DisableFontCache was called first, when MergeFile was called to merge two PDF files, the output PDF could not be opened in Adobe Reader®. | After updates to the code base, the issue was resolved. |
10086 | Japanese file paths: SetHeaderImage, SetHeaderJPEG, and SetHeaderTiff do not function when using Japanese file paths. | Toolkit was not handling Unicode characters or processing TIFF images correctly. The code was updated to resolve these issues. |
10106 | File specific: After calling CopyForm or MergeFile, the barcode in the output PDF did not display correctly. | After updates to the code base, the issue was resolved. |
10111 | File specific: Unless DisableFontCache was called before MergeFile, the output PDF was missing content. | Toolkit's internal string parsing function was updated, and this issue is resolved. |
10171 | Microsoft Windows Server 2012 R2 only: When AddLogo is used before CopyForm, Toolkit fails with a c0000005 error (memory address access violation). | Use MergeFile instead of CopyForm. |
11126 | File specific: After calling CopyForm or MergeFile, the output PDF was missing its image. | Changes to Toolkit's code to resolve similar issues also resolved this issue. |
11797 | File specific: When using a -997 or - 998 flag for SetFormFieldData the $ character was replaced with an empty square in the output PDF. | Code changes related to the handling of hex strings resolved this issue. |
11860 | After adding a form field with AddField, the PDF had to be saved, closed, and re-opened before performing other operations. | You can now perform other operations on a PDF immediately after adding a form field. |
12508 | File specific: after using CopyForm to merge the two PDFs, images were missing in the output PDF. | Changes to Toolkit's code to resolve similar issues also resolved this issue. |
12777 | After calling SetFormFieldData, the text in the JavaScript-controlled form field did not display. | After updates to the code base, the issue was resolved. |
13016 | When looping through input PDFs while calling GetInputFields, only the first PDF processed returned information. | The code was updated to resolve this issue. |
13042 | File specific: After calling OpenInputFile and CopyForm, after opening the output PDF and editing it in Adobe Acrobat, the PDF could not be saved. | After updates to the code base, the issue was resolved. |
Additional Solutions
These occurrences may happen when Toolkit is working as expected.
ID # | Incident | What to do |
4533 | When using the StitchPDF method to stitch a PDF with populated fields, the data in the fields is missing in the output file. | The stitching process does not transfer form fields. When stitching a PDF with populated fields, flatten the form fields by setting Flag -998 when using SetFormFieldData, and call FlattenRemainingFormFields before calling StitchPDF. |
13129 | After encrypting a file using EncryptPDF set to AES 256 bit, the file does not open in Adobe Reader 8 and 9. | Acrobat Reader versions 8 and 9 do not support AES 256-bit encryption. Use Acrobat Reader 10, 11, or higher to open the file. Or choose a lower encryption level. |
12965 | After calling AddField, and then calling SetFormFieldData and setting its -997 flag to flatten the field, the field is not flattened. | After calling AddField, close and reopen the PDF, then call SetFormFieldData and set the -997 flag to flatten the field. |
13026 | When using the OpenInputFile and CopyForm calls on PDFs with linked rather than embedded fonts, the process may use over 1GB of memory, because Windows font files are large. | Before calling CopyForm, call the DisableFontCache property and set it to true. |
Known Bugs
When a bug is fixed, it is moved to the Bug Fixes table.
NOTE: Even if a workaround exists, the bug may be fixed in a later release.
ID # | Known Issue | Workaround |
2566 | When BarWidthReduction is used to reduce the width of a barcode in the input file, the width of the barcode in the output PDF does not change. | No resolution at this time. |
2627 | When digitally signing a PDF containing compressed object streams, the output file is corrupt.
| At this time, Toolkit does not support writing out compressed object streams with digital signatures. |
2962 | When StichPDF is used to stitch pages to a PDF with different-sized pages, the CPU run at 90%, and takes a very long time to finish. Cause: The resource replacement code could be optimized when stitching different-sized pages. An enhancement request has been submitted for this. | No resolution for this file at this time. |
3082 | When using Barcode.Symbology with the values 125.126,127,128, no barcode is created in the output PDF. | At this time, use alternate symbologies. |
3249 | When iteratively merging or form filling the same file from a sample application, Toolkit's memory appears to progressively accumulate. Cause: This is not a memory leak; over successive runs, the memory accumulates proportionately and then stabilizes. This is due to a best fit memory issue with .NET string marshaling and Toolkit's native code interface. An enhancement request has been submitted to improve the string marshaling behavior. | No resolution for this application at this time. |
4128 | After a PDF with a logo was merged, the output PDF displays corrupt characters and returns an error "Cannot extract the embedded font". Cause: The PDF has Type 3 fonts which use XObject image resources that are not copied over. | Set DisableFontCache = true. |
4618 | After using AddField to add a text form field, the output file size is larger than expected. | No resolution at this time. |
4620 | After using AddLogo, the output file displays an error message when opened with Acrobat Version 8 or earlier. | No resolution at this time. |
4689 | After calling ParseDataStream, in the output PDF, the data in fields is misaligned and extends outside the field. | No resolution at this time. |
11884 | After using MergeFile with two PDFs that contain bookmarks, in the output PDF the bookmarks of one file are nested under the bookmarks of the other file, instead of displaying at the root level. | No resolution at this time. |
11885 | When using an evaluation key for Toolkit, watermarks are not displayed on all pages. | No resolution at this time. |
12427 | When fonts associated with end-user-defined characters (EUDCs) are used in the source file, after using PrintText or SetFont, the text does not display in the output PDF. | No resolution at this time. |
12475 | When using PrintImage to add .WMF images to a PDF, the images in the output PDF do not display as expected. | Convert the .WMF image to .PNG or .JPG before using Toolkit. |
12784 | When using AddBookmarks and CopyForm(i,i) to copy the source file one page at a time, the output PDF contains duplicate bookmarks that do not function. | If possible use Copyform (0,0) and copy all pages in one process. |
13086 | After inserting Japanese characters into a form field, the form field in the output PDF contains garbled characters. | No resolution at this time. |
13039 | After calling MergeFile, the output PDF uses different font in the signature field. | No resolution at this time. |
2645 4606 | File specific bugs. | Please contact customer support for further information. |
Documentation
The ActivePDF Help documents are not shipped with the product. The manual listed below is posted online so that the most current and accurate information is always available.
Installation and API Reference
Installation and API information is available in the Legacy documentation section for Toolkit API Reference Guide at: