Repository navigation
Core API
Patrick Corless edited this page Oct 17, 2026
·
3 revisions
The core API provides a range of utilities for working with PDF documents and extracting their content, including:
- Page rendering: Render pages to any Java2D graphics context, making it easy to generate images or thumbnails (Page Captures).
- Text extraction and search: Extract page text along with its position, and search documents for words or phrases.
- Programmatic redaction: Permanently remove sensitive text and content from a document.
- Programmatic annotation creation: Add annotations such as highlights, notes, links, and markup through code.
- Printing: Print documents using the standard Java printing services.
Examples can be found int the examplesfolder. The following is an example of how to save page captures in an SVG format
~$ gradle :core:core-awt:assemble
~$ mvn -pl :icepdf-core package
# defaultTasks allows for a call to just gradle
~$ gradle
# or one can use the full task list
~$ gradle projectReport, sourcesJar, genPomFileForCoreJarPub, genPomFileForViewerJarPub, osDistZip, osDistTar
Project site · Javadoc · Releases · Discussions · Issues
Start
Use the library
Viewers
Configure and tune
Project