pdf_output

(plugins.pdf_output)

Overview

The PDF Output plugin allows for creating, manipulating, and enhancing PDF files. It includes functionalities such as combining multiple PDFs, adding overlays or watermarks, numbering pages, and encrypting documents with password protection and custom permissions. The plugin supports working with both regular and protected PDFs and provides options for customizing fonts, colors, and layout elements during PDF manipulations.

For further details on working with PDF files using this plugin, refer to the PDF Output Plugin Guide.

Methods Summarized

Type	Name	Summary
Array	combinePDFDocuments(pdf_docs_bytearrays)	Combine multiple PDF docs into one.
Array	combineProtectedPDFDocuments(pdf_docs_bytearrays, pdf_docs_passwords)	Combine multiple protected PDF docs into one.
Array	convertPDFFormToPDFDocument(pdf_form, field_values)	Convert a PDF form to a PDF document.
Array	convertPDFFormToPDFDocument(pdf_form, field_values, partialFlattening)	Convert a PDF form to a PDF document.
Array	convertProtectedPDFFormToPDFDocument(pdf_form, pdf_password, field_values)	Convert a protected PDF form to a PDF document.
Array	convertProtectedPDFFormToPDFDocument(pdf_form, pdf_password, field_values, partialFlattening)	Convert a protected PDF form to a PDF document.
Array	encrypt(data, ownerPassword)	Add password protection and security options to the PDF
Array	encrypt(data, ownerPassword, userPassword)	Add password protection and security options to the PDF
Array	encrypt(data, ownerPassword, userPassword, allowAssembly, allowCopy, allowDegradedPrinting, allowFillIn, allowModifyAnnotations, allowModifyContents, allowPrinting, allowScreenreaders)	Add password protection and security options to the PDF
Array	encrypt(data, ownerPassword, userPassword, allowAssembly, allowCopy, allowDegradedPrinting, allowFillIn, allowModifyAnnotations, allowModifyContents, allowPrinting, allowScreenreaders, is128bit)	Add password protection and security options to the PDF
Array	encrypt(data, ownerPassword, userPassword, allowAssembly, allowCopy, allowDegradedPrinting, allowFillIn, allowModifyAnnotations, allowModifyContents, allowPrinting, allowScreenreaders, is128bit, metaData)	Add password protection and security options to the PDF
Number	getNumberOfPages(data)	Returns the number of pages for pdf document.
Array	getThumbnailImage(data)	Create a thumbnail from the provided PDF
Array	getThumbnailImage(data, pageNumber)	Create a thumbnail from the provided PDF
Array	getThumbnailImage(data, pageNumber, dpi)	Create a thumbnail from the provided PDF
Array	numberPages(data)	Add pages numbers to a PDF
Array	numberPages(data, fontSize, locationX, locationY, font, hexColor)	Add pages numbers to a PDF
Array	overlay(data, forOverlay)	Add some PDF based content over a PDF
Array	overlay(data, forOverlay, isOver)	Add some PDF based content over a PDF
Array	overlay(data, forOverlay, isOver, pages)	Add some PDF based content over a PDF
Array	overlay(data, forOverlay, pages)	Add some PDF based content over a PDF
Array	overlayText(data, text)	Add text over every page at a 45 degree angle
Array	overlayText(data, text, locationX, locationY, isOver, fontSize, font, hexColor)	Add text over every page at a 45 degree angle
Array	overlayText(data, text, locationX, locationY, isOver, fontSize, font, hexColor, angle)	Add text over every page at a 45 degree angle
Array	watermark(data, image)	Add an image as a watermark on every page, or the pages specified as a parameter
Array	watermark(data, image, locationX, locationY, isOver)	Add an image as a watermark on every page, or the pages specified as a parameter
Array	watermark(data, image, locationX, locationY, isOver, pages)	Add an image as a watermark on every page, or the pages specified as a parameter

Methods Detailed

combinePDFDocuments(pdf_docs_bytearrays)

Combine multiple PDF docs into one. Note: this function may fail when creating large PDF files due to lack of available heap memory. To compensate, please configure the application server with more heap memory via -Xmx parameter.

Parameters

• Array pdf_docs_bytearrays the array of documents to combine

Returns: Array the combined PDF document as a byte array, or null if the input array is empty or invalid.

Sample

pdf_blob_column = combinePDFDocuments(new Array(pdf_blob1,pdf_blob2,pdf_blob3));

combineProtectedPDFDocuments(pdf_docs_bytearrays, pdf_docs_passwords)

Combine multiple protected PDF docs into one. Note: this function may fail when creating large PDF files due to lack of available heap memory. To compensate, please configure the application server with more heap memory via -Xmx parameter.

Parameters

• Array pdf_docs_bytearrays the array of documents to combine
• Array pdf_docs_passwords an array of passwords to use

Returns: Array the combined PDF document as a byte array, or null if the input array is empty or invalid.

Sample

pdf_blob_column = combineProtectedPDFDocuments(new Array(pdf_blob1,pdf_blob2,pdf_blob3), new Array(pdf_blob1_pass,pdf_blob2_pass,pdf_blob3_pass));

convertPDFFormToPDFDocument(pdf_form, field_values)

Convert a PDF form to a PDF document. By default, all fields of the pdf form will be flattened.

Parameters

• Array pdf_form the PDF Form to convert
• Object field_values the values to use

Returns: Array the flattened PDF document as a byte array, or null in case of an error.

Sample

var pdfform = plugins.file.readFile('c:/temp/1040a-form.pdf');
//var field_values = plugins.file.readFile('c:/temp/1040a-data.fdf');//read adobe fdf values or
var field_values = new Array()//construct field values
field_values[0] = 'f1-1=John C.J.'
field_values[1] = 'f1-2=Longlasting'
var result_pdf_doc = plugins.pdf_output.convertPDFFormToPDFDocument(pdfform, field_values)
if (result_pdf_doc != null)
{
	plugins.file.writeFile('c:/temp/1040a-flatten.pdf', result_pdf_doc)
}

convertPDFFormToPDFDocument(pdf_form, field_values, partialFlattening)

Convert a PDF form to a PDF document. The PDF form can be have all the fields flattened or just the fields specified by values.

Parameters

• Array pdf_form the PDF Form to convert
• Object field_values the values to use. If partialFlattening is true, only these fields will be flattened.
• Boolean partialFlattening if true, only flatten the fields set as values, the rest remain unchanged

Returns: Array the flattened PDF document as a byte array, or null in case of an error.

Sample

var pdfform = plugins.file.readFile('c:/temp/1040a-form.pdf');
//var field_values = plugins.file.readFile('c:/temp/1040a-data.fdf');//read adobe fdf values or
var field_values = new Array()//construct field values
field_values[0] = 'f1-1=John C.J.'
field_values[1] = 'f1-2=Longlasting'
var result_pdf_doc = plugins.pdf_output.convertPDFFormToPDFDocument(pdfform, field_values)
if (result_pdf_doc != null)
{
	plugins.file.writeFile('c:/temp/1040a-flatten.pdf', result_pdf_doc)
}

convertProtectedPDFFormToPDFDocument(pdf_form, pdf_password, field_values)

Convert a protected PDF form to a PDF document. By default, all fields of the pdf form will be flattened.

Parameters

• Array pdf_form the PDF Form to convert
• String pdf_password the password to use
• Object field_values the field values to use

Returns: Array the flattened PDF document as a byte array, or null in case of an error.

Sample

var pdfform = plugins.file.readFile('c:/temp/1040a-form.pdf');
//var field_values = plugins.file.readFile('c:/temp/1040a-data.fdf');//read adobe fdf values or
var field_values = new Array()//construct field values
field_values[0] = 'f1-1=John C.J.'
field_values[1] = 'f1-2=Longlasting'
var result_pdf_doc = plugins.pdf_output.convertProtectedPDFFormToPDFDocument(pdfform, 'pdf_password', field_values)
if (result_pdf_doc != null)
{
	plugins.file.writeFile('c:/temp/1040a-flatten.pdf', result_pdf_doc)
}

convertProtectedPDFFormToPDFDocument(pdf_form, pdf_password, field_values, partialFlattening)

Convert a protected PDF form to a PDF document. Can specify if all fields or just specified fields will be flattened.

Parameters

• Array pdf_form the PDF Form to convert
• String pdf_password the password to use
• Object field_values the field values to use. If partialFlattening is true, only these fields will be flattened.
• Boolean partialFlattening if true, only flatten the fields set as values, the rest remain unchanged

Returns: Array the flattened PDF document as a byte array, or null in case of an error. If partialFlattening is true, only the specified fields are flattened, while others remain interactive.

Sample

var pdfform = plugins.file.readFile('c:/temp/1040a-form.pdf');
//var field_values = plugins.file.readFile('c:/temp/1040a-data.fdf');//read adobe fdf values or
var field_values = new Array()//construct field values
field_values[0] = 'f1-1=John C.J.'
field_values[1] = 'f1-2=Longlasting'
var result_pdf_doc = plugins.pdf_output.convertProtectedPDFFormToPDFDocument(pdfform, 'pdf_password', field_values)
if (result_pdf_doc != null)
{
	plugins.file.writeFile('c:/temp/1040a-flatten.pdf', result_pdf_doc)
}

encrypt(data, ownerPassword)

Add password protection and security options to the PDF

Parameters

• Array data the PDF
• String ownerPassword the owner password

Returns: Array the encrypted PDF

Sample

// Add password protection and security options to the PDF
// NOTE: Passwords are case sensitive
var unEncryptedFile = plugins.file.showFileOpenDialog();
if (unEncryptedFile) {
	var data = plugins.file.readFile(unEncryptedFile);
	encryptedResult = myElement.encrypt(data, 'secretPassword', 'secretUserPassword', false, false, false, false, false, false, false, false, true);
}

encrypt(data, ownerPassword, userPassword)

Add password protection and security options to the PDF

Parameters

• Array data the PDF
• String ownerPassword the owner password
• String userPassword the user password

Returns: Array the encrypted PDF

Sample

// Add password protection and security options to the PDF
// NOTE: Passwords are case sensitive
var unEncryptedFile = plugins.file.showFileOpenDialog();
if (unEncryptedFile) {
	var data = plugins.file.readFile(unEncryptedFile);
	encryptedResult = myElement.encrypt(data, 'secretPassword', 'secretUserPassword', false, false, false, false, false, false, false, false, true);
}

encrypt(data, ownerPassword, userPassword, allowAssembly, allowCopy, allowDegradedPrinting, allowFillIn, allowModifyAnnotations, allowModifyContents, allowPrinting, allowScreenreaders)

Add password protection and security options to the PDF

Parameters

• Array data the PDF
• String ownerPassword the owner password
• String userPassword the user password
• Boolean allowAssembly whether to set the allow assembly permission
• Boolean allowCopy whether to set the allow copy permission
• Boolean allowDegradedPrinting whether to set the allow degraded printing permission
• Boolean allowFillIn whether to set the allow fill in permission
• Boolean allowModifyAnnotations whether to set the allow modify annotations permission
• Boolean allowModifyContents whether to set the allow modify contents permission
• Boolean allowPrinting whether to set the allow printing permission
• Boolean allowScreenreaders whether to set the allow screen readers permission

Returns: Array the encrypted PDF

Sample

// Add password protection and security options to the PDF
// NOTE: Passwords are case sensitive
var unEncryptedFile = plugins.file.showFileOpenDialog();
if (unEncryptedFile) {
	var data = plugins.file.readFile(unEncryptedFile);
	encryptedResult = myElement.encrypt(data, 'secretPassword', 'secretUserPassword', false, false, false, false, false, false, false, false, true);
}

encrypt(data, ownerPassword, userPassword, allowAssembly, allowCopy, allowDegradedPrinting, allowFillIn, allowModifyAnnotations, allowModifyContents, allowPrinting, allowScreenreaders, is128bit)

Add password protection and security options to the PDF

Parameters

• Array data the PDF
• String ownerPassword the owner password
• String userPassword the user password
• Boolean allowAssembly whether to set the allow assembly permission
• Boolean allowCopy whether to set the allow copy permission
• Boolean allowDegradedPrinting whether to set the allow degraded printing permission
• Boolean allowFillIn whether to set the allow fill in permission
• Boolean allowModifyAnnotations whether to set the allow modify annotations permission
• Boolean allowModifyContents whether to set the allow modify contents permission
• Boolean allowPrinting whether to set the allow printing permission
• Boolean allowScreenreaders whether to set the allow screen readers permission
• Boolean is128bit whether to use 128-bit encryption

Returns: Array the encrypted PDF

Sample

// Add password protection and security options to the PDF
// NOTE: Passwords are case sensitive
var unEncryptedFile = plugins.file.showFileOpenDialog();
if (unEncryptedFile) {
	var data = plugins.file.readFile(unEncryptedFile);
	encryptedResult = myElement.encrypt(data, 'secretPassword', 'secretUserPassword', false, false, false, false, false, false, false, false, true);
}

encrypt(data, ownerPassword, userPassword, allowAssembly, allowCopy, allowDegradedPrinting, allowFillIn, allowModifyAnnotations, allowModifyContents, allowPrinting, allowScreenreaders, is128bit, metaData)

Add password protection and security options to the PDF

Parameters

• Array data the PDF
• String ownerPassword the owner password
• String userPassword the user password
• Boolean allowAssembly whether to set the allow assembly permission
• Boolean allowCopy whether to set the allow copy permission
• Boolean allowDegradedPrinting whether to set the allow degraded printing permission
• Boolean allowFillIn whether to set the allow fill in permission
• Boolean allowModifyAnnotations whether to set the allow modify annotations permission
• Boolean allowModifyContents whether to set the allow modify contents permission
• Boolean allowPrinting whether to set the allow printing permission
• Boolean allowScreenreaders whether to set the allow screen readers permission
• Boolean is128bit whether to use 128-bit encryption
• Object metaData a JavaScript object (Scriptable) that contains the metadata as property/value pairs

Returns: Array the encrypted PDF

Sample

// Add password protection and security options to the PDF
// NOTE: Passwords are case sensitive
var unEncryptedFile = plugins.file.showFileOpenDialog();
if (unEncryptedFile) {
	var data = plugins.file.readFile(unEncryptedFile);
	encryptedResult = myElement.encrypt(data, 'secretPassword', 'secretUserPassword', false, false, false, false, false, false, false, false, true);
}

getNumberOfPages(data)

Returns the number of pages for pdf document.

Parameters

• Array data the PDF

Returns: Number the number of pages of the PDF document

Sample

//get the number of pages
var pages = plugins.pdf_output.getNumberOfPages(bytes);

getThumbnailImage(data)

Create a thumbnail from the provided PDF

Parameters

• Array data the PDF

Returns: Array the PDF thumbnail as PNG format

Sample

//read PDF file data
var pdf = plugins.file.readFile();
//get the thumbnail (default the first page is rendered with 72 dpi resolution)
var pngImg = plugins.pdf_output.getThumbnailImage(pdf);
//save PNG image to file
var thumbnailFile = plugins.file.convertToJSFile()
plugins.file.writeFile(thumbnailFile, pngImg);

getThumbnailImage(data, pageNumber)

Create a thumbnail from the provided PDF

Parameters

• Array data the PDF
• Number pageNumber PDF page to get thumbnail of. This parameter is zero based index.

Returns: Array the PDF thumbnail as PNG format

Sample

//read PDF file data
var pdf = plugins.file.readFile();
//get the thumbnail (default the first page is rendered with 72 dpi resolution)
var pngImg = plugins.pdf_output.getThumbnailImage(pdf);
//save PNG image to file
var thumbnailFile = plugins.file.convertToJSFile()
plugins.file.writeFile(thumbnailFile, pngImg);

getThumbnailImage(data, pageNumber, dpi)

Create a thumbnail from the provided PDF

Parameters

• Array data the PDF
• Number pageNumber PDF page to get thumbnail of. This parameter is zero based index.
• Number dpi resolution used to render the thumbnail image

Returns: Array the PDF thumbnail as PNG format

Sample

//read PDF file data
var pdf = plugins.file.readFile();
//get the thumbnail (default the first page is rendered with 72 dpi resolution)
var pngImg = plugins.pdf_output.getThumbnailImage(pdf);
//save PNG image to file
var thumbnailFile = plugins.file.convertToJSFile()
plugins.file.writeFile(thumbnailFile, pngImg);

numberPages(data)

Add pages numbers to a PDF

Parameters

• Array data the PDF

Returns: Array the PDF with numbered pages

Sample

// Add pages numbers to a PDF
var unNumberedFile = plugins.file.showFileOpenDialog();
if (unNumberedFile) {
	var data = plugins.file.readFile(unNumberedFile);
	pageNumberedPdf = myElement.numberPages(data, 12, 520, 30, 'Courier', '#ff0033');
}

numberPages(data, fontSize, locationX, locationY, font, hexColor)

Add pages numbers to a PDF

Parameters

• Array data the PDF
• Number fontSize the font size to use
• Number locationX the x location of the numbers
• Number locationY the y location of the numbers
• String font the font to use
• String hexColor the font color to use

Returns: Array the PDF with numbered pages

Sample

// Add pages numbers to a PDF
var unNumberedFile = plugins.file.showFileOpenDialog();
if (unNumberedFile) {
	var data = plugins.file.readFile(unNumberedFile);
	pageNumberedPdf = myElement.numberPages(data, 12, 520, 30, 'Courier', '#ff0033');
}

overlay(data, forOverlay)

Add some PDF based content over a PDF

Parameters

• Array data the PDF
• Array forOverlay a PDF to use as overlay

Returns: Array the PDF with added overlay

Sample

// Add some PDF based content over a PDF
var pages = new Array();
pages[0] = '1';
pages[1] = '3';
pages[2] = '5';
var input1 = plugins.file.showFileOpenDialog(1,null,false,'pdf',null,'Select source file');
if (input1) {
	var data = plugins.file.readFile(input1);
	var input2 = plugins.file.showFileOpenDialog(1,null,false,'pdf',null,'Select file for overlay');
	if (input2) {
		var data2 = plugins.file.readFile(input2);
		overlayedPdf = myElement.overlay( data, data2, false, pages );
		//overlayedPdf = myElement.overlay( data, data2 );
		//overlayedPdf = myElement.overlay( data, data2, false, null );
		//overlayedPdf = myElement.overlay( data, data2, pages );
	}
}

overlay(data, forOverlay, isOver)

Add some PDF based content over a PDF

Parameters

• Array data the PDF
• Array forOverlay a PDF to use as overlay
• Boolean isOver whether the overlay will be put over the content

Returns: Array the PDF with added overlay

Sample

// Add some PDF based content over a PDF
var pages = new Array();
pages[0] = '1';
pages[1] = '3';
pages[2] = '5';
var input1 = plugins.file.showFileOpenDialog(1,null,false,'pdf',null,'Select source file');
if (input1) {
	var data = plugins.file.readFile(input1);
	var input2 = plugins.file.showFileOpenDialog(1,null,false,'pdf',null,'Select file for overlay');
	if (input2) {
		var data2 = plugins.file.readFile(input2);
		overlayedPdf = myElement.overlay( data, data2, false, pages );
		//overlayedPdf = myElement.overlay( data, data2 );
		//overlayedPdf = myElement.overlay( data, data2, false, null );
		//overlayedPdf = myElement.overlay( data, data2, pages );
	}
}

overlay(data, forOverlay, isOver, pages)

Add some PDF based content over a PDF

Parameters

• Array data the PDF
• Array forOverlay a PDF to use as overlay
• Boolean isOver whether the overlay will be put over the content
• Array pages an array of page numbers to put the overlay on

Returns: Array the PDF with added overlay

Sample

// Add some PDF based content over a PDF
var pages = new Array();
pages[0] = '1';
pages[1] = '3';
pages[2] = '5';
var input1 = plugins.file.showFileOpenDialog(1,null,false,'pdf',null,'Select source file');
if (input1) {
	var data = plugins.file.readFile(input1);
	var input2 = plugins.file.showFileOpenDialog(1,null,false,'pdf',null,'Select file for overlay');
	if (input2) {
		var data2 = plugins.file.readFile(input2);
		overlayedPdf = myElement.overlay( data, data2, false, pages );
		//overlayedPdf = myElement.overlay( data, data2 );
		//overlayedPdf = myElement.overlay( data, data2, false, null );
		//overlayedPdf = myElement.overlay( data, data2, pages );
	}
}

overlay(data, forOverlay, pages)

Add some PDF based content over a PDF

Parameters

• Array data the PDF
• Array forOverlay a PDF to use as overlay
• Array pages an array of page numbers to put the overlay on

Returns: Array the PDF with added overlay

Sample

// Add some PDF based content over a PDF
var pages = new Array();
pages[0] = '1';
pages[1] = '3';
pages[2] = '5';
var input1 = plugins.file.showFileOpenDialog(1,null,false,'pdf',null,'Select source file');
if (input1) {
	var data = plugins.file.readFile(input1);
	var input2 = plugins.file.showFileOpenDialog(1,null,false,'pdf',null,'Select file for overlay');
	if (input2) {
		var data2 = plugins.file.readFile(input2);
		overlayedPdf = myElement.overlay( data, data2, false, pages );
		//overlayedPdf = myElement.overlay( data, data2 );
		//overlayedPdf = myElement.overlay( data, data2, false, null );
		//overlayedPdf = myElement.overlay( data, data2, pages );
	}
}

overlayText(data, text)

Add text over every page at a 45 degree angle

Parameters

• Array data the PDF
• String text the text to use for the overlay

Returns: Array the PDF with added overlay

Sample

// Add text over every page at a 45 degree angle\m
var pdf = plugins.file.showFileOpenDialog();
if (pdf) {
	var data = plugins.file.readFile(pdf);
	modifiedPdf = myElement.overlayText(data, 'DRAFT', 230, 430, true, 32, 'Helvetica', '#33ff33');
}

overlayText(data, text, locationX, locationY, isOver, fontSize, font, hexColor)

Add text over every page at a 45 degree angle

Parameters

• Array data the PDF
• String text the text to use for the overlay
• Number locationX the x location of the overlay
• Number locationY the y location of the overlay
• Boolean isOver whether to put the overlay over the content
• Number fontSize the font size to use
• String font the font to use
• String hexColor the font color to use

Returns: Array the PDF with added overlay

Sample

// Add text over every page at a 45 degree angle\m
var pdf = plugins.file.showFileOpenDialog();
if (pdf) {
	var data = plugins.file.readFile(pdf);
	modifiedPdf = myElement.overlayText(data, 'DRAFT', 230, 430, true, 32, 'Helvetica', '#33ff33');
}

overlayText(data, text, locationX, locationY, isOver, fontSize, font, hexColor, angle)

Add text over every page at a 45 degree angle

Parameters

• Array data the PDF
• String text the text to use for the overlay
• Number locationX the x location of the overlay
• Number locationY the y location of the overlay
• Boolean isOver whether to put the overlay over the content
• Number fontSize the font size to use
• String font the font to use
• String hexColor the font color to use
• Number angle the angle of the overlay

Returns: Array the PDF with added overlay

Sample

// Add text over every page at a 45 degree angle\m
var pdf = plugins.file.showFileOpenDialog();
if (pdf) {
	var data = plugins.file.readFile(pdf);
	modifiedPdf = myElement.overlayText(data, 'DRAFT', 230, 430, true, 32, 'Helvetica', '#33ff33');
}

watermark(data, image)

Add an image as a watermark on every page, or the pages specified as a parameter

Parameters

• Array data the PDF
• Object image the path of an image to use or array of bytes containing actual image

Returns: Array the PDF with added watermak

Sample

// Add an image as a watermark on every page, or the pages specified as a parameter.
var pdf = plugins.file.showFileOpenDialog();
if (pdf) {
	var data = plugins.file.readFile(pdf);
	var image = plugins.file.showFileOpenDialog();
	modifiedPdf = myElement.watermark(data, image);
}

watermark(data, image, locationX, locationY, isOver)

Add an image as a watermark on every page, or the pages specified as a parameter

Parameters

• Array data the PDF
• Object image the path of an image to use or array of bytes containing actual image
• Number locationX the x location of the image
• Number locationY the y location of the image
• Boolean isOver whether to put over the content

Returns: Array the PDF with added watermak

watermark(data, image, locationX, locationY, isOver, pages)

Add an image as a watermark on every page, or the pages specified as a parameter

Parameters

• Array data the PDF
• Object image the path of an image to use or array of bytes containing actual image
• Number locationX the x location of the image
• Number locationY the y location of the image
• Boolean isOver whether to put over the content
• Array pages an array of pages where to apply the watermark

Returns: Array the PDF with added watermak

---