Class Page_Api
java.lang.Object
com.ironsoftware.ironpdf.internal.staticapi.Page_Api
The type Page api.
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic void
appendPdf
(InternalPdfDocument mainPdfDocument, InternalPdfDocument anotherPdf) Appends another PDF to the end of the currentInternalPdfDocument
If AnotherPdfFile contains form fields, those fields will be appended with '_' in the resulting PDF.static InternalPdfDocument
copyPage
(InternalPdfDocument internalPdfDocument, Iterable<Integer> pageIndexes) Creates a new PDF by copying a range of pages from this PdfDocument.getPagesInfo
(InternalPdfDocument internalPdfDocument) Gets the list of pages with information in the PDF document.static void
insertPage
(InternalPdfDocument internalPdfDocument, InternalPdfDocument anotherPdf) Inserts another PDF into the current PdfDocument, starting at a given Page Index.static void
insertPage
(InternalPdfDocument internalPdfDocument, InternalPdfDocument anotherPdf, int atIndex) Inserts another PDF into the current PdfDocument, starting at a given Page Index.static InternalPdfDocument
mergePage
(List<InternalPdfDocument> pdfDocuments) Static method that joins (concatenates) multiple PDF documents together into one compiled PDF document.static void
removePage
(InternalPdfDocument internalPdfDocument, Iterable<Integer> pageIndexes) Removes a range of pages from the PDFstatic void
resizePage
(InternalPdfDocument internalPdfDocument, double pageWidth, double pageHeight, Integer pageIndex) Resize a page to the specified dimensions (in millimeters)static void
setPageRotation
(InternalPdfDocument internalPdfDocument, PageRotation pageRotation) Rotates all page of the PdfDocument by a specified number of degrees.static void
setPageRotation
(InternalPdfDocument internalPdfDocument, PageRotation pageRotation, Iterable<Integer> pageIndexes) Rotates pages of the PdfDocument by a specified number of degrees.
-
Constructor Details
-
Page_Api
public Page_Api()
-
-
Method Details
-
removePage
public static void removePage(InternalPdfDocument internalPdfDocument, Iterable<Integer> pageIndexes) Removes a range of pages from the PDF- Parameters:
internalPdfDocument
- the internal pdf documentpageIndexes
- A list of pages indexes to remove.
-
mergePage
Static method that joins (concatenates) multiple PDF documents together into one compiled PDF document. If the PDF contains form fields the form field in the resulting PDF's name will be appended with '_{index}' e.g. 'Name' will be 'Name_0'- Parameters:
pdfDocuments
- A IEnumerable of PdfDocument. To merge existing PDF files you may use the PdfDocument.FromFile static method in conjunction with Merge.- Returns:
- A new, merged
InternalPdfDocument
-
insertPage
public static void insertPage(InternalPdfDocument internalPdfDocument, InternalPdfDocument anotherPdf) Inserts another PDF into the current PdfDocument, starting at a given Page Index. If AnotherPdfFile contains form fields, those fields will be appended with '_' in the resulting PDF. e.g. 'Name' will be 'Name_'- Parameters:
internalPdfDocument
- the internal pdf documentanotherPdf
- internal pdf document to append.
-
insertPage
public static void insertPage(InternalPdfDocument internalPdfDocument, InternalPdfDocument anotherPdf, int atIndex) Inserts another PDF into the current PdfDocument, starting at a given Page Index. If AnotherPdfFile contains form fields, those fields will be appended with '_' in the resulting PDF. e.g. 'Name' will be 'Name_'- Parameters:
internalPdfDocument
- the internal pdf documentanotherPdf
- internal pdf document to append.atIndex
- Index at which to insert the new content. Note: Page 1 has index 0...
-
appendPdf
Appends another PDF to the end of the currentInternalPdfDocument
If AnotherPdfFile contains form fields, those fields will be appended with '_' in the resulting PDF. e.g. 'Name' will be 'Name_'- Parameters:
mainPdfDocument
- the main internal pdf documentanotherPdf
- internal pdf document to append.
-
getPagesInfo
Gets the list of pages with information in the PDF document.- Parameters:
internalPdfDocument
- the internal pdf document- Returns:
- the pages info
-
setPageRotation
public static void setPageRotation(InternalPdfDocument internalPdfDocument, PageRotation pageRotation) Rotates all page of the PdfDocument by a specified number of degrees.- Parameters:
internalPdfDocument
- the internal pdf documentpageRotation
- Degrees of rotation
-
setPageRotation
public static void setPageRotation(InternalPdfDocument internalPdfDocument, PageRotation pageRotation, Iterable<Integer> pageIndexes) Rotates pages of the PdfDocument by a specified number of degrees.- Parameters:
internalPdfDocument
- the internal pdf documentpageRotation
- Degrees of rotationpageIndexes
- Indexes of the pages to rotate in an IEnumerable, list or array. PageIndex is a 'Zero based' page number, the first page being 0
-
copyPage
public static InternalPdfDocument copyPage(InternalPdfDocument internalPdfDocument, Iterable<Integer> pageIndexes) Creates a new PDF by copying a range of pages from this PdfDocument.- Parameters:
internalPdfDocument
- the internal pdf documentpageIndexes
- An IEnumerable of page indexes to copy into the new PDF.- Returns:
- A new
InternalPdfDocument
-
resizePage
public static void resizePage(InternalPdfDocument internalPdfDocument, double pageWidth, double pageHeight, Integer pageIndex) Resize a page to the specified dimensions (in millimeters)- Parameters:
internalPdfDocument
- the internal pdf documentpageWidth
- Desired page width, in millimeterspageHeight
- Desired page height, in millimeterspageIndex
- Selected page indexes.
-