PdfTools is a GeneXus External Object that brings together, in a single place, the most common functionalities for working with PDF files: merging them, adding text or watermarks, digitally signing them, protecting them with a password and permissions, reading and filling out forms, extracting their text, generating them from HTML, and transporting them as text (Base64).
These rules apply to all functionalities of the component, unless a specific functionality's detail document states otherwise.
- File paths: it is always recommended to use absolute paths for both source and destination files. The component typically runs inside an application server (for example IIS),
and the starting point for resolving a relative path can vary depending on the environment, so relying on relative paths is not a reliable practice in production.
- Page numbering: always starts at 1 (the first page of the document is page 1).
- Operation result: almost all functionalities return a uniform result indicating whether the operation succeeded or not and, in case of error, a descriptive message (Error/ErrorMessage).
In addition, some functionalities can report a warning (Warning/WarningMessage) independent of the error: the operation completed and produced its output file, but there is something worth reviewing (for example, a font that could not be resolved).
- No default values: the component does not apply default values automatically. For functionalities with appearance or configuration parameters (text, font size, color, angle,
opacity, page, etc.), the desired value must be explicitly indicated in each invocation, even when a "neutral" value is desired (for example, black color, angle 0, full opacity).
- Source files that are already protected are not supported: no functionality accepts, as a source file, a PDF that is already protected with a password (with or without permission
restrictions). The only functionality related to document protection (Restrict permissions) generates the output protection from an unprotected file; it does not allow modifying the
protection of an already protected file.
- Activity logging: all functionalities log their execution (start, end, warnings, errors, and received parameters) through the same logging mechanism already used by generated GeneXus
applications. See How to enable the log.
| Generator |
Requirement |
| .NET Framework |
.NET Framework 4.7.2 or higher |
| .NET |
.NET 6 or higher |
| Java |
To be defined |
| Generator |
Dependency used |
Why it was chosen |
| .NET Framework / .NET |
iTextSharp 4.1.6.0 |
It is the last version of this library distributed under a free-software license that allows commercial use at no cost. Later versions (including its successor, iText) changed their licensing to a model that requires publishing the full source code of any application that uses and distributes it (unless a commercial license is purchased). Since this component is meant to be used across different applications and clients, the version that does not impose that condition was prioritized. |
| Java |
To be defined |
Will be documented here once the dependency to be used for this generator is defined. |