Skip navigation links
A B C D E F G H I J L M N O P R S T U V W 

A

addAttachment(String, byte[]) - Method in class com.ironsoftware.ironpdf.attachment.AttachmentManager
Add a new attachment.
addBackgroundPdf(PdfDocument) - Method in class com.ironsoftware.ironpdf.PdfDocument
Adds a background to each page of this PDF.
addBackgroundPdf(PdfDocument, int) - Method in class com.ironsoftware.ironpdf.PdfDocument
Adds a background to each page of this PDF.
addBackgroundPdf(PdfDocument, PageSelection) - Method in class com.ironsoftware.ironpdf.PdfDocument
Adds a background to selected page(s) of this PDF.
addBackgroundPdf(PdfDocument, int, PageSelection) - Method in class com.ironsoftware.ironpdf.PdfDocument
Adds a background to selected page(s) of this PDF.
addBookMarkAtEnd(String, int) - Method in class com.ironsoftware.ironpdf.bookmark.BookmarkManager
Add a new bookmark at the end of the bookmark collection
addBookMarkAtStart(String, int) - Method in class com.ironsoftware.ironpdf.bookmark.BookmarkManager
Add a new bookmark at the start of the document collection
AddChildBookmark(String, int) - Method in class com.ironsoftware.ironpdf.bookmark.Bookmark
Add a new bookmark as a first child of this bookmark.
addChildBookmark(String, int, String) - Method in class com.ironsoftware.ironpdf.bookmark.BookmarkManager
Add a new bookmark as a first child of this bookmark.
addForegroundPdf(PdfDocument) - Method in class com.ironsoftware.ironpdf.PdfDocument
Adds a foreground to each page of this PDF.
addForegroundPdf(PdfDocument, int) - Method in class com.ironsoftware.ironpdf.PdfDocument
Adds a foreground to each page of this PDF.
addForegroundPdf(PdfDocument, PageSelection) - Method in class com.ironsoftware.ironpdf.PdfDocument
Adds a foreground to selected page(s) of this PDF.
addForegroundPdf(PdfDocument, int, PageSelection) - Method in class com.ironsoftware.ironpdf.PdfDocument
Adds a foreground to selected page(s) of this PDF.
addHtmlFooter(HtmlHeaderFooter) - Method in class com.ironsoftware.ironpdf.PdfDocument
Renders HTML page footers onto an existing PDF File
addHtmlFooter(HtmlHeaderFooter, PageSelection) - Method in class com.ironsoftware.ironpdf.PdfDocument
Renders HTML page footers onto an existing PDF File
addHtmlFooter(HtmlHeaderFooter, HeaderFooterOptions) - Method in class com.ironsoftware.ironpdf.PdfDocument
Renders HTML page footer onto an existing PDF File
addHtmlFooter(HtmlHeaderFooter, HeaderFooterOptions, PageSelection) - Method in class com.ironsoftware.ironpdf.PdfDocument
Renders HTML page footer onto an existing PDF File
addHtmlHeader(HtmlHeaderFooter) - Method in class com.ironsoftware.ironpdf.PdfDocument
Renders HTML page headers onto an existing PDF File
addHtmlHeader(HtmlHeaderFooter, PageSelection) - Method in class com.ironsoftware.ironpdf.PdfDocument
Renders HTML page headers onto an existing PDF File
addHtmlHeader(HtmlHeaderFooter, HeaderFooterOptions) - Method in class com.ironsoftware.ironpdf.PdfDocument
Renders HTML page headers onto an existing PDF File
addHtmlHeader(HtmlHeaderFooter, HeaderFooterOptions, PageSelection) - Method in class com.ironsoftware.ironpdf.PdfDocument
Renders HTML page headers onto an existing PDF File
addLinkAnnotation(LinkAnnotation) - Method in class com.ironsoftware.ironpdf.annotation.AnnotationManager
Adds a clickable link annotation that navigates to another page within the same PDF document.
addNextBookmark(String, int) - Method in class com.ironsoftware.ironpdf.bookmark.Bookmark
Add a new bookmark after this bookmark
AddPreviousBookmark(String, int) - Method in class com.ironsoftware.ironpdf.bookmark.Bookmark
Add a new bookmark before this bookmark
addTextAnnotation(AnnotationOptions, int) - Method in class com.ironsoftware.ironpdf.annotation.AnnotationManager
Adds an annotation to a page of this InternalPdfDocument
addTextFooter(TextHeaderFooter) - Method in class com.ironsoftware.ironpdf.PdfDocument
Renders TEXT page footers onto an existing PDF File
addTextFooter(TextHeaderFooter, PageSelection) - Method in class com.ironsoftware.ironpdf.PdfDocument
Renders TEXT page footers onto an existing PDF File
addTextFooter(TextHeaderFooter, HeaderFooterOptions) - Method in class com.ironsoftware.ironpdf.PdfDocument
Renders TEXT page footer onto an existing PDF File
addTextFooter(TextHeaderFooter, HeaderFooterOptions, PageSelection) - Method in class com.ironsoftware.ironpdf.PdfDocument
Renders TEXT page footer onto an existing PDF File
addTextHeader(TextHeaderFooter) - Method in class com.ironsoftware.ironpdf.PdfDocument
Renders TEXT page headers onto an existing PDF File
addTextHeader(TextHeaderFooter, PageSelection) - Method in class com.ironsoftware.ironpdf.PdfDocument
Renders TEXT page headers onto an existing PDF File
addTextHeader(TextHeaderFooter, HeaderFooterOptions) - Method in class com.ironsoftware.ironpdf.PdfDocument
Renders TEXT page headers onto an existing PDF File
addTextHeader(TextHeaderFooter, HeaderFooterOptions, PageSelection) - Method in class com.ironsoftware.ironpdf.PdfDocument
Renders TEXT page headers onto an existing PDF File
AdvancedCompressionOptions - Class in com.ironsoftware.ironpdf.compression
Configuration for the advanced compression pipeline.
AdvancedCompressionOptions() - Constructor for class com.ironsoftware.ironpdf.compression.AdvancedCompressionOptions
 
AllFontsLoaded() - Method in class com.ironsoftware.ironpdf.render.WaitFor
This method proceeds rendering by waiting until all of its fonts have been loaded.
AllFontsLoaded(int) - Method in class com.ironsoftware.ironpdf.render.WaitFor
This method proceeds rendering by waiting until all of its fonts have been loaded.
allPages() - Static method in class com.ironsoftware.ironpdf.edit.PageSelection
Every page of the PDF.
AnnotationIcon - Enum in com.ironsoftware.ironpdf.annotation
Icons used to interact (open/close) with a PDF annotation on a page.
AnnotationManager - Class in com.ironsoftware.ironpdf.annotation
Class used to add annotations to a PdfDocument.
AnnotationManager(InternalPdfDocument) - Constructor for class com.ironsoftware.ironpdf.annotation.AnnotationManager
Please get AnnotationManager by PdfDocument.getAnnotation() instead.
AnnotationOptions - Class in com.ironsoftware.ironpdf.annotation
Class used to configure annotations to a PdfDocument.
AnnotationOptions(String, String, int, int) - Constructor for class com.ironsoftware.ironpdf.annotation.AnnotationOptions
Adds an annotation to a page of this PdfDocument
AnnotationOptions(String) - Constructor for class com.ironsoftware.ironpdf.annotation.AnnotationOptions
Adds an annotation to a page of this PdfDocument
appendPdf(PdfDocument) - Method in class com.ironsoftware.ironpdf.PdfDocument
Appends another PDF to the end of the current PdfDocument.
applyStamp(Stamper) - Method in class com.ironsoftware.ironpdf.PdfDocument
Edits the PDF by applying the Stamper's rendered to every page.
applyStamp(Stamper, PageSelection) - Method in class com.ironsoftware.ironpdf.PdfDocument
Edits the PDF by applying the Stamper's rendered to only selected page(s).
applyWatermark(String, int, VerticalAlignment) - Method in class com.ironsoftware.ironpdf.PdfDocument
Adds a watermark to this PDF.
applyWatermark(String, int, VerticalAlignment, HorizontalAlignment) - Method in class com.ironsoftware.ironpdf.PdfDocument
Adds a watermark to this PDF.
applyWatermark(String, int) - Method in class com.ironsoftware.ironpdf.PdfDocument
Adds Watermark to PDF, Please use PdfDocument.applyStamp(Stamper) for more control.
applyWatermark(String) - Method in class com.ironsoftware.ironpdf.PdfDocument
Adds Watermark to PDF, Please use PdfDocument.applyStamp(Stamper) for more control.
AttachmentManager - Class in com.ironsoftware.ironpdf.attachment
Class used to edit attachment to a PdfDocument.
AttachmentManager(InternalPdfDocument) - Constructor for class com.ironsoftware.ironpdf.attachment.AttachmentManager
Please get AttachmentManager by PdfDocument.getAttachment() instead.

B

BarcodeEncoding - Enum in com.ironsoftware.ironpdf.stamp
Barcode Encoding Types.
BarcodeStamper - Class in com.ironsoftware.ironpdf.stamp
Allows the developers to add Barcode(s) and QR code(s) to PDF documents elegantly and easily.
BarcodeStamper(String, BarcodeEncoding) - Constructor for class com.ironsoftware.ironpdf.stamp.BarcodeStamper
Initializes a new instance of the BarcodeStamper class.
BarcodeStamper(String, BarcodeEncoding, int, int) - Constructor for class com.ironsoftware.ironpdf.stamp.BarcodeStamper
Initializes a new instance of the BarcodeStamper class.
Bookmark - Class in com.ironsoftware.ironpdf.bookmark
Represents a PDF bookmark as seen in the sidebar of PDF reader software to help users navigate.
Bookmark(String, int, String, BookmarkDestinations, String, String) - Constructor for class com.ironsoftware.ironpdf.bookmark.Bookmark
Instantiates a new Bookmark.
BookmarkDestinations - Enum in com.ironsoftware.ironpdf.bookmark
Destination type that controls how a PDF reader displays the target page when a bookmark or internal hyperlink is followed.
BookmarkManager - Class in com.ironsoftware.ironpdf.bookmark
Class used to add , edit and remove bookmarks from a PdfDocument outline.
BookmarkManager(InternalPdfDocument) - Constructor for class com.ironsoftware.ironpdf.bookmark.BookmarkManager
Please get BookmarkManager by PdfDocument.getBookmark() instead.

C

ChangeTrackingModes - Enum in com.ironsoftware.ironpdf.edit
The unit of measurement used for positioning and sizing.
CheckBoxField - Class in com.ironsoftware.ironpdf.form
The type Check box field.
CheckBoxField(int, String, int, double, double, double, double, String, boolean, boolean) - Constructor for class com.ironsoftware.ironpdf.form.CheckBoxField
(INTERNAL) Please Get CheckBoxField from FormFieldsSet.getCheckBoxFields() from FormManager.getFields()
ChromeHttpLoginCredentials - Class in com.ironsoftware.ironpdf.render
Provides credentials for IronPdf's embedded Chrome browser to log in to an intranet, extranet or website, impersonating a user.
ChromeHttpLoginCredentials() - Constructor for class com.ironsoftware.ironpdf.render.ChromeHttpLoginCredentials
 
ChromePdfRenderOptions - Class in com.ironsoftware.ironpdf.render
Html To PDF output options for Render_Api.
ChromePdfRenderOptions() - Constructor for class com.ironsoftware.ironpdf.render.ChromePdfRenderOptions
 
Clone() - Method in class com.ironsoftware.ironpdf.headerfooter.HtmlHeaderFooter
Supports Cloneable.
Clone() - Method in class com.ironsoftware.ironpdf.headerfooter.TextHeaderFooter
Clones this instance.
Clone() - Method in class com.ironsoftware.ironpdf.render.ChromePdfRenderOptions
Supports Cloneable.
close() - Method in class com.ironsoftware.ironpdf.PdfDocument
 
com.ironsoftware.ironpdf - package com.ironsoftware.ironpdf
 
com.ironsoftware.ironpdf.annotation - package com.ironsoftware.ironpdf.annotation
 
com.ironsoftware.ironpdf.attachment - package com.ironsoftware.ironpdf.attachment
 
com.ironsoftware.ironpdf.bookmark - package com.ironsoftware.ironpdf.bookmark
 
com.ironsoftware.ironpdf.compression - package com.ironsoftware.ironpdf.compression
 
com.ironsoftware.ironpdf.edit - package com.ironsoftware.ironpdf.edit
 
com.ironsoftware.ironpdf.exception - package com.ironsoftware.ironpdf.exception
 
com.ironsoftware.ironpdf.font - package com.ironsoftware.ironpdf.font
 
com.ironsoftware.ironpdf.form - package com.ironsoftware.ironpdf.form
 
com.ironsoftware.ironpdf.headerfooter - package com.ironsoftware.ironpdf.headerfooter
 
com.ironsoftware.ironpdf.image - package com.ironsoftware.ironpdf.image
 
com.ironsoftware.ironpdf.metadata - package com.ironsoftware.ironpdf.metadata
 
com.ironsoftware.ironpdf.page - package com.ironsoftware.ironpdf.page
 
com.ironsoftware.ironpdf.render - package com.ironsoftware.ironpdf.render
 
com.ironsoftware.ironpdf.security - package com.ironsoftware.ironpdf.security
 
com.ironsoftware.ironpdf.signature - package com.ironsoftware.ironpdf.signature
 
com.ironsoftware.ironpdf.stamp - package com.ironsoftware.ironpdf.stamp
 
com.ironsoftware.ironpdf.standard - package com.ironsoftware.ironpdf.standard
 
ComboBoxField - Class in com.ironsoftware.ironpdf.form
The type Combo box field.
ComboBoxField(int, String, int, double, double, double, double, String, List<String>, int, boolean) - Constructor for class com.ironsoftware.ironpdf.form.ComboBoxField
(INTERNAL) Please Get ComboBoxField from FormFieldsSet.getComboBoxFields() from FormManager.getFields()
compressAndSaveAs(String) - Method in class com.ironsoftware.ironpdf.PdfDocument
Compresses the PDF using QPdf smart compression and saves the result to a file.
compressAndSaveAs(String, int) - Method in class com.ironsoftware.ironpdf.PdfDocument
Compresses the PDF using QPdf smart compression and saves the result to a file, with JPEG quality setting for image recompression.
compressAndSaveAs(String, AdvancedCompressionOptions) - Method in class com.ironsoftware.ironpdf.PdfDocument
Apply the advanced compression pipeline and save the result to a file.
compressAndSaveAs(byte[], String, String, AdvancedCompressionOptions) - Static method in class com.ironsoftware.ironpdf.PdfDocument
Apply the advanced compression pipeline to byte[] input and save the result to a file.
compressAndSaveAs(InputStream, String, String, AdvancedCompressionOptions) - Static method in class com.ironsoftware.ironpdf.PdfDocument
Apply the advanced compression pipeline to a stream input and save the result to a file.
compressImages(int) - Method in class com.ironsoftware.ironpdf.PdfDocument
Deprecated.
compressImages(int, boolean) - Method in class com.ironsoftware.ironpdf.PdfDocument
Deprecated.
compressPdfToBytes() - Method in class com.ironsoftware.ironpdf.PdfDocument
Compresses the PDF using QPdf smart compression and returns the compressed bytes in memory.
compressPdfToBytes(String) - Method in class com.ironsoftware.ironpdf.PdfDocument
Compresses the PDF using QPdf smart compression and returns the compressed bytes in memory.
compressPdfToStream() - Method in class com.ironsoftware.ironpdf.PdfDocument
Compresses the PDF using QPdf smart compression and returns the result as an InputStream.
compressPdfToStream(String) - Method in class com.ironsoftware.ironpdf.PdfDocument
Compresses the PDF using QPdf smart compression and returns the result as an InputStream.
compressStructTree(int, boolean) - Method in class com.ironsoftware.ironpdf.PdfDocument
Remove document struct tree information which describes the logical layout of the document.
configure() - Static method in class com.ironsoftware.ironpdf.IronPdfEngineConnection
Static factory method to initiate the configuration of IronPdfEngineConnection.
convertToPdfA() - Method in class com.ironsoftware.ironpdf.PdfDocument
Convert the current document into the PDF-A (PDF/A-3B ISO 19005-3) standard format
convertToPdfA(String) - Method in class com.ironsoftware.ironpdf.PdfDocument
Convert the current document into the PDF-A (PDF/A-3B ISO 19005-3) standard format
convertToPdfA(PdfAVersions) - Method in class com.ironsoftware.ironpdf.PdfDocument
Convert the current document into the specified PDF-A standard format
convertToPdfA(PdfAVersions, String) - Method in class com.ironsoftware.ironpdf.PdfDocument
Convert the current document into the specified PDF-A standard format
convertToPdfUA(NaturalLanguages) - Method in class com.ironsoftware.ironpdf.PdfDocument
Convert the current document into the specified PDF/UA standard format (defaults to PDF/UA-1)
convertToPdfUA(NaturalLanguages, PdfUAVersions) - Method in class com.ironsoftware.ironpdf.PdfDocument
Convert the current document into the specified PDF/UA standard format
copyPage(int) - Method in class com.ironsoftware.ironpdf.PdfDocument
Creates a new PDF by copying a page from this PdfDocument into a new blank document.
copyPages(PageSelection) - Method in class com.ironsoftware.ironpdf.PdfDocument
Creates a new PDF by copying a page from this PdfDocument into a new blank document.
copyPages(int, int) - Method in class com.ironsoftware.ironpdf.PdfDocument
Creates a new PDF by copying a range of pages from this PdfDocument into a new blank document.
createCustomFont(String, String) - Static method in class com.ironsoftware.ironpdf.font.FontTypes
Deprecated.
This method is deprecated and is no longer supported. Create custom font types.
CssMediaType - Enum in com.ironsoftware.ironpdf.render
Defines which style-sheet should be rendered.

D

DefaultMaxWaitTime - Static variable in class com.ironsoftware.ironpdf.render.WaitFor
Default maximum wait time in milliseconds
DefaultRenderDelayDuration - Static variable in class com.ironsoftware.ironpdf.render.WaitFor
Default render delay duration in milliseconds.
disableFormFontFallback() - Method in class com.ironsoftware.ironpdf.form.FormManager
Suppresses the automatic Tahoma/Arial fallback embed for non-ASCII form values without registering any replacement font.
drawImage(Path, DrawImageOptions) - Method in class com.ironsoftware.ironpdf.PdfDocument
Draws an image onto the PDF document
drawImage(byte[], DrawImageOptions) - Method in class com.ironsoftware.ironpdf.PdfDocument
Draws an image onto the PDF document
DrawImageOptions - Class in com.ironsoftware.ironpdf.image
Defines options available to the developers when drawing images onto a PdfDocument.
DrawImageOptions(int, int, int, int) - Constructor for class com.ironsoftware.ironpdf.image.DrawImageOptions
Draw image options
DrawImageOptions(int, int, int, int, PageSelection) - Constructor for class com.ironsoftware.ironpdf.image.DrawImageOptions
Draw image options

E

extractAllImages() - Method in class com.ironsoftware.ironpdf.PdfDocument
Finds all embedded Images from within the PDF and returns them as a list of BufferedImage images.
extractAllImagesFromPages(PageSelection) - Method in class com.ironsoftware.ironpdf.PdfDocument
Finds all embedded Images from within the PDF and returns as a list of image bytes
extractAllRawImages() - Method in class com.ironsoftware.ironpdf.PdfDocument
Finds all embedded Images from within the PDF and returns as a list of image bytes
extractAllRawImagesFromPages(PageSelection) - Method in class com.ironsoftware.ironpdf.PdfDocument
Finds all embedded Images from within the PDF and returns them as raw bytes.
extractAllText() - Method in class com.ironsoftware.ironpdf.PdfDocument
Extracts the written text content from the PDF and returns it as a string.
extractTextFromPage(PageSelection) - Method in class com.ironsoftware.ironpdf.PdfDocument
Extracts the text content from one page of the PDF and returns it as a string.

F

firstPage() - Static method in class com.ironsoftware.ironpdf.edit.PageSelection
First page (page index 0).
FitToPaperModes - Enum in com.ironsoftware.ironpdf.render
Behaviors when fitting HTML content to a physical paper size Can affect zoom level and css layout
flatten() - Method in class com.ironsoftware.ironpdf.form.FormManager
Flattens a document (make all form fields non-editable).
flatten(PageSelection) - Method in class com.ironsoftware.ironpdf.form.FormManager
Flattens a document (make all form fields non-editable).
FontTypes - Class in com.ironsoftware.ironpdf.font
Supported PDF Fonts
FormField - Class in com.ironsoftware.ironpdf.form
Generic base class from which all PDF Form fields are derived.
FormField(int, String, int, String, double, double, double, double, String, boolean) - Constructor for class com.ironsoftware.ironpdf.form.FormField
(INTERNAL) Please Get ComboBoxField from FormFieldsSet.getUnknownFields() from FormManager.getFields()
FormFieldsSet - Class in com.ironsoftware.ironpdf.form
A container class contains the list of form field separated by the type.
FormFieldsSet(List<CheckBoxField>, List<TextField>, List<ComboBoxField>, List<ImageField>, List<RadioField>, List<SignatureField>, List<FormField>) - Constructor for class com.ironsoftware.ironpdf.form.FormFieldsSet
(INTERNAL) Please Get FormFieldsSet from FormManager.getFields()
FormFieldTypes - Enum in com.ironsoftware.ironpdf.form
Form field types
FormManager - Class in com.ironsoftware.ironpdf.form
Class used to read and write data to AcroForms in a PdfDocument.
FormManager(InternalPdfDocument) - Constructor for class com.ironsoftware.ironpdf.form.FormManager
Please get FormManager by PdfDocument.getForm() instead.
forValue(int) - Static method in enum com.ironsoftware.ironpdf.render.WaitForType
 
fromFile(Path, String) - Static method in class com.ironsoftware.ironpdf.PdfDocument
Opens an existing PDF document for editing.
fromFile(Path, String, ChangeTrackingModes) - Static method in class com.ironsoftware.ironpdf.PdfDocument
Opens an existing PDF document for editing.
fromFile(Path, String, String) - Static method in class com.ironsoftware.ironpdf.PdfDocument
Opens an existing PDF document for editing.
fromFile(Path, String, String, ChangeTrackingModes) - Static method in class com.ironsoftware.ironpdf.PdfDocument
Opens an existing PDF document for editing.
fromFile(Path) - Static method in class com.ironsoftware.ironpdf.PdfDocument
Opens an existing PDF document for editing.
fromFile(Path, ChangeTrackingModes) - Static method in class com.ironsoftware.ironpdf.PdfDocument
Opens an existing PDF document for editing.
fromFormType(String) - Static method in enum com.ironsoftware.ironpdf.form.FormFieldTypes
 
fromImage(List<Path>) - Static method in class com.ironsoftware.ironpdf.PdfDocument
Converts a single image file to an identical PDF document of matching dimensions.
fromImage(List<Path>, PaperSize) - Static method in class com.ironsoftware.ironpdf.PdfDocument
Converts a single image file to an identical PDF document of matching dimensions.
fromImage(List<Path>, ImageBehavior) - Static method in class com.ironsoftware.ironpdf.PdfDocument
Converts a single image file to an identical PDF document of matching dimensions.
fromImage(List<Path>, ImageBehavior, PaperSize) - Static method in class com.ironsoftware.ironpdf.PdfDocument
Converts a single image file to an identical PDF document of matching dimensions.
fromImage(List<Path>, ImageBehavior, ChromePdfRenderOptions) - Static method in class com.ironsoftware.ironpdf.PdfDocument
Converts a single image file to an identical PDF document of matching dimensions.
fromString(String) - Static method in class com.ironsoftware.ironpdf.font.FontTypes
Deprecated.
This method is deprecated and is no longer supported. Gets FontTypes from font file path.

G

getAllFields() - Method in class com.ironsoftware.ironpdf.form.FormFieldsSet
Gets all form fields.
getAllowUserEdits() - Method in class com.ironsoftware.ironpdf.security.SecurityOptions
Gets allow user edits.
getAllowUserPrinting() - Method in class com.ironsoftware.ironpdf.security.SecurityOptions
Gets allow user printing.
getAnnotation() - Method in class com.ironsoftware.ironpdf.PdfDocument
Gets the annotation manager for this PDF document.
getAnnotationCount(int) - Method in class com.ironsoftware.ironpdf.annotation.AnnotationManager
Retrieves the number of annotations contained on the specified page
getAnnotationIndex() - Method in class com.ironsoftware.ironpdf.annotation.LinkAnnotation
 
getAnnotationIndex() - Method in class com.ironsoftware.ironpdf.annotation.TextAnnotation
Gets index of the annotation on a page.
getAnnotationIndex() - Method in class com.ironsoftware.ironpdf.form.FormField
Gets annotation index.
getAnyMetadata(String) - Method in class com.ironsoftware.ironpdf.metadata.MetadataManager
Gets any metadata value of the document form given key.
getArial() - Static method in class com.ironsoftware.ironpdf.font.FontTypes
Gets arial.
getArialBold() - Static method in class com.ironsoftware.ironpdf.font.FontTypes
Gets arial bold.
getArialBoldItalic() - Static method in class com.ironsoftware.ironpdf.font.FontTypes
Gets arial bold italic.
getArialItalic() - Static method in class com.ironsoftware.ironpdf.font.FontTypes
Gets arial italic.
getAttachment() - Method in class com.ironsoftware.ironpdf.PdfDocument
Gets the attachment manager for this PDF document.
getAttachmentData(String) - Method in class com.ironsoftware.ironpdf.attachment.AttachmentManager
Gets attachment data from attachment name
getAttachmentData(int) - Method in class com.ironsoftware.ironpdf.attachment.AttachmentManager
Gets attachment data from attachment index
getAttachments() - Method in class com.ironsoftware.ironpdf.attachment.AttachmentManager
A Collection of file attachment names (keys) contained within this PdfDocument.
getAuthor() - Method in class com.ironsoftware.ironpdf.metadata.MetadataManager
Gets the Author of the document.
getAutoBookmarkCssSelectors() - Method in class com.ironsoftware.ironpdf.render.ChromePdfRenderOptions
Gets the additional CSS selectors used to mark non-heading elements as auto-bookmarks.
getAutoBookmarkMaxHeadingLevel() - Method in class com.ironsoftware.ironpdf.render.ChromePdfRenderOptions
Gets the maximum HTML heading level (inclusive) to include as an auto-bookmark.
getAutoBookmarkMinHeadingLevel() - Method in class com.ironsoftware.ironpdf.render.ChromePdfRenderOptions
Gets the minimum HTML heading level (inclusive) to include as an auto-bookmark.
getBackgroundColorCode() - Method in class com.ironsoftware.ironpdf.stamp.TextStamper
Gets Background Color.
getBarcodeType() - Method in class com.ironsoftware.ironpdf.stamp.BarcodeStamper
Gets barcode type.
getBaseUrl() - Method in class com.ironsoftware.ironpdf.headerfooter.HtmlHeaderFooter
The Base URL all URLS in the HtmlHeaderFooter.htmlFragment" will be relative to.
getBinaryData() - Method in class com.ironsoftware.ironpdf.PdfDocument
Saves the PDF as byte array, including any changes.
getBinaryDataIncremental() - Method in class com.ironsoftware.ironpdf.PdfDocument
Saves the PDF as byte array with changes appended to the end of the file.
getBookmark() - Method in class com.ironsoftware.ironpdf.PdfDocument
Gets the BookmarkManager for this PDF document.
getBookmarkManager() - Method in class com.ironsoftware.ironpdf.bookmark.Bookmark
Gets bookmark manager.
getBookmarks() - Method in class com.ironsoftware.ironpdf.bookmark.BookmarkManager
Retrieve all bookmarks within this PDF, recursively retrieve all children of bookmarks within this collection, and return as a flat list
getBooleanValue() - Method in class com.ironsoftware.ironpdf.form.CheckBoxField
Gets boolean value of the checkbox.
getCenterText() - Method in class com.ironsoftware.ironpdf.headerfooter.TextHeaderFooter
Gets center text.
getCertificateRawData() - Method in class com.ironsoftware.ironpdf.signature.Signature
Get certificate raw data byte [ ].
getCheckBoxFields() - Method in class com.ironsoftware.ironpdf.form.FormFieldsSet
Gets checkbox fields.
getChromeBrowserCachePath() - Static method in class com.ironsoftware.ironpdf.Settings
Disk cache path for Chrome browser instances default null
getChromeBrowserLimit() - Static method in class com.ironsoftware.ironpdf.Settings
Get Maximum number of concurrent browsers when using the Chrome renderer default is 30
getChromeGpuMode() - Static method in class com.ironsoftware.ironpdf.Settings
Chrome renderer GPU compatibility mode.
getColorCode() - Method in class com.ironsoftware.ironpdf.annotation.LinkAnnotation
 
getColorCode() - Method in class com.ironsoftware.ironpdf.annotation.TextAnnotation
Gets the color of the annotation's 'Sticky Note'.
getComboBoxFields() - Method in class com.ironsoftware.ironpdf.form.FormFieldsSet
Gets combobox fields.
getCompressionLevel() - Method in class com.ironsoftware.ironpdf.compression.AdvancedCompressionOptions
zlib compression level (0-9).
getConnectionMode() - Static method in class com.ironsoftware.ironpdf.Settings
Get IronPdfEngineConnection to set up various connection modes for IronPdfEngine.
getContents() - Method in class com.ironsoftware.ironpdf.annotation.AnnotationOptions
Gets contents.
getContents() - Method in class com.ironsoftware.ironpdf.annotation.LinkAnnotation
 
getContents() - Method in class com.ironsoftware.ironpdf.annotation.TextAnnotation
Gets the contents of the 'sticky note' annotation.
getCount() - Method in class com.ironsoftware.ironpdf.bookmark.BookmarkManager
Total number of bookmarks, including all nested bookmarks
getCourier() - Static method in class com.ironsoftware.ironpdf.font.FontTypes
Gets courier.
getCourierBold() - Static method in class com.ironsoftware.ironpdf.font.FontTypes
Gets courier bold.
getCourierBoldOblique() - Static method in class com.ironsoftware.ironpdf.font.FontTypes
Gets courier bold oblique.
getCourierNew() - Static method in class com.ironsoftware.ironpdf.font.FontTypes
Gets courier new.
getCourierNewBold() - Static method in class com.ironsoftware.ironpdf.font.FontTypes
Gets courier new bold.
getCourierNewBoldItalic() - Static method in class com.ironsoftware.ironpdf.font.FontTypes
Gets courier new bold italic.
getCourierNewItalic() - Static method in class com.ironsoftware.ironpdf.font.FontTypes
Gets courier new italic.
getCourierOblique() - Static method in class com.ironsoftware.ironpdf.font.FontTypes
Gets courier oblique.
getCreationDate() - Method in class com.ironsoftware.ironpdf.metadata.MetadataManager
Gets the PDF file creation DateTime.
getCreator() - Method in class com.ironsoftware.ironpdf.metadata.MetadataManager
Gets the Creator of the document.
getCssMediaType() - Method in class com.ironsoftware.ironpdf.render.ChromePdfRenderOptions
Gets css media type.
getCssMediaType() - Method in class com.ironsoftware.ironpdf.stamp.HtmlStamper
Gets css media type.
getCurrentSecurityOptions() - Method in class com.ironsoftware.ironpdf.security.SecurityManager
Gets the advanced security settings for this PDF document.
getCustomChannel() - Method in class com.ironsoftware.ironpdf.IronPdfEngineConnection
Retrieves custom channel.
getCustomCookies() - Method in class com.ironsoftware.ironpdf.render.ChromeHttpLoginCredentials
Gets custom cookies.
getCustomCssUrl() - Method in class com.ironsoftware.ironpdf.render.ChromePdfRenderOptions
Gets custom css url.
getCustomPaperHeight() - Method in class com.ironsoftware.ironpdf.render.ChromePdfRenderOptions
Gets custom paper height.
getCustomPaperWidth() - Method in class com.ironsoftware.ironpdf.render.ChromePdfRenderOptions
Gets custom paper width (mm).
getDestinationBottom() - Method in class com.ironsoftware.ironpdf.annotation.LinkAnnotation
 
getDestinationLeft() - Method in class com.ironsoftware.ironpdf.annotation.LinkAnnotation
 
getDestinationPageIndex() - Method in class com.ironsoftware.ironpdf.annotation.LinkAnnotation
 
getDestinationRight() - Method in class com.ironsoftware.ironpdf.annotation.LinkAnnotation
 
getDestinationTop() - Method in class com.ironsoftware.ironpdf.annotation.LinkAnnotation
 
getDestinationType() - Method in class com.ironsoftware.ironpdf.annotation.LinkAnnotation
 
getDestinationType() - Method in class com.ironsoftware.ironpdf.bookmark.Bookmark
Gets destination type.
getDestinationZoom() - Method in class com.ironsoftware.ironpdf.annotation.LinkAnnotation
 
getDividerLineColor() - Method in class com.ironsoftware.ironpdf.headerfooter.HtmlHeaderFooter
Gets divider line color code.
getDividerLineColor() - Method in class com.ironsoftware.ironpdf.headerfooter.TextHeaderFooter
Gets divider line color code.
getDpi() - Method in class com.ironsoftware.ironpdf.image.ToImageOptions
Gets dpi.
getElementIndex() - Method in class com.ironsoftware.ironpdf.render.RenderedElementLocation
 
getElementLocations() - Method in class com.ironsoftware.ironpdf.PdfDocument
Retrieves the rendered page locations of HTML elements that were tracked during rendering.
getElementQuerySelectors() - Method in class com.ironsoftware.ironpdf.render.ChromePdfRenderOptions
Gets the CSS selectors whose matching elements should have their rendered page positions tracked during rendering.
getFields() - Method in class com.ironsoftware.ironpdf.form.FormManager
Get a collection of the user-editable form fields within a PDF document
getFilter() - Method in class com.ironsoftware.ironpdf.signature.VerifiedSignature
Signature filter
getFirstPageNumber() - Method in class com.ironsoftware.ironpdf.headerfooter.HeaderFooterOptions
Gets first page number.First number used in {page} merge fields on the first page of the PDF.
getFitToPaperMode() - Method in class com.ironsoftware.ironpdf.render.ChromePdfRenderOptions
getFont() - Method in class com.ironsoftware.ironpdf.headerfooter.TextHeaderFooter
Gets font.
getFontColorCode() - Method in class com.ironsoftware.ironpdf.stamp.TextStamper
Gets Font Color.
getFontFamily() - Method in class com.ironsoftware.ironpdf.stamp.TextStamper
Gets font family.
getFontSize() - Method in class com.ironsoftware.ironpdf.headerfooter.TextHeaderFooter
Gets font size.
getFontSize() - Method in class com.ironsoftware.ironpdf.stamp.TextStamper
Gets font size.
getForm() - Method in class com.ironsoftware.ironpdf.PdfDocument
Gets the form manager for this PDF document.
getFormType() - Method in enum com.ironsoftware.ironpdf.form.FormFieldTypes
 
getHeight() - Method in class com.ironsoftware.ironpdf.annotation.AnnotationOptions
Gets height of your annotation's icon and interactive area in pixels.
getHeight() - Method in class com.ironsoftware.ironpdf.annotation.LinkAnnotation
 
getHeight() - Method in class com.ironsoftware.ironpdf.form.FormField
Gets form field height.
getHeight() - Method in class com.ironsoftware.ironpdf.image.DrawImageOptions
Gets height (Pixel).
getHeight() - Method in class com.ironsoftware.ironpdf.page.PageInfo
Gets height of the pdf page in mm.
getHeight() - Method in class com.ironsoftware.ironpdf.stamp.BarcodeStamper
Gets height.
getHelvetica() - Static method in class com.ironsoftware.ironpdf.font.FontTypes
Gets helvetica.
getHelveticaBold() - Static method in class com.ironsoftware.ironpdf.font.FontTypes
Gets helvetica bold.
getHelveticaBoldOblique() - Static method in class com.ironsoftware.ironpdf.font.FontTypes
Gets helvetica bold oblique.
getHelveticaOblique() - Static method in class com.ironsoftware.ironpdf.font.FontTypes
Gets helvetica oblique.
getHorizontalAlignment() - Method in class com.ironsoftware.ironpdf.stamp.Stamper
Gets horizontal alignment.
getHorizontalOffset() - Method in class com.ironsoftware.ironpdf.stamp.Stamper
Gets horizontal offset.
getHost() - Method in class com.ironsoftware.ironpdf.IronPdfEngineConnection
Retrieves the host name of the gRPC server.
getHtml() - Method in class com.ironsoftware.ironpdf.stamp.Stamper
Gets html.
getHtmlBaseUrl() - Method in class com.ironsoftware.ironpdf.stamp.HtmlStamper
Gets the HTML base URL for which references to external CSS, Javascript and Image files will be relative.
getHtmlElementQueryStr() - Method in class com.ironsoftware.ironpdf.render.WaitFor
 
getHtmlFragment() - Method in class com.ironsoftware.ironpdf.headerfooter.HtmlHeaderFooter
The Html which will be used to render the Header / Footer.
getHtmlTitle() - Method in class com.ironsoftware.ironpdf.headerfooter.HeaderFooterOptions
Gets html title.
getHyperlink() - Method in class com.ironsoftware.ironpdf.stamp.Stamper
Gets hyperlink.
getIcon() - Method in class com.ironsoftware.ironpdf.annotation.AnnotationOptions
Gets AnnotationIcon used to display the interactive annotation within the PDF.
getIcon() - Method in class com.ironsoftware.ironpdf.annotation.TextAnnotation
Gets icon.
getImageData() - Method in class com.ironsoftware.ironpdf.stamp.ImageStamper
Gets image data (byte[]).
getImageFields() - Method in class com.ironsoftware.ironpdf.form.FormFieldsSet
Gets image fields.
getImageMaxHeight() - Method in class com.ironsoftware.ironpdf.image.ToImageOptions
Gets image max height.
getImageMaxWidth() - Method in class com.ironsoftware.ironpdf.image.ToImageOptions
Gets image max width.
getInputEncoding() - Method in class com.ironsoftware.ironpdf.render.ChromePdfRenderOptions
Gets input character encoding as a string; e.g.
getInternalIndex() - Method in class com.ironsoftware.ironpdf.signature.Signature
Internal using only
getIronPdfEngineHost() - Static method in class com.ironsoftware.ironpdf.Settings
Deprecated.
This method is obsolete. Use Settings.getConnectionMode() instead.
getIronPdfEnginePort() - Static method in class com.ironsoftware.ironpdf.Settings
Deprecated.
This method is obsolete. Use Settings.getConnectionMode() instead.
getIronPdfEngineTimeout() - Static method in class com.ironsoftware.ironpdf.Settings
A Timeout (in seconds) to wait for any response from IronPdfEngine default 120 seconds
getIronPdfEngineVersion() - Static method in class com.ironsoftware.ironpdf.Settings
Gets IronPDF engine version.
getIronPdfEngineWorkingDirectory() - Static method in class com.ironsoftware.ironpdf.Settings
Gets path to IronPDF engine working directory.
getJavascript() - Method in class com.ironsoftware.ironpdf.render.ChromePdfRenderOptions
Get A custom javascript string to be executed after all HTML has loaded but before PDf rendering.
getJobQueueWatchdogTimeoutSeconds() - Static method in class com.ironsoftware.ironpdf.Settings
Watchdog timeout (in seconds) for queued IronPdfEngine Chrome jobs.
getJpegQuality() - Method in class com.ironsoftware.ironpdf.compression.AdvancedCompressionOptions
JPEG quality used when re-encoding images during optimization (1-100).
getKeywords() - Method in class com.ironsoftware.ironpdf.metadata.MetadataManager
Gets Keywords of the document.
getLeftText() - Method in class com.ironsoftware.ironpdf.headerfooter.TextHeaderFooter
Gets left text.
getLicenseKey() - Static method in class com.ironsoftware.ironpdf.License
Gets your current license key.
getLogPath() - Static method in class com.ironsoftware.ironpdf.Settings
Gets IronPDF engine log file path.
getMarginBottom() - Method in class com.ironsoftware.ironpdf.render.ChromePdfRenderOptions
Gets margin bottom.
getMarginBottomMm() - Method in class com.ironsoftware.ironpdf.headerfooter.HeaderFooterOptions
Gets margin bottom mm.
getMarginLeft() - Method in class com.ironsoftware.ironpdf.render.ChromePdfRenderOptions
Gets margin left.
getMarginLeftMm() - Method in class com.ironsoftware.ironpdf.headerfooter.HeaderFooterOptions
Gets margin left mm.
getMarginRight() - Method in class com.ironsoftware.ironpdf.render.ChromePdfRenderOptions
Gets margin right.
getMarginRightMm() - Method in class com.ironsoftware.ironpdf.headerfooter.HeaderFooterOptions
Gets margin right mm.
getMarginTop() - Method in class com.ironsoftware.ironpdf.render.ChromePdfRenderOptions
Gets margin top.
getMarginTopMm() - Method in class com.ironsoftware.ironpdf.headerfooter.HeaderFooterOptions
Gets margin top mm.
getMaxHeight() - Method in class com.ironsoftware.ironpdf.headerfooter.HtmlHeaderFooter
Maximum Height of the Html Header / Footer in millimeters.
getMaxHeight() - Method in class com.ironsoftware.ironpdf.stamp.Stamper
Gets the maximum height of the output stamp.
getMaxWidth() - Method in class com.ironsoftware.ironpdf.stamp.Stamper
Gets the maximum width of the output stamp.
getMetadata() - Method in class com.ironsoftware.ironpdf.PdfDocument
Gets the metadata manager for this PDF document.
getMinHeight() - Method in class com.ironsoftware.ironpdf.stamp.Stamper
Gets the minimum height of the output stamp.
getMinWidth() - Method in class com.ironsoftware.ironpdf.stamp.Stamper
Gets the minimum width of the output stamp.
getMode() - Method in class com.ironsoftware.ironpdf.IronPdfEngineConnection
Retrieves the current connection mode (HOST_PORT, TARGET, SUBPROCESS, or CUSTOM).
getModifiedDate() - Method in class com.ironsoftware.ironpdf.metadata.MetadataManager
Gets the PDF file last-modified DateTime.
getName() - Method in class com.ironsoftware.ironpdf.form.FormField
Gets the ID name of this field.
getNetworkIdleDuration() - Method in class com.ironsoftware.ironpdf.render.WaitFor
 
getNetworkPassword() - Method in class com.ironsoftware.ironpdf.render.ChromeHttpLoginCredentials
Gets network password.
getNetworkUsername() - Method in class com.ironsoftware.ironpdf.render.ChromeHttpLoginCredentials
Gets network username.
getNextBookmarkText() - Method in class com.ironsoftware.ironpdf.bookmark.Bookmark
Gets next bookmark text.
getNumAllowedInFlight() - Method in class com.ironsoftware.ironpdf.render.WaitFor
 
getObjectStreams() - Method in class com.ironsoftware.ironpdf.compression.AdvancedCompressionOptions
Object stream mode used when writing the output PDF.
getOpacity() - Method in class com.ironsoftware.ironpdf.annotation.AnnotationOptions
Gets the opacity of the annotation (valid values are from 0.0 to 1.0).
getOpacity() - Method in class com.ironsoftware.ironpdf.annotation.TextAnnotation
Gets the opacity of the annotation (valid values are from 0.0 to 1.0).
getOpacity() - Method in class com.ironsoftware.ironpdf.stamp.Stamper
Gets opacity.
getOptimizeImagesMinArea() - Method in class com.ironsoftware.ironpdf.compression.AdvancedCompressionOptions
Minimum image area (width × height pixels) for image optimization to apply.
getOptimizeImagesMinHeight() - Method in class com.ironsoftware.ironpdf.compression.AdvancedCompressionOptions
Minimum image height (in pixels) for image optimization to apply.
getOptimizeImagesMinWidth() - Method in class com.ironsoftware.ironpdf.compression.AdvancedCompressionOptions
Minimum image width (in pixels) for image optimization to apply.
getOptions() - Method in class com.ironsoftware.ironpdf.form.ComboBoxField
Gets options.
getOptions() - Method in class com.ironsoftware.ironpdf.form.RadioField
Gets options.
getOwnerPassword() - Method in class com.ironsoftware.ironpdf.security.SecurityManager
Gets the owner password and enables 128-bit encryption of PDF content.
getOwnerPassword() - Method in class com.ironsoftware.ironpdf.security.SecurityOptions
Gets owner password.
getPageIndex() - Method in class com.ironsoftware.ironpdf.annotation.LinkAnnotation
 
getPageIndex() - Method in class com.ironsoftware.ironpdf.annotation.TextAnnotation
Gets index of the page to add the annotation.
getPageIndex() - Method in class com.ironsoftware.ironpdf.bookmark.Bookmark
Gets page index.
getPageIndex() - Method in class com.ironsoftware.ironpdf.form.FormField
Gets page index.
getPageIndex() - Method in class com.ironsoftware.ironpdf.page.PageInfo
Gets page index
getPageIndex() - Method in class com.ironsoftware.ironpdf.render.RenderedElementLocation
 
getPageRotation() - Method in class com.ironsoftware.ironpdf.page.PageInfo
Gets page rotation.
getPageSelection() - Method in class com.ironsoftware.ironpdf.image.DrawImageOptions
Gets page selection.
getPagesInfo() - Method in class com.ironsoftware.ironpdf.PdfDocument
Gets a list of information about pages in this PDF as a List of PageInfo.
getPagesInfo(PageSelection) - Method in class com.ironsoftware.ironpdf.PdfDocument
Gets a Map of information a selection of pages in this PDF as a List of PageInfo.
getPaperOrientation() - Method in class com.ironsoftware.ironpdf.render.ChromePdfRenderOptions
Gets paper orientation.
getPaperSize() - Method in class com.ironsoftware.ironpdf.render.ChromePdfRenderOptions
Gets paper size.
getParentBookmarkText() - Method in class com.ironsoftware.ironpdf.bookmark.Bookmark
Gets parent bookmark text.
getPassword() - Method in class com.ironsoftware.ironpdf.security.SecurityManager
Gets a Password used to protect and encrypt the PDF File.
getPassword() - Method in class com.ironsoftware.ironpdf.signature.Signature
Gets password.
getPdfTitle() - Method in class com.ironsoftware.ironpdf.headerfooter.HeaderFooterOptions
Gets pdf title.
getPort() - Method in class com.ironsoftware.ironpdf.IronPdfEngineConnection
Retrieves the port number of the IronPdfEngine.
getPreviousBookmarkText() - Method in class com.ironsoftware.ironpdf.bookmark.Bookmark
Gets previous bookmark text.
getPrintHeight() - Method in class com.ironsoftware.ironpdf.page.PageInfo
Gets print height of the pdf page in printer points.
getPrintWidth() - Method in class com.ironsoftware.ironpdf.page.PageInfo
Gets print width of the pdf page in printer points.
getProducer() - Method in class com.ironsoftware.ironpdf.metadata.MetadataManager
Gets the Producer of the document.
getRadioFields() - Method in class com.ironsoftware.ironpdf.form.FormFieldsSet
Gets radio fields.
getRectangle() - Method in class com.ironsoftware.ironpdf.annotation.LinkAnnotation
 
getRectangle() - Method in class com.ironsoftware.ironpdf.annotation.TextAnnotation
Gets the X and Y coordinates, as well as the width and height, of the annotation's icon and interactive area in pixels.
getRectangle() - Method in class com.ironsoftware.ironpdf.render.RenderedElementLocation
 
getRenderDelay() - Method in class com.ironsoftware.ironpdf.stamp.HtmlStamper
Deprecated.
getRenderDelayDuration() - Method in class com.ironsoftware.ironpdf.render.WaitFor
 
getRenderPdfCssMediaType() - Method in class com.ironsoftware.ironpdf.headerfooter.HeaderFooterOptions
Gets render pdf css media type.
getRevision(int) - Method in class com.ironsoftware.ironpdf.PdfDocument
Saves the PDF as byte array at the specified revision number.
getRgbColor() - Method in class com.ironsoftware.ironpdf.annotation.AnnotationOptions
Gets color of the annotation's background 'sticky note' using Html color notation.
getRightText() - Method in class com.ironsoftware.ironpdf.headerfooter.TextHeaderFooter
Gets right text.
getRotation() - Method in class com.ironsoftware.ironpdf.stamp.Stamper
Gets rotation.
getScale() - Method in class com.ironsoftware.ironpdf.stamp.Stamper
Gets scale.
getSecurity() - Method in class com.ironsoftware.ironpdf.PdfDocument
Gets security.
getSelectedIndex() - Method in class com.ironsoftware.ironpdf.form.ComboBoxField
Gets The index of the selected option.
getSelectedIndex() - Method in class com.ironsoftware.ironpdf.form.RadioField
Gets The index of the selected option.
getSignature() - Method in class com.ironsoftware.ironpdf.PdfDocument
Gets signature.
getSignatureDate() - Method in class com.ironsoftware.ironpdf.signature.Signature
Gets signature date.
getSignatureFields() - Method in class com.ironsoftware.ironpdf.form.FormFieldsSet
Gets signature fields.
getSignatureImage() - Method in class com.ironsoftware.ironpdf.signature.Signature
Get signature image.
getSignatureImageRectangle() - Method in class com.ironsoftware.ironpdf.signature.Signature
Get signature image Rectangle.
getSignatureName() - Method in class com.ironsoftware.ironpdf.signature.VerifiedSignature
Gets the field name of the digital signature.
getSigningContact() - Method in class com.ironsoftware.ironpdf.signature.Signature
Gets signing contact.
getSigningContact() - Method in class com.ironsoftware.ironpdf.signature.VerifiedSignature
Gets the contact person or email address for signing related inquiries (optional).
getSigningDate() - Method in class com.ironsoftware.ironpdf.signature.VerifiedSignature
Gets date and time of the digital signature.
getSigningLocation() - Method in class com.ironsoftware.ironpdf.signature.Signature
Gets signing location.
getSigningLocation() - Method in class com.ironsoftware.ironpdf.signature.VerifiedSignature
Gets physical location the PDF was signed (optional).
getSigningReason() - Method in class com.ironsoftware.ironpdf.signature.Signature
Gets signing reason.
getSigningReason() - Method in class com.ironsoftware.ironpdf.signature.VerifiedSignature
Gets reason the PDF was signed (optional).
getSpacing() - Method in class com.ironsoftware.ironpdf.headerfooter.TextHeaderFooter
Gets spacing.
getSubject() - Method in class com.ironsoftware.ironpdf.annotation.AnnotationOptions
Gets subject or 'subheading' of the annotation.
getSubject() - Method in class com.ironsoftware.ironpdf.annotation.TextAnnotation
Gets subject.
getSubject() - Method in class com.ironsoftware.ironpdf.metadata.MetadataManager
Gets Subject of the document.
getSymbol() - Static method in class com.ironsoftware.ironpdf.font.FontTypes
Gets symbol.
getTableOfContents() - Method in class com.ironsoftware.ironpdf.render.ChromePdfRenderOptions
Gets TableOfContents.
getTarget() - Method in class com.ironsoftware.ironpdf.IronPdfEngineConnection
Retrieves the target string used for service discovery (if applicable).
getTargetImageDpi() - Method in class com.ironsoftware.ironpdf.compression.AdvancedCompressionOptions
Target DPI for image downsampling during advanced compression.
getTempFolderPath() - Static method in class com.ironsoftware.ironpdf.Settings
Get temp folder path.
getText() - Method in class com.ironsoftware.ironpdf.bookmark.Bookmark
Gets text.
getText() - Method in class com.ironsoftware.ironpdf.render.RenderedElementLocation
 
getText() - Method in class com.ironsoftware.ironpdf.stamp.TextStamper
Gets text to be stamped by the Stamper
getTextFields() - Method in class com.ironsoftware.ironpdf.form.FormFieldsSet
Gets text fields.
getTimeout() - Method in class com.ironsoftware.ironpdf.render.ChromePdfRenderOptions
Gets render timeout in seconds.
getTimeout() - Method in class com.ironsoftware.ironpdf.render.WaitFor
 
getTimeout() - Method in class com.ironsoftware.ironpdf.stamp.HtmlStamper
Gets timeout.
getTimesNewRoman() - Static method in class com.ironsoftware.ironpdf.font.FontTypes
Gets times new roman.
getTimesNewRomanBold() - Static method in class com.ironsoftware.ironpdf.font.FontTypes
Gets times new roman bold.
getTimesNewRomanBoldItalic() - Static method in class com.ironsoftware.ironpdf.font.FontTypes
Gets times new roman bold italic.
getTimesNewRomanItalic() - Static method in class com.ironsoftware.ironpdf.font.FontTypes
Gets times new roman italic.
getTimeStampUrl() - Method in class com.ironsoftware.ironpdf.signature.Signature
Gets Url to be used when time-stamping the signature
getTitle() - Method in class com.ironsoftware.ironpdf.annotation.AnnotationOptions
Gets title.
getTitle() - Method in class com.ironsoftware.ironpdf.annotation.LinkAnnotation
 
getTitle() - Method in class com.ironsoftware.ironpdf.annotation.TextAnnotation
Gets title.
getTitle() - Method in class com.ironsoftware.ironpdf.metadata.MetadataManager
Gets the Title of the document.
getTitle() - Method in class com.ironsoftware.ironpdf.render.ChromePdfRenderOptions
Gets title.
getType() - Method in class com.ironsoftware.ironpdf.form.FormField
Gets form field types.
getType() - Method in class com.ironsoftware.ironpdf.render.WaitFor
 
getUnit() - Method in class com.ironsoftware.ironpdf.edit.Length
Gets unit.
getUnknownFields() - Method in class com.ironsoftware.ironpdf.form.FormFieldsSet
Gets unknown fields.
getUserPassword() - Method in class com.ironsoftware.ironpdf.security.SecurityOptions
Gets user password.
getValue() - Method in class com.ironsoftware.ironpdf.edit.Length
Gets value.
getValue() - Method in class com.ironsoftware.ironpdf.form.FormField
Gets the value of the editable PDF field.
getValue() - Method in enum com.ironsoftware.ironpdf.NaturalLanguages
 
getValue() - Method in enum com.ironsoftware.ironpdf.render.TableOfContentsTypes
 
getValue() - Method in enum com.ironsoftware.ironpdf.render.WaitForType
 
getValue() - Method in enum com.ironsoftware.ironpdf.signature.SignaturePermissions
 
getValue() - Method in enum com.ironsoftware.ironpdf.stamp.BarcodeEncoding
 
getValue() - Method in class com.ironsoftware.ironpdf.stamp.BarcodeStamper
Gets value.
getValue() - Method in enum com.ironsoftware.ironpdf.standard.PdfAVersions
 
getValue() - Method in enum com.ironsoftware.ironpdf.standard.PdfUAVersions
 
getVerifiedSignature() - Method in class com.ironsoftware.ironpdf.signature.SignatureManager
Returns a list of VerifiedSignature.
getVerticalAlignment() - Method in class com.ironsoftware.ironpdf.stamp.Stamper
Gets vertical alignment.
getVerticalOffset() - Method in class com.ironsoftware.ironpdf.stamp.Stamper
Gets vertical offset.
getViewPortHeight() - Method in class com.ironsoftware.ironpdf.render.ChromePdfRenderOptions
internal use
getViewPortWidth() - Method in class com.ironsoftware.ironpdf.render.ChromePdfRenderOptions
internal use
getWaitFor() - Method in class com.ironsoftware.ironpdf.render.ChromePdfRenderOptions
Gets a wrapper object that holds configuration for wait-for mechanism for user to wait for certain events before rendering.
getWaitFor() - Method in class com.ironsoftware.ironpdf.stamp.Stamper
Get A convenient wrapper to wait for various events, or just wait for amount of time.
getWidth() - Method in class com.ironsoftware.ironpdf.annotation.AnnotationOptions
Gets width of your annotation's icon and interactive area in pixels.
getWidth() - Method in class com.ironsoftware.ironpdf.annotation.LinkAnnotation
 
getWidth() - Method in class com.ironsoftware.ironpdf.form.FormField
Gets form field width.
getWidth() - Method in class com.ironsoftware.ironpdf.image.DrawImageOptions
Gets width (Pixel).
getWidth() - Method in class com.ironsoftware.ironpdf.page.PageInfo
Gets width of the pdf page in mm.
getWidth() - Method in class com.ironsoftware.ironpdf.stamp.BarcodeStamper
Gets width.
getX() - Method in class com.ironsoftware.ironpdf.annotation.AnnotationOptions
Gets the horizontal X position of the annotation on your page in pixels.
getX() - Method in class com.ironsoftware.ironpdf.annotation.LinkAnnotation
 
getX() - Method in class com.ironsoftware.ironpdf.form.FormField
Gets form field x position.
getX() - Method in class com.ironsoftware.ironpdf.image.DrawImageOptions
Gets X coordinate.
getY() - Method in class com.ironsoftware.ironpdf.annotation.AnnotationOptions
Gets the vertical Y position of the annotation on your page in pixels.
getY() - Method in class com.ironsoftware.ironpdf.annotation.LinkAnnotation
 
getY() - Method in class com.ironsoftware.ironpdf.form.FormField
Gets form field y position.
getY() - Method in class com.ironsoftware.ironpdf.image.DrawImageOptions
Gets Y coordinate.
getZapfDingbats() - Static method in class com.ironsoftware.ironpdf.font.FontTypes
Gets zapf dingbats.
getZoom() - Method in class com.ironsoftware.ironpdf.render.ChromePdfRenderOptions
internal use

H

HeaderFooterOptions - Class in com.ironsoftware.ironpdf.headerfooter
Defines options for Headers and Footers applied to a PdfDocument during rendering or at any other time.
HeaderFooterOptions() - Constructor for class com.ironsoftware.ironpdf.headerfooter.HeaderFooterOptions
Instantiates a new Header footer options.
HorizontalAlignment - Enum in com.ironsoftware.ironpdf.stamp
Horizontal layout alignment relative to the PDF page.
HtmlElementByClassName(String) - Method in class com.ironsoftware.ironpdf.render.WaitFor
This method proceeds rendering by waiting until it finds the HTML element whose the class name as of the specified one.
HtmlElementByClassName(String, int) - Method in class com.ironsoftware.ironpdf.render.WaitFor
This method proceeds rendering by waiting until it finds the HTML element whose the class name as of the specified one.
HtmlElementById(String) - Method in class com.ironsoftware.ironpdf.render.WaitFor
This method proceeds rendering by waiting until it finds the HTML element that has the same id as specified one.
HtmlElementById(String, int) - Method in class com.ironsoftware.ironpdf.render.WaitFor
This method proceeds rendering by waiting until it finds the HTML element that has the same id as specified one.
HtmlElementByName(String) - Method in class com.ironsoftware.ironpdf.render.WaitFor
This method proceeds rendering by waiting until it finds the element with the attribute name as of the specified one.
HtmlElementByName(String, int) - Method in class com.ironsoftware.ironpdf.render.WaitFor
This method proceeds rendering by waiting until it finds the element with the attribute name as of the specified one.
HtmlElementByTagName(String) - Method in class com.ironsoftware.ironpdf.render.WaitFor
This method proceeds rendering by waiting until it finds the HTML element that itself has the same tag name as of specified one.
HtmlElementByTagName(String, int) - Method in class com.ironsoftware.ironpdf.render.WaitFor
This method proceeds rendering by waiting until it finds the HTML element that itself has the same tag name as of specified one.
HtmlHeaderFooter - Class in com.ironsoftware.ironpdf.headerfooter
A Html Header or Footer which will be printed onto every page of the PDF.
HtmlHeaderFooter() - Constructor for class com.ironsoftware.ironpdf.headerfooter.HtmlHeaderFooter
Instantiates a new Html header footer.
HtmlHeaderFooter(String) - Constructor for class com.ironsoftware.ironpdf.headerfooter.HtmlHeaderFooter
Instantiates a new Html header footer.
HtmlQuerySelector(String) - Method in class com.ironsoftware.ironpdf.render.WaitFor
This method proceeds rendering by waiting until it finds the HTML element via the specified query string which is executed by a JavaScript function document.querySelector().
HtmlQuerySelector(String, int) - Method in class com.ironsoftware.ironpdf.render.WaitFor
This method proceeds rendering by waiting until it finds the HTML element via the specified query string which is executed by a JavaScript function document.querySelector().
HtmlStamper - Class in com.ironsoftware.ironpdf.stamp
Defines an HTML stamper allowing developers to edit a PdfDocument by adding new content designed in HTML, CSS and JavaScript.
HtmlStamper(String) - Constructor for class com.ironsoftware.ironpdf.stamp.HtmlStamper
Initializes a new instance of the HtmlStamper class.
HtmlStamper(String, String) - Constructor for class com.ironsoftware.ironpdf.stamp.HtmlStamper
Initializes a new instance of the HtmlStamper class.
HtmlStamper(String, Path) - Constructor for class com.ironsoftware.ironpdf.stamp.HtmlStamper
Initializes a new instance of the HtmlStamper class.
HtmlStamper() - Constructor for class com.ironsoftware.ironpdf.stamp.HtmlStamper
Initializes a new instance of the HtmlStamper class.

I

ImageBehavior - Enum in com.ironsoftware.ironpdf.image
Defines layout behavior relative to the page size when creating a PDF from images.
ImageField - Class in com.ironsoftware.ironpdf.form
 
ImageField(int, String, int, double, double, double, double, String, boolean) - Constructor for class com.ironsoftware.ironpdf.form.ImageField
(INTERNAL) Please Get ImageField from FormFieldsSet.getImageFields() from FormManager.getFields()
ImageStamper - Class in com.ironsoftware.ironpdf.stamp
This allows the user to edit an existing PDF by adding an image.
ImageStamper(String) - Constructor for class com.ironsoftware.ironpdf.stamp.ImageStamper
Initializes a new instance of the ImageStamper class.
ImageStamper(Path) - Constructor for class com.ironsoftware.ironpdf.stamp.ImageStamper
Initializes a new instance of the ImageStamper class.
ImageStamper(byte[]) - Constructor for class com.ironsoftware.ironpdf.stamp.ImageStamper
Initializes a new instance of the ImageStamper class.
ImageStamper(BufferedImage) - Constructor for class com.ironsoftware.ironpdf.stamp.ImageStamper
Initializes a new instance of the ImageStamper class.
insertBookmark(String, int, String, String) - Method in class com.ironsoftware.ironpdf.bookmark.BookmarkManager
Insert a new bookmark
insertBookmark(Bookmark) - Method in class com.ironsoftware.ironpdf.bookmark.BookmarkManager
Insert a new bookmark
insertPdf(PdfDocument) - Method in class com.ironsoftware.ironpdf.PdfDocument
Inserts another PDF into the current PdfDocument, starting at a given Page Index.
insertPdf(PdfDocument, int) - Method in class com.ironsoftware.ironpdf.PdfDocument
Inserts another PDF into the current PdfDocument, starting at a given Page Index.
IronPdfDeploymentException - Exception in com.ironsoftware.ironpdf.exception
Represents errors that occur during IronPDF binary asset deployment.
IronPdfDeploymentException(String, String, String) - Constructor for exception com.ironsoftware.ironpdf.exception.IronPdfDeploymentException
Instantiates a new Iron pdf deployment exception.
IronPdfDeploymentException(Exception_RemoteException) - Constructor for exception com.ironsoftware.ironpdf.exception.IronPdfDeploymentException
Instantiates a new Iron pdf deployment exception.
IronPdfEngineConnection - Class in com.ironsoftware.ironpdf
IronPdfEngineConnection is a configuration class used to set up various connection modes for IronPdfEngine.
IronPdfEngineConnection() - Constructor for class com.ironsoftware.ironpdf.IronPdfEngineConnection
 
IronPdfEngineConnection.ConnectionMode - Enum in com.ironsoftware.ironpdf
 
IronPdfEngineManager - Class in com.ironsoftware.ironpdf
Manages the lifecycle of the IronPdfEngine.
IronPdfInputException - Exception in com.ironsoftware.ironpdf.exception
 
IronPdfInputException(String, String, String) - Constructor for exception com.ironsoftware.ironpdf.exception.IronPdfInputException
 
IronPdfInputException(String) - Constructor for exception com.ironsoftware.ironpdf.exception.IronPdfInputException
 
IronPdfInputException(Exception_RemoteException) - Constructor for exception com.ironsoftware.ironpdf.exception.IronPdfInputException
 
IronPdfLicensingException - Exception in com.ironsoftware.ironpdf.exception
Get a free development license at https://ironpdf.com/licensing/#trial-license or purchase a deployment license from https://ironpdf.com/licensing/.
IronPdfLicensingException(String, String, String) - Constructor for exception com.ironsoftware.ironpdf.exception.IronPdfLicensingException
Instantiates a new Iron pdf licensing exception.
IronPdfLicensingException(Exception_RemoteException) - Constructor for exception com.ironsoftware.ironpdf.exception.IronPdfLicensingException
Instantiates a new Iron pdf licensing exception.
IronPdfNativeException - Exception in com.ironsoftware.ironpdf.exception
Represents errors that occur from native code within IronPDF.
IronPdfNativeException(String, String, String) - Constructor for exception com.ironsoftware.ironpdf.exception.IronPdfNativeException
Initializes a new instance of the IronPdfNativeException class with a specified error message.
IronPdfNativeException(Exception_RemoteException) - Constructor for exception com.ironsoftware.ironpdf.exception.IronPdfNativeException
Instantiates a new Iron pdf native exception.
IronPdfProductException - Exception in com.ironsoftware.ironpdf.exception
Represents meaningful errors that are thrown explicitly by IronPDF.
IronPdfProductException(String, String, String) - Constructor for exception com.ironsoftware.ironpdf.exception.IronPdfProductException
Initializes a new instance of the IronPdfProductException class with a specified error message.
IronPdfProductException(Exception_RemoteException) - Constructor for exception com.ironsoftware.ironpdf.exception.IronPdfProductException
Instantiates a new Iron pdf product exception.
isAllowUserAnnotations() - Method in class com.ironsoftware.ironpdf.security.SecurityOptions
Is allow user annotations boolean.
isAllowUserCopyPasteContent() - Method in class com.ironsoftware.ironpdf.security.SecurityOptions
Is allow user copy and paste content boolean.
isAllowUserCopyPasteContentForAccessibility() - Method in class com.ironsoftware.ironpdf.security.SecurityOptions
Is allow user copy and paste content for accessibility boolean.
isAllowUserFormData() - Method in class com.ironsoftware.ironpdf.security.SecurityOptions
Is allow user form data boolean.
isAutoBookmarksFromHeadings() - Method in class com.ironsoftware.ironpdf.render.ChromePdfRenderOptions
Gets whether PDF bookmarks are automatically generated from HTML headings.
isAutoInstallDependency() - Static method in class com.ironsoftware.ironpdf.Settings
If true The necessary package dependencies for IronPDF rendering will we automatically installed to Docker and Debian / Ubuntu Linux deployments.
isBold() - Method in class com.ironsoftware.ironpdf.stamp.TextStamper
Is bold boolean.
isCoalesceContents() - Method in class com.ironsoftware.ironpdf.compression.AdvancedCompressionOptions
Merge a page's separate content streams so they Flate-compress together.
isCompressStreams() - Method in class com.ironsoftware.ironpdf.compression.AdvancedCompressionOptions
Compress content streams using zlib/Flate.
isCreatePdfFormsFromHtml() - Method in class com.ironsoftware.ironpdf.render.ChromePdfRenderOptions
Is create pdf forms from html.
isDebug() - Static method in class com.ironsoftware.ironpdf.Settings
Is debug boolean.
isDecodeGeneralizedStreams() - Method in class com.ironsoftware.ironpdf.compression.AdvancedCompressionOptions
Decode generalized filters (FlateDecode, LZW, ASCII85, ASCIIHex) before re-encoding.
isDrawDividerLine() - Method in class com.ironsoftware.ironpdf.headerfooter.HtmlHeaderFooter
A horizontal line divider between the header / footer and the page content on every page of the PDF document.
isDrawDividerLine() - Method in class com.ironsoftware.ironpdf.headerfooter.TextHeaderFooter
Is draw divider line boolean.
isEnableCookies() - Method in class com.ironsoftware.ironpdf.render.ChromeHttpLoginCredentials
Is enable cookies boolean.
isEnableJavaScript() - Method in class com.ironsoftware.ironpdf.render.ChromePdfRenderOptions
Is enable JavaScript.
isEngineActive() - Static method in class com.ironsoftware.ironpdf.IronPdfEngineManager
Checks whether IronPdfEngine is currently reachable and responsive.
isGrayScale() - Method in class com.ironsoftware.ironpdf.render.ChromePdfRenderOptions
Is gray scale boolean.
isHidden() - Method in class com.ironsoftware.ironpdf.annotation.AnnotationOptions
Gets a flag that hides the annotation from users.
isHidden() - Method in class com.ironsoftware.ironpdf.annotation.LinkAnnotation
 
isHidden() - Method in class com.ironsoftware.ironpdf.annotation.TextAnnotation
Hides the annotation from users.
isHighQualityImageSubsampling() - Method in class com.ironsoftware.ironpdf.compression.AdvancedCompressionOptions
4:4:4 chroma subsampling when true (better color), 4:1:1 when false (smaller).
isItalic() - Method in class com.ironsoftware.ironpdf.stamp.TextStamper
Is italic boolean.
isLicensed() - Static method in class com.ironsoftware.ironpdf.License
Determines whether this instance of IronPDF is Licensed.
isLinearized(String) - Static method in class com.ironsoftware.ironpdf.PdfDocument
Check whether the PDF file at the given path is linearized (a.k.a.
isLinearized(String, String) - Static method in class com.ironsoftware.ironpdf.PdfDocument
Check whether the PDF file at the given path is linearized (a.k.a.
isLinearized(Path) - Static method in class com.ironsoftware.ironpdf.PdfDocument
Check whether the PDF file at the given path is linearized (a.k.a.
isLoadStylesAndCSSFromMainHtmlDocument() - Method in class com.ironsoftware.ironpdf.headerfooter.HtmlHeaderFooter
Loads style code blocks and links to CSS style sheets from the main HTML document (which provides the PDF content) into the HtmlHeaderFooter .
isOpen() - Method in class com.ironsoftware.ironpdf.annotation.AnnotationOptions
Gets a flag for annotation to be opened and readable by default, without user interaction.
isOpenByDefault() - Method in class com.ironsoftware.ironpdf.annotation.TextAnnotation
The annotation to be opened and readable by default, without user interaction.
isPrintable() - Method in class com.ironsoftware.ironpdf.annotation.AnnotationOptions
Gets a flag that the annotation render during user PDF printing operations..
isPrintable() - Method in class com.ironsoftware.ironpdf.annotation.TextAnnotation
Is allows the annotation to be printed when users print the PDF.
isPrintHtmlBackgrounds() - Method in class com.ironsoftware.ironpdf.render.ChromePdfRenderOptions
Is print html backgrounds boolean.
isReadonly() - Method in class com.ironsoftware.ironpdf.annotation.AnnotationOptions
Gets a flag that makes the annotation readonly.
isReadOnly() - Method in class com.ironsoftware.ironpdf.annotation.TextAnnotation
Sets the annotation to be read only.
isReadOnly() - Method in class com.ironsoftware.ironpdf.form.FormField
Is read only boolean.
isRecompressFlate() - Method in class com.ironsoftware.ironpdf.compression.AdvancedCompressionOptions
Re-compress already Flate-encoded streams using AdvancedCompressionOptions.getCompressionLevel().
isRemoveStructureTree() - Method in class com.ironsoftware.ironpdf.compression.AdvancedCompressionOptions
Remove the document structure tree before compression.
isRemoveUnreferencedResources() - Method in class com.ironsoftware.ironpdf.compression.AdvancedCompressionOptions
Drop indirect objects that are not referenced from the document catalog.
isRotatable() - Method in class com.ironsoftware.ironpdf.annotation.TextAnnotation
Is rotateable boolean.
isRotateable() - Method in class com.ironsoftware.ironpdf.annotation.AnnotationOptions
Gets a flag that allows the annotation to be rotated.
isShowBorder() - Method in class com.ironsoftware.ironpdf.annotation.LinkAnnotation
 
isSingleProcess() - Static method in class com.ironsoftware.ironpdf.Settings
SingleProcess mode Forces Chrome renderer to perform everything in the current process, rather than using subprocesses default is false
isStampBehindContent() - Method in class com.ironsoftware.ironpdf.stamp.Stamper
Is stamp behind content boolean.
isStrikethrough() - Method in class com.ironsoftware.ironpdf.stamp.TextStamper
Is strikethrough boolean.
isUnderline() - Method in class com.ironsoftware.ironpdf.stamp.TextStamper
Is underline boolean.
isUseGoogleFont() - Method in class com.ironsoftware.ironpdf.stamp.TextStamper
Is use google font boolean.
isValid() - Method in class com.ironsoftware.ironpdf.signature.VerifiedSignature
If the signature is valid,
isValidLicensed(String) - Static method in class com.ironsoftware.ironpdf.License
Determines whether a string license key is valid.

J

JavaScript() - Method in class com.ironsoftware.ironpdf.render.WaitFor
This method proceeds rendering by waiting until user calls IronPdf's internal JavaScript function window.ironpdf.notifyRender().
JavaScript(int) - Method in class com.ironsoftware.ironpdf.render.WaitFor
This method proceeds rendering by waiting until user calls IronPdf's internal JavaScript function window.ironpdf.notifyRender().

L

lastPage() - Static method in class com.ironsoftware.ironpdf.edit.PageSelection
First page (page index 0).
Length - Class in com.ironsoftware.ironpdf.edit
A length value with MeasurementUnit
Length(double) - Constructor for class com.ironsoftware.ironpdf.edit.Length
Instantiates a new Length.
Length(double, MeasurementUnit) - Constructor for class com.ironsoftware.ironpdf.edit.Length
Instantiates a new Length.
Length() - Constructor for class com.ironsoftware.ironpdf.edit.Length
Gets default length : 0%
License - Class in com.ironsoftware.ironpdf
Allows developers to apply license keys for of IronPDF for Java
License() - Constructor for class com.ironsoftware.ironpdf.License
 
LinearizationMode - Enum in com.ironsoftware.ironpdf.render
Specifies the linearization strategy to use when producing a linearized (web-optimized) PDF.
linearizePdfToBytes() - Method in class com.ironsoftware.ironpdf.PdfDocument
Linearizes the current PDF document and returns the result as a byte array using the LinearizationMode.Automatic strategy.
linearizePdfToBytes(LinearizationMode) - Method in class com.ironsoftware.ironpdf.PdfDocument
Linearizes the current PDF document and returns the result as a byte array.
linearizePdfToBytes(String) - Method in class com.ironsoftware.ironpdf.PdfDocument
Linearizes the current PDF document and returns the result as a byte array.
linearizePdfToBytes(String, LinearizationMode) - Method in class com.ironsoftware.ironpdf.PdfDocument
Linearizes the current PDF document and returns the result as a byte array.
linearizePdfToBytes(byte[]) - Static method in class com.ironsoftware.ironpdf.PdfDocument
Static helper that linearizes the given PDF bytes and returns the linearized bytes using the LinearizationMode.Automatic strategy.
linearizePdfToBytes(byte[], String) - Static method in class com.ironsoftware.ironpdf.PdfDocument
Static helper that linearizes the given PDF bytes and returns the linearized bytes.
linearizePdfToBytes(byte[], String, LinearizationMode) - Static method in class com.ironsoftware.ironpdf.PdfDocument
Static helper that linearizes the given PDF bytes and returns the linearized bytes.
linearizePdfToBytes(InputStream) - Static method in class com.ironsoftware.ironpdf.PdfDocument
Static helper that linearizes a PDF from an InputStream and returns the linearized bytes.
linearizePdfToBytes(InputStream, String) - Static method in class com.ironsoftware.ironpdf.PdfDocument
Static helper that linearizes a PDF from an InputStream and returns the linearized bytes.
linearizePdfToBytes(InputStream, String, LinearizationMode) - Static method in class com.ironsoftware.ironpdf.PdfDocument
Static helper that linearizes a PDF from an InputStream and returns the linearized bytes.
linearizePdfToStream() - Method in class com.ironsoftware.ironpdf.PdfDocument
Linearizes the current PDF document and returns the result as an InputStream.
linearizePdfToStream(LinearizationMode) - Method in class com.ironsoftware.ironpdf.PdfDocument
Linearizes the current PDF document and returns the result as an InputStream.
linearizePdfToStream(String) - Method in class com.ironsoftware.ironpdf.PdfDocument
Linearizes the current PDF document and returns the result as an InputStream.
linearizePdfToStream(String, LinearizationMode) - Method in class com.ironsoftware.ironpdf.PdfDocument
Linearizes the current PDF document and returns the result as an InputStream.
LinkAnnotation - Class in com.ironsoftware.ironpdf.annotation
Defines a clickable link annotation that navigates to a specific page within the same PDF document.
LinkAnnotation(int, int) - Constructor for class com.ironsoftware.ironpdf.annotation.LinkAnnotation
Creates a link annotation on the specified page that navigates to a destination page.
LinkAnnotation(int, int, String) - Constructor for class com.ironsoftware.ironpdf.annotation.LinkAnnotation
Creates a link annotation on the specified page that navigates to a destination page, with descriptive text for identification.

M

makePdfDocumentReadOnly(String) - Method in class com.ironsoftware.ironpdf.security.SecurityManager
Makes this PDF document read only such that:
MeasurementUnit - Enum in com.ironsoftware.ironpdf.edit
The unit of measurement used for positioning and sizing.
merge(PdfDocument, PdfDocument) - Static method in class com.ironsoftware.ironpdf.PdfDocument
Static method that joins (concatenates) 2 PDF documents together into one PDF document.
merge(List<PdfDocument>) - Static method in class com.ironsoftware.ironpdf.PdfDocument
Static method that joins (concatenates) 2 PDF documents together into one PDF document.
MetadataManager - Class in com.ironsoftware.ironpdf.metadata
Class used to read and edit MetaData in a PdfDocument.
MetadataManager(InternalPdfDocument) - Constructor for class com.ironsoftware.ironpdf.metadata.MetadataManager
Please get MetadataManager by PdfDocument.getMetadata() instead.

N

NaturalLanguages - Enum in com.ironsoftware.ironpdf
Natural Languages Specification
NetworkIdle(int, int) - Method in class com.ironsoftware.ironpdf.render.WaitFor
This method proceeds rendering by waiting until it internally detects a network idle event when there is no network activity after at least specified networkIdleDuration as well as at maximum of maxNumAllowedInflight inflight (outstanding) network requests.
NetworkIdle(int, int, int) - Method in class com.ironsoftware.ironpdf.render.WaitFor
This method proceeds rendering by waiting until it internally detects a network idle event when there is no network activity after at least specified networkIdleDuration as well as at maximum of maxNumAllowedInflight inflight (outstanding) network requests.
NetworkIdle0() - Method in class com.ironsoftware.ironpdf.render.WaitFor
This method proceeds rendering by waiting until it internally detects a network idle event when there is no network activity.
NetworkIdle0(int) - Method in class com.ironsoftware.ironpdf.render.WaitFor
This method proceeds rendering by waiting until it internally detects a network idle event when there is no network activity.
NetworkIdle2() - Method in class com.ironsoftware.ironpdf.render.WaitFor
This method proceeds rendering by waiting until it internally detects a network idle event when there is no network activity after at least 500ms as well as at maximum of 2 inflight (outstanding) network request.
NetworkIdle2(int) - Method in class com.ironsoftware.ironpdf.render.WaitFor
This method proceeds rendering by waiting until it internally detects a network idle event when there is no network activity after at least 500ms as well as at maximum of 2 inflight (outstanding) network request.

O

ObjectStreamMode - Enum in com.ironsoftware.ironpdf.compression
Object stream mode used when writing the compressed PDF.

P

PageInfo - Class in com.ironsoftware.ironpdf.page
A class which represents one page of a PDF Document.
PageInfo(int, double, double, double, double, PageRotation) - Constructor for class com.ironsoftware.ironpdf.page.PageInfo
Instantiates a new Page info.
PageLoad() - Method in class com.ironsoftware.ironpdf.render.WaitFor
Basically it waits for nothing, but will render as soon as the page loaded.
pageRange(int, int) - Static method in class com.ironsoftware.ironpdf.edit.PageSelection
The selection of pages to be used.
pageRange(List<Integer>) - Static method in class com.ironsoftware.ironpdf.edit.PageSelection
PageSelection factory.
PageRotation - Enum in com.ironsoftware.ironpdf.page
PageRotation setting of a PDF page
PageSelection - Class in com.ironsoftware.ironpdf.edit
A PageSelection is a collection of pages from a PDF document.
PageSelection() - Constructor for class com.ironsoftware.ironpdf.edit.PageSelection
 
PaperOrientation - Enum in com.ironsoftware.ironpdf.render
Paper Orientation
PaperSize - Enum in com.ironsoftware.ironpdf.render
Defines the target virtual paper size the PDF.
PdfAVersions - Enum in com.ironsoftware.ironpdf.standard
Versions of PDF/A compliant
PdfDocument - Class in com.ironsoftware.ironpdf
Represents a PDF document.
PdfDocument(Path, String) - Constructor for class com.ironsoftware.ironpdf.PdfDocument
Opens an existing PDF document for editing.
PdfDocument(Path, String, ChangeTrackingModes) - Constructor for class com.ironsoftware.ironpdf.PdfDocument
Opens an existing PDF document for editing.
PdfDocument(Path, String, String) - Constructor for class com.ironsoftware.ironpdf.PdfDocument
Opens an existing PDF document for editing.
PdfDocument(Path, String, String, ChangeTrackingModes) - Constructor for class com.ironsoftware.ironpdf.PdfDocument
Opens an existing PDF document for editing.
PdfDocument(byte[], String, String) - Constructor for class com.ironsoftware.ironpdf.PdfDocument
Opens an existing PDF document for editing.
PdfDocument(byte[], String, String, ChangeTrackingModes) - Constructor for class com.ironsoftware.ironpdf.PdfDocument
Opens an existing PDF document for editing.
PdfDocument(Path) - Constructor for class com.ironsoftware.ironpdf.PdfDocument
Opens an existing PDF document for editing.
PdfDocument(Path, ChangeTrackingModes) - Constructor for class com.ironsoftware.ironpdf.PdfDocument
Opens an existing PDF document for editing.
PdfDocument(byte[], String) - Constructor for class com.ironsoftware.ironpdf.PdfDocument
Opens an existing PDF document for editing.
PdfDocument(byte[], String, ChangeTrackingModes) - Constructor for class com.ironsoftware.ironpdf.PdfDocument
Opens an existing PDF document for editing.
PdfDocument(byte[]) - Constructor for class com.ironsoftware.ironpdf.PdfDocument
Opens an existing PDF document for editing.
PdfDocument(byte[], ChangeTrackingModes) - Constructor for class com.ironsoftware.ironpdf.PdfDocument
Opens an existing PDF document for editing.
PdfEditSecurity - Enum in com.ironsoftware.ironpdf.security
Enumeration defining levels of PDF user access rights to edit a PDF.
pdfiumWillReEncode() - Method in class com.ironsoftware.ironpdf.compression.AdvancedCompressionOptions
Returns true if pdfium-side image re-encoding is engaged (because a positive targetImageDpi was set).
PdfPrintSecurity - Enum in com.ironsoftware.ironpdf.security
Enumeration defining levels of PDF user access rights to print a PDF.
PdfUAVersions - Enum in com.ironsoftware.ironpdf.standard
Versions of PDF/UA compliant (Universal Accessibility)
prependPdf(PdfDocument) - Method in class com.ironsoftware.ironpdf.PdfDocument
Adds another PDF to the beginning of the current PdfDocument.
print() - Method in class com.ironsoftware.ironpdf.PdfDocument
Prints this PDF by sending it to the computer's real world printer(s).
print(Graphics, PageFormat, int) - Method in class com.ironsoftware.ironpdf.PdfDocument
 
printWithoutDialog() - Method in class com.ironsoftware.ironpdf.PdfDocument
Prints this PDF by sending it to the computer's real world printer(s).

R

RadioField - Class in com.ironsoftware.ironpdf.form
The type Radio field.
RadioField(int, String, int, double, double, double, double, String, List<String>, int, boolean) - Constructor for class com.ironsoftware.ironpdf.form.RadioField
(INTERNAL) Please Get RadioFormField from FormFieldsSet.getRadioFields() from FormManager.getFields()
removeAttachment(String) - Method in class com.ironsoftware.ironpdf.attachment.AttachmentManager
Remove an attachment by attachment name
removeAttachment(int) - Method in class com.ironsoftware.ironpdf.attachment.AttachmentManager
Remove an attachment by attachment index
removeMetadata(String) - Method in class com.ironsoftware.ironpdf.metadata.MetadataManager
Method for removing Metadata property by its name.
removePages(PageSelection) - Method in class com.ironsoftware.ironpdf.PdfDocument
Removes a range of pages from the PDF
removePasswordsAndEncryption() - Method in class com.ironsoftware.ironpdf.security.SecurityManager
Removes all user and owner password security for a PDF document.
RemoveSignature() - Method in class com.ironsoftware.ironpdf.signature.SignatureManager
Removes all signature from the PDF document.
renameField(String, String) - Method in class com.ironsoftware.ironpdf.form.FormManager
Rename a FormField
RenderDelay(int) - Method in class com.ironsoftware.ironpdf.render.WaitFor
This method proceeds rendering by introducing an initial delay before rendering.
RenderedElementLocation - Class in com.ironsoftware.ironpdf.render
Represents the rendered location of an HTML element within a PDF document.
RenderedElementLocation() - Constructor for class com.ironsoftware.ironpdf.render.RenderedElementLocation
Default constructor.
RenderedElementLocation(String, int, Rectangle2D.Double, int) - Constructor for class com.ironsoftware.ironpdf.render.RenderedElementLocation
Full constructor.
renderHtmlAsPdf(String) - Static method in class com.ironsoftware.ironpdf.PdfDocument
Creates a PDF file from a Html string, and returns it as a PdfDocument.
renderHtmlAsPdf(String, ChromeHttpLoginCredentials) - Static method in class com.ironsoftware.ironpdf.PdfDocument
Creates a PDF file from a Html string, and returns it as a PdfDocument.
renderHtmlAsPdf(String, ChromePdfRenderOptions) - Static method in class com.ironsoftware.ironpdf.PdfDocument
Creates a PDF file from a Html string, and returns it as a PdfDocument.
renderHtmlAsPdf(String, ChromePdfRenderOptions, ChromeHttpLoginCredentials) - Static method in class com.ironsoftware.ironpdf.PdfDocument
Creates a PDF file from a Html string, and returns it as a PdfDocument.
renderHtmlAsPdfUA(String) - Static method in class com.ironsoftware.ironpdf.PdfDocument
Render HTML to PDF and convert to PDF/UA format with screen reader support.
renderHtmlAsPdfUA(String, NaturalLanguages) - Static method in class com.ironsoftware.ironpdf.PdfDocument
Render HTML to PDF and convert to PDF/UA format with screen reader support.
renderHtmlAsPdfUA(String, NaturalLanguages, ChromePdfRenderOptions) - Static method in class com.ironsoftware.ironpdf.PdfDocument
Render HTML to PDF and convert to PDF/UA format with screen reader support.
renderHtmlFileAsPdf(String) - Static method in class com.ironsoftware.ironpdf.PdfDocument
Creates a PDF file from a local Html file, and returns it as a PdfDocument.
renderHtmlFileAsPdf(String, String) - Static method in class com.ironsoftware.ironpdf.PdfDocument
Creates a PDF file from a local Html file, and returns it as a PdfDocument.
renderHtmlFileAsPdf(String, ChromePdfRenderOptions, ChromeHttpLoginCredentials) - Static method in class com.ironsoftware.ironpdf.PdfDocument
Creates a PDF file from a local Html file, and returns it as a PdfDocument.
renderHtmlFileAsPdf(String, String, ChromePdfRenderOptions, ChromeHttpLoginCredentials) - Static method in class com.ironsoftware.ironpdf.PdfDocument
Creates a PDF file from a local Html file, and returns it as a PdfDocument.
renderHtmlFileAsPdf(String, ChromeHttpLoginCredentials) - Static method in class com.ironsoftware.ironpdf.PdfDocument
Creates a PDF file from a local Html file, and returns it as a PdfDocument.
renderHtmlFileAsPdf(String, String, ChromeHttpLoginCredentials) - Static method in class com.ironsoftware.ironpdf.PdfDocument
Creates a PDF file from a local Html file, and returns it as a PdfDocument.
renderHtmlFileAsPdf(String, ChromePdfRenderOptions) - Static method in class com.ironsoftware.ironpdf.PdfDocument
Creates a PDF file from a local HTML file and returns it as a PdfDocument.
renderHtmlFileAsPdf(String, String, ChromePdfRenderOptions) - Static method in class com.ironsoftware.ironpdf.PdfDocument
Creates a PDF file from a local Html file, and returns it as a PdfDocument.
renderRtfAsPdf(String) - Static method in class com.ironsoftware.ironpdf.PdfDocument
Creates a PDF file from RTF string, and returns it as a PdfDocument.
renderRtfFileAsPdf(String) - Static method in class com.ironsoftware.ironpdf.PdfDocument
Creates a PDF file from RTF file, and returns it as a PdfDocument.
renderRtfFileAsPdf(Path) - Static method in class com.ironsoftware.ironpdf.PdfDocument
Creates a PDF file from RTF file, and returns it as a PdfDocument.
renderUrlAsPdf(String) - Static method in class com.ironsoftware.ironpdf.PdfDocument
Creates a PDF file from a URL or local file path and returns it as a PdfDocument.
renderUrlAsPdf(String, ChromePdfRenderOptions, ChromeHttpLoginCredentials) - Static method in class com.ironsoftware.ironpdf.PdfDocument
Creates a PDF file from a URL or local file path and returns it as a PdfDocument.
renderUrlAsPdf(String, ChromeHttpLoginCredentials) - Static method in class com.ironsoftware.ironpdf.PdfDocument
Creates a PDF file from a URL or local file path and returns it as a PdfDocument.
renderUrlAsPdf(String, ChromePdfRenderOptions) - Static method in class com.ironsoftware.ironpdf.PdfDocument
Creates a PDF file from a URL or local file path and returns it as a PdfDocument.
renderZipAsPdf(Path, String, ChromePdfRenderOptions) - Static method in class com.ironsoftware.ironpdf.PdfDocument
Creates a PDF file from a local Zip file, and returns it as a PdfDocument.
renderZipAsPdf(Path, String) - Static method in class com.ironsoftware.ironpdf.PdfDocument
Creates a PDF file from a local Zip file, and returns it as a PdfDocument.
replaceText(PageSelection, String, String) - Method in class com.ironsoftware.ironpdf.PdfDocument
Replace the specified old text with new text on a given page.
replaceText(PageSelection, String, String, FontTypes, Float) - Method in class com.ironsoftware.ironpdf.PdfDocument
Replace the specified old text with new text on a given page.
resetElementLocationCache() - Method in class com.ironsoftware.ironpdf.PdfDocument
Clears the cached result of PdfDocument.getElementLocations(), forcing a fresh scan of the document's annotations on the next call.
resizePage(double, double, PageSelection) - Method in class com.ironsoftware.ironpdf.PdfDocument
Resize a page to the specified dimensions (in millimeters)
restartEngine() - Static method in class com.ironsoftware.ironpdf.IronPdfEngineManager
Restarts IronPdfEngine by stopping it (if running) and establishing a fresh connection.
rotateAllPages(PageRotation) - Method in class com.ironsoftware.ironpdf.PdfDocument
Rotates all pages of the PdfDocument by a specified number of degrees.
rotatePage(PageRotation, PageSelection) - Method in class com.ironsoftware.ironpdf.PdfDocument
Rotates a selection page of the PdfDocument by a specified number of degrees.

S

saveAs(Path) - Method in class com.ironsoftware.ironpdf.PdfDocument
Saves this PdfDocument to a file.
saveAs(String) - Method in class com.ironsoftware.ironpdf.PdfDocument
Saves this PdfDocument to a file.
saveAsLinearized(String) - Method in class com.ironsoftware.ironpdf.PdfDocument
Linearizes the current PDF document and saves the result to a file path.
saveAsLinearized(String, String) - Method in class com.ironsoftware.ironpdf.PdfDocument
Linearizes the current PDF document and saves the result to a file path.
saveAsLinearized(byte[], String) - Static method in class com.ironsoftware.ironpdf.PdfDocument
Static helper that linearizes the given PDF bytes and saves the result to the given output file path.
saveAsLinearized(byte[], String, String) - Static method in class com.ironsoftware.ironpdf.PdfDocument
Static helper that linearizes the given PDF bytes and saves the result to the given output file path.
saveAsPdfA(String) - Method in class com.ironsoftware.ironpdf.PdfDocument
Save the current document into the PDF-A (PDF/A-3B ISO 19005-3) standard format
saveAsPdfA(String, String) - Method in class com.ironsoftware.ironpdf.PdfDocument
Save the current document into the PDF-A (PDF/A-3B ISO 19005-3) standard format
saveAsPdfA(String, PdfAVersions) - Method in class com.ironsoftware.ironpdf.PdfDocument
Save the current document into the specified PDF-A standard format
saveAsPdfA(String, PdfAVersions, String) - Method in class com.ironsoftware.ironpdf.PdfDocument
Save the current document into the specified PDF-A standard format
saveAsPdfUA(String, NaturalLanguages) - Method in class com.ironsoftware.ironpdf.PdfDocument
Save the current document into the specified PDF/UA standard format.
saveAsRevision(Path) - Method in class com.ironsoftware.ironpdf.PdfDocument
Saves this PdfDocument to a file.
saveAsRevision(String) - Method in class com.ironsoftware.ironpdf.PdfDocument
Saves this PdfDocument to a file.
SecurityManager - Class in com.ironsoftware.ironpdf.security
Allows the developer to control: user access passwords, encryption, and also who may edit, print and copy content from the PDF document.
SecurityManager(InternalPdfDocument) - Constructor for class com.ironsoftware.ironpdf.security.SecurityManager
Please get SecurityManager by PdfDocument.getSecurity() instead.
SecurityOptions - Class in com.ironsoftware.ironpdf.security
A class defining user security settings for a PDF document.
SecurityOptions() - Constructor for class com.ironsoftware.ironpdf.security.SecurityOptions
Instantiates a new Security options.
setAllowUserAnnotations(Boolean) - Method in class com.ironsoftware.ironpdf.security.SecurityOptions
Sets allow user annotations.
setAllowUserCopyPasteContent(Boolean) - Method in class com.ironsoftware.ironpdf.security.SecurityOptions
Sets allow user copy and paste content.
setAllowUserCopyPasteContentForAccessibility(Boolean) - Method in class com.ironsoftware.ironpdf.security.SecurityOptions
Sets allow user copy and paste content for accessibility.
setAllowUserEdits(PdfEditSecurity) - Method in class com.ironsoftware.ironpdf.security.SecurityOptions
Sets allow user edits.
setAllowUserFormData(Boolean) - Method in class com.ironsoftware.ironpdf.security.SecurityOptions
Sets allow user form data.
setAllowUserPrinting(PdfPrintSecurity) - Method in class com.ironsoftware.ironpdf.security.SecurityOptions
Sets allow user printing.
setAnnotationIndex(int) - Method in class com.ironsoftware.ironpdf.annotation.LinkAnnotation
 
setAnnotationIndex(int) - Method in class com.ironsoftware.ironpdf.annotation.TextAnnotation
Sets index of the annotation on a page.
setAnyMetadata(String, String) - Method in class com.ironsoftware.ironpdf.metadata.MetadataManager
Sets any metadata value of the document form given key.
setAuthor(String) - Method in class com.ironsoftware.ironpdf.metadata.MetadataManager
Sets the Author of the document.
setAutoBookmarkCssSelectors(String[]) - Method in class com.ironsoftware.ironpdf.render.ChromePdfRenderOptions
Sets the additional CSS selectors used to mark non-heading elements as auto-bookmarks.
setAutoBookmarkMaxHeadingLevel(int) - Method in class com.ironsoftware.ironpdf.render.ChromePdfRenderOptions
Sets the maximum HTML heading level (inclusive) to include as an auto-bookmark.
setAutoBookmarkMinHeadingLevel(int) - Method in class com.ironsoftware.ironpdf.render.ChromePdfRenderOptions
Sets the minimum HTML heading level (inclusive) to include as an auto-bookmark.
setAutoBookmarksFromHeadings(boolean) - Method in class com.ironsoftware.ironpdf.render.ChromePdfRenderOptions
Enables or disables automatic PDF bookmark generation from HTML headings.
setAutoInstallDependency(boolean) - Static method in class com.ironsoftware.ironpdf.Settings
If true The necessary package dependencies for IronPDF rendering will we automatically installed to Docker and Debian / Ubuntu Linux deployments.
setBackgroundColorCode(String) - Method in class com.ironsoftware.ironpdf.stamp.TextStamper
Sets Background Color.
setBarcodeType(BarcodeEncoding) - Method in class com.ironsoftware.ironpdf.stamp.BarcodeStamper
Sets barcode type.
setBaseUrl(String) - Method in class com.ironsoftware.ironpdf.headerfooter.HtmlHeaderFooter
The Base URL all URLS in the HtmlHeaderFooter.htmlFragment" will be relative to.
setBold(boolean) - Method in class com.ironsoftware.ironpdf.stamp.TextStamper
Sets bold.
setCenterText(String) - Method in class com.ironsoftware.ironpdf.headerfooter.TextHeaderFooter
Sets center text.
setCertificateRawData(byte[]) - Method in class com.ironsoftware.ironpdf.signature.Signature
Sets certificate raw data.
setChromeBrowserCachePath(Path) - Static method in class com.ironsoftware.ironpdf.Settings
Disk cache path for Chrome browser instances default null
setChromeBrowserLimit(int) - Static method in class com.ironsoftware.ironpdf.Settings
Set Maximum number of concurrent browsers when using the Chrome renderer default is 30
setChromeGpuMode(Settings.ChromeGpuModes) - Static method in class com.ironsoftware.ironpdf.Settings
Chrome renderer GPU compatibility mode.
setCoalesceContents(boolean) - Method in class com.ironsoftware.ironpdf.compression.AdvancedCompressionOptions
 
setColorCode(String) - Method in class com.ironsoftware.ironpdf.annotation.LinkAnnotation
 
setColorCode(String) - Method in class com.ironsoftware.ironpdf.annotation.TextAnnotation
Sets the color of the annotation's 'Sticky Note'.
setCompressionLevel(int) - Method in class com.ironsoftware.ironpdf.compression.AdvancedCompressionOptions
 
setCompressStreams(boolean) - Method in class com.ironsoftware.ironpdf.compression.AdvancedCompressionOptions
 
setConnectionMode(IronPdfEngineConnection) - Static method in class com.ironsoftware.ironpdf.Settings
Set IronPdfEngineConnection to set up various connection modes for IronPdfEngine.
setContents(String) - Method in class com.ironsoftware.ironpdf.annotation.AnnotationOptions
Sets contents.
setContents(String) - Method in class com.ironsoftware.ironpdf.annotation.LinkAnnotation
 
setContents(String) - Method in class com.ironsoftware.ironpdf.annotation.TextAnnotation
Sets the contents of the 'sticky note' annotation.
setCreatePdfFormsFromHtml(boolean) - Method in class com.ironsoftware.ironpdf.render.ChromePdfRenderOptions
Sets create pdf forms from html.
setCreationDate(String) - Method in class com.ironsoftware.ironpdf.metadata.MetadataManager
Deprecated.
As of version 2025.7.17, replaced by #setCreationDate(). This method will be removed in a future release. Please use the new method to provide an OffsetDateTime object instead of a String.
setCreationDate(OffsetDateTime) - Method in class com.ironsoftware.ironpdf.metadata.MetadataManager
Sets the PDF file creation DateTime.
setCreator(String) - Method in class com.ironsoftware.ironpdf.metadata.MetadataManager
Sets the Creator of the document.
setCssMediaType(CssMediaType) - Method in class com.ironsoftware.ironpdf.render.ChromePdfRenderOptions
Sets css media type.
setCssMediaType(CssMediaType) - Method in class com.ironsoftware.ironpdf.stamp.HtmlStamper
Sets css media type.
setCustomCookies(HashMap<String, String>) - Method in class com.ironsoftware.ironpdf.render.ChromeHttpLoginCredentials
Sets custom cookies.
setCustomCssUrl(String) - Method in class com.ironsoftware.ironpdf.render.ChromePdfRenderOptions
Sets custom css url.
setCustomPaperHeight(double) - Method in class com.ironsoftware.ironpdf.render.ChromePdfRenderOptions
Sets custom paper height (mm).
setCustomPaperSizeInCentimeters(double, double) - Method in class com.ironsoftware.ironpdf.render.ChromePdfRenderOptions
Set an output paper size for PDF pages.
SetCustomPaperSizeInInches(double, double) - Method in class com.ironsoftware.ironpdf.render.ChromePdfRenderOptions
Set an output paper size for PDF pages.
setCustomPaperSizeInMillimeters(double, double) - Method in class com.ironsoftware.ironpdf.render.ChromePdfRenderOptions
Set an output paper size for PDF pages.
setCustomPaperSizeInPixelsOrPoints(double, double) - Method in class com.ironsoftware.ironpdf.render.ChromePdfRenderOptions
Set an output paper size for PDF pages.
setCustomPaperSizeInPixelsOrPoints(double, double, int) - Method in class com.ironsoftware.ironpdf.render.ChromePdfRenderOptions
Set an output paper size for PDF pages.
setCustomPaperWidth(double) - Method in class com.ironsoftware.ironpdf.render.ChromePdfRenderOptions
Sets custom paper width (mm).
setDebug(boolean) - Static method in class com.ironsoftware.ironpdf.Settings
Enable or disable debug mode.
setDecodeGeneralizedStreams(boolean) - Method in class com.ironsoftware.ironpdf.compression.AdvancedCompressionOptions
 
setDestinationBottom(int) - Method in class com.ironsoftware.ironpdf.annotation.LinkAnnotation
 
setDestinationLeft(int) - Method in class com.ironsoftware.ironpdf.annotation.LinkAnnotation
 
setDestinationPageIndex(int) - Method in class com.ironsoftware.ironpdf.annotation.LinkAnnotation
 
setDestinationRight(int) - Method in class com.ironsoftware.ironpdf.annotation.LinkAnnotation
 
setDestinationTop(int) - Method in class com.ironsoftware.ironpdf.annotation.LinkAnnotation
 
setDestinationType(BookmarkDestinations) - Method in class com.ironsoftware.ironpdf.annotation.LinkAnnotation
 
setDestinationZoom(int) - Method in class com.ironsoftware.ironpdf.annotation.LinkAnnotation
 
setDividerLineColor(String) - Method in class com.ironsoftware.ironpdf.headerfooter.HtmlHeaderFooter
Sets divider line color.
setDividerLineColor(String) - Method in class com.ironsoftware.ironpdf.headerfooter.TextHeaderFooter
Sets divider line color.
setDpi(int) - Method in class com.ironsoftware.ironpdf.image.ToImageOptions
Sets dpi.
setDrawDividerLine(boolean) - Method in class com.ironsoftware.ironpdf.headerfooter.HtmlHeaderFooter
Adds a horizontal line divider between the header / footer and the page content on every page of the PDF document.
setDrawDividerLine(boolean) - Method in class com.ironsoftware.ironpdf.headerfooter.TextHeaderFooter
Sets draw divider line.
setElementIndex(int) - Method in class com.ironsoftware.ironpdf.render.RenderedElementLocation
 
setElementQuerySelectors(String[]) - Method in class com.ironsoftware.ironpdf.render.ChromePdfRenderOptions
Sets the CSS selectors whose matching elements should have their rendered page positions tracked during rendering.
setEnableCookies(boolean) - Method in class com.ironsoftware.ironpdf.render.ChromeHttpLoginCredentials
Sets enable cookies.
setEnableJavaScript(boolean) - Method in class com.ironsoftware.ironpdf.render.ChromePdfRenderOptions
Sets enable JavaScript.
setFieldReadOnly(String, boolean) - Method in class com.ironsoftware.ironpdf.form.FormManager
Set the is read only value of a FormField
setFieldValue(String, String) - Method in class com.ironsoftware.ironpdf.form.FormManager
Set the string value of a FormField
setFirstPageNumber(int) - Method in class com.ironsoftware.ironpdf.headerfooter.HeaderFooterOptions
Sets first page number.
setFitToPaperMode(FitToPaperModes) - Method in class com.ironsoftware.ironpdf.render.ChromePdfRenderOptions
setFont(FontTypes) - Method in class com.ironsoftware.ironpdf.headerfooter.TextHeaderFooter
Sets font.
setFontColor(String) - Method in class com.ironsoftware.ironpdf.stamp.TextStamper
Sets Font Color.
setFontFamily(String) - Method in class com.ironsoftware.ironpdf.stamp.TextStamper
Sets font family.
setFontSize(double) - Method in class com.ironsoftware.ironpdf.headerfooter.TextHeaderFooter
Sets font size.
setFontSize(int) - Method in class com.ironsoftware.ironpdf.stamp.TextStamper
Sets font size.
setFormFont(String, byte[], boolean) - Method in class com.ironsoftware.ironpdf.form.FormManager
Sets the document-wide font for all subsequent form-field fills on this document.
setFormFont(String, byte[]) - Method in class com.ironsoftware.ironpdf.form.FormManager
Sets the document-wide form font without forcing a re-embed.
setFormFont(String) - Method in class com.ironsoftware.ironpdf.form.FormManager
Sets the document-wide form font by name only.
setFormFontFromFile(Path) - Method in class com.ironsoftware.ironpdf.form.FormManager
Loads a TrueType/OpenType font from disk and applies it as the document-wide form font.
setFormFontFromFile(Path, String, boolean) - Method in class com.ironsoftware.ironpdf.form.FormManager
Loads a TrueType/OpenType font from disk and applies it as the document-wide form font.
setGrayScale(boolean) - Method in class com.ironsoftware.ironpdf.render.ChromePdfRenderOptions
Sets gray scale.
setHeight(int) - Method in class com.ironsoftware.ironpdf.annotation.AnnotationOptions
Sets height of your annotation's icon and interactive area in pixels.
setHeight(int) - Method in class com.ironsoftware.ironpdf.annotation.LinkAnnotation
 
setHeight(int) - Method in class com.ironsoftware.ironpdf.image.DrawImageOptions
Sets height (Pixel).
setHeight(int) - Method in class com.ironsoftware.ironpdf.stamp.BarcodeStamper
Sets height.
setHidden(boolean) - Method in class com.ironsoftware.ironpdf.annotation.AnnotationOptions
Sets a flag that hides the annotation from users.
setHidden(boolean) - Method in class com.ironsoftware.ironpdf.annotation.LinkAnnotation
 
setHidden(boolean) - Method in class com.ironsoftware.ironpdf.annotation.TextAnnotation
Hides the annotation from users.
setHighQualityImageSubsampling(boolean) - Method in class com.ironsoftware.ironpdf.compression.AdvancedCompressionOptions
 
setHorizontalAlignment(HorizontalAlignment) - Method in class com.ironsoftware.ironpdf.stamp.Stamper
Sets horizontal alignment.
setHorizontalOffset(Length) - Method in class com.ironsoftware.ironpdf.stamp.Stamper
Sets horizontal offset.
setHtml(String) - Method in class com.ironsoftware.ironpdf.stamp.Stamper
Sets html.
setHtmlBaseUrl(String) - Method in class com.ironsoftware.ironpdf.stamp.HtmlStamper
Sets the HTML base URL for which references to external CSS, Javascript and Image files will be relative.
setHtmlFragment(String) - Method in class com.ironsoftware.ironpdf.headerfooter.HtmlHeaderFooter
The Html which will be used to render the Header / Footer.
setHtmlTitle(String) - Method in class com.ironsoftware.ironpdf.headerfooter.HeaderFooterOptions
Sets html title.
setHyperlink(String) - Method in class com.ironsoftware.ironpdf.stamp.Stamper
Sets hyperlink.
setIcon(AnnotationIcon) - Method in class com.ironsoftware.ironpdf.annotation.AnnotationOptions
Sets AnnotationIcon used to display the interactive annotation within the PDF.
setIcon(AnnotationIcon) - Method in class com.ironsoftware.ironpdf.annotation.TextAnnotation
Sets icon.
setImageMaxHeight(Integer) - Method in class com.ironsoftware.ironpdf.image.ToImageOptions
Sets image max height.
setImageMaxWidth(Integer) - Method in class com.ironsoftware.ironpdf.image.ToImageOptions
Sets image max width.
setInputEncoding(String) - Method in class com.ironsoftware.ironpdf.render.ChromePdfRenderOptions
Sets input character encoding as a string; e.g.
setIronPdfEngineHost(String) - Static method in class com.ironsoftware.ironpdf.Settings
Deprecated.
This method is obsolete. Use Settings.setConnectionMode(IronPdfEngineConnection) instead.
setIronPdfEnginePort(int) - Static method in class com.ironsoftware.ironpdf.Settings
Deprecated.
This method is obsolete. Use Settings.setConnectionMode(IronPdfEngineConnection) instead.
setIronPdfEngineTimeout(int) - Static method in class com.ironsoftware.ironpdf.Settings
A Timeout (in seconds) to wait for any response from IronPdfEngine default 120 seconds
setIronPdfEngineWorkingDirectory(Path) - Static method in class com.ironsoftware.ironpdf.Settings
Sets path to IronPDF engine working directory.
setItalic(boolean) - Method in class com.ironsoftware.ironpdf.stamp.TextStamper
Sets italic.
setJavascript(String) - Method in class com.ironsoftware.ironpdf.render.ChromePdfRenderOptions
Set A custom javascript string to be executed after all HTML has loaded but before PDf rendering.
setJobQueueWatchdogTimeoutSeconds(int) - Static method in class com.ironsoftware.ironpdf.Settings
 
setJpegQuality(Integer) - Method in class com.ironsoftware.ironpdf.compression.AdvancedCompressionOptions
 
setKeywords(String) - Method in class com.ironsoftware.ironpdf.metadata.MetadataManager
Sets Keywords of the document.
setLeftText(String) - Method in class com.ironsoftware.ironpdf.headerfooter.TextHeaderFooter
Sets left text.
setLicenseKey(String) - Static method in class com.ironsoftware.ironpdf.License
Sets your license key.
setLoadStylesAndCSSFromMainHtmlDocument(boolean) - Method in class com.ironsoftware.ironpdf.headerfooter.HtmlHeaderFooter
Loads style code blocks and links to CSS style sheets from the main HTML document (which provides the PDF content) into the HtmlHeaderFooter .
setLogPath(Path) - Static method in class com.ironsoftware.ironpdf.Settings
Sets IronPDF engine log file path.
setMarginBottom(double) - Method in class com.ironsoftware.ironpdf.render.ChromePdfRenderOptions
Sets margin bottom.
setMarginBottomMm(int) - Method in class com.ironsoftware.ironpdf.headerfooter.HeaderFooterOptions
Sets margin bottom mm.
setMarginLeft(double) - Method in class com.ironsoftware.ironpdf.render.ChromePdfRenderOptions
Sets margin left.
setMarginLeftMm(int) - Method in class com.ironsoftware.ironpdf.headerfooter.HeaderFooterOptions
Sets margin left mm.
setMarginRight(double) - Method in class com.ironsoftware.ironpdf.render.ChromePdfRenderOptions
Sets margin right.
setMarginRightMm(int) - Method in class com.ironsoftware.ironpdf.headerfooter.HeaderFooterOptions
Sets margin right mm.
setMarginTop(double) - Method in class com.ironsoftware.ironpdf.render.ChromePdfRenderOptions
Sets margin top.
setMarginTopMm(int) - Method in class com.ironsoftware.ironpdf.headerfooter.HeaderFooterOptions
Sets margin top mm.
setMaxHeight(Integer) - Method in class com.ironsoftware.ironpdf.headerfooter.HtmlHeaderFooter
Maximum Height of the Html Header / Footer in millimeters.
setMaxHeight(Length) - Method in class com.ironsoftware.ironpdf.stamp.Stamper
Sets the maximum height of the output stamp.
setMaxWidth(Length) - Method in class com.ironsoftware.ironpdf.stamp.Stamper
Sets the maximum width of the output stamp.
setMinHeight(Length) - Method in class com.ironsoftware.ironpdf.stamp.Stamper
Sets the minimum height of the output stamp.
setMinWidth(Length) - Method in class com.ironsoftware.ironpdf.stamp.Stamper
Sets the minimum width of the output stamp.
setModifiedDate(String) - Method in class com.ironsoftware.ironpdf.metadata.MetadataManager
Deprecated.
As of version 2025.7.17, replaced by #setModifiedDate(). This method will be removed in a future release. Please use the new method to provide an OffsetDateTime object instead of a String.
setModifiedDate(OffsetDateTime) - Method in class com.ironsoftware.ironpdf.metadata.MetadataManager
Sets the PDF file last-modified DateTime.
setNetworkPassword(String) - Method in class com.ironsoftware.ironpdf.render.ChromeHttpLoginCredentials
Sets network password.
setNetworkUsername(String) - Method in class com.ironsoftware.ironpdf.render.ChromeHttpLoginCredentials
Sets network username.
setObjectStreams(ObjectStreamMode) - Method in class com.ironsoftware.ironpdf.compression.AdvancedCompressionOptions
 
setOpacity(double) - Method in class com.ironsoftware.ironpdf.annotation.AnnotationOptions
Sets the opacity of the annotation (valid values are from 0.0 to 1.0).
setOpacity(double) - Method in class com.ironsoftware.ironpdf.annotation.TextAnnotation
Sets the opacity of the annotation (valid values are from 0.0 to 1.0).
setOpacity(int) - Method in class com.ironsoftware.ironpdf.stamp.Stamper
Sets opacity.
setOpen(boolean) - Method in class com.ironsoftware.ironpdf.annotation.AnnotationOptions
Sets a flag for annotation to be opened and readable by default, without user interaction.
setOpenByDefault(boolean) - Method in class com.ironsoftware.ironpdf.annotation.TextAnnotation
Sets the annotation to be opened and readable by default, without user interaction.
setOptimizeImagesMinArea(int) - Method in class com.ironsoftware.ironpdf.compression.AdvancedCompressionOptions
 
setOptimizeImagesMinHeight(int) - Method in class com.ironsoftware.ironpdf.compression.AdvancedCompressionOptions
 
setOptimizeImagesMinWidth(int) - Method in class com.ironsoftware.ironpdf.compression.AdvancedCompressionOptions
 
setOwnerPassword(String) - Method in class com.ironsoftware.ironpdf.security.SecurityManager
Sets the owner password and enables 128-bit encryption of PDF content.
setOwnerPassword(String) - Method in class com.ironsoftware.ironpdf.security.SecurityOptions
Sets owner password.
setPageIndex(int) - Method in class com.ironsoftware.ironpdf.annotation.LinkAnnotation
 
setPageIndex(int) - Method in class com.ironsoftware.ironpdf.annotation.TextAnnotation
Sets index of the page to add the annotation.
setPageIndex(int) - Method in class com.ironsoftware.ironpdf.render.RenderedElementLocation
 
setPageSelection(PageSelection) - Method in class com.ironsoftware.ironpdf.image.DrawImageOptions
Sets page selection.
setPaperOrientation(PaperOrientation) - Method in class com.ironsoftware.ironpdf.render.ChromePdfRenderOptions
Sets paper orientation.
setPaperSize(PaperSize) - Method in class com.ironsoftware.ironpdf.render.ChromePdfRenderOptions
Sets paper size.
setPassword(String) - Method in class com.ironsoftware.ironpdf.security.SecurityManager
Sets a Password used to protect and encrypt the PDF File.
setPassword(String) - Method in class com.ironsoftware.ironpdf.signature.Signature
Sets password.
setPdfTitle(String) - Method in class com.ironsoftware.ironpdf.headerfooter.HeaderFooterOptions
Sets pdf title.
setPrintable(boolean) - Method in class com.ironsoftware.ironpdf.annotation.AnnotationOptions
Sets a flag that the annotation render during user PDF printing operations..
setPrintable(boolean) - Method in class com.ironsoftware.ironpdf.annotation.TextAnnotation
Sets allows the annotation to be printed when users print the PDF.
setPrintHtmlBackgrounds(boolean) - Method in class com.ironsoftware.ironpdf.render.ChromePdfRenderOptions
Sets print html backgrounds.
setProducer(String) - Method in class com.ironsoftware.ironpdf.metadata.MetadataManager
Sets the Producer of the document.
setReadonly(boolean) - Method in class com.ironsoftware.ironpdf.annotation.AnnotationOptions
Sets a flag that makes the annotation readonly.
setReadOnly(boolean) - Method in class com.ironsoftware.ironpdf.annotation.TextAnnotation
Sets the annotation to be read only.
setRecompressFlate(boolean) - Method in class com.ironsoftware.ironpdf.compression.AdvancedCompressionOptions
 
setRectangle(Rectangle) - Method in class com.ironsoftware.ironpdf.annotation.LinkAnnotation
 
setRectangle(Rectangle) - Method in class com.ironsoftware.ironpdf.annotation.TextAnnotation
Sets the X and Y coordinates, as well as the width and height, of the annotation's icon and interactive area in pixels.
setRectangle(Rectangle2D.Double) - Method in class com.ironsoftware.ironpdf.render.RenderedElementLocation
 
setRemoveStructureTree(boolean) - Method in class com.ironsoftware.ironpdf.compression.AdvancedCompressionOptions
 
setRemoveUnreferencedResources(boolean) - Method in class com.ironsoftware.ironpdf.compression.AdvancedCompressionOptions
 
setRenderDelay(int) - Method in class com.ironsoftware.ironpdf.stamp.HtmlStamper
setRenderPdfCssMediaType(CssMediaType) - Method in class com.ironsoftware.ironpdf.headerfooter.HeaderFooterOptions
Sets render pdf css media type.
setRgbColor(String) - Method in class com.ironsoftware.ironpdf.annotation.AnnotationOptions
Sets the color of the annotation's background 'sticky note' using Html color notation.
setRightText(String) - Method in class com.ironsoftware.ironpdf.headerfooter.TextHeaderFooter
Sets right text.
setRotatable(boolean) - Method in class com.ironsoftware.ironpdf.annotation.TextAnnotation
Sets rotatable.
setRotateable(boolean) - Method in class com.ironsoftware.ironpdf.annotation.AnnotationOptions
Sets A flag that allows the annotation to be rotated.
setRotation(int) - Method in class com.ironsoftware.ironpdf.stamp.Stamper
Sets rotation.
setScale(double) - Method in class com.ironsoftware.ironpdf.stamp.Stamper
Sets scale.
setSecurityOptions(SecurityOptions) - Method in class com.ironsoftware.ironpdf.security.SecurityManager
Sets advanced security settings for the PDF.
setShowBorder(boolean) - Method in class com.ironsoftware.ironpdf.annotation.LinkAnnotation
 
setSignatureDate(Instant) - Method in class com.ironsoftware.ironpdf.signature.Signature
Sets signature date.
setSignatureImage(byte[], Rectangle) - Method in class com.ironsoftware.ironpdf.signature.Signature
Sets signature image.
setSignatureImageRectangle(Rectangle) - Method in class com.ironsoftware.ironpdf.signature.Signature
Set signature image Rectangle.
setSigningContact(String) - Method in class com.ironsoftware.ironpdf.signature.Signature
Sets signing contact.
setSigningLocation(String) - Method in class com.ironsoftware.ironpdf.signature.Signature
Sets signing location.
setSigningReason(String) - Method in class com.ironsoftware.ironpdf.signature.Signature
Sets signing reason.
setSingleProcess(boolean) - Static method in class com.ironsoftware.ironpdf.Settings
SingleProcess mode Forces Chrome renderer to perform everything in the current process, rather than using subprocesses default is false
setSpacing(double) - Method in class com.ironsoftware.ironpdf.headerfooter.TextHeaderFooter
Sets spacing.
setStampBehindContent(boolean) - Method in class com.ironsoftware.ironpdf.stamp.Stamper
Sets stamp behind content.
setStrikethrough(boolean) - Method in class com.ironsoftware.ironpdf.stamp.TextStamper
Sets strikethrough.
setSubject(String) - Method in class com.ironsoftware.ironpdf.annotation.AnnotationOptions
Sets subject or 'subheading' of the annotation.
setSubject(String) - Method in class com.ironsoftware.ironpdf.annotation.TextAnnotation
Sets subject.
setSubject(String) - Method in class com.ironsoftware.ironpdf.metadata.MetadataManager
Sets the Subject of the document.
setTableOfContents(TableOfContentsTypes) - Method in class com.ironsoftware.ironpdf.render.ChromePdfRenderOptions
Sets TableOfContents.
setTargetImageDpi(Integer) - Method in class com.ironsoftware.ironpdf.compression.AdvancedCompressionOptions
 
setTempFolderPath(Path) - Static method in class com.ironsoftware.ironpdf.Settings
Set temp folder path.
setText(String) - Method in class com.ironsoftware.ironpdf.bookmark.Bookmark
Sets text.
setText(String) - Method in class com.ironsoftware.ironpdf.render.RenderedElementLocation
 
setText(String) - Method in class com.ironsoftware.ironpdf.stamp.TextStamper
Sets text to be stamped by the Stamper
setTextFieldFont(String, FontTypes, int) - Method in class com.ironsoftware.ironpdf.form.FormManager
Deprecated.
This method is deprecated and no longer has any effect. Set the font of a TextField
setTimeout(int) - Method in class com.ironsoftware.ironpdf.render.ChromePdfRenderOptions
Sets render timeout in seconds.
setTimeout(int) - Method in class com.ironsoftware.ironpdf.stamp.HtmlStamper
Sets timeout.
setTimeStampUrl(String) - Method in class com.ironsoftware.ironpdf.signature.Signature
Sets Url to be used when time-stamping the signature
Settings - Class in com.ironsoftware.ironpdf
Important global settings for configuration of IronPDF for Java
Settings() - Constructor for class com.ironsoftware.ironpdf.Settings
 
Settings.ChromeGpuModes - Enum in com.ironsoftware.ironpdf
Chrome GPU hardware utilization when rendering HTML to PDF
setTitle(String) - Method in class com.ironsoftware.ironpdf.annotation.AnnotationOptions
Sets title.
setTitle(String) - Method in class com.ironsoftware.ironpdf.annotation.LinkAnnotation
 
setTitle(String) - Method in class com.ironsoftware.ironpdf.annotation.TextAnnotation
Sets title.
setTitle(String) - Method in class com.ironsoftware.ironpdf.metadata.MetadataManager
Sets the Title of the document.
setTitle(String) - Method in class com.ironsoftware.ironpdf.render.ChromePdfRenderOptions
Sets title.
setUnderline(boolean) - Method in class com.ironsoftware.ironpdf.stamp.TextStamper
Sets underline.
setUnit(MeasurementUnit) - Method in class com.ironsoftware.ironpdf.edit.Length
Sets unit.
setUseGoogleFont(boolean) - Method in class com.ironsoftware.ironpdf.stamp.TextStamper
Sets use google font.
setUserPassword(String) - Method in class com.ironsoftware.ironpdf.security.SecurityOptions
Sets user password.
setValue(double) - Method in class com.ironsoftware.ironpdf.edit.Length
Sets value.
setValue(String) - Method in class com.ironsoftware.ironpdf.stamp.BarcodeStamper
Sets value.
setVerticalAlignment(VerticalAlignment) - Method in class com.ironsoftware.ironpdf.stamp.Stamper
Sets vertical alignment.
setVerticalOffset(Length) - Method in class com.ironsoftware.ironpdf.stamp.Stamper
Sets vertical offset.
setWaitFor(WaitFor) - Method in class com.ironsoftware.ironpdf.render.ChromePdfRenderOptions
Sets a wrapper object that holds configuration for wait-for mechanism for user to wait for certain events before rendering.
setWaitFor(WaitFor) - Method in class com.ironsoftware.ironpdf.stamp.Stamper
Set A convenient wrapper to wait for various events, or just wait for amount of time.
setWidth(int) - Method in class com.ironsoftware.ironpdf.annotation.AnnotationOptions
Sets width of your annotation's icon and interactive area in pixels.
setWidth(int) - Method in class com.ironsoftware.ironpdf.annotation.LinkAnnotation
 
setWidth(int) - Method in class com.ironsoftware.ironpdf.image.DrawImageOptions
Sets width (Pixel).
setWidth(int) - Method in class com.ironsoftware.ironpdf.stamp.BarcodeStamper
Sets width.
setX(int) - Method in class com.ironsoftware.ironpdf.annotation.AnnotationOptions
Sets horizontal X position of the annotation on your page in pixels.
setX(int) - Method in class com.ironsoftware.ironpdf.annotation.LinkAnnotation
 
setX(int) - Method in class com.ironsoftware.ironpdf.image.DrawImageOptions
Sets X coordinate.
setY(int) - Method in class com.ironsoftware.ironpdf.annotation.AnnotationOptions
Sets the vertical Y position of the annotation on your page in pixels.
setY(int) - Method in class com.ironsoftware.ironpdf.annotation.LinkAnnotation
 
setY(int) - Method in class com.ironsoftware.ironpdf.image.DrawImageOptions
Sets Y coordinate.
Signature - Class in com.ironsoftware.ironpdf.signature
A class that represents a PDF signing certificate (.PFX or .p12) format which can be used to digitally sign a PDF.
Signature(String, String) - Constructor for class com.ironsoftware.ironpdf.signature.Signature
Initializes a new instance of the Signature class using a .pfx or .p12 digital signature file.
Signature(Path, String) - Constructor for class com.ironsoftware.ironpdf.signature.Signature
Initializes a new instance of the Signature class using a .pfx or .p12 digital signature file.
Signature(byte[], String) - Constructor for class com.ironsoftware.ironpdf.signature.Signature
Initializes a new instance of the Signature class.
Signature(byte[], String, Instant, byte[], String, String, String, Rectangle) - Constructor for class com.ironsoftware.ironpdf.signature.Signature
Initializes a new instance of the Signature class.
SignatureField - Class in com.ironsoftware.ironpdf.form
 
SignatureField(int, String, int, double, double, double, double, String, boolean) - Constructor for class com.ironsoftware.ironpdf.form.SignatureField
(INTERNAL) Please Get TextField from FormFieldsSet.getSignatureFields() from FormManager.getFields()
SignatureManager - Class in com.ironsoftware.ironpdf.signature
Class used to sign , get and signature from a PdfDocument.
SignatureManager(InternalPdfDocument) - Constructor for class com.ironsoftware.ironpdf.signature.SignatureManager
Please get SignatureManager by PdfDocument.getSignature() instead.
SignaturePermissions - Enum in com.ironsoftware.ironpdf.signature
Permission options for a PDF document which is digitally signed
SignPdfWithSignature(Signature) - Method in class com.ironsoftware.ironpdf.signature.SignatureManager
Signs the PDF with digital signature with advanced options.
SignPdfWithSignature(Signature, SignaturePermissions) - Method in class com.ironsoftware.ironpdf.signature.SignatureManager
Signs the PDF with digital signature with advanced options.
singlePage(int) - Static method in class com.ironsoftware.ironpdf.edit.PageSelection
Specific page index.
SIZE - Static variable in enum com.ironsoftware.ironpdf.render.WaitForType
 
Stamper - Class in com.ironsoftware.ironpdf.stamp
Defines a PDF Stamper.
startEngine() - Static method in class com.ironsoftware.ironpdf.IronPdfEngineManager
Ensures IronPdfEngine is started and connected.
stopEngine() - Static method in class com.ironsoftware.ironpdf.IronPdfEngineManager
Stops IronPdfEngine and releases the connection.

T

TableOfContentsTypes - Enum in com.ironsoftware.ironpdf.render
Table of contents layout type
TextAnnotation - Class in com.ironsoftware.ironpdf.annotation
Defines a Sticky-Note style PDF annotation.
TextAnnotation() - Constructor for class com.ironsoftware.ironpdf.annotation.TextAnnotation
Instantiates a new text annotation.
TextAnnotation(String) - Constructor for class com.ironsoftware.ironpdf.annotation.TextAnnotation
Instantiates a new text annotation.
TextField - Class in com.ironsoftware.ironpdf.form
 
TextField(int, String, int, double, double, double, double, String, boolean) - Constructor for class com.ironsoftware.ironpdf.form.TextField
(INTERNAL) Please Get TextField from FormFieldsSet.getTextFields() from FormManager.getFields()
TextHeaderFooter - Class in com.ironsoftware.ironpdf.headerfooter
Defines a text based PDF Header and Footer.
TextHeaderFooter() - Constructor for class com.ironsoftware.ironpdf.headerfooter.TextHeaderFooter
Creates a text based PDF Header and Footer.
TextHeaderFooter(String, String, String) - Constructor for class com.ironsoftware.ironpdf.headerfooter.TextHeaderFooter
Creates a text based PDF Header and Footer.
TextStamper - Class in com.ironsoftware.ironpdf.stamp
This allows the user to edit an existing PDF by adding some stamped text.
TextStamper() - Constructor for class com.ironsoftware.ironpdf.stamp.TextStamper
Instantiates a new Text stamper.
TextStamper(String) - Constructor for class com.ironsoftware.ironpdf.stamp.TextStamper
Instantiates a new Text stamper.
toBufferedImages() - Method in class com.ironsoftware.ironpdf.PdfDocument
Rasterizes (renders) the PDF into BufferedImage objects.
toBufferedImages(ToImageOptions) - Method in class com.ironsoftware.ironpdf.PdfDocument
Rasterizes (renders) the PDF into BufferedImage objects.
toBufferedImages(PageSelection) - Method in class com.ironsoftware.ironpdf.PdfDocument
Rasterizes (renders) the PDF into BufferedImage objects.
toBufferedImages(ToImageOptions, PageSelection) - Method in class com.ironsoftware.ironpdf.PdfDocument
Rasterizes (renders) the PDF into BufferedImage objects.
ToImageOptions - Class in com.ironsoftware.ironpdf.image
Defines options when rasterizing (converting) an PDf to image objects and files.
ToImageOptions() - Constructor for class com.ironsoftware.ironpdf.image.ToImageOptions
 
toImages(String, String) - Method in class com.ironsoftware.ironpdf.PdfDocument
Renders the pages of the PDF as specific image files type and saves them to disk.
toImages(String, String, ToImageOptions) - Method in class com.ironsoftware.ironpdf.PdfDocument
Renders the pages of the PDF as specific image files type and saves them to disk.
toImages(String, String, PageSelection) - Method in class com.ironsoftware.ironpdf.PdfDocument
Renders the pages of the PDF as specific image files type and saves them to disk.
toImages(String, String, ToImageOptions, PageSelection) - Method in class com.ironsoftware.ironpdf.PdfDocument
Renders the pages of the PDF as specific image files type and saves them to disk.
toJpegImages(String) - Method in class com.ironsoftware.ironpdf.PdfDocument
Renders the pages of the PDF as JPEG image files and saves them to disk.
toJpegImages(String, ToImageOptions) - Method in class com.ironsoftware.ironpdf.PdfDocument
Renders the pages of the PDF as JPEG image files and saves them to disk.
toJpegImages(String, PageSelection) - Method in class com.ironsoftware.ironpdf.PdfDocument
Renders the pages of the PDF as JPEG image files and saves them to disk.
toJpegImages(String, ToImageOptions, PageSelection) - Method in class com.ironsoftware.ironpdf.PdfDocument
Renders the pages of the PDF as JPEG image files and saves them to disk.
toMultiPageTiff(Path) - Method in class com.ironsoftware.ironpdf.PdfDocument
Renders the pages of the PDF as TIFF (Tagged Image File Format / Tif) file and saves it to disk.
toMultiPageTiff(Path, PageSelection) - Method in class com.ironsoftware.ironpdf.PdfDocument
Renders the pages of the PDF as TIFF (Tagged Image File Format / Tif) file and saves it to disk.
toMultiPageTiff(Path, ToImageOptions) - Method in class com.ironsoftware.ironpdf.PdfDocument
Renders the pages of the PDF as TIFF (Tagged Image File Format / Tif) file and saves it to disk.
toMultiPageTiff(Path, ToImageOptions, PageSelection) - Method in class com.ironsoftware.ironpdf.PdfDocument
Renders the pages of the PDF as TIFF (Tagged Image File Format / Tif) file and saves it to disk.
toPngImages(String) - Method in class com.ironsoftware.ironpdf.PdfDocument
Renders the pages of the PDF as PNG (Portable Network Graphic) files and saves them to disk.
toPngImages(String, ToImageOptions) - Method in class com.ironsoftware.ironpdf.PdfDocument
Renders the pages of the PDF as PNG (Portable Network Graphic) files and saves them to disk.
toPngImages(String, PageSelection) - Method in class com.ironsoftware.ironpdf.PdfDocument
Renders the pages of the PDF as PNG (Portable Network Graphic) files and saves them to disk.
toPngImages(String, ToImageOptions, PageSelection) - Method in class com.ironsoftware.ironpdf.PdfDocument
Renders the pages of the PDF as PNG (Portable Network Graphic) files and saves them to disk.
toString() - Method in class com.ironsoftware.ironpdf.annotation.LinkAnnotation
 
toString() - Method in class com.ironsoftware.ironpdf.annotation.TextAnnotation
Returns a String that represents this annotation.
toString() - Method in class com.ironsoftware.ironpdf.IronPdfEngineConnection
Provides a string representation of the current IronPdfEngine settings.
toString() - Method in class com.ironsoftware.ironpdf.render.RenderedElementLocation
 
toWire() - Method in enum com.ironsoftware.ironpdf.compression.ObjectStreamMode
The wire-format string the engine expects on QPdfCompressionFlagsP.object_streams.

U

UseChromeDefaultRendering() - Method in class com.ironsoftware.ironpdf.render.ChromePdfRenderOptions
Lays out PDF pages in the same way as when viewed from Google Chrome's print preview.
UseContinuousFeedRendering() - Method in class com.ironsoftware.ironpdf.render.ChromePdfRenderOptions
Creates a single page PDF which will force its entire content's width and height to fit into one page.
UseContinuousFeedRendering(int) - Method in class com.ironsoftware.ironpdf.render.ChromePdfRenderOptions
Creates a single page PDF which will force its entire content's width and height to fit into one page.
UseContinuousFeedRendering(double) - Method in class com.ironsoftware.ironpdf.render.ChromePdfRenderOptions
Creates a single page PDF which will force its entire content's width and height to fit into one page.
UseContinuousFeedRendering(double, int) - Method in class com.ironsoftware.ironpdf.render.ChromePdfRenderOptions
Creates a single page PDF which will force its entire content's width and height to fit into one page.
UseFitToPageRendering() - Method in class com.ironsoftware.ironpdf.render.ChromePdfRenderOptions
Scales content to fit the specified ChromePdfRenderOptions.setPaperSize(PaperSize).
UseFitToPageRendering(int) - Method in class com.ironsoftware.ironpdf.render.ChromePdfRenderOptions
Scales content to fit the specified ChromePdfRenderOptions.setPaperSize(PaperSize).
useIronPdfEngineDocker() - Static method in class com.ironsoftware.ironpdf.Settings
Deprecated.
This method is obsolete. Use Settings.setConnectionMode(IronPdfEngineConnection) instead.
useIronPdfEngineDocker(int) - Static method in class com.ironsoftware.ironpdf.Settings
Deprecated.
UseResponsiveCssRendering() - Method in class com.ironsoftware.ironpdf.render.ChromePdfRenderOptions
Uses Responsive CSS to define the rendering of the HTML based on the ViewPortWidth parameter.
UseResponsiveCssRendering(int) - Method in class com.ironsoftware.ironpdf.render.ChromePdfRenderOptions
Uses Responsive CSS to define the rendering of the HTML based on the ViewPortWidth parameter.
UseScaledRendering() - Method in class com.ironsoftware.ironpdf.render.ChromePdfRenderOptions
Adopts a layout which behaves in the same way the 'Chrome Print Preview' does for a given paper size, with an additional zoom level applied to allow content to be manually scaled by the developer.
UseScaledRendering(int) - Method in class com.ironsoftware.ironpdf.render.ChromePdfRenderOptions
Adopts a layout which behaves in the same way the 'Chrome Print Preview' does for a given paper size, with an additional zoom level applied to allow content to be manually scaled by the developer.

V

valueOf(String) - Static method in enum com.ironsoftware.ironpdf.annotation.AnnotationIcon
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.ironsoftware.ironpdf.bookmark.BookmarkDestinations
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.ironsoftware.ironpdf.compression.ObjectStreamMode
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.ironsoftware.ironpdf.edit.ChangeTrackingModes
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.ironsoftware.ironpdf.edit.MeasurementUnit
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.ironsoftware.ironpdf.form.FormFieldTypes
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.ironsoftware.ironpdf.image.ImageBehavior
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.ironsoftware.ironpdf.IronPdfEngineConnection.ConnectionMode
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.ironsoftware.ironpdf.NaturalLanguages
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.ironsoftware.ironpdf.page.PageRotation
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.ironsoftware.ironpdf.render.CssMediaType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.ironsoftware.ironpdf.render.FitToPaperModes
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.ironsoftware.ironpdf.render.LinearizationMode
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.ironsoftware.ironpdf.render.PaperOrientation
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.ironsoftware.ironpdf.render.PaperSize
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.ironsoftware.ironpdf.render.TableOfContentsTypes
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.ironsoftware.ironpdf.render.WaitForType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.ironsoftware.ironpdf.security.PdfEditSecurity
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.ironsoftware.ironpdf.security.PdfPrintSecurity
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.ironsoftware.ironpdf.Settings.ChromeGpuModes
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.ironsoftware.ironpdf.signature.SignaturePermissions
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.ironsoftware.ironpdf.stamp.BarcodeEncoding
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.ironsoftware.ironpdf.stamp.HorizontalAlignment
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.ironsoftware.ironpdf.stamp.VerticalAlignment
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.ironsoftware.ironpdf.standard.PdfAVersions
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.ironsoftware.ironpdf.standard.PdfUAVersions
Returns the enum constant of this type with the specified name.
values() - Static method in enum com.ironsoftware.ironpdf.annotation.AnnotationIcon
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.ironsoftware.ironpdf.bookmark.BookmarkDestinations
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.ironsoftware.ironpdf.compression.ObjectStreamMode
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.ironsoftware.ironpdf.edit.ChangeTrackingModes
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.ironsoftware.ironpdf.edit.MeasurementUnit
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.ironsoftware.ironpdf.form.FormFieldTypes
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.ironsoftware.ironpdf.image.ImageBehavior
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.ironsoftware.ironpdf.IronPdfEngineConnection.ConnectionMode
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.ironsoftware.ironpdf.NaturalLanguages
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.ironsoftware.ironpdf.page.PageRotation
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.ironsoftware.ironpdf.render.CssMediaType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.ironsoftware.ironpdf.render.FitToPaperModes
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.ironsoftware.ironpdf.render.LinearizationMode
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.ironsoftware.ironpdf.render.PaperOrientation
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.ironsoftware.ironpdf.render.PaperSize
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.ironsoftware.ironpdf.render.TableOfContentsTypes
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.ironsoftware.ironpdf.render.WaitForType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.ironsoftware.ironpdf.security.PdfEditSecurity
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.ironsoftware.ironpdf.security.PdfPrintSecurity
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.ironsoftware.ironpdf.Settings.ChromeGpuModes
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.ironsoftware.ironpdf.signature.SignaturePermissions
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.ironsoftware.ironpdf.stamp.BarcodeEncoding
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.ironsoftware.ironpdf.stamp.HorizontalAlignment
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.ironsoftware.ironpdf.stamp.VerticalAlignment
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.ironsoftware.ironpdf.standard.PdfAVersions
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.ironsoftware.ironpdf.standard.PdfUAVersions
Returns an array containing the constants of this enum type, in the order they are declared.
VerifiedSignature - Class in com.ironsoftware.ironpdf.signature
A class that represents a verified digital signature for a PDF document.
VerifiedSignature(String, String, String, String, Instant, boolean, String) - Constructor for class com.ironsoftware.ironpdf.signature.VerifiedSignature
 
VerifyPdfSignatures() - Method in class com.ironsoftware.ironpdf.signature.SignatureManager
Verifies all the PDF signatures for this PDF document and returns true if there are no invalid signatures.
VerticalAlignment - Enum in com.ironsoftware.ironpdf.stamp
Vertical layout alignment relative to the PDF page.

W

WaitFor - Class in com.ironsoftware.ironpdf.render
 
WaitFor(int) - Constructor for class com.ironsoftware.ironpdf.render.WaitFor
Default construct WaitFor object.
WaitFor() - Constructor for class com.ironsoftware.ironpdf.render.WaitFor
Default construct WaitFor object.
WaitFor(int, int) - Constructor for class com.ironsoftware.ironpdf.render.WaitFor
Default construct WaitFor object.
WaitFor(WaitForType, int, int, int, int, String) - Constructor for class com.ironsoftware.ironpdf.render.WaitFor
Intended to be used internally as our API recommends user to use convenient methods e.g.
WaitForType - Enum in com.ironsoftware.ironpdf.render
Type of wait-for for the user to have a chance to control when to commit rendering.
withCustomGrpcConnection(ManagedChannel) - Method in class com.ironsoftware.ironpdf.IronPdfEngineConnection
 
withHostPort(String, int) - Method in class com.ironsoftware.ironpdf.IronPdfEngineConnection
Recommended for hosting IronPdfEngine Docker in local network.
withOfficialCloud() - Method in class com.ironsoftware.ironpdf.IronPdfEngineConnection
Configures IronPDF Java to use an official cloud-based IronPdfEngine.
withSubprocess() - Method in class com.ironsoftware.ironpdf.IronPdfEngineConnection
Default use-case.
withSubprocess(int) - Method in class com.ironsoftware.ironpdf.IronPdfEngineConnection
Recommended if port 33350 is not available.
withTarget(String) - Method in class com.ironsoftware.ironpdf.IronPdfEngineConnection
Recommended for hosting IronPdfEngine Docker in Cloud or remote server.
A B C D E F G H I J L M N O P R S T U V W 
Skip navigation links

Copyright © 2022–2026 Iron Software. All rights reserved.