PdfDocument (com.ironsoftware:ironpdf 2026.7.3 API)

java.lang.Object
- com.ironsoftware.ironpdf.PdfDocument

All Implemented Interfaces:

Printable, AutoCloseable
```
public class PdfDocument
extends Object
implements Printable, AutoCloseable
```
Represents a PDF document. Allows: loading, editing, manipulating, merging, signing printing and saving PDFs.

Field Summary
- Fields inherited from interface java.awt.print.Printable
  NO_SUCH_PAGE, PAGE_EXISTS

Constructor Summary

Constructors
Constructor and Description
`PdfDocument(byte[] pdfData)` Opens an existing PDF document for editing.
`PdfDocument(byte[] pdfData, ChangeTrackingModes trackChanges)` Opens an existing PDF document for editing.
`PdfDocument(byte[] pdfData, String password)` Opens an existing PDF document for editing.
`PdfDocument(byte[] pdfData, String password, ChangeTrackingModes trackChanges)` Opens an existing PDF document for editing.
`PdfDocument(byte[] pdfData, String password, String ownerPassword)` Opens an existing PDF document for editing.
`PdfDocument(byte[] pdfData, String password, String ownerPassword, ChangeTrackingModes trackChanges)` Opens an existing PDF document for editing.
`PdfDocument(Path pdfFilePath)` Opens an existing PDF document for editing.
`PdfDocument(Path pdfFilePath, ChangeTrackingModes trackChanges)` Opens an existing PDF document for editing.
`PdfDocument(Path pdfFilePath, String password)` Opens an existing PDF document for editing.
`PdfDocument(Path pdfFilePath, String password, ChangeTrackingModes trackChanges)` Opens an existing PDF document for editing.
`PdfDocument(Path pdfFilePath, String password, String ownerPassword)` Opens an existing PDF document for editing.
`PdfDocument(Path pdfFilePath, String password, String ownerPassword, ChangeTrackingModes trackChanges)` Opens an existing PDF document for editing.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`PdfDocument`	`addBackgroundPdf(PdfDocument backgroundPdf)` Adds a background to each page of this PDF.
`PdfDocument`	`addBackgroundPdf(PdfDocument backgroundPdf, int backgroundPdfPageIndex)` Adds a background to each page of this PDF.
`PdfDocument`	`addBackgroundPdf(PdfDocument backgroundPdf, int backgroundPdfPageIndex, PageSelection pageSelection)` Adds a background to selected page(s) of this PDF.
`PdfDocument`	`addBackgroundPdf(PdfDocument backgroundPdf, PageSelection pageSelection)` Adds a background to selected page(s) of this PDF.
`PdfDocument`	`addForegroundPdf(PdfDocument foregroundPdf)` Adds a foreground to each page of this PDF.
`PdfDocument`	`addForegroundPdf(PdfDocument foregroundPdf, int foregroundPdfPageIndex)` Adds a foreground to each page of this PDF.
`PdfDocument`	`addForegroundPdf(PdfDocument foregroundPdf, int foregroundPdfPageIndex, PageSelection pageSelection)` Adds a foreground to selected page(s) of this PDF.
`PdfDocument`	`addForegroundPdf(PdfDocument foregroundPdf, PageSelection pageSelection)` Adds a foreground to selected page(s) of this PDF.
`PdfDocument`	`addHtmlFooter(HtmlHeaderFooter footer)` Renders HTML page footers onto an existing PDF File
`PdfDocument`	`addHtmlFooter(HtmlHeaderFooter footer, HeaderFooterOptions headerFooterOptions)` Renders HTML page footer onto an existing PDF File
`PdfDocument`	`addHtmlFooter(HtmlHeaderFooter footer, HeaderFooterOptions headerFooterOptions, PageSelection pageSelection)` Renders HTML page footer onto an existing PDF File
`PdfDocument`	`addHtmlFooter(HtmlHeaderFooter footer, PageSelection pageSelection)` Renders HTML page footers onto an existing PDF File
`PdfDocument`	`addHtmlHeader(HtmlHeaderFooter header)` Renders HTML page headers onto an existing PDF File
`PdfDocument`	`addHtmlHeader(HtmlHeaderFooter header, HeaderFooterOptions headerFooterOptions)` Renders HTML page headers onto an existing PDF File
`PdfDocument`	`addHtmlHeader(HtmlHeaderFooter header, HeaderFooterOptions headerFooterOptions, PageSelection pageSelection)` Renders HTML page headers onto an existing PDF File
`PdfDocument`	`addHtmlHeader(HtmlHeaderFooter header, PageSelection pageSelection)` Renders HTML page headers onto an existing PDF File
`PdfDocument`	`addTextFooter(TextHeaderFooter footer)` Renders TEXT page footers onto an existing PDF File
`PdfDocument`	`addTextFooter(TextHeaderFooter footer, HeaderFooterOptions headerFooterOptions)` Renders TEXT page footer onto an existing PDF File
`PdfDocument`	`addTextFooter(TextHeaderFooter footer, HeaderFooterOptions headerFooterOptions, PageSelection pageSelection)` Renders TEXT page footer onto an existing PDF File
`PdfDocument`	`addTextFooter(TextHeaderFooter footer, PageSelection pageSelection)` Renders TEXT page footers onto an existing PDF File
`PdfDocument`	`addTextHeader(TextHeaderFooter header)` Renders TEXT page headers onto an existing PDF File
`PdfDocument`	`addTextHeader(TextHeaderFooter header, HeaderFooterOptions headerFooterOptions)` Renders TEXT page headers onto an existing PDF File
`PdfDocument`	`addTextHeader(TextHeaderFooter header, HeaderFooterOptions headerFooterOptions, PageSelection pageSelection)` Renders TEXT page headers onto an existing PDF File
`PdfDocument`	`addTextHeader(TextHeaderFooter header, PageSelection pageSelection)` Renders TEXT page headers onto an existing PDF File
`PdfDocument`	`appendPdf(PdfDocument AnotherPdfFile)` Appends another PDF to the end of the current `PdfDocument`.
`PdfDocument`	`applyStamp(Stamper stamper)` Edits the PDF by applying the `Stamper`'s rendered to every page.
`PdfDocument`	`applyStamp(Stamper stamper, PageSelection pageSelection)` Edits the PDF by applying the `Stamper`'s rendered to only selected page(s).
`PdfDocument`	`applyWatermark(String html)` Adds Watermark to PDF, Please use `applyStamp(Stamper)` for more control.
`PdfDocument`	`applyWatermark(String html, int opacity)` Adds Watermark to PDF, Please use `applyStamp(Stamper)` for more control.
`PdfDocument`	`applyWatermark(String html, int opacity, VerticalAlignment verticalAlignment)` Adds a watermark to this PDF.
`PdfDocument`	`applyWatermark(String html, int opacity, VerticalAlignment verticalAlignment, HorizontalAlignment horizontalAlignment)` Adds a watermark to this PDF.
`void`	`close()`
`static void`	`compressAndSaveAs(byte[] pdfBytes, String outputFilePath, String password, AdvancedCompressionOptions options)` Apply the advanced compression pipeline to byte[] input and save the result to a file.
`static void`	`compressAndSaveAs(InputStream pdfStream, String outputFilePath, String password, AdvancedCompressionOptions options)` Apply the advanced compression pipeline to a stream input and save the result to a file.
`void`	`compressAndSaveAs(String outputFilePath)` Compresses the PDF using QPdf smart compression and saves the result to a file.
`void`	`compressAndSaveAs(String outputFilePath, AdvancedCompressionOptions options)` Apply the advanced compression pipeline and save the result to a file.
`void`	`compressAndSaveAs(String outputFilePath, int jpegQuality)` Compresses the PDF using QPdf smart compression and saves the result to a file, with JPEG quality setting for image recompression.
`void`	`compressImages(int quality)` Deprecated. Use `compressAndSaveAs(String)` or `compressPdfToBytes()` for QPdf smart compression.
`void`	`compressImages(int quality, boolean scaleToVisibleSize)` Deprecated. Use `compressAndSaveAs(String)` or `compressPdfToBytes()` for QPdf smart compression.
`byte[]`	`compressPdfToBytes()` Compresses the PDF using QPdf smart compression and returns the compressed bytes in memory.
`byte[]`	`compressPdfToBytes(String password)` Compresses the PDF using QPdf smart compression and returns the compressed bytes in memory.
`InputStream`	`compressPdfToStream()` Compresses the PDF using QPdf smart compression and returns the result as an InputStream.
`InputStream`	`compressPdfToStream(String password)` Compresses the PDF using QPdf smart compression and returns the result as an InputStream.
`void`	`compressStructTree(int quality, boolean scaleToVisibleSize)` Remove document struct tree information which describes the logical layout of the document.
`PdfDocument`	`convertToPdfA()` Convert the current document into the PDF-A (PDF/A-3B ISO 19005-3) standard format
`PdfDocument`	`convertToPdfA(PdfAVersions pdfAVersion)` Convert the current document into the specified PDF-A standard format
`PdfDocument`	`convertToPdfA(PdfAVersions pdfAVersion, String customICCFilePath)` Convert the current document into the specified PDF-A standard format
`PdfDocument`	`convertToPdfA(String customICCFilePath)` Convert the current document into the PDF-A (PDF/A-3B ISO 19005-3) standard format
`PdfDocument`	`convertToPdfUA(NaturalLanguages naturalLanguages)` Convert the current document into the specified PDF/UA standard format (defaults to PDF/UA-1)
`PdfDocument`	`convertToPdfUA(NaturalLanguages naturalLanguages, PdfUAVersions pdfUaVersion)` Convert the current document into the specified PDF/UA standard format
`PdfDocument`	`copyPage(int PageIndex)` Creates a new PDF by copying a page from this PdfDocument into a new blank document.
`PdfDocument`	`copyPages(int StartIndex, int EndIndex)` Creates a new PDF by copying a range of pages from this `PdfDocument` into a new blank document.
`PdfDocument`	`copyPages(PageSelection pageSelection)` Creates a new PDF by copying a page from this PdfDocument into a new blank document.
`void`	`drawImage(byte[] imageBytes, DrawImageOptions option)` Draws an image onto the PDF document
`void`	`drawImage(Path imagePath, DrawImageOptions option)` Draws an image onto the PDF document
`List<BufferedImage>`	`extractAllImages()` Finds all embedded Images from within the PDF and returns them as a list of `BufferedImage` images.
`List<BufferedImage>`	`extractAllImagesFromPages(PageSelection pageSelection)` Finds all embedded Images from within the PDF and returns as a list of image bytes
`List<byte[]>`	`extractAllRawImages()` Finds all embedded Images from within the PDF and returns as a list of image bytes
`List<byte[]>`	`extractAllRawImagesFromPages(PageSelection pageSelection)` Finds all embedded Images from within the PDF and returns them as raw bytes.
`String`	`extractAllText()` Extracts the written text content from the PDF and returns it as a string.
`String`	`extractTextFromPage(PageSelection pageSelection)` Extracts the text content from one page of the PDF and returns it as a string.
`static PdfDocument`	`fromFile(Path pdfFilePath)` Opens an existing PDF document for editing.
`static PdfDocument`	`fromFile(Path pdfFilePath, ChangeTrackingModes trackChanges)` Opens an existing PDF document for editing.
`static PdfDocument`	`fromFile(Path pdfFilePath, String password)` Opens an existing PDF document for editing.
`static PdfDocument`	`fromFile(Path pdfFilePath, String password, ChangeTrackingModes trackChanges)` Opens an existing PDF document for editing.
`static PdfDocument`	`fromFile(Path pdfFilePath, String password, String ownerPassword)` Opens an existing PDF document for editing.
`static PdfDocument`	`fromFile(Path pdfFilePath, String password, String ownerPassword, ChangeTrackingModes trackChanges)` Opens an existing PDF document for editing.
`static PdfDocument`	`fromImage(List<Path> imagesPath)` Converts a single image file to an identical PDF document of matching dimensions.
`static PdfDocument`	`fromImage(List<Path> imagesPath, ImageBehavior imageBehavior)` Converts a single image file to an identical PDF document of matching dimensions.
`static PdfDocument`	`fromImage(List<Path> imagesPath, ImageBehavior imageBehavior, ChromePdfRenderOptions renderOptions)` Converts a single image file to an identical PDF document of matching dimensions.
`static PdfDocument`	`fromImage(List<Path> imagesPath, ImageBehavior imageBehavior, PaperSize paperSize)` Converts a single image file to an identical PDF document of matching dimensions.
`static PdfDocument`	`fromImage(List<Path> imagesPath, PaperSize paperSize)` Converts a single image file to an identical PDF document of matching dimensions.
`AnnotationManager`	`getAnnotation()` Gets the annotation manager for this PDF document.
`AttachmentManager`	`getAttachment()` Gets the attachment manager for this PDF document.
`byte[]`	`getBinaryData()` Saves the PDF as byte array, including any changes.
`byte[]`	`getBinaryDataIncremental()` Saves the PDF as byte array with changes appended to the end of the file.
`BookmarkManager`	`getBookmark()` Gets the BookmarkManager for this PDF document.
`List<RenderedElementLocation>`	`getElementLocations()` Retrieves the rendered page locations of HTML elements that were tracked during rendering.
`FormManager`	`getForm()` Gets the form manager for this PDF document.
`MetadataManager`	`getMetadata()` Gets the metadata manager for this PDF document.
`List<PageInfo>`	`getPagesInfo()` Gets a list of information about pages in this PDF as a List of `PageInfo`.
`Map<Integer,PageInfo>`	`getPagesInfo(PageSelection pageSelection)` Gets a Map of information a selection of pages in this PDF as a List of `PageInfo`.
`byte[]`	`getRevision(int index)` Saves the PDF as byte array at the specified revision number.
`SecurityManager`	`getSecurity()` Gets security.
`SignatureManager`	`getSignature()` Gets signature.
`PdfDocument`	`insertPdf(PdfDocument AnotherPdfFile)` Inserts another PDF into the current PdfDocument, starting at a given Page Index.
`PdfDocument`	`insertPdf(PdfDocument AnotherPdfFile, int AtIndex)` Inserts another PDF into the current PdfDocument, starting at a given Page Index.
`static boolean`	`isLinearized(Path pdfFilePath)` Check whether the PDF file at the given path is linearized (a.k.a.
`static boolean`	`isLinearized(String pdfFilePath)` Check whether the PDF file at the given path is linearized (a.k.a.
`static boolean`	`isLinearized(String pdfFilePath, String password)` Check whether the PDF file at the given path is linearized (a.k.a.
`byte[]`	`linearizePdfToBytes()` Linearizes the current PDF document and returns the result as a byte array using the `LinearizationMode.Automatic` strategy.
`static byte[]`	`linearizePdfToBytes(byte[] pdfBytes)` Static helper that linearizes the given PDF bytes and returns the linearized bytes using the `LinearizationMode.Automatic` strategy.
`static byte[]`	`linearizePdfToBytes(byte[] pdfBytes, String password)` Static helper that linearizes the given PDF bytes and returns the linearized bytes.
`static byte[]`	`linearizePdfToBytes(byte[] pdfBytes, String password, LinearizationMode mode)` Static helper that linearizes the given PDF bytes and returns the linearized bytes.
`static byte[]`	`linearizePdfToBytes(InputStream pdfStream)` Static helper that linearizes a PDF from an `InputStream` and returns the linearized bytes.
`static byte[]`	`linearizePdfToBytes(InputStream pdfStream, String password)` Static helper that linearizes a PDF from an `InputStream` and returns the linearized bytes.
`static byte[]`	`linearizePdfToBytes(InputStream pdfStream, String password, LinearizationMode mode)` Static helper that linearizes a PDF from an `InputStream` and returns the linearized bytes.
`byte[]`	`linearizePdfToBytes(LinearizationMode mode)` Linearizes the current PDF document and returns the result as a byte array.
`byte[]`	`linearizePdfToBytes(String password)` Linearizes the current PDF document and returns the result as a byte array.
`byte[]`	`linearizePdfToBytes(String password, LinearizationMode mode)` Linearizes the current PDF document and returns the result as a byte array.
`InputStream`	`linearizePdfToStream()` Linearizes the current PDF document and returns the result as an `InputStream`.
`InputStream`	`linearizePdfToStream(LinearizationMode mode)` Linearizes the current PDF document and returns the result as an `InputStream`.
`InputStream`	`linearizePdfToStream(String password)` Linearizes the current PDF document and returns the result as an `InputStream`.
`InputStream`	`linearizePdfToStream(String password, LinearizationMode mode)` Linearizes the current PDF document and returns the result as an `InputStream`.
`static PdfDocument`	`merge(List<PdfDocument> Documents)` Static method that joins (concatenates) 2 PDF documents together into one PDF document.
`static PdfDocument`	`merge(PdfDocument A, PdfDocument B)` Static method that joins (concatenates) 2 PDF documents together into one PDF document.
`PdfDocument`	`prependPdf(PdfDocument AnotherPdfFile)` Adds another PDF to the beginning of the current PdfDocument.
`void`	`print()` Prints this PDF by sending it to the computer's real world printer(s).
`int`	`print(Graphics graphics, PageFormat pageFormat, int pageIndex)`
`void`	`printWithoutDialog()` Prints this PDF by sending it to the computer's real world printer(s).
`PdfDocument`	`removePages(PageSelection pageSelection)` Removes a range of pages from the PDF
`static PdfDocument`	`renderHtmlAsPdf(String html)` Creates a PDF file from a Html string, and returns it as a `PdfDocument`.
`static PdfDocument`	`renderHtmlAsPdf(String html, ChromeHttpLoginCredentials loginCredentials)` Creates a PDF file from a Html string, and returns it as a `PdfDocument`.
`static PdfDocument`	`renderHtmlAsPdf(String html, ChromePdfRenderOptions renderOptions)` Creates a PDF file from a Html string, and returns it as a `PdfDocument`.
`static PdfDocument`	`renderHtmlAsPdf(String html, ChromePdfRenderOptions renderOptions, ChromeHttpLoginCredentials loginCredentials)` Creates a PDF file from a Html string, and returns it as a `PdfDocument`.
`static PdfDocument`	`renderHtmlAsPdfUA(String html)` Render HTML to PDF and convert to PDF/UA format with screen reader support.
`static PdfDocument`	`renderHtmlAsPdfUA(String html, NaturalLanguages naturalLanguages)` Render HTML to PDF and convert to PDF/UA format with screen reader support.
`static PdfDocument`	`renderHtmlAsPdfUA(String html, NaturalLanguages naturalLanguages, ChromePdfRenderOptions renderOptions)` Render HTML to PDF and convert to PDF/UA format with screen reader support.
`static PdfDocument`	`renderHtmlFileAsPdf(String htmlFilePath)` Creates a PDF file from a local Html file, and returns it as a `PdfDocument`.
`static PdfDocument`	`renderHtmlFileAsPdf(String htmlFilePath, ChromeHttpLoginCredentials loginCredentials)` Creates a PDF file from a local Html file, and returns it as a `PdfDocument`.
`static PdfDocument`	`renderHtmlFileAsPdf(String htmlFilePath, ChromePdfRenderOptions renderOptions)` Creates a PDF file from a local HTML file and returns it as a `PdfDocument`.
`static PdfDocument`	`renderHtmlFileAsPdf(String htmlFilePath, ChromePdfRenderOptions renderOptions, ChromeHttpLoginCredentials loginCredentials)` Creates a PDF file from a local Html file, and returns it as a `PdfDocument`.
`static PdfDocument`	`renderHtmlFileAsPdf(String htmlFilePath, String baseUrl)` Creates a PDF file from a local Html file, and returns it as a `PdfDocument`.
`static PdfDocument`	`renderHtmlFileAsPdf(String htmlFilePath, String baseUrl, ChromeHttpLoginCredentials loginCredentials)` Creates a PDF file from a local Html file, and returns it as a `PdfDocument`.
`static PdfDocument`	`renderHtmlFileAsPdf(String htmlFilePath, String baseUrl, ChromePdfRenderOptions renderOptions)` Creates a PDF file from a local Html file, and returns it as a `PdfDocument`.
`static PdfDocument`	`renderHtmlFileAsPdf(String htmlFilePath, String baseUrl, ChromePdfRenderOptions renderOptions, ChromeHttpLoginCredentials loginCredentials)` Creates a PDF file from a local Html file, and returns it as a `PdfDocument`.
`static PdfDocument`	`renderRtfAsPdf(String rtfString)` Creates a PDF file from RTF string, and returns it as a `PdfDocument`.
`static PdfDocument`	`renderRtfFileAsPdf(Path rtfFilePath)` Creates a PDF file from RTF file, and returns it as a `PdfDocument`.
`static PdfDocument`	`renderRtfFileAsPdf(String rtfFilePath)` Creates a PDF file from RTF file, and returns it as a `PdfDocument`.
`static PdfDocument`	`renderUrlAsPdf(String url)` Creates a PDF file from a URL or local file path and returns it as a `PdfDocument`.
`static PdfDocument`	`renderUrlAsPdf(String url, ChromeHttpLoginCredentials loginCredentials)` Creates a PDF file from a URL or local file path and returns it as a `PdfDocument`.
`static PdfDocument`	`renderUrlAsPdf(String url, ChromePdfRenderOptions renderOptions)` Creates a PDF file from a URL or local file path and returns it as a `PdfDocument`.
`static PdfDocument`	`renderUrlAsPdf(String url, ChromePdfRenderOptions renderOptions, ChromeHttpLoginCredentials loginCredentials)` Creates a PDF file from a URL or local file path and returns it as a `PdfDocument`.
`static PdfDocument`	`renderZipAsPdf(Path zipFilePath, String mainFile)` Creates a PDF file from a local Zip file, and returns it as a `PdfDocument`.
`static PdfDocument`	`renderZipAsPdf(Path zipFilePath, String mainFile, ChromePdfRenderOptions renderOptions)` Creates a PDF file from a local Zip file, and returns it as a `PdfDocument`.
`void`	`replaceText(PageSelection pageSelection, String oldText, String newText)` Replace the specified old text with new text on a given page.
`void`	`replaceText(PageSelection pageSelection, String oldText, String newText, FontTypes customFont, Float customFontSize)` Replace the specified old text with new text on a given page.
`void`	`resetElementLocationCache()` Clears the cached result of `getElementLocations()`, forcing a fresh scan of the document's annotations on the next call.
`void`	`resizePage(double pageWidth, double pageHeight, PageSelection pageSelection)` Resize a page to the specified dimensions (in millimeters)
`void`	`rotateAllPages(PageRotation rotation)` Rotates all pages of the PdfDocument by a specified number of degrees.
`void`	`rotatePage(PageRotation pageRotation, PageSelection pageSelection)` Rotates a selection page of the PdfDocument by a specified number of degrees.
`PdfDocument`	`saveAs(Path filePath)` Saves this PdfDocument to a file.
`PdfDocument`	`saveAs(String filePath)` Saves this PdfDocument to a file.
`static void`	`saveAsLinearized(byte[] pdfBytes, String outputFilePath)` Static helper that linearizes the given PDF bytes and saves the result to the given output file path.
`static void`	`saveAsLinearized(byte[] pdfBytes, String outputFilePath, String password)` Static helper that linearizes the given PDF bytes and saves the result to the given output file path.
`void`	`saveAsLinearized(String outputFilePath)` Linearizes the current PDF document and saves the result to a file path.
`void`	`saveAsLinearized(String outputFilePath, String password)` Linearizes the current PDF document and saves the result to a file path.
`PdfDocument`	`saveAsPdfA(String filePath)` Save the current document into the PDF-A (PDF/A-3B ISO 19005-3) standard format
`PdfDocument`	`saveAsPdfA(String filePath, PdfAVersions pdfAVersion)` Save the current document into the specified PDF-A standard format
`PdfDocument`	`saveAsPdfA(String filePath, PdfAVersions pdfAVersion, String customICCFilePath)` Save the current document into the specified PDF-A standard format
`PdfDocument`	`saveAsPdfA(String filePath, String customICCFilePath)` Save the current document into the PDF-A (PDF/A-3B ISO 19005-3) standard format
`PdfDocument`	`saveAsPdfUA(String filePath, NaturalLanguages naturalLanguages)` Save the current document into the specified PDF/UA standard format.
`PdfDocument`	`saveAsRevision(Path filePath)` Saves this PdfDocument to a file.
`PdfDocument`	`saveAsRevision(String filePath)` Saves this PdfDocument to a file.
`List<BufferedImage>`	`toBufferedImages()` Rasterizes (renders) the PDF into BufferedImage objects.
`List<BufferedImage>`	`toBufferedImages(PageSelection pageSelection)` Rasterizes (renders) the PDF into BufferedImage objects.
`List<BufferedImage>`	`toBufferedImages(ToImageOptions options)` Rasterizes (renders) the PDF into BufferedImage objects.
`List<BufferedImage>`	`toBufferedImages(ToImageOptions options, PageSelection pageSelection)` Rasterizes (renders) the PDF into BufferedImage objects.
`List<String>`	`toImages(String fileNamePattern, String imageFileType)` Renders the pages of the PDF as specific image files type and saves them to disk.
`List<String>`	`toImages(String fileNamePattern, String imageFileType, PageSelection pageSelection)` Renders the pages of the PDF as specific image files type and saves them to disk.
`List<String>`	`toImages(String fileNamePattern, String imageFileType, ToImageOptions options)` Renders the pages of the PDF as specific image files type and saves them to disk.
`List<String>`	`toImages(String fileNamePattern, String imageFileType, ToImageOptions options, PageSelection pageSelection)` Renders the pages of the PDF as specific image files type and saves them to disk.
`List<String>`	`toJpegImages(String fileNamePattern)` Renders the pages of the PDF as JPEG image files and saves them to disk.
`List<String>`	`toJpegImages(String fileNamePattern, PageSelection pageSelection)` Renders the pages of the PDF as JPEG image files and saves them to disk.
`List<String>`	`toJpegImages(String fileNamePattern, ToImageOptions options)` Renders the pages of the PDF as JPEG image files and saves them to disk.
`List<String>`	`toJpegImages(String fileNamePattern, ToImageOptions options, PageSelection pageSelection)` Renders the pages of the PDF as JPEG image files and saves them to disk.
`String`	`toMultiPageTiff(Path filePath)` Renders the pages of the PDF as TIFF (Tagged Image File Format / Tif) file and saves it to disk.
`String`	`toMultiPageTiff(Path filePath, PageSelection pageSelection)` Renders the pages of the PDF as TIFF (Tagged Image File Format / Tif) file and saves it to disk.
`String`	`toMultiPageTiff(Path filePath, ToImageOptions options)` Renders the pages of the PDF as TIFF (Tagged Image File Format / Tif) file and saves it to disk.
`String`	`toMultiPageTiff(Path filePath, ToImageOptions options, PageSelection pageSelection)` Renders the pages of the PDF as TIFF (Tagged Image File Format / Tif) file and saves it to disk.
`List<String>`	`toPngImages(String fileNamePattern)` Renders the pages of the PDF as PNG (Portable Network Graphic) files and saves them to disk.
`List<String>`	`toPngImages(String fileNamePattern, PageSelection pageSelection)` Renders the pages of the PDF as PNG (Portable Network Graphic) files and saves them to disk.
`List<String>`	`toPngImages(String fileNamePattern, ToImageOptions options)` Renders the pages of the PDF as PNG (Portable Network Graphic) files and saves them to disk.
`List<String>`	`toPngImages(String fileNamePattern, ToImageOptions options, PageSelection pageSelection)` Renders the pages of the PDF as PNG (Portable Network Graphic) files and saves them to disk.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - PdfDocument
```
public PdfDocument(Path pdfFilePath,
                   String password)
            throws IOException
```
    Opens an existing PDF document for editing.
    
    Parameters:
    
    pdfFilePath - The PDF file path.
    
    password - Optional user password if the PDF document is encrypted.
    
    Throws:
    
    IOException - if an I/O error occurs reading from the stream
  - PdfDocument
```
public PdfDocument(Path pdfFilePath,
                   String password,
                   ChangeTrackingModes trackChanges)
            throws IOException
```
    Opens an existing PDF document for editing.
    
    Parameters:
    
    pdfFilePath - The PDF file path.
    
    password - Optional user password if the PDF document is encrypted.
    
    trackChanges - Optionally track changes to the document (for use with incremental saves)
    
    Throws:
    
    IOException - if an I/O error occurs reading from the stream
  - PdfDocument
```
public PdfDocument(Path pdfFilePath,
                   String password,
                   String ownerPassword)
            throws IOException
```
    Opens an existing PDF document for editing.
    
    Parameters:
    
    pdfFilePath - The PDF file path.
    
    password - Optional user password if the PDF document is encrypted.
    
    ownerPassword - Optional password if the PDF document is protected by owner (printing, modifying restrictions etc..)
    
    Throws:
    
    IOException - if an I/O error occurs reading from the stream
  - PdfDocument
```
public PdfDocument(Path pdfFilePath,
                   String password,
                   String ownerPassword,
                   ChangeTrackingModes trackChanges)
            throws IOException
```
    Opens an existing PDF document for editing.
    
    Parameters:
    
    pdfFilePath - The PDF file path.
    
    password - Optional user password if the PDF document is encrypted.
    
    ownerPassword - Optional password if the PDF document is protected by owner (printing, modifying restrictions etc..)
    
    trackChanges - Optionally track changes to the document (for use with incremental saves)
    
    Throws:
    
    IOException - if an I/O error occurs reading from the stream
  - PdfDocument
```
public PdfDocument(byte[] pdfData,
                   String password,
                   String ownerPassword)
```
    Opens an existing PDF document for editing.
    
    Parameters:
    
    pdfData - The PDF file data as byte array.
    
    password - Optional user password if the PDF document is encrypted.
    
    ownerPassword - Optional password if the PDF document is protected by owner (printing, modifying restrictions etc..)
  - PdfDocument
```
public PdfDocument(byte[] pdfData,
                   String password,
                   String ownerPassword,
                   ChangeTrackingModes trackChanges)
```
    Opens an existing PDF document for editing.
    
    Parameters:
    
    pdfData - The PDF file data as byte array.
    
    password - Optional user password if the PDF document is encrypted.
    
    ownerPassword - Optional password if the PDF document is protected by owner (printing, modifying restrictions etc..)
    
    trackChanges - Optionally track changes to the document (for use with incremental saves)
  - PdfDocument
```
public PdfDocument(Path pdfFilePath)
            throws IOException
```
    Opens an existing PDF document for editing.
    
    Parameters:
    
    pdfFilePath - The PDF file path.
    
    Throws:
    
    IOException - the io exception
  - PdfDocument
```
public PdfDocument(Path pdfFilePath,
                   ChangeTrackingModes trackChanges)
            throws IOException
```
    Opens an existing PDF document for editing.
    
    Parameters:
    
    pdfFilePath - The PDF file path.
    
    trackChanges - Optionally track changes to the document (for use with incremental saves)
    
    Throws:
    
    IOException - the io exception
  - PdfDocument
```
public PdfDocument(byte[] pdfData,
                   String password)
```
    Opens an existing PDF document for editing.
    
    Parameters:
    
    pdfData - The PDF file data as byte array.
    
    password - Optional user password if the PDF document is encrypted.
  - PdfDocument
```
public PdfDocument(byte[] pdfData,
                   String password,
                   ChangeTrackingModes trackChanges)
```
    Opens an existing PDF document for editing.
    
    Parameters:
    
    pdfData - The PDF file data as byte array.
    
    password - Optional user password if the PDF document is encrypted.
    
    trackChanges - Optionally track changes to the document (for use with incremental saves)
  - PdfDocument
```
public PdfDocument(byte[] pdfData)
```
    Opens an existing PDF document for editing.
    
    Parameters:
    
    pdfData - The PDF file data as byte array.
  - PdfDocument
```
public PdfDocument(byte[] pdfData,
                   ChangeTrackingModes trackChanges)
```
    Opens an existing PDF document for editing.
    
    Parameters:
    
    pdfData - The PDF file data as byte array.
    
    trackChanges - Optionally track changes to the document (for use with incremental saves)
- Method Detail
  - fromFile
```
public static PdfDocument fromFile(Path pdfFilePath,
                                   String password)
                            throws IOException
```
    Opens an existing PDF document for editing.
    
    Parameters:
    
    pdfFilePath - The PDF file path.
    
    password - Optional user password if the PDF document is encrypted.
    
    Returns:
    
    An IronPdf.PdfDocument object as loaded from the file path.
    
    Throws:
    
    IOException - if an I/O error occurs reading from the stream
  - fromFile
```
public static PdfDocument fromFile(Path pdfFilePath,
                                   String password,
                                   ChangeTrackingModes trackChanges)
                            throws IOException
```
    Opens an existing PDF document for editing.
    
    Parameters:
    
    pdfFilePath - The PDF file path.
    
    password - Optional user password if the PDF document is encrypted.
    
    trackChanges - Optionally track changes to the document (for use with incremental saves)
    
    Returns:
    
    An IronPdf.PdfDocument object as loaded from the file path.
    
    Throws:
    
    IOException - if an I/O error occurs reading from the stream
  - fromFile
```
public static PdfDocument fromFile(Path pdfFilePath,
                                   String password,
                                   String ownerPassword)
                            throws IOException
```
    Opens an existing PDF document for editing.
    
    Parameters:
    
    pdfFilePath - The PDF file path.
    
    password - Optional user password if the PDF document is encrypted.
    
    ownerPassword - Optional password if the PDF document is protected by owner (printing, modifying restrictions etc..)
    
    Returns:
    
    An IronPdf.PdfDocument object as loaded from the file path.
    
    Throws:
    
    IOException - if an I/O error occurs reading from the stream
  - fromFile
```
public static PdfDocument fromFile(Path pdfFilePath,
                                   String password,
                                   String ownerPassword,
                                   ChangeTrackingModes trackChanges)
                            throws IOException
```
    Opens an existing PDF document for editing.
    
    Parameters:
    
    pdfFilePath - The PDF file path.
    
    password - Optional user password if the PDF document is encrypted.
    
    ownerPassword - Optional password if the PDF document is protected by owner (printing, modifying restrictions etc..)
    
    trackChanges - Optionally track changes to the document (for use with incremental saves)
    
    Returns:
    
    An IronPdf.PdfDocument object as loaded from the file path.
    
    Throws:
    
    IOException - if an I/O error occurs reading from the stream
  - fromFile
```
public static PdfDocument fromFile(Path pdfFilePath)
                            throws IOException
```
    Opens an existing PDF document for editing.
    
    Parameters:
    
    pdfFilePath - The PDF file path.
    
    Returns:
    
    An IronPdf.PdfDocument object as loaded from the file path.
    
    Throws:
    
    IOException - if an I/O error occurs reading from the stream
  - fromFile
```
public static PdfDocument fromFile(Path pdfFilePath,
                                   ChangeTrackingModes trackChanges)
                            throws IOException
```
    Opens an existing PDF document for editing.
    
    Parameters:
    
    pdfFilePath - The PDF file path.
    
    trackChanges - Optionally track changes to the document (for use with incremental saves)
    
    Returns:
    
    An IronPdf.PdfDocument object as loaded from the file path.
    
    Throws:
    
    IOException - if an I/O error occurs reading from the stream
  - fromImage
```
public static PdfDocument fromImage(List<Path> imagesPath)
```
    Converts a single image file to an identical PDF document of matching dimensions.
    The default PaperSize is A4.
    
    Note: Imaging.ImageBehavior.CropPage will set PaperSize equal to ImageSize.
    
    Parameters:
    
    imagesPath - A list of file path of the image file.
    
    Returns:
    
    Returns a PdfDocument document which can then be edited, saved or served over the web.
  - fromImage
```
public static PdfDocument fromImage(List<Path> imagesPath,
                                    PaperSize paperSize)
```
    Converts a single image file to an identical PDF document of matching dimensions.
    The default PaperSize is A4. You can set it via ImageToPdfConverter.PaperSize.
    
    Note: Imaging.ImageBehavior.CropPage will set PaperSize equal to ImageSize.
    
    Parameters:
    
    imagesPath - A list of file path of the image file.
    
    paperSize - A target paper size. Default is A4.
    
    Returns:
    
    Returns a PdfDocument document which can then be edited, saved or served over the web.
  - fromImage
```
public static PdfDocument fromImage(List<Path> imagesPath,
                                    ImageBehavior imageBehavior)
```
    Converts a single image file to an identical PDF document of matching dimensions.
    The default PaperSize is A4.
    
    Note: Imaging.ImageBehavior.CropPage will set PaperSize equal to ImageSize.
    
    Parameters:
    
    imagesPath - A list of file path of the image file.
    
    imageBehavior - Describes how image should be placed on the PDF page
    
    Returns:
    
    Returns a PdfDocument document which can then be edited, saved or served over the web.
  - fromImage
```
public static PdfDocument fromImage(List<Path> imagesPath,
                                    ImageBehavior imageBehavior,
                                    PaperSize paperSize)
```
    Converts a single image file to an identical PDF document of matching dimensions.
    Note: Imaging.ImageBehavior.CropPage will set PaperSize equal to ImageSize.
    
    Parameters:
    
    imagesPath - A list of file path of the image file.
    
    imageBehavior - Describes how image should be placed on the PDF page.
    
    paperSize - A target paper size. Default is A4.
    
    Returns:
    
    Returns a PdfDocument document which can then be edited, saved or served over the web.
  - fromImage
```
public static PdfDocument fromImage(List<Path> imagesPath,
                                    ImageBehavior imageBehavior,
                                    ChromePdfRenderOptions renderOptions)
```
    Converts a single image file to an identical PDF document of matching dimensions.
    The default PaperSize is A4. You can set it via ChromePdfRenderOptions.setPaperSize(PaperSize).
    
    Note: Imaging.ImageBehavior.CropPage will set PaperSize equal to ImageSize.
    
    Parameters:
    
    imagesPath - A list of file path of the image file.
    
    imageBehavior - Describes how image should be placed on the PDF page.
    
    renderOptions - Rendering options.
    
    Returns:
    
    Returns a PdfDocument document which can then be edited, saved or served over the web.
  - getBookmark
```
public BookmarkManager getBookmark()
```
    Gets the BookmarkManager for this PDF document. BookmarkManager allows reading, removing and editing of bookmarks from the PDF outline. *
    See: BookmarkManager.
    
    Returns:
    
    the BookmarkManager
  - getMetadata
```
public MetadataManager getMetadata()
```
    Gets the metadata manager for this PDF document. MetadataManager allows metadata such as Author etc. to be read and set.
    See: MetadataManager.
    
    Returns:
    
    the MetadataManager
  - getAnnotation
```
public AnnotationManager getAnnotation()
```
    Gets the annotation manager for this PDF document. AnnotationManager allows annotation objects to be edited.
    See: AnnotationManager.
    
    Returns:
    
    the AnnotationManager
  - getForm
```
public FormManager getForm()
```
    Gets the form manager for this PDF document. FormManager allows AcroForm fields to be read and set.
    See: FormManager.
    
    Returns:
    
    the FormManager
  - getAttachment
```
public AttachmentManager getAttachment()
```
    Gets the attachment manager for this PDF document. AttachmentManager allows attachment objects to be edited.
    See: AttachmentManager.
    
    Returns:
    
    the AttachmentManager
  - getSecurity
```
public SecurityManager getSecurity()
```
    Gets security.
    
    Returns:
    
    the SecurityManager
  - getSignature
```
public SignatureManager getSignature()
```
    Gets signature.
    
    Returns:
    
    the SignatureManager
  - merge
```
public static PdfDocument merge(PdfDocument A,
                                PdfDocument B)
```
    Static method that joins (concatenates) 2 PDF documents together into one PDF document.
    If the second PDF contains form fields, the resulting PDF's form fields will be appended with an origin index number. e.g. 'Name' from the first PDF will become 'Name_0'
    
    Parameters:
    
    A - A PDF
    
    B - A Seconds PDF
    
    Returns:
    
    A new, merged PdfDocument
  - merge
```
public static PdfDocument merge(List<PdfDocument> Documents)
```
    Static method that joins (concatenates) 2 PDF documents together into one PDF document.
    If the second PDF contains form fields, the resulting PDF's form fields will be appended with an origin index number. e.g. 'Name' from the first PDF will become 'Name_0'
    
    Parameters:
    
    Documents - A List of PdfDocument. To merge existing PDF files you may use the PdfDocument.FromFile static method in conjunction with Merge.
    
    Returns:
    
    A new, merged PdfDocument
  - copyPage
```
public final PdfDocument copyPage(int PageIndex)
```
    Creates a new PDF by copying a page from this PdfDocument into a new blank document.
    
    Parameters:
    
    PageIndex - Index of the page. Note: Page 1 has index 0...
    
    Returns:
    
    A new PdfDocument
  - copyPages
```
public final PdfDocument copyPages(PageSelection pageSelection)
```
    Creates a new PDF by copying a page from this PdfDocument into a new blank document.
    
    Parameters:
    
    pageSelection - The selected page index(es). Default is all pages.
    
    Returns:
    
    A new PdfDocument
  - copyPages
```
public final PdfDocument copyPages(int StartIndex,
                                   int EndIndex)
```
    Creates a new PDF by copying a range of pages from this PdfDocument into a new blank document.
    
    Parameters:
    
    StartIndex - The index of the first PDF page to copy. Note: Page 1 has index 0
    
    EndIndex - The index of the last PDF page to copy.
    
    Returns:
    
    A new PdfDocument
  - appendPdf
```
public final PdfDocument appendPdf(PdfDocument AnotherPdfFile)
```
    Appends another PDF to the end of the current PdfDocument.
    If AnotherPdfFile contains form fields, those fields will be appended with '_' in the resulting PDF. e.g. 'Name' will become 'Name_'
    
    Parameters:
    
    AnotherPdfFile - PdfDocument to append.
    
    Returns:
    
    A new PdfDocument
  - insertPdf
```
public final PdfDocument insertPdf(PdfDocument AnotherPdfFile)
```
    Inserts another PDF into the current PdfDocument, starting at a given Page Index.
    If AnotherPdfFile contains form fields, those fields will be appended with '_' in the resulting PDF. e.g. 'Name' will be 'Name_'
    
    Parameters:
    
    AnotherPdfFile - Another PdfDocument...
    
    Returns:
    
    Returns this PdfDocument object, allowing for a 'fluent' chained in-line code style
  - insertPdf
```
public final PdfDocument insertPdf(PdfDocument AnotherPdfFile,
                                   int AtIndex)
```
    Inserts another PDF into the current PdfDocument, starting at a given Page Index.
    If AnotherPdfFile contains form fields, those fields will be appended with '_' in the resulting PDF. e.g. 'Name' will be 'Name_'
    
    Parameters:
    
    AnotherPdfFile - Another PdfDocument.
    
    AtIndex - Index at which to insert the new content. Note: Page 1 has index 0...
    
    Returns:
    
    Returns this PdfDocument object, allowing for a 'fluent' chained in-line code style
  - prependPdf
```
public final PdfDocument prependPdf(PdfDocument AnotherPdfFile)
```
    Adds another PDF to the beginning of the current PdfDocument.
    If AnotherPdfFile contains form fields, those fields will be appended with '_' in the resulting PDF. e.g. 'Name' will be 'Name_'
    
    Parameters:
    
    AnotherPdfFile - PdfDocument to prepend.
    
    Returns:
    
    Returns this PdfDocument object, allowing for a 'fluent' chained in-line code style
  - removePages
```
public final PdfDocument removePages(PageSelection pageSelection)
```
    Removes a range of pages from the PDF
    
    Parameters:
    
    pageSelection - The selected page index(es). Default is all pages.
    
    Returns:
    
    Returns this PdfDocument object, allowing for a 'fluent' chained in-line code style
  - getPagesInfo
```
public final List<PageInfo> getPagesInfo()
```
    Gets a list of information about pages in this PDF as a List of PageInfo.
    
    Returns:
    
    A list of information about the PDF’s pages.
  - getPagesInfo
```
public final Map<Integer,PageInfo> getPagesInfo(PageSelection pageSelection)
```
    Gets a Map of information a selection of pages in this PDF as a List of PageInfo.
    
    Parameters:
    
    pageSelection - Selected page indexes. Default is all pages.
    
    Returns:
    
    a map of page index and page information.
  - rotateAllPages
```
public final void rotateAllPages(PageRotation rotation)
```
    Rotates all pages of the PdfDocument by a specified number of degrees.
    
    Parameters:
    
    rotation - Degrees of rotation. May be 0,90,180 or 270
  - rotatePage
```
public final void rotatePage(PageRotation pageRotation,
                             PageSelection pageSelection)
```
    Rotates a selection page of the PdfDocument by a specified number of degrees.
    
    Parameters:
    
    pageRotation - Degrees of rotation. May be 0,90,180 or 270
    
    pageSelection - Selected page indexes. Default is all pages.
  - resizePage
```
public final void resizePage(double pageWidth,
                             double pageHeight,
                             PageSelection pageSelection)
```
    Resize a page to the specified dimensions (in millimeters)
    
    Parameters:
    
    pageWidth - Desired page width, in millimeters
    
    pageHeight - Desired page height, in millimeters
    
    pageSelection - Selected page indexes.
  - addBackgroundPdf
```
public final PdfDocument addBackgroundPdf(PdfDocument backgroundPdf)
```
    Adds a background to each page of this PDF. The background is copied from a first page in the backgroundPdf document.
    
    Parameters:
    
    backgroundPdf - The background PDF document.
    
    Returns:
    
    Returns this PdfDocument object, allowing for a 'fluent' chained in-line code style
  - addBackgroundPdf
```
public final PdfDocument addBackgroundPdf(PdfDocument backgroundPdf,
                                          int backgroundPdfPageIndex)
```
    Adds a background to each page of this PDF. The background is copied from a selected page in the backgroundPdf document.
    
    Parameters:
    
    backgroundPdf - The background PDF document.
    
    backgroundPdfPageIndex - Index (zero-based page number) of the page to copy from the Background/Foreground PDF. Default is 0.
    
    Returns:
    
    Returns this PdfDocument object, allowing for a 'fluent' chained in-line code style
  - addBackgroundPdf
```
public final PdfDocument addBackgroundPdf(PdfDocument backgroundPdf,
                                          PageSelection pageSelection)
```
    Adds a background to selected page(s) of this PDF. The background is copied from a selected page in the backgroundPdf document.
    
    Parameters:
    
    backgroundPdf - The background PDF document.
    
    pageSelection - PageSelection to which the background/foreground will be added. Default is PageSelection.AllPages().
    
    Returns:
    
    Returns this PdfDocument object, allowing for a 'fluent' chained in-line code style
  - addBackgroundPdf
```
public final PdfDocument addBackgroundPdf(PdfDocument backgroundPdf,
                                          int backgroundPdfPageIndex,
                                          PageSelection pageSelection)
```
    Adds a background to selected page(s) of this PDF. The background is copied from a selected page in the backgroundPdf document.
    
    Parameters:
    
    backgroundPdf - The background PDF document.
    
    backgroundPdfPageIndex - Index (zero-based page number) of the page to copy from the Background/Foreground PDF. Default is 0.
    
    pageSelection - PageSelection to which the background/foreground will be added. Default is PageSelection.AllPages().
    
    Returns:
    
    Returns this PdfDocument object, allowing for a 'fluent' chained in-line code style
  - addForegroundPdf
```
public final PdfDocument addForegroundPdf(PdfDocument foregroundPdf)
```
    Adds a foreground to each page of this PDF. The foreground is copied from a first page of the foregroundPdf document.
    
    Parameters:
    
    foregroundPdf - The foreground PDF document.
    
    Returns:
    
    Returns this PdfDocument object, allowing for a 'fluent' chained in-line code style
  - addForegroundPdf
```
public final PdfDocument addForegroundPdf(PdfDocument foregroundPdf,
                                          int foregroundPdfPageIndex)
```
    Adds a foreground to each page of this PDF. The foreground is copied from a selected page in the foregroundPdf document.
    
    Parameters:
    
    foregroundPdf - The foreground PDF document.
    
    foregroundPdfPageIndex - Index (zero-based page number) of the page to copy from the Background/Foreground PDF. Default is 0.
    
    Returns:
    
    Returns this PdfDocument object, allowing for a 'fluent' chained in-line code style
  - addForegroundPdf
```
public final PdfDocument addForegroundPdf(PdfDocument foregroundPdf,
                                          PageSelection pageSelection)
```
    Adds a foreground to selected page(s) of this PDF. The foreground is copied from a selected page in the foregroundPdf document.
    
    Parameters:
    
    foregroundPdf - The foreground PDF document.
    
    pageSelection - PageSelection to which the background/foreground will be added. Default is PageSelection.AllPages().
    
    Returns:
    
    Returns this PdfDocument object, allowing for a 'fluent' chained in-line code style
  - addForegroundPdf
```
public final PdfDocument addForegroundPdf(PdfDocument foregroundPdf,
                                          int foregroundPdfPageIndex,
                                          PageSelection pageSelection)
```
    Adds a foreground to selected page(s) of this PDF. The foreground is copied from a selected page in the foregroundPdf document.
    
    Parameters:
    
    foregroundPdf - The foreground PDF document.
    
    foregroundPdfPageIndex - Index (zero-based page number) of the page to copy from the Background/Foreground PDF. Default is 0.
    
    pageSelection - PageSelection to which the background/foreground will be added. Default is PageSelection.AllPages().
    
    Returns:
    
    Returns this PdfDocument object, allowing for a 'fluent' chained in-line code style
  - addTextHeader
```
public PdfDocument addTextHeader(TextHeaderFooter header)
```
    Renders TEXT page headers onto an existing PDF File
    
    Parameters:
    
    header - A new instance of IronPdf.TextHeaderFooter that defines the header content and layout.
    
    Returns:
    
    the pdf document
  - addTextHeader
```
public PdfDocument addTextHeader(TextHeaderFooter header,
                                 PageSelection pageSelection)
```
    Renders TEXT page headers onto an existing PDF File
    
    Parameters:
    
    header - A new instance of IronPdf.TextHeaderFooter that defines the header content and layout.
    
    pageSelection - Selected page indexes. Default is all pages.
    
    Returns:
    
    the pdf document
  - addTextHeader
```
public PdfDocument addTextHeader(TextHeaderFooter header,
                                 HeaderFooterOptions headerFooterOptions)
```
    Renders TEXT page headers onto an existing PDF File
    
    Parameters:
    
    header - A new instance of IronPdf.TextHeaderFooter that defines the header content and layout.
    
    headerFooterOptions - HeaderFooterOption.
    
    Returns:
    
    the pdf document
  - addTextHeader
```
public PdfDocument addTextHeader(TextHeaderFooter header,
                                 HeaderFooterOptions headerFooterOptions,
                                 PageSelection pageSelection)
```
    Renders TEXT page headers onto an existing PDF File
    
    Parameters:
    
    header - A new instance of IronPdf.TextHeaderFooter that defines the header content and layout.
    
    headerFooterOptions - HeaderFooterOption.
    
    pageSelection - Selected page indexes. Default is all pages.
    
    Returns:
    
    the pdf document
  - addTextFooter
```
public PdfDocument addTextFooter(TextHeaderFooter footer)
```
    Renders TEXT page footers onto an existing PDF File
    
    Parameters:
    
    footer - A new instance of IronPdf.TextHeaderFooter that defines the footer content and layout.
    
    Returns:
    
    the pdf document
  - addTextFooter
```
public PdfDocument addTextFooter(TextHeaderFooter footer,
                                 PageSelection pageSelection)
```
    Renders TEXT page footers onto an existing PDF File
    
    Parameters:
    
    footer - A new instance of IronPdf.TextHeaderFooter that defines the footer content and layout.
    
    pageSelection - Selected page indexes. Default is all pages.
    
    Returns:
    
    the pdf document
  - addTextFooter
```
public PdfDocument addTextFooter(TextHeaderFooter footer,
                                 HeaderFooterOptions headerFooterOptions)
```
    Renders TEXT page footer onto an existing PDF File
    
    Parameters:
    
    footer - A new instance of IronPdf.TextHeaderFooter that defines the footer content and layout.
    
    headerFooterOptions - HeaderFooterOption.
    
    Returns:
    
    the pdf document
  - addTextFooter
```
public PdfDocument addTextFooter(TextHeaderFooter footer,
                                 HeaderFooterOptions headerFooterOptions,
                                 PageSelection pageSelection)
```
    Renders TEXT page footer onto an existing PDF File
    
    Parameters:
    
    footer - A new instance of IronPdf.TextHeaderFooter that defines the footer content and layout.
    
    headerFooterOptions - HeaderFooterOption.
    
    pageSelection - Selected page indexes. Default is all pages.
    
    Returns:
    
    the pdf document
  - addHtmlHeader
```
public PdfDocument addHtmlHeader(HtmlHeaderFooter header)
```
    Renders HTML page headers onto an existing PDF File
    
    Parameters:
    
    header - A new instance of IronPdf.HtmlHeaderFooter that defines the header content and layout.
    
    Returns:
    
    the pdf document
  - addHtmlHeader
```
public PdfDocument addHtmlHeader(HtmlHeaderFooter header,
                                 PageSelection pageSelection)
```
    Renders HTML page headers onto an existing PDF File
    
    Parameters:
    
    header - A new instance of IronPdf.HtmlHeaderFooter that defines the header content and layout.
    
    pageSelection - Selected page indexes. Default is all pages.
    
    Returns:
    
    the pdf document
  - addHtmlHeader
```
public PdfDocument addHtmlHeader(HtmlHeaderFooter header,
                                 HeaderFooterOptions headerFooterOptions)
```
    Renders HTML page headers onto an existing PDF File
    
    Parameters:
    
    header - A new instance of IronPdf.HtmlHeaderFooter that defines the header content and layout.
    
    headerFooterOptions - HeaderFooterOption.
    
    Returns:
    
    the pdf document
  - addHtmlHeader
```
public PdfDocument addHtmlHeader(HtmlHeaderFooter header,
                                 HeaderFooterOptions headerFooterOptions,
                                 PageSelection pageSelection)
```
    Renders HTML page headers onto an existing PDF File
    
    Parameters:
    
    header - A new instance of IronPdf.HtmlHeaderFooter that defines the header content and layout.
    
    headerFooterOptions - HeaderFooterOption.
    
    pageSelection - Selected page indexes. Default is all pages.
    
    Returns:
    
    the pdf document
  - addHtmlFooter
```
public PdfDocument addHtmlFooter(HtmlHeaderFooter footer)
```
    Renders HTML page footers onto an existing PDF File
    
    Parameters:
    
    footer - A new instance of IronPdf.HtmlHeaderFooter that defines the footer content and layout.
    
    Returns:
    
    the pdf document
  - addHtmlFooter
```
public PdfDocument addHtmlFooter(HtmlHeaderFooter footer,
                                 PageSelection pageSelection)
```
    Renders HTML page footers onto an existing PDF File
    
    Parameters:
    
    footer - A new instance of IronPdf.HtmlHeaderFooter that defines the footer content and layout.
    
    pageSelection - Selected page indexes. Default is all pages.
    
    Returns:
    
    the pdf document
  - addHtmlFooter
```
public PdfDocument addHtmlFooter(HtmlHeaderFooter footer,
                                 HeaderFooterOptions headerFooterOptions)
```
    Renders HTML page footer onto an existing PDF File
    
    Parameters:
    
    footer - A new instance of IronPdf.HtmlHeaderFooter that defines the footer content and layout.
    
    headerFooterOptions - HeaderFooterOption.
    
    Returns:
    
    the pdf document
  - addHtmlFooter
```
public PdfDocument addHtmlFooter(HtmlHeaderFooter footer,
                                 HeaderFooterOptions headerFooterOptions,
                                 PageSelection pageSelection)
```
    Renders HTML page footer onto an existing PDF File
    
    Parameters:
    
    footer - A new instance of IronPdf.HtmlHeaderFooter that defines the footer content and layout.
    
    headerFooterOptions - HeaderFooterOption.
    
    pageSelection - Selected page indexes. Default is all pages.
    
    Returns:
    
    the pdf document
  - drawImage
```
public final void drawImage(Path imagePath,
                            DrawImageOptions option)
                     throws IOException
```
    Draws an image onto the PDF document
    
    Parameters:
    
    imagePath - The image file path.
    
    option - the option
    
    Throws:
    
    IOException - the io exception
  - drawImage
```
public final void drawImage(byte[] imageBytes,
                            DrawImageOptions option)
```
    Draws an image onto the PDF document
    
    Parameters:
    
    imageBytes - image byte array
    
    option - the option
  - toBufferedImages
```
public final List<BufferedImage> toBufferedImages()
                                           throws IOException
```
    Rasterizes (renders) the PDF into BufferedImage objects. 1 BufferedImage for each page.
    
    Returns:
    
    An array of BufferedImage objects.
    
    Throws:
    
    IOException - the io exception
  - toBufferedImages
```
public final List<BufferedImage> toBufferedImages(ToImageOptions options)
                                           throws IOException
```
    Rasterizes (renders) the PDF into BufferedImage objects. 1 BufferedImage for each page.
    
    Parameters:
    
    options - The ToImageOptions
    
    Returns:
    
    An array of BufferedImage objects.
    
    Throws:
    
    IOException - the io exception
  - toBufferedImages
```
public final List<BufferedImage> toBufferedImages(PageSelection pageSelection)
                                           throws IOException
```
    Rasterizes (renders) the PDF into BufferedImage objects. 1 BufferedImage for each page.
    
    Parameters:
    
    pageSelection - Selected page indexes. Default is all pages.
    
    Returns:
    
    An array of BufferedImage objects.
    
    Throws:
    
    IOException - the io exception
  - toBufferedImages
```
public final List<BufferedImage> toBufferedImages(ToImageOptions options,
                                                  PageSelection pageSelection)
                                           throws IOException
```
    Rasterizes (renders) the PDF into BufferedImage objects. 1 BufferedImage for each page.
    
    Parameters:
    
    options - The ToImageOptions
    
    pageSelection - Selected page indexes. Default is all pages.
    
    Returns:
    
    An array of BufferedImage objects.
    
    Throws:
    
    IOException - the io exception
  - toPngImages
```
public final List<String> toPngImages(String fileNamePattern)
                               throws IOException
```
    Renders the pages of the PDF as PNG (Portable Network Graphic) files and saves them to disk.
    Specific image dimensions and page numbers may be given as optional parameters.
    
    fileNamePattern should normally contain an asterisk (*) character which will be substituted for the page numbers.
    
    Parameters:
    
    fileNamePattern - A full or partial file path for the output files containing an asterisk. E.g. C:\images\pdf_pages_*.png
    
    Returns:
    
    An array of the file paths of the image files created.
    
    Throws:
    
    IOException - the io exception
  - toPngImages
```
public final List<String> toPngImages(String fileNamePattern,
                                      ToImageOptions options)
                               throws IOException
```
    Renders the pages of the PDF as PNG (Portable Network Graphic) files and saves them to disk.
    Specific image dimensions and page numbers may be given as optional parameters.
    
    fileNamePattern should normally contain an asterisk (*) character which will be substituted for the page numbers.
    
    Parameters:
    
    fileNamePattern - A full or partial file path for the output files containing an asterisk. E.g. C:\images\pdf_pages_*.png
    
    options - The ToImageOptions
    
    Returns:
    
    An array of the file paths of the image files created.
    
    Throws:
    
    IOException - the io exception
  - toPngImages
```
public final List<String> toPngImages(String fileNamePattern,
                                      PageSelection pageSelection)
                               throws IOException
```
    Renders the pages of the PDF as PNG (Portable Network Graphic) files and saves them to disk.
    Specific image dimensions and page numbers may be given as optional parameters.
    
    fileNamePattern should normally contain an asterisk (*) character which will be substituted for the page numbers.
    
    Parameters:
    
    fileNamePattern - A full or partial file path for the output files containing an asterisk. E.g. C:\images\pdf_pages_*.png
    
    pageSelection - Selected page indexes. Default is all pages.
    
    Returns:
    
    An array of the file paths of the image files created.
    
    Throws:
    
    IOException - the io exception
  - toPngImages
```
public final List<String> toPngImages(String fileNamePattern,
                                      ToImageOptions options,
                                      PageSelection pageSelection)
                               throws IOException
```
    Renders the pages of the PDF as PNG (Portable Network Graphic) files and saves them to disk.
    Specific image dimensions and page numbers may be given as optional parameters.
    
    fileNamePattern should normally contain an asterisk (*) character which will be substituted for the page numbers.
    
    Parameters:
    
    fileNamePattern - A full or partial file path for the output files containing an asterisk. E.g. C:\images\pdf_pages_*.png
    
    options - The ToImageOptions
    
    pageSelection - Selected page indexes. Default is all pages.
    
    Returns:
    
    An array of the file paths of the image files created.
    
    Throws:
    
    IOException - the io exception
  - toImages
```
public List<String> toImages(String fileNamePattern,
                             String imageFileType)
                      throws IOException
```
    Renders the pages of the PDF as specific image files type and saves them to disk.
    Specific image dimensions and page numbers may be given as optional parameters.
    
    fileNamePattern should normally contain an asterisk (*) character which will be substituted for the page numbers.
    
    Parameters:
    
    fileNamePattern - A full or partial file path for the output files containing an asterisk. E.g. C:\images\pdf_page_*.jpg
    
    imageFileType - a specific image file type without dot. E.g. "jpg", "png", "bmp", "gif", "tiff"
    
    Returns:
    
    An array of the file paths of the image files created.
    
    Throws:
    
    IOException - the io exception
  - toImages
```
public List<String> toImages(String fileNamePattern,
                             String imageFileType,
                             ToImageOptions options)
                      throws IOException
```
    Renders the pages of the PDF as specific image files type and saves them to disk.
    Specific image dimensions and page numbers may be given as optional parameters.
    
    fileNamePattern should normally contain an asterisk (*) character which will be substituted for the page numbers.
    
    Parameters:
    
    fileNamePattern - A full or partial file path for the output files containing an asterisk. E.g. C:\images\pdf_page_*.jpg
    
    imageFileType - a specific image file type without dot. E.g. "jpg", "png", "bmp", "gif", "tiff"
    
    options - The ToImageOptions
    
    Returns:
    
    An array of the file paths of the image files created.
    
    Throws:
    
    IOException - the io exception
  - toImages
```
public List<String> toImages(String fileNamePattern,
                             String imageFileType,
                             PageSelection pageSelection)
                      throws IOException
```
    Renders the pages of the PDF as specific image files type and saves them to disk.
    Specific image dimensions and page numbers may be given as optional parameters.
    
    fileNamePattern should normally contain an asterisk (*) character which will be substituted for the page numbers.
    
    Parameters:
    
    fileNamePattern - A full or partial file path for the output files containing an asterisk. E.g. C:\images\pdf_page_*.jpg
    
    imageFileType - a specific image file type without dot. E.g. "jpg", "png", "bmp", "gif", "tiff"
    
    pageSelection - Selected page indexes. Default is all pages.
    
    Returns:
    
    An array of the file paths of the image files created.
    
    Throws:
    
    IOException - the io exception
  - toImages
```
public List<String> toImages(String fileNamePattern,
                             String imageFileType,
                             ToImageOptions options,
                             PageSelection pageSelection)
                      throws IOException
```
    Renders the pages of the PDF as specific image files type and saves them to disk.
    Specific image dimensions and page numbers may be given as optional parameters.
    
    fileNamePattern should normally contain an asterisk (*) character which will be substituted for the page numbers.
    
    Parameters:
    
    fileNamePattern - A full or partial file path for the output files containing an asterisk. E.g. C:\images\pdf_page_*.jpg
    
    imageFileType - a specific image file type without dot. E.g. "jpg", "png", "bmp", "gif", "tiff"
    
    options - The ToImageOptions
    
    pageSelection - Selected page indexes. Default is all pages.
    
    Returns:
    
    An array of the file paths of the image files created.
    
    Throws:
    
    IOException - the io exception
  - toJpegImages
```
public final List<String> toJpegImages(String fileNamePattern)
                                throws IOException
```
    Renders the pages of the PDF as JPEG image files and saves them to disk.
    Specific image dimensions and page numbers may be given as optional parameters.
    
    fileNamePattern should normally contain an asterisk (*) character which will be substituted for the page numbers.
    
    Parameters:
    
    fileNamePattern - A full or partial file path for the output files containing an asterisk. E.g. C:\images\pdf_page_*.jpg
    
    Returns:
    
    An array of the file paths of the image files created.
    
    Throws:
    
    IOException - the io exception
  - toJpegImages
```
public final List<String> toJpegImages(String fileNamePattern,
                                       ToImageOptions options)
                                throws IOException
```
    Renders the pages of the PDF as JPEG image files and saves them to disk.
    Specific image dimensions and page numbers may be given as optional parameters.
    
    fileNamePattern should normally contain an asterisk (*) character which will be substituted for the page numbers.
    
    Parameters:
    
    fileNamePattern - A full or partial file path for the output files containing an asterisk. E.g. C:\images\pdf_page_*.jpg
    
    options - The ToImageOptions
    
    Returns:
    
    An array of the file paths of the image files created.
    
    Throws:
    
    IOException - the io exception
  - toJpegImages
```
public final List<String> toJpegImages(String fileNamePattern,
                                       PageSelection pageSelection)
                                throws IOException
```
    Renders the pages of the PDF as JPEG image files and saves them to disk.
    Specific image dimensions and page numbers may be given as optional parameters.
    
    fileNamePattern should normally contain an asterisk (*) character which will be substituted for the page numbers.
    
    Parameters:
    
    fileNamePattern - A full or partial file path for the output files containing an asterisk. E.g. C:\images\pdf_page_*.jpg
    
    pageSelection - Selected page indexes. Default is all pages.
    
    Returns:
    
    An array of the file paths of the image files created.
    
    Throws:
    
    IOException - the io exception
  - toJpegImages
```
public final List<String> toJpegImages(String fileNamePattern,
                                       ToImageOptions options,
                                       PageSelection pageSelection)
                                throws IOException
```
    Renders the pages of the PDF as JPEG image files and saves them to disk.
    Specific image dimensions and page numbers may be given as optional parameters.
    
    fileNamePattern should normally contain an asterisk (*) character which will be substituted for the page numbers.
    
    Parameters:
    
    fileNamePattern - A full or partial file path for the output files containing an asterisk. E.g. C:\images\pdf_page_*.jpg
    
    options - The ToImageOptions
    
    pageSelection - Selected page indexes. Default is all pages.
    
    Returns:
    
    An array of the file paths of the image files created.
    
    Throws:
    
    IOException - the io exception
  - toMultiPageTiff
```
public String toMultiPageTiff(Path filePath)
                       throws IOException
```
    Renders the pages of the PDF as TIFF (Tagged Image File Format / Tif) file and saves it to disk. Specific image dimensions and page numbers may be given as optional parameters FileNamePattern should normally contain an asterisk (*) character which will be substituted for the page numbers
    
    Parameters:
    
    filePath - A file path for the output file. E.g. C:\images\pdf_pages.tiff
    
    Returns:
    
    A file path of the image file created.
    
    Throws:
    
    IOException - the io exception
  - toMultiPageTiff
```
public String toMultiPageTiff(Path filePath,
                              PageSelection pageSelection)
                       throws IOException
```
    Renders the pages of the PDF as TIFF (Tagged Image File Format / Tif) file and saves it to disk. Specific image dimensions and page numbers may be given as optional parameters FileNamePattern should normally contain an asterisk (*) character which will be substituted for the page numbers
    
    Parameters:
    
    filePath - A file path for the output file. E.g. C:\images\pdf_pages.tiff
    
    pageSelection - Selected page indexes. Default is all pages.
    
    Returns:
    
    A file path of the image file created.
    
    Throws:
    
    IOException - the io exception
  - toMultiPageTiff
```
public String toMultiPageTiff(Path filePath,
                              ToImageOptions options)
                       throws IOException
```
    Renders the pages of the PDF as TIFF (Tagged Image File Format / Tif) file and saves it to disk. Specific image dimensions and page numbers may be given as optional parameters FileNamePattern should normally contain an asterisk (*) character which will be substituted for the page numbers
    
    Parameters:
    
    filePath - A file path for the output file. E.g. C:\images\pdf_pages.tiff
    
    options - The ToImageOptions
    
    Returns:
    
    A file path of the image file created.
    
    Throws:
    
    IOException - the io exception
  - toMultiPageTiff
```
public String toMultiPageTiff(Path filePath,
                              ToImageOptions options,
                              PageSelection pageSelection)
                       throws IOException
```
    Renders the pages of the PDF as TIFF (Tagged Image File Format / Tif) file and saves it to disk. Specific image dimensions and page numbers may be given as optional parameters FileNamePattern should normally contain an asterisk (*) character which will be substituted for the page numbers
    
    Parameters:
    
    filePath - A file path for the output file. E.g. C:\images\pdf_pages.tiff
    
    options - The ToImageOptions
    
    pageSelection - Selected page indexes. Default is all pages.
    
    Returns:
    
    A file path of the image file created.
    
    Throws:
    
    IOException - the io exception
  - compressImages
```
@Deprecated
public final void compressImages(int quality)
```
    Deprecated. Use compressAndSaveAs(String) or compressPdfToBytes() for QPdf smart compression.
    
    Reduces the PDF's file size by compressing existing images using JPEG encoding and the specified quality setting.
    
    Parameters:
    
    quality - Quality (1 - 100) to use during compression
  - compressImages
```
@Deprecated
public final void compressImages(int quality,
                                             boolean scaleToVisibleSize)
```
    Deprecated. Use compressAndSaveAs(String) or compressPdfToBytes() for QPdf smart compression.
    
    Reduces the PDF's file size by compressing existing images using JPEG encoding and the specified quality settings.
    
    Parameters:
    
    quality - Quality (1 - 100) to use during compression
    
    scaleToVisibleSize - Scale down the image resolution according to its visible size in the PDF document; may cause distortion with some image configurations. Default is false.
  - compressStructTree
```
public final void compressStructTree(int quality,
                                     boolean scaleToVisibleSize)
```
    Remove document struct tree information which describes the logical layout of the document. Removing the "structure tree" can significantly reduce the disk space used by the document. Removing the "structure tree" of a complicated document can negatively impact text selection.
  - compressPdfToBytes
```
public final byte[] compressPdfToBytes()
```
    Compresses the PDF using QPdf smart compression and returns the compressed bytes in memory. Unlike compressImages(int), this uses QPdf's full compression pipeline without saving to disk.
    
    Returns:
    
    the compressed PDF as a byte array
  - compressPdfToBytes
```
public final byte[] compressPdfToBytes(String password)
```
    Compresses the PDF using QPdf smart compression and returns the compressed bytes in memory. Unlike compressImages(int), this uses QPdf's full compression pipeline without saving to disk.
    
    Parameters:
    
    password - the PDF password (empty string if none)
    
    Returns:
    
    the compressed PDF as a byte array
  - compressPdfToStream
```
public final InputStream compressPdfToStream()
```
    Compresses the PDF using QPdf smart compression and returns the result as an InputStream. This is the stream equivalent of compressPdfToBytes().
    
    Returns:
    
    the compressed PDF as an InputStream
  - compressPdfToStream
```
public final InputStream compressPdfToStream(String password)
```
    Compresses the PDF using QPdf smart compression and returns the result as an InputStream. This is the stream equivalent of compressPdfToBytes(String).
    
    Parameters:
    
    password - the PDF password (empty string if none)
    
    Returns:
    
    the compressed PDF as an InputStream
  - compressAndSaveAs
```
public final void compressAndSaveAs(String outputFilePath)
```
    Compresses the PDF using QPdf smart compression and saves the result to a file.
    
    Parameters:
    
    outputFilePath - the file path to save the compressed PDF
  - compressAndSaveAs
```
public final void compressAndSaveAs(String outputFilePath,
                                    int jpegQuality)
```
    Compresses the PDF using QPdf smart compression and saves the result to a file, with JPEG quality setting for image recompression.
    
    Parameters:
    
    outputFilePath - the file path to save the compressed PDF
    
    jpegQuality - JPEG quality (1-100) for image recompression
  - compressAndSaveAs
```
public final void compressAndSaveAs(String outputFilePath,
                                    AdvancedCompressionOptions options)
```
    Apply the advanced compression pipeline and save the result to a file.
    Combines pdfium-side image DPI downsampling with qpdf-side structural optimization in a single call.
    
    Parameters:
    
    outputFilePath - the file path to save the compressed PDF
    
    options - advanced compression options
  - compressAndSaveAs
```
public static void compressAndSaveAs(byte[] pdfBytes,
                                     String outputFilePath,
                                     String password,
                                     AdvancedCompressionOptions options)
```
    Apply the advanced compression pipeline to byte[] input and save the result to a file.
    
    Parameters:
    
    pdfBytes - the input PDF bytes
    
    outputFilePath - the file path to save the compressed PDF
    
    password - the PDF password (empty string or null if none)
    
    options - advanced compression options
  - compressAndSaveAs
```
public static void compressAndSaveAs(InputStream pdfStream,
                                     String outputFilePath,
                                     String password,
                                     AdvancedCompressionOptions options)
                              throws IOException
```
    Apply the advanced compression pipeline to a stream input and save the result to a file.
    
    Throws:
    
    IOException
  - isLinearized
```
public static boolean isLinearized(String pdfFilePath)
                            throws IOException
```
    Check whether the PDF file at the given path is linearized (a.k.a. "Fast Web View"). A linearized PDF can be streamed and displayed incrementally by web browsers.
    
    Parameters:
    
    pdfFilePath - the path to the PDF file on disk
    
    Returns:
    
    true if the file is linearized, false otherwise
    
    Throws:
    
    IOException - if the file cannot be read
  - isLinearized
```
public static boolean isLinearized(String pdfFilePath,
                                   String password)
                            throws IOException
```
    Check whether the PDF file at the given path is linearized (a.k.a. "Fast Web View"). A linearized PDF can be streamed and displayed incrementally by web browsers.
    
    Parameters:
    
    pdfFilePath - the path to the PDF file on disk
    
    password - the PDF password (empty string if none)
    
    Returns:
    
    true if the file is linearized, false otherwise
    
    Throws:
    
    IOException - if the file cannot be read
  - isLinearized
```
public static boolean isLinearized(Path pdfFilePath)
                            throws IOException
```
    Check whether the PDF file at the given path is linearized (a.k.a. "Fast Web View").
    
    Parameters:
    
    pdfFilePath - the path to the PDF file on disk
    
    Returns:
    
    true if the file is linearized, false otherwise
    
    Throws:
    
    IOException - if the file cannot be read
  - linearizePdfToBytes
```
public final byte[] linearizePdfToBytes()
```
    Linearizes the current PDF document and returns the result as a byte array using the LinearizationMode.Automatic strategy.
    
    Returns:
    
    the linearized PDF as a byte array
  - linearizePdfToBytes
```
public final byte[] linearizePdfToBytes(LinearizationMode mode)
```
    Linearizes the current PDF document and returns the result as a byte array.
    
    Parameters:
    
    mode - the linearization strategy to use; defaults to LinearizationMode.Automatic if null
    
    Returns:
    
    the linearized PDF as a byte array
  - linearizePdfToBytes
```
public final byte[] linearizePdfToBytes(String password)
```
    Linearizes the current PDF document and returns the result as a byte array.
    
    Parameters:
    
    password - the PDF password (empty string if none)
    
    Returns:
    
    the linearized PDF as a byte array
  - linearizePdfToBytes
```
public final byte[] linearizePdfToBytes(String password,
                                        LinearizationMode mode)
```
    Linearizes the current PDF document and returns the result as a byte array.
    
    Parameters:
    
    password - the PDF password (empty string if none)
    
    mode - the linearization strategy to use
    
    Returns:
    
    the linearized PDF as a byte array
  - linearizePdfToStream
```
public final InputStream linearizePdfToStream()
```
    Linearizes the current PDF document and returns the result as an InputStream. This is the stream equivalent of linearizePdfToBytes().
    
    Returns:
    
    the linearized PDF as an InputStream
  - linearizePdfToStream
```
public final InputStream linearizePdfToStream(LinearizationMode mode)
```
    Linearizes the current PDF document and returns the result as an InputStream.
    
    Parameters:
    
    mode - the linearization strategy to use
    
    Returns:
    
    the linearized PDF as an InputStream
  - linearizePdfToStream
```
public final InputStream linearizePdfToStream(String password)
```
    Linearizes the current PDF document and returns the result as an InputStream.
    
    Parameters:
    
    password - the PDF password (empty string if none)
    
    Returns:
    
    the linearized PDF as an InputStream
  - linearizePdfToStream
```
public final InputStream linearizePdfToStream(String password,
                                              LinearizationMode mode)
```
    Linearizes the current PDF document and returns the result as an InputStream.
    
    Parameters:
    
    password - the PDF password (empty string if none)
    
    mode - the linearization strategy to use
    
    Returns:
    
    the linearized PDF as an InputStream
  - saveAsLinearized
```
public final void saveAsLinearized(String outputFilePath)
                            throws IOException
```
    Linearizes the current PDF document and saves the result to a file path.
    
    Parameters:
    
    outputFilePath - the file path to save the linearized PDF
    
    Throws:
    
    IOException - if the file cannot be written
  - saveAsLinearized
```
public final void saveAsLinearized(String outputFilePath,
                                   String password)
                            throws IOException
```
    Linearizes the current PDF document and saves the result to a file path.
    
    Parameters:
    
    outputFilePath - the file path to save the linearized PDF
    
    password - the PDF password (empty string if none)
    
    Throws:
    
    IOException - if the file cannot be written
  - linearizePdfToBytes
```
public static byte[] linearizePdfToBytes(byte[] pdfBytes)
```
    Static helper that linearizes the given PDF bytes and returns the linearized bytes using the LinearizationMode.Automatic strategy.
    
    Parameters:
    
    pdfBytes - the PDF bytes to linearize
    
    Returns:
    
    the linearized PDF as a byte array
  - linearizePdfToBytes
```
public static byte[] linearizePdfToBytes(byte[] pdfBytes,
                                         String password)
```
    Static helper that linearizes the given PDF bytes and returns the linearized bytes.
    
    Parameters:
    
    pdfBytes - the PDF bytes to linearize
    
    password - the PDF password (empty string if none)
    
    Returns:
    
    the linearized PDF as a byte array
  - linearizePdfToBytes
```
public static byte[] linearizePdfToBytes(byte[] pdfBytes,
                                         String password,
                                         LinearizationMode mode)
```
    Static helper that linearizes the given PDF bytes and returns the linearized bytes.
    
    Parameters:
    
    pdfBytes - the PDF bytes to linearize
    
    password - the PDF password (empty string if none)
    
    mode - the linearization strategy to use
    
    Returns:
    
    the linearized PDF as a byte array
  - linearizePdfToBytes
```
public static byte[] linearizePdfToBytes(InputStream pdfStream)
                                  throws IOException
```
    Static helper that linearizes a PDF from an InputStream and returns the linearized bytes.
    
    Parameters:
    
    pdfStream - the input PDF stream
    
    Returns:
    
    the linearized PDF as a byte array
    
    Throws:
    
    IOException - if the stream cannot be read
  - linearizePdfToBytes
```
public static byte[] linearizePdfToBytes(InputStream pdfStream,
                                         String password)
                                  throws IOException
```
    Static helper that linearizes a PDF from an InputStream and returns the linearized bytes.
    
    Parameters:
    
    pdfStream - the input PDF stream
    
    password - the PDF password (empty string if none)
    
    Returns:
    
    the linearized PDF as a byte array
    
    Throws:
    
    IOException - if the stream cannot be read
  - linearizePdfToBytes
```
public static byte[] linearizePdfToBytes(InputStream pdfStream,
                                         String password,
                                         LinearizationMode mode)
                                  throws IOException
```
    Static helper that linearizes a PDF from an InputStream and returns the linearized bytes.
    
    Parameters:
    
    pdfStream - the input PDF stream
    
    password - the PDF password (empty string if none)
    
    mode - the linearization strategy to use
    
    Returns:
    
    the linearized PDF as a byte array
    
    Throws:
    
    IOException - if the stream cannot be read
  - saveAsLinearized
```
public static void saveAsLinearized(byte[] pdfBytes,
                                    String outputFilePath)
                             throws IOException
```
    Static helper that linearizes the given PDF bytes and saves the result to the given output file path.
    
    Parameters:
    
    pdfBytes - the input PDF bytes
    
    outputFilePath - the path to save the linearized PDF
    
    Throws:
    
    IOException - if the file cannot be written
  - saveAsLinearized
```
public static void saveAsLinearized(byte[] pdfBytes,
                                    String outputFilePath,
                                    String password)
                             throws IOException
```
    Static helper that linearizes the given PDF bytes and saves the result to the given output file path.
    
    Parameters:
    
    pdfBytes - the input PDF bytes
    
    outputFilePath - the path to save the linearized PDF
    
    password - the PDF password (empty string if none)
    
    Throws:
    
    IOException - if the file cannot be written
  - getElementLocations
```
public final List<RenderedElementLocation> getElementLocations()
```
    Retrieves the rendered page locations of HTML elements that were tracked during rendering.
    To use this feature, set ChromePdfRenderOptions.setElementQuerySelectors(String[]) with CSS selectors before rendering. After rendering, call this method to retrieve the page index and coordinates of each matched element.
    
    Mirrors IronPdf.PdfDocument.GetElementLocations() on the C# side.
    
    Returns:
    
    A list of RenderedElementLocation objects, one per matched element, sorted in document order. Returns an empty list if no element query selectors were configured or no elements matched.
  - resetElementLocationCache
```
public final void resetElementLocationCache()
```
    Clears the cached result of getElementLocations(), forcing a fresh scan of the document's annotations on the next call. Call this if you've modified the document's annotations or structure after rendering.
  - extractAllImages
```
public final List<BufferedImage> extractAllImages()
                                           throws IOException
```
    Finds all embedded Images from within the PDF and returns them as a list of BufferedImage images.
    
    Returns:
    
    The extracted images as BufferedImage objects.
    
    Throws:
    
    IOException - the io exception
  - extractAllRawImages
```
public final List<byte[]> extractAllRawImages()
                                       throws IOException
```
    Finds all embedded Images from within the PDF and returns as a list of image bytes
    
    Returns:
    
    The extracted images as byte arrays.
    
    Throws:
    
    IOException - the io exception
  - extractAllImagesFromPages
```
public final List<BufferedImage> extractAllImagesFromPages(PageSelection pageSelection)
                                                    throws IOException
```
    Finds all embedded Images from within the PDF and returns as a list of image bytes
    
    Parameters:
    
    pageSelection - The selected page index(es). Default is all pages.
    
    Returns:
    
    The extracted images as BufferedImage objects.
    
    Throws:
    
    IOException - the io exception
  - extractAllRawImagesFromPages
```
public final List<byte[]> extractAllRawImagesFromPages(PageSelection pageSelection)
                                                throws IOException
```
    Finds all embedded Images from within the PDF and returns them as raw bytes.
    
    Parameters:
    
    pageSelection - The selected page index(es). Default is all pages.
    
    Returns:
    
    The extracted images as byte arrays.
    
    Throws:
    
    IOException - the io exception
  - saveAs
```
public final PdfDocument saveAs(Path filePath)
                         throws IOException
```
    Saves this PdfDocument to a file.
    
    Parameters:
    
    filePath - File Path
    
    Returns:
    
    This PdfDocument for fluid code notation.
    
    Throws:
    
    IOException - the io exception
  - saveAs
```
public final PdfDocument saveAs(String filePath)
                         throws IOException
```
    Saves this PdfDocument to a file.
    
    Parameters:
    
    filePath - File path string
    
    Returns:
    
    This PdfDocument for fluid code notation.
    
    Throws:
    
    IOException - the io exception
  - saveAsRevision
```
public final PdfDocument saveAsRevision(Path filePath)
                                 throws IOException
```
    Saves this PdfDocument to a file.
    
    Parameters:
    
    filePath - File Path
    
    Returns:
    
    This PdfDocument for fluid code notation.
    
    Throws:
    
    IOException - the io exception
  - saveAsRevision
```
public final PdfDocument saveAsRevision(String filePath)
                                 throws IOException
```
    Saves this PdfDocument to a file.
    
    Parameters:
    
    filePath - File path string
    
    Returns:
    
    This PdfDocument for fluid code notation.
    
    Throws:
    
    IOException - the io exception
  - getBinaryData
```
public final byte[] getBinaryData()
```
    Saves the PDF as byte array, including any changes.
    
    Returns:
    
    The PDF file as a byte array.
  - getBinaryDataIncremental
```
public final byte[] getBinaryDataIncremental()
```
    Saves the PDF as byte array with changes appended to the end of the file.
    
    Returns:
    
    The PDF file as a byte array.
  - getRevision
```
public final byte[] getRevision(int index)
```
    Saves the PDF as byte array at the specified revision number. saveAsRevision(java.nio.file.Path)
    
    Parameters:
    
    index - revision index
    
    Returns:
    
    a PdfDocument document
  - print
```
public void print()
           throws PrinterException
```
    Prints this PDF by sending it to the computer's real world printer(s).
    For advanced real-world printing options please implement your own java.awt.print code.
    This class PdfDocumentimplements java.awt.print.Printable.
    
    Throws:
    
    PrinterException - the printer exception
  - printWithoutDialog
```
public void printWithoutDialog()
                        throws PrinterException
```
    Prints this PDF by sending it to the computer's real world printer(s).
    For advanced real-world printing options please implement your own java.awt.print code.
    This class PdfDocumentimplements java.awt.print.Printable.
    
    Throws:
    
    PrinterException - the printer exception
  - print
```
public int print(Graphics graphics,
                 PageFormat pageFormat,
                 int pageIndex)
          throws PrinterException
```
    Specified by:
    
    print in interface Printable
    
    Throws:
    
    PrinterException
  - applyWatermark
```
public final PdfDocument applyWatermark(String html,
                                        int opacity,
                                        VerticalAlignment verticalAlignment)
```
    Adds a watermark to this PDF.
    Please use applyStamp(Stamper) for more control.
    
    Parameters:
    
    html - The HTML fragment which will be stamped onto your PDF.
    
    opacity - Watermark transparent value. 0 is invisible, 100 if fully opaque.
    
    verticalAlignment - The vertical alignment of the watermark relative to the page.
    
    Returns:
    
    Returns this PdfDocument, allowing for a 'fluent' chained in-line code style
  - applyWatermark
```
public final PdfDocument applyWatermark(String html,
                                        int opacity,
                                        VerticalAlignment verticalAlignment,
                                        HorizontalAlignment horizontalAlignment)
```
    Adds a watermark to this PDF.
    Please use applyStamp(Stamper) for more control.
    
    Parameters:
    
    html - The HTML fragment which will be stamped onto your PDF.
    
    opacity - Watermark transparent value. 0 is invisible, 100 if fully opaque.
    
    verticalAlignment - The vertical alignment of the watermark relative to the page.
    
    horizontalAlignment - The horizontal alignment of the watermark relative to the page.
    
    Returns:
    
    Returns this PdfDocument, allowing for a 'fluent' chained in-line code style
  - applyWatermark
```
public final PdfDocument applyWatermark(String html,
                                        int opacity)
```
    Adds Watermark to PDF, Please use applyStamp(Stamper) for more control.
    
    Parameters:
    
    html - The HTML fragment which will be stamped onto your PDF.
    
    opacity - Watermark transparent value. 0 is invisible, 100 if fully opaque.
    
    Returns:
    
    Returns this PdfDocument, allowing for a 'fluent' chained in-line code style
  - applyWatermark
```
public final PdfDocument applyWatermark(String html)
```
    Adds Watermark to PDF, Please use applyStamp(Stamper) for more control.
    
    Parameters:
    
    html - The HTML fragment which will be stamped onto your PDF.
    
    Returns:
    
    Returns this PdfDocument, allowing for a 'fluent' chained in-line code style
  - applyStamp
```
public final PdfDocument applyStamp(Stamper stamper)
```
    Edits the PDF by applying the Stamper's rendered to every page.
    
    Parameters:
    
    stamper - The Stamper object that has the content to be stamped onto the PDF.
    
    Returns:
    
    Returns this PdfDocument, allowing for a 'fluent' chained in-line code style
  - applyStamp
```
public final PdfDocument applyStamp(Stamper stamper,
                                    PageSelection pageSelection)
```
    Edits the PDF by applying the Stamper's rendered to only selected page(s).
    
    Parameters:
    
    stamper - The Stamper object that has the content to be stamped onto the PDF.
    
    pageSelection - The selected page index(es). Default is all pages,
    
    Returns:
    
    Returns this PdfDocument, allowing for a 'fluent' chained in-line code style
  - extractAllText
```
public final String extractAllText()
```
    Extracts the written text content from the PDF and returns it as a string.
    
    Returns:
    
    All text in the PDF as a string.
    Pages are separated by 4 consecutive line breaks
  - extractTextFromPage
```
public final String extractTextFromPage(PageSelection pageSelection)
```
    Extracts the text content from one page of the PDF and returns it as a string.
    
    Parameters:
    
    pageSelection - The selected page index(es). Default is all pages.
    
    Returns:
    
    The text extracted from the PDF page as a string.
  - replaceText
```
public final void replaceText(PageSelection pageSelection,
                              String oldText,
                              String newText)
```
    Replace the specified old text with new text on a given page.
    
    Parameters:
    
    pageSelection - The selected page index(es).
    
    oldText - Old text to remove.
    
    newText - New text to add.
  - replaceText
```
public final void replaceText(PageSelection pageSelection,
                              String oldText,
                              String newText,
                              FontTypes customFont,
                              Float customFontSize)
```
    Replace the specified old text with new text on a given page.
    
    Parameters:
    
    pageSelection - The selected page index(es).
    
    oldText - Old text to remove.
    
    newText - New text to add.
    
    customFont - The font to use for the new text (nullable).
    
    customFontSize - The font size to use for the new text (nullable).
  - renderHtmlFileAsPdf
```
public static PdfDocument renderHtmlFileAsPdf(String htmlFilePath)
                                       throws IOException
```
    Creates a PDF file from a local Html file, and returns it as a PdfDocument.
    
    Parameters:
    
    htmlFilePath - Path to a Html to be rendered as a PDF.
    
    Returns:
    
    A PdfDocument
    
    Throws:
    
    IOException - the io exception
  - renderHtmlFileAsPdf
```
public static PdfDocument renderHtmlFileAsPdf(String htmlFilePath,
                                              String baseUrl)
                                       throws IOException
```
    Creates a PDF file from a local Html file, and returns it as a PdfDocument.
    
    Parameters:
    
    htmlFilePath - Path to a Html to be rendered as a PDF.
    
    baseUrl - Optional. Setting the BaseURL property gives the relative file path or URL context for hyperlinks, images, CSS and JavaScript files.
    
    Returns:
    
    A PdfDocument
    
    Throws:
    
    IOException - the io exception
  - renderHtmlFileAsPdf
```
public static PdfDocument renderHtmlFileAsPdf(String htmlFilePath,
                                              ChromePdfRenderOptions renderOptions,
                                              ChromeHttpLoginCredentials loginCredentials)
                                       throws IOException
```
    Creates a PDF file from a local Html file, and returns it as a PdfDocument.
    
    Parameters:
    
    htmlFilePath - Path to a Html to be rendered as a PDF.
    
    renderOptions - Rendering options
    
    loginCredentials - Http login credentials
    
    Returns:
    
    A PdfDocument
    
    Throws:
    
    IOException - the io exception
  - renderHtmlFileAsPdf
```
public static PdfDocument renderHtmlFileAsPdf(String htmlFilePath,
                                              String baseUrl,
                                              ChromePdfRenderOptions renderOptions,
                                              ChromeHttpLoginCredentials loginCredentials)
                                       throws IOException
```
    Creates a PDF file from a local Html file, and returns it as a PdfDocument.
    
    Parameters:
    
    htmlFilePath - Path to a Html to be rendered as a PDF.
    
    baseUrl - Optional. Setting the BaseURL property gives the relative file path or URL context for hyperlinks, images, CSS and JavaScript files.
    
    renderOptions - Rendering options
    
    loginCredentials - Http login credentials
    
    Returns:
    
    A PdfDocument
    
    Throws:
    
    IOException - the io exception
  - renderHtmlFileAsPdf
```
public static PdfDocument renderHtmlFileAsPdf(String htmlFilePath,
                                              ChromeHttpLoginCredentials loginCredentials)
                                       throws IOException
```
    Creates a PDF file from a local Html file, and returns it as a PdfDocument.
    
    Parameters:
    
    htmlFilePath - Path to a Html to be rendered as a PDF.
    
    loginCredentials - Http login credentials
    
    Returns:
    
    A PdfDocument
    
    Throws:
    
    IOException - the io exception
  - renderHtmlFileAsPdf
```
public static PdfDocument renderHtmlFileAsPdf(String htmlFilePath,
                                              String baseUrl,
                                              ChromeHttpLoginCredentials loginCredentials)
                                       throws IOException
```
    Creates a PDF file from a local Html file, and returns it as a PdfDocument.
    
    Parameters:
    
    htmlFilePath - Path to a Html to be rendered as a PDF.
    
    baseUrl - Optional. Setting the BaseURL property gives the relative file path or URL context for hyperlinks, images, CSS and JavaScript files.
    
    loginCredentials - Http login credentials
    
    Returns:
    
    A PdfDocument
    
    Throws:
    
    IOException - the io exception
  - renderHtmlFileAsPdf
```
public static PdfDocument renderHtmlFileAsPdf(String htmlFilePath,
                                              ChromePdfRenderOptions renderOptions)
                                       throws IOException
```
    Creates a PDF file from a local HTML file and returns it as a PdfDocument.
    ------------------------------------------------
    
    Usage:
```
 PdfDocument pdf = renderHtmlAsPdf(htmlFilePath, renderOptions);
 
```
    ------------------------------------------------
    Parameters:
    
    htmlFilePath - The path to the local HTML file to be rendered as a PDF.
    
    renderOptions - Rendering options used for PDF generation.
    
    Returns:
    
    A PdfDocument generated from the provided HTML file.
    
    Throws:
    
    IOException - If an I/O error occurs while accessing the file or generating the PDF.
    Important Notes:
    
    🐳 Docker Limitation: This method does not work when the application is running inside a Docker environment due to rendering engine limitations. In such cases, use renderZipAsPdf() instead.
    
    📄 Input: Requires access to a local HTML file on disk.
    
    Related Methods:
    
    📌 renderZipAsPdf() — Recommended alternative when running inside Docker.
  - renderHtmlFileAsPdf
```
public static PdfDocument renderHtmlFileAsPdf(String htmlFilePath,
                                              String baseUrl,
                                              ChromePdfRenderOptions renderOptions)
                                       throws IOException
```
    Creates a PDF file from a local Html file, and returns it as a PdfDocument.
    
    Parameters:
    
    htmlFilePath - Path to a Html to be rendered as a PDF.
    
    baseUrl - Optional. Setting the BaseURL property gives the relative file path or URL context for hyperlinks, images, CSS and JavaScript files.
    
    renderOptions - Rendering options
    
    Returns:
    
    A PdfDocument
    
    Throws:
    
    IOException - the io exception
  - renderUrlAsPdf
```
public static PdfDocument renderUrlAsPdf(String url)
```
    Creates a PDF file from a URL or local file path and returns it as a PdfDocument.
    
    Parameters:
    
    url - An absolute (fully formed) Uri. Points to the Html document to be rendered as a PDF.
    
    Returns:
    
    A PdfDocument
  - renderUrlAsPdf
```
public static PdfDocument renderUrlAsPdf(String url,
                                         ChromePdfRenderOptions renderOptions,
                                         ChromeHttpLoginCredentials loginCredentials)
```
    Creates a PDF file from a URL or local file path and returns it as a PdfDocument.
    
    Parameters:
    
    url - An absolute (fully formed) Uri. Points to the Html document to be rendered as a PDF.
    
    renderOptions - Rendering options
    
    loginCredentials - Http login credentials
    
    Returns:
    
    A PdfDocument
  - renderUrlAsPdf
```
public static PdfDocument renderUrlAsPdf(String url,
                                         ChromeHttpLoginCredentials loginCredentials)
```
    Creates a PDF file from a URL or local file path and returns it as a PdfDocument.
    
    Parameters:
    
    url - An absolute (fully formed) Uri. Points to the Html document to be rendered as a PDF.
    
    loginCredentials - Http login credentials
    
    Returns:
    
    A PdfDocument
  - renderUrlAsPdf
```
public static PdfDocument renderUrlAsPdf(String url,
                                         ChromePdfRenderOptions renderOptions)
```
    Creates a PDF file from a URL or local file path and returns it as a PdfDocument.
    
    Parameters:
    
    url - An absolute (fully formed) Uri. Points to the Html document to be rendered as a PDF.
    
    renderOptions - Rendering options
    
    Returns:
    
    A PdfDocument
  - renderHtmlAsPdf
```
public static PdfDocument renderHtmlAsPdf(String html)
```
    Creates a PDF file from a Html string, and returns it as a PdfDocument.
    
    Parameters:
    
    html - The Html to be rendered as a PDF.
    
    Returns:
    
    A PdfDocument
  - renderHtmlAsPdf
```
public static PdfDocument renderHtmlAsPdf(String html,
                                          ChromeHttpLoginCredentials loginCredentials)
```
    Creates a PDF file from a Html string, and returns it as a PdfDocument.
    
    Parameters:
    
    html - The Html to be rendered as a PDF.
    
    loginCredentials - Http login credentials
    
    Returns:
    
    A PdfDocument
  - renderHtmlAsPdf
```
public static PdfDocument renderHtmlAsPdf(String html,
                                          ChromePdfRenderOptions renderOptions)
```
    Creates a PDF file from a Html string, and returns it as a PdfDocument.
    
    Parameters:
    
    html - The Html to be rendered as a PDF.
    
    renderOptions - Rendering options
    
    Returns:
    
    A PdfDocument
  - renderHtmlAsPdf
```
public static PdfDocument renderHtmlAsPdf(String html,
                                          ChromePdfRenderOptions renderOptions,
                                          ChromeHttpLoginCredentials loginCredentials)
```
    Creates a PDF file from a Html string, and returns it as a PdfDocument.
    
    Parameters:
    
    html - The Html to be rendered as a PDF.
    
    renderOptions - Rendering options
    
    loginCredentials - Http login credentials
    
    Returns:
    
    A PdfDocument
  - renderRtfAsPdf
```
public static PdfDocument renderRtfAsPdf(String rtfString)
```
    Creates a PDF file from RTF string, and returns it as a PdfDocument.
    
    Parameters:
    
    rtfString - The RTF string to be rendered as a PDF.
    
    Returns:
    
    A PdfDocument
  - renderRtfFileAsPdf
```
public static PdfDocument renderRtfFileAsPdf(String rtfFilePath)
                                      throws IOException
```
    Creates a PDF file from RTF file, and returns it as a PdfDocument.
    
    Parameters:
    
    rtfFilePath - The RTF file path to be rendered as a PDF.
    
    Returns:
    
    A PdfDocument
    
    Throws:
    
    IOException - the io exception
  - renderRtfFileAsPdf
```
public static PdfDocument renderRtfFileAsPdf(Path rtfFilePath)
                                      throws IOException
```
    Creates a PDF file from RTF file, and returns it as a PdfDocument.
    
    Parameters:
    
    rtfFilePath - The RTF file path to be rendered as a PDF.
    
    Returns:
    
    A PdfDocument
    
    Throws:
    
    IOException - the io exception
  - renderZipAsPdf
```
public static PdfDocument renderZipAsPdf(Path zipFilePath,
                                         String mainFile,
                                         ChromePdfRenderOptions renderOptions)
                                  throws IOException
```
    Creates a PDF file from a local Zip file, and returns it as a PdfDocument.
    IronPDF is a W3C standards compliant HTML rendering based on Google's Chromium browser. If your output PDF does not look as expected:
    - Validate your HTML file using https://validator.w3.org/ & CSS https://jigsaw.w3.org/css-validator/
    - To debug HTML, view the file in Chrome web browser's print preview which will work almost exactly as IronPDF.
    - Read our detailed documentation on pixel perfect HTML to PDF: https://ironpdf.com/tutorials/pixel-perfect-html-to-pdf/
    
    Parameters:
    
    zipFilePath - Path to a Zip to be rendered as a PDF.
    
    mainFile - Name of the primary HTML file.
    
    renderOptions - Rendering options
    
    Returns:
    
    A PdfDocument
    
    Throws:
    
    IOException - the io exception
  - renderZipAsPdf
```
public static PdfDocument renderZipAsPdf(Path zipFilePath,
                                         String mainFile)
                                  throws IOException
```
    Creates a PDF file from a local Zip file, and returns it as a PdfDocument.
    IronPDF is a W3C standards compliant HTML rendering based on Google's Chromium browser. If your output PDF does not look as expected:
    - Validate your HTML file using https://validator.w3.org/ & CSS https://jigsaw.w3.org/css-validator/
    - To debug HTML, view the file in Chrome web browser's print preview which will work almost exactly as IronPDF.
    - Read our detailed documentation on pixel perfect HTML to PDF: https://ironpdf.com/tutorials/pixel-perfect-html-to-pdf/
    
    Parameters:
    
    zipFilePath - Path to a Zip to be rendered as a PDF.
    
    mainFile - Name of the primary HTML file.
    
    Returns:
    
    A PdfDocument
    
    Throws:
    
    IOException - the io exception
  - saveAsPdfA
```
public PdfDocument saveAsPdfA(String filePath)
                       throws IOException
```
    Save the current document into the PDF-A (PDF/A-3B ISO 19005-3) standard format
    
    Parameters:
    
    filePath - Target file path string
    
    Returns:
    
    A PdfDocument
    
    Throws:
    
    IOException - the io exception
  - saveAsPdfA
```
public PdfDocument saveAsPdfA(String filePath,
                              String customICCFilePath)
                       throws IOException
```
    Save the current document into the PDF-A (PDF/A-3B ISO 19005-3) standard format
    
    Parameters:
    
    filePath - Target file path string
    
    customICCFilePath - (Optional) Custom color profile file path
    
    Returns:
    
    A PdfDocument
    
    Throws:
    
    IOException - the io exception
  - saveAsPdfA
```
public PdfDocument saveAsPdfA(String filePath,
                              PdfAVersions pdfAVersion)
                       throws IOException
```
    Save the current document into the specified PDF-A standard format
    
    Parameters:
    
    filePath - Target file path string
    
    pdfAVersion - PDF-A standard version
    
    Returns:
    
    A PdfDocument
    
    Throws:
    
    IOException - the io exception
  - saveAsPdfA
```
public PdfDocument saveAsPdfA(String filePath,
                              PdfAVersions pdfAVersion,
                              String customICCFilePath)
                       throws IOException
```
    Save the current document into the specified PDF-A standard format
    
    Parameters:
    
    filePath - Target file path string
    
    pdfAVersion - PDF-A standard version
    
    customICCFilePath - (Optional) Custom color profile file path
    
    Returns:
    
    A PdfDocument
    
    Throws:
    
    IOException - the io exception
  - convertToPdfA
```
public PdfDocument convertToPdfA()
                          throws IOException
```
    Convert the current document into the PDF-A (PDF/A-3B ISO 19005-3) standard format
    
    Returns:
    
    A PdfDocument
    
    Throws:
    
    IOException - the io exception
  - convertToPdfA
```
public PdfDocument convertToPdfA(String customICCFilePath)
                          throws IOException
```
    Convert the current document into the PDF-A (PDF/A-3B ISO 19005-3) standard format
    
    Parameters:
    
    customICCFilePath - (Optional) Custom color profile file path
    
    Returns:
    
    A PdfDocument
    
    Throws:
    
    IOException - the io exception
  - convertToPdfA
```
public PdfDocument convertToPdfA(PdfAVersions pdfAVersion)
                          throws IOException
```
    Convert the current document into the specified PDF-A standard format
    
    Parameters:
    
    pdfAVersion - PDF-A standard version
    
    Returns:
    
    A PdfDocument
    
    Throws:
    
    IOException - the io exception
  - convertToPdfA
```
public PdfDocument convertToPdfA(PdfAVersions pdfAVersion,
                                 String customICCFilePath)
                          throws IOException
```
    Convert the current document into the specified PDF-A standard format
    
    Parameters:
    
    pdfAVersion - PDF-A standard version
    
    customICCFilePath - (Optional) Custom color profile file path
    
    Returns:
    
    A PdfDocument
    
    Throws:
    
    IOException - the io exception
  - saveAsPdfUA
```
public PdfDocument saveAsPdfUA(String filePath,
                               NaturalLanguages naturalLanguages)
                        throws IOException
```
    Save the current document into the specified PDF/UA standard format. Compliant with the ISO 14289-1 (PDF/UA-1)
    
    Parameters:
    
    naturalLanguages - Natural Languages Specification
    
    Returns:
    
    A PdfDocument
    
    Throws:
    
    IOException - the io exception
  - convertToPdfUA
```
public PdfDocument convertToPdfUA(NaturalLanguages naturalLanguages)
                           throws IOException
```
    Convert the current document into the specified PDF/UA standard format (defaults to PDF/UA-1)
    
    Parameters:
    
    naturalLanguages - Natural Languages Specification
    
    Returns:
    
    A PdfDocument
    
    Throws:
    
    IOException - the io exception
  - convertToPdfUA
```
public PdfDocument convertToPdfUA(NaturalLanguages naturalLanguages,
                                  PdfUAVersions pdfUaVersion)
                           throws IOException
```
    Convert the current document into the specified PDF/UA standard format
    
    Parameters:
    
    naturalLanguages - Natural Languages Specification
    
    pdfUaVersion - PDF/UA standard version
    
    Returns:
    
    A PdfDocument
    
    Throws:
    
    IOException - the io exception
  - renderHtmlAsPdfUA
```
public static PdfDocument renderHtmlAsPdfUA(String html)
```
    Render HTML to PDF and convert to PDF/UA format with screen reader support. Produces a proper semantic structure tree for accessibility.
    
    Parameters:
    
    html - The HTML string to render
    
    Returns:
    
    A PdfDocument in PDF/UA format
  - renderHtmlAsPdfUA
```
public static PdfDocument renderHtmlAsPdfUA(String html,
                                            NaturalLanguages naturalLanguages)
```
    Render HTML to PDF and convert to PDF/UA format with screen reader support.
    
    Parameters:
    
    html - The HTML string to render
    
    naturalLanguages - Document language for screen readers
    
    Returns:
    
    A PdfDocument in PDF/UA format
  - renderHtmlAsPdfUA
```
public static PdfDocument renderHtmlAsPdfUA(String html,
                                            NaturalLanguages naturalLanguages,
                                            ChromePdfRenderOptions renderOptions)
```
    Render HTML to PDF and convert to PDF/UA format with screen reader support.
    
    Parameters:
    
    html - The HTML string to render
    
    naturalLanguages - Document language for screen readers
    
    renderOptions - Chrome PDF render options
    
    Returns:
    
    A PdfDocument in PDF/UA format
  - close
```
public void close()
```
    Specified by:
    
    close in interface AutoCloseable

Class PdfDocument

Field Summary

Fields inherited from interface java.awt.print.Printable

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

PdfDocument

PdfDocument

PdfDocument

PdfDocument

PdfDocument

PdfDocument

PdfDocument

PdfDocument

PdfDocument

PdfDocument

PdfDocument

PdfDocument

Method Detail

fromFile

fromFile

fromFile

fromFile

fromFile

fromFile

fromImage

fromImage

fromImage

fromImage

fromImage

getBookmark

getMetadata

getAnnotation

getForm

getAttachment

getSecurity

getSignature

merge

merge

copyPage

copyPages

copyPages

appendPdf

insertPdf

insertPdf

prependPdf

removePages

getPagesInfo

getPagesInfo

rotateAllPages

rotatePage

resizePage

addBackgroundPdf

addBackgroundPdf

addBackgroundPdf

addBackgroundPdf

addForegroundPdf

addForegroundPdf

addForegroundPdf

addForegroundPdf

addTextHeader

addTextHeader

addTextHeader

addTextHeader

addTextFooter

addTextFooter

addTextFooter

addTextFooter

addHtmlHeader

addHtmlHeader

addHtmlHeader

addHtmlHeader

addHtmlFooter

addHtmlFooter

addHtmlFooter

addHtmlFooter

drawImage

drawImage

toBufferedImages