Uses of Class
com.ironsoftware.ironpdf.PdfDocument

Packages that use PdfDocument

Package	Description
com.ironsoftware.ironpdf

Uses of PdfDocument in com.ironsoftware.ironpdf

Methods in com.ironsoftware.ironpdf that return PdfDocument

Modifier and Type	Method	Description
final PdfDocument	PdfDocument.addBackgroundPdf(PdfDocument backgroundPdf)	Adds a background to each page of this PDF.
final PdfDocument	PdfDocument.addBackgroundPdf(PdfDocument backgroundPdf, int backgroundPdfPageIndex)	Adds a background to each page of this PDF.
final PdfDocument	PdfDocument.addBackgroundPdf(PdfDocument backgroundPdf, int backgroundPdfPageIndex, PageSelection pageSelection)	Adds a background to selected page(s) of this PDF.
final PdfDocument	PdfDocument.addBackgroundPdf(PdfDocument backgroundPdf, PageSelection pageSelection)	Adds a background to selected page(s) of this PDF.
final PdfDocument	PdfDocument.addForegroundPdf(PdfDocument foregroundPdf)	Adds a foreground to each page of this PDF.
final PdfDocument	PdfDocument.addForegroundPdf(PdfDocument foregroundPdf, int foregroundPdfPageIndex)	Adds a foreground to each page of this PDF.
final PdfDocument	PdfDocument.addForegroundPdf(PdfDocument foregroundPdf, int foregroundPdfPageIndex, PageSelection pageSelection)	Adds a foreground to selected page(s) of this PDF.
final PdfDocument	PdfDocument.addForegroundPdf(PdfDocument foregroundPdf, PageSelection pageSelection)	Adds a foreground to selected page(s) of this PDF.
PdfDocument	PdfDocument.addHtmlFooter(HtmlHeaderFooter footer)	Renders HTML page footers onto an existing PDF File
PdfDocument	PdfDocument.addHtmlFooter(HtmlHeaderFooter footer, PageSelection pageSelection)	Renders HTML page footers onto an existing PDF File
PdfDocument	PdfDocument.addHtmlFooter(HtmlHeaderFooter footer, HeaderFooterOptions headerFooterOptions)	Renders HTML page footer onto an existing PDF File
PdfDocument	PdfDocument.addHtmlFooter(HtmlHeaderFooter footer, HeaderFooterOptions headerFooterOptions, PageSelection pageSelection)	Renders HTML page footer onto an existing PDF File
PdfDocument	PdfDocument.addHtmlHeader(HtmlHeaderFooter header)	Renders HTML page headers onto an existing PDF File
PdfDocument	PdfDocument.addHtmlHeader(HtmlHeaderFooter header, PageSelection pageSelection)	Renders HTML page headers onto an existing PDF File
PdfDocument	PdfDocument.addHtmlHeader(HtmlHeaderFooter header, HeaderFooterOptions headerFooterOptions)	Renders HTML page headers onto an existing PDF File
PdfDocument	PdfDocument.addHtmlHeader(HtmlHeaderFooter header, HeaderFooterOptions headerFooterOptions, PageSelection pageSelection)	Renders HTML page headers onto an existing PDF File
PdfDocument	PdfDocument.addTextFooter(TextHeaderFooter footer)	Renders TEXT page footers onto an existing PDF File
PdfDocument	PdfDocument.addTextFooter(TextHeaderFooter footer, PageSelection pageSelection)	Renders TEXT page footers onto an existing PDF File
PdfDocument	PdfDocument.addTextFooter(TextHeaderFooter footer, HeaderFooterOptions headerFooterOptions)	Renders TEXT page footer onto an existing PDF File
PdfDocument	PdfDocument.addTextFooter(TextHeaderFooter footer, HeaderFooterOptions headerFooterOptions, PageSelection pageSelection)	Renders TEXT page footer onto an existing PDF File
PdfDocument	PdfDocument.addTextHeader(TextHeaderFooter header)	Renders TEXT page headers onto an existing PDF File
PdfDocument	PdfDocument.addTextHeader(TextHeaderFooter header, PageSelection pageSelection)	Renders TEXT page headers onto an existing PDF File
PdfDocument	PdfDocument.addTextHeader(TextHeaderFooter header, HeaderFooterOptions headerFooterOptions)	Renders TEXT page headers onto an existing PDF File
PdfDocument	PdfDocument.addTextHeader(TextHeaderFooter header, HeaderFooterOptions headerFooterOptions, PageSelection pageSelection)	Renders TEXT page headers onto an existing PDF File
final PdfDocument	PdfDocument.appendPdf(PdfDocument AnotherPdfFile)	Appends another PDF to the end of the current PdfDocument.
final PdfDocument	PdfDocument.applyStamp(Stamper stamper)	Edits the PDF by applying the Stamper's rendered to every page.
final PdfDocument	PdfDocument.applyStamp(Stamper stamper, PageSelection pageSelection)	Edits the PDF by applying the Stamper's rendered to only selected page(s).
final PdfDocument	PdfDocument.applyWatermark(String html)	Adds Watermark to PDF, Please use applyStamp(Stamper) for more control.
final PdfDocument	PdfDocument.applyWatermark(String html, int opacity)	Adds Watermark to PDF, Please use applyStamp(Stamper) for more control.
final PdfDocument	PdfDocument.applyWatermark(String html, int opacity, VerticalAlignment verticalAlignment)	Adds a watermark to this PDF.
final PdfDocument	PdfDocument.applyWatermark(String html, int opacity, VerticalAlignment verticalAlignment, HorizontalAlignment horizontalAlignment)	Adds a watermark to this PDF.
final PdfDocument	PdfDocument.copyPage(int PageIndex)	Creates a new PDF by copying a page from this PdfDocument into a new blank document.
final PdfDocument	PdfDocument.copyPages(int StartIndex, int EndIndex)	Creates a new PDF by copying a range of pages from this PdfDocument into a new blank document.
final PdfDocument	PdfDocument.copyPages(Iterable<Integer> PageIndexes)	Creates a new PDF by copying a page from this PdfDocument into a new blank document.
static PdfDocument	PdfDocument.fromFile(Path pdfFilePath)	Opens an existing PDF document for editing.
static PdfDocument	PdfDocument.fromFile(Path pdfFilePath, String password)	Opens an existing PDF document for editing.
static PdfDocument	PdfDocument.fromFile(Path pdfFilePath, String password, String ownerPassword)	Opens an existing PDF document for editing.
static PdfDocument	PdfDocument.fromImage(List<Path> imagesPath)	Converts a single image file to an identical PDF document of matching dimensions.
static PdfDocument	PdfDocument.fromImage(List<Path> imagesPath, ImageBehavior imageBehavior)	Converts a single image file to an identical PDF document of matching dimensions.
static PdfDocument	PdfDocument.fromImage(List<Path> imagesPath, ImageBehavior imageBehavior, ChromePdfRenderOptions renderOptions)	Converts a single image file to an identical PDF document of matching dimensions.
static PdfDocument	PdfDocument.fromImage(List<Path> imagesPath, ImageBehavior imageBehavior, PaperSize paperSize)	Converts a single image file to an identical PDF document of matching dimensions.
static PdfDocument	PdfDocument.fromImage(List<Path> imagesPath, PaperSize paperSize)	Converts a single image file to an identical PDF document of matching dimensions.
final PdfDocument	PdfDocument.getRevision(int index)	Creates a copy of this document at the specified revision number.
final PdfDocument	PdfDocument.insertPdf(PdfDocument AnotherPdfFile)	Inserts another PDF into the current PdfDocument, starting at a given Page Index.
final PdfDocument	PdfDocument.insertPdf(PdfDocument AnotherPdfFile, int AtIndex)	Inserts another PDF into the current PdfDocument, starting at a given Page Index.
static PdfDocument	PdfDocument.merge(PdfDocument A, PdfDocument B)	Static method that joins (concatenates) 2 PDF documents together into one PDF document.
static PdfDocument	PdfDocument.merge(List<PdfDocument> Documents)	Static method that joins (concatenates) 2 PDF documents together into one PDF document.
final PdfDocument	PdfDocument.prependPdf(PdfDocument AnotherPdfFile)	Adds another PDF to the beginning of the current PdfDocument.
final PdfDocument	PdfDocument.removePages(PageSelection pageSelection)	Removes a range of pages from the PDF
static PdfDocument	PdfDocument.renderHtmlAsPdf(String html)	Creates a PDF file from a Html string, and returns it as a PdfDocument.
static PdfDocument	PdfDocument.renderHtmlAsPdf(String html, ChromeHttpLoginCredentials loginCredentials)	Creates a PDF file from a Html string, and returns it as a PdfDocument.
static PdfDocument	PdfDocument.renderHtmlAsPdf(String html, ChromePdfRenderOptions renderOptions)	Creates a PDF file from a Html string, and returns it as a PdfDocument.
static PdfDocument	PdfDocument.renderHtmlAsPdf(String html, ChromePdfRenderOptions renderOptions, ChromeHttpLoginCredentials loginCredentials)	Creates a PDF file from a Html string, and returns it as a PdfDocument.
static PdfDocument	PdfDocument.renderHtmlAsPdf(String html, ChromePdfRenderOptions renderOptions, ChromeHttpLoginCredentials loginCredentials, String baseUrl)	Creates a PDF file from a Html string, and returns it as a PdfDocument.
static PdfDocument	PdfDocument.renderHtmlAsPdf(String html, String baseUrl)	Creates a PDF file from a Html string, and returns it as a PdfDocument.
static PdfDocument	PdfDocument.renderHtmlAsPdf(String html, String baseUrl, ChromeHttpLoginCredentials loginCredentials)	Creates a PDF file from a Html string, and returns it as a PdfDocument.
static PdfDocument	PdfDocument.renderHtmlAsPdf(String html, String baseUrl, ChromePdfRenderOptions renderOptions)	Creates a PDF file from a Html string, and returns it as a PdfDocument.
static PdfDocument	PdfDocument.renderHtmlFileAsPdf(String htmlFilePath)	Creates a PDF file from a local Html file, and returns it as a PdfDocument.
static PdfDocument	PdfDocument.renderHtmlFileAsPdf(String htmlFilePath, ChromeHttpLoginCredentials loginCredentials)	Creates a PDF file from a local Html file, and returns it as a PdfDocument.
static PdfDocument	PdfDocument.renderHtmlFileAsPdf(String htmlFilePath, ChromePdfRenderOptions renderOptions)	Creates a PDF file from a local Html file, and returns it as a PdfDocument.
static PdfDocument	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	PdfDocument.renderHtmlFileAsPdf(String htmlFilePath, String baseUrl)	Creates a PDF file from a local Html file, and returns it as a PdfDocument.
static PdfDocument	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	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	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	PdfDocument.renderRtfAsPdf(String rtfString)	Creates a PDF file from RTF string, and returns it as a PdfDocument.
static PdfDocument	PdfDocument.renderRtfFileAsPdf(String rtfFilePath)	Creates a PDF file from RTF file, and returns it as a PdfDocument.
static PdfDocument	PdfDocument.renderRtfFileAsPdf(Path rtfFilePath)	Creates a PDF file from RTF file, and returns it as a PdfDocument.
static PdfDocument	PdfDocument.renderUrlAsPdf(String url)	Creates a PDF file from a URL or local file path and returns it as a PdfDocument.
static PdfDocument	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	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	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	PdfDocument.renderZipAsPdf(Path zipFilePath, String mainFile)	Creates a PDF file from a local Zip file, and returns it as a PdfDocument.
static PdfDocument	PdfDocument.renderZipAsPdf(Path zipFilePath, String mainFile, ChromePdfRenderOptions renderOptions)	Creates a PDF file from a local Zip file, and returns it as a PdfDocument.
final PdfDocument	PdfDocument.saveAs(String filePath)	Saves this PdfDocument to a file.
final PdfDocument	PdfDocument.saveAs(Path filePath)	Saves this PdfDocument to a file.
final PdfDocument	PdfDocument.saveAsRevision(String filePath)	Saves this PdfDocument to a file.
final PdfDocument	PdfDocument.saveAsRevision(Path filePath)	Saves this PdfDocument to a file.

Methods in com.ironsoftware.ironpdf with parameters of type PdfDocument

Modifier and Type	Method	Description
final PdfDocument	PdfDocument.addBackgroundPdf(PdfDocument backgroundPdf)	Adds a background to each page of this PDF.
final PdfDocument	PdfDocument.addBackgroundPdf(PdfDocument backgroundPdf, int backgroundPdfPageIndex)	Adds a background to each page of this PDF.
final PdfDocument	PdfDocument.addBackgroundPdf(PdfDocument backgroundPdf, int backgroundPdfPageIndex, PageSelection pageSelection)	Adds a background to selected page(s) of this PDF.
final PdfDocument	PdfDocument.addBackgroundPdf(PdfDocument backgroundPdf, PageSelection pageSelection)	Adds a background to selected page(s) of this PDF.
final PdfDocument	PdfDocument.addForegroundPdf(PdfDocument foregroundPdf)	Adds a foreground to each page of this PDF.
final PdfDocument	PdfDocument.addForegroundPdf(PdfDocument foregroundPdf, int foregroundPdfPageIndex)	Adds a foreground to each page of this PDF.
final PdfDocument	PdfDocument.addForegroundPdf(PdfDocument foregroundPdf, int foregroundPdfPageIndex, PageSelection pageSelection)	Adds a foreground to selected page(s) of this PDF.
final PdfDocument	PdfDocument.addForegroundPdf(PdfDocument foregroundPdf, PageSelection pageSelection)	Adds a foreground to selected page(s) of this PDF.
final PdfDocument	PdfDocument.appendPdf(PdfDocument AnotherPdfFile)	Appends another PDF to the end of the current PdfDocument.
final PdfDocument	PdfDocument.insertPdf(PdfDocument AnotherPdfFile)	Inserts another PDF into the current PdfDocument, starting at a given Page Index.
final PdfDocument	PdfDocument.insertPdf(PdfDocument AnotherPdfFile, int AtIndex)	Inserts another PDF into the current PdfDocument, starting at a given Page Index.
static PdfDocument	PdfDocument.merge(PdfDocument A, PdfDocument B)	Static method that joins (concatenates) 2 PDF documents together into one PDF document.
final PdfDocument	PdfDocument.prependPdf(PdfDocument AnotherPdfFile)	Adds another PDF to the beginning of the current PdfDocument.

Method parameters in com.ironsoftware.ironpdf with type arguments of type PdfDocument

Modifier and Type	Method	Description
static PdfDocument	PdfDocument.merge(List<PdfDocument> Documents)	Static method that joins (concatenates) 2 PDF documents together into one PDF document.