PDFDocumentOpen

Summary

Returns a PDFDocument object (the contents of the object come from a PDF file on disk, and subsequent operations followed by a call to saveAndClose will modify the original PDF file).

Discussion

Use the PDFDocumentOpen function to get a reference to an existing PDF file and modify its contents. For your changes to be committed to disk, be sure to call saveAndClose after performing the PDFDocument operations.

Syntax

PDFDocumentOpen (pdf_path, {user_password}, {master_password})

Parameter	Explanation	Data Type
pdf_path	A string that specifies the path and file name of the PDF file to open.	String
user_password	A string that specifies the user password. User passwords are typically used to restrict opening and specific master-defined operations for a PDF file.	String
master_password	A string that specifies the master password. Master passwords are typically used to restrict setting of user permissions for a PDF file.	String

Code sample

PDFDocumentOpen example

The following script modifies the PDF document metadata properties and sets the style in which the document will open.

import arcpy
pdfDoc = arcpy.mapping.PDFDocumentOpen(r"C:\Project\ParcelAtlasMapBook.pdf")
pdfDoc.updateDocProperties(pdf_title="Atlas Map",
                           pdf_author="Esri",
                           pdf_subject="Map Book",
                           pdf_keywords="Atlas; Map Books",
                           pdf_open_view="USE_THUMBS",
                           pdf_layout="SINGLE_PAGE")
pdfDoc.saveAndClose()
del pdfDoc