PDFDocument

Краткая информация

Позволяет управлять документами PDF, включая объединение и удаление страниц, поведение при открытии, добавление вложений и создание или изменение настроек безопасности документа.

Обсуждение

PDFDocumentOpen и PDFDocumentCreate являются двумя функциями, которые обеспечивают ссылку на объект PDFDocument.

Один из стандартных сценариев создания новых файлов PDF предназначен для создания атласов. Как правило, необходимо создать новый объект PDFDocument, присоединить к нему содержание других PDF-файлов и сохранить объект PDFDocument на диск. Другим стандартным сценарием является изменение содержания существующего файла PDF или его свойств. После того, как вы получили ссылку на PDFDocument, вы можете выполнить методы appendPages, insertPages или deletePages, а также использовать методы updateDocProperties и updateDocSecurity для изменения настроек PDF-файла.

Метод deletePages удобен для выгрузки только тех страниц, которые должны быть изменены. Обработка большого количества страниц занимает много времени. Если были изменены всего несколько страниц, быстрее удалить их, затем добавить измененные страницы с помощью метода insertPages.

В настоящий момент при использовании Python для настройки безопасности PDF документа, она ограничена шифрованием RC4. Если вы настраиваете безопасность PDF в ArcGIS Pro, она ограничена шифрованием AES 256-bit. Это значит, что, если вы управляете документами PDF, используя Python, вы ограничены работой только с теми документами PDF, которые не защищены, либо документами с шифрованием RC4.

Свойства

СвойствоОписаниеТип данных
pageCount
(только чтение)

Возвращает целое число, отображающее общее число страниц в документе PDF.

Long

Обзор метода

МетодОписание
appendPages (pdf_path, {input_pdf_password})

Добавляет один документ PDF в конце другого.

deletePages (page_range)

Позволяет удалить одну или несколько страниц из документа PDF.

insertPages (pdf_path, {before_page_number}, {input_pdf_password})

Позволяет вставлять содержимое одного документа PDF в начало или в середину другого PDF.

saveAndClose ()

Сохраняет изменения, внесенные в текущий PDFDocument.

updateDocProperties ({pdf_title}, {pdf_author}, {pdf_subject}, {pdf_keywords}, {pdf_open_view}, {pdf_layout})

Обновляет метаданные PDF. С помощью этого метода можно также задать параметры поведения, которые будут срабатывать при открытии документа в Adobe Reader или Adobe Acrobat, например, начальный вид или вид эскизов страниц.

updateDocSecurity (new_master_password, {new_user_password}, {encryption})

Устанавливает для PDF-файла пароль, шифрование и ограничения безопасности.

Методы

appendPages (pdf_path, {input_pdf_password})
ПараметрОписаниеТип данных
pdf_path

Необходимо вставить строку с указанием расположения и имени присоединяемого документа PDF.

String
input_pdf_password

Строка, определяющая главный пароль для защищенного файла. Это должен быть главный пароль: пользовательский пароль не подойдет.

(Значение по умолчанию — None)

String

При присоединении документов PDF с различными настройками безопасности настройки выходного документа будут основаны на настройках главного документа, к которому будет присоединены страницы. Например, если документ, к которому будут присоединены страницы, не имеет защитного пароля, а присоединяемые страницы имеют, полученный документ не будет иметь защитного пароля.

Для добавления страницы в начало текущего документа PDF используйте insertPages.

deletePages (page_range)
ПараметрОписаниеТип данных
page_range

Строка, задающая страницы для удаления. Для удаления одной страницы в строке указывается одно значение (например, "3"). Несколько страниц можно удалить, задав их номера через запятую (например, "3, 5, 7"). Кроме того, можно задать диапазоны страниц (например, "1, 3, 5-12" ).

String

Необходимо внимательно следить за удаляемыми страницами, т.к. после каждого удаления номера страниц в документе PDF автоматически пересчитываются. Например, страница 3 станет страницей 2 сразу после удаления страницы 1 или 2. Если страницы 1 и 2 удалены, страница 3 станет страницей 1. Необходимо учитывать эти особенности, если при использовании команды deletePages вы сразу же следом применяете команду insertPages вместе со значением before_page_number.

insertPages (pdf_path, {before_page_number}, {input_pdf_password})
ПараметрОписаниеТип данных
pdf_path

Необходимо вставить строку с указанием расположения и имени вставляемого документа PDF.

String
before_page_number

Целое число, определяющее номер страницы в ссылаемом PDFDocument, перед которым необходимо вставить новые страницы. Например, если before_page_value равно 1, вставляемая страница будет находиться перед всеми страницами.

(Значение по умолчанию — 1)

Integer
input_pdf_password

Строка, определяющая главный пароль для защищенного файла. Это должен быть главный пароль: пользовательский пароль не подойдет.

(Значение по умолчанию — None)

String

При использовании документов PDF с различными настройками безопасности настройки выходного документа будут основаны на настройках главного документа, в который будут вставляться страницы. Например, если документ, в который будут вставляться страницы, не имеет защитного пароля, а вставляемые страницы имеют, полученный документ не будет иметь защитного пароля.

Для добавления страницы в конец текущего документа PDF используйте appendPages.

saveAndClose ()

Метод saveAndClose следует использовать для сохраняемых изменений. Если скрипт завершает работу до исполнения saveAndClose, изменения не сохраняются. Если вы создаете новый файл с помощью PDFDocumentCreate, файл не появится на диске, пока не будет выполнена команда saveAndClose.

updateDocProperties ({pdf_title}, {pdf_author}, {pdf_subject}, {pdf_keywords}, {pdf_open_view}, {pdf_layout})
ПараметрОписаниеТип данных
pdf_title

The document title. This is a PDF metadata property.

(Значение по умолчанию — None)

String
pdf_author

The document author. This is a PDF metadata property.

(Значение по умолчанию — None)

String
pdf_subject

The document subject. This is a PDF metadata property.

(Значение по умолчанию — None)

String
pdf_keywords

The document keywords. This is a PDF metadata property.

(Значение по умолчанию — None)

String
pdf_open_view

Specifies the Adobe Reader view mode that will be used.

  • VIEWER_DEFAULTThe application user preference when opening the file will be used.
  • USE_NONEOnly the document will display. No other panels will display.
  • USE_THUMBSThe document and the Pages panel will display.
  • USE_BOOKMARKSThe document and the Bookmarks panel will display.
  • FULL_SCREENThe document will display in full-screen viewing mode.
  • LAYERSThe document and the Layers panel will display.
  • ATTACHMENTThe document and the Attachments panel will display.

(Значение по умолчанию — USE_THUMBS)

String
pdf_layout

Specifies the Adobe Reader layout mode that will be used.

  • DONT_CAREThe application user preference when opening the file will be used.
  • SINGLE_PAGESingle-page mode will be used.
  • ONE_COLUMNOne-column continuous mode will be used.
  • TWO_COLUMN_LEFTTwo-column continuous mode with the first page on the left will be used.
  • TWO_COLUMN_RIGHTTwo-column continuous mode with the first page on the right will be used.
  • TWO_PAGE_LEFTTwo-page mode left will be used.
  • TWO_PAGE_RIGHTTwo-page mode right will be used.

(Значение по умолчанию — SINGLE_PAGE)

String

Если для pdf_open_view установить значение FULL_SCREEN, то при открытии PDF-файла будет появляться предупреждение о полноэкранном режиме. Если для pdf_open_view задать другое значение, то установленный параметр будет сброшен только в том случае, если для pdf_open_view будет установлено значение USE_NONE.

updateDocSecurity (new_master_password, {new_user_password}, {encryption})
ПараметрОписаниеТип данных
new_master_password

The master document password.

String
new_user_password

The user password needed to open the PDF for viewing.

(Значение по умолчанию — None)

String
encryption

The encryption technique that will be used for the PDF.

  • AES-128128-bit AES encryption (Acrobat 7.0 compatible) will be used.
  • AES-256-R5256-bit AES encryption with R5 encoding (Acrobat 9.0 compatible) will be used.
  • AES-256256-bit AES encryption (Acrobat X compatible) will be used.
  • RC4128-bit RC4 encryption (Acrobat 5.0 compatible) will be used.
    Прежние версии:

    RC4 is only included for compatibility. AES encryption is recommended. RC4 will be deprecated in a future release.

(Значение по умолчанию — AES-256)

String
Подсказка:

Пароль на защищенном PDF-файле можно удалить, задав в свойствах new_master_password или new_user_password пустые строки.

Пример кода

PDFDocument, пример 1

Этот скрипт создает новый документ PDF, присоединяет содержание трех других отдельных документов PDF и сохраняет полученный файл PDF.

import arcpy, os

#Set file name and remove if it already exists
pdfPath = r"C:\Projects\YosemiteNP\AttractionsMapBook.pdf"
if os.path.exists(pdfPath):
    os.remove(pdfPath)

#Create the file and append pages
pdfDoc = arcpy.mp.PDFDocumentCreate(pdfPath)
pdfDoc.appendPages(r"C:\Projects\YosemiteNP\Title.pdf")
pdfDoc.appendPages(r"C:\Projects\YosemiteNP\MapPages.pdf")
pdfDoc.appendPages(r"C:\Projects\YosemiteNP\ContactInfo.pdf")

#Commit changes and delete variable reference
pdfDoc.saveAndClose()
del pdfDoc
PDFDocument, пример 2

Следующий скрипт изменяет свойства метаданных документа PDF и задает стиль, с которым открывается документ.

import arcpy
pdfDoc = arcpy.mp.PDFDocumentOpen(r"C:\Projects\YosemiteNP\AttractionsMapBook.pdf")
pdfDoc.updateDocProperties(pdf_title="Yosemite Main Attrations Map Book",
                           pdf_author="Esri",
                           pdf_subject="Main Attractions Map Book",
                           pdf_keywords="Yosemite; Map Books; Attractions",
                           pdf_open_view="USE_THUMBS",
                           pdf_layout="SINGLE_PAGE")
pdfDoc.saveAndClose()
del pdfDoc
PDFDocument, пример 3

Следующий скрипт задает пароли user_password и master_password, зашифровывает PDF с помощью сжатия RC4 и требует пароль при открытии документа. Ознакомьтесь с ограничениями защищенного PDF в описание класса выше.

import arcpy
pdfDoc = arcpy.mp.PDFDocumentOpen(r"C:\Projects\YosemiteNP\AttractionsMapBook.pdf")
pdfDoc.updateDocSecurity("master", "user", "RC4")
pdfDoc.saveAndClose()
del pdfDoc
PDFDocument, пример 4

Следующий скрипт заменяет все четыре страницы в существующем PDF, используя методы deletePages и затем insertPages. Обратите внимание, как была вставлена новая страница 3 перед текущей страницей 3, которая на самом деле была страницей 4 до удаления исходной страницы 3. То же самое происходит с диапазоном страниц 5-7. Ознакомьтесь с ограничениями защищенного PDF в описание класса выше.

import arcpy
pdfDoc = arcpy.mp.PDFDocumentOpen(r"C:\Projects\YosemiteNP\AttractionsMapBook.pdf", "master")
pdfDoc.deletePages("3, 5-7")
pdfDoc.insertPages(r"C:\Projects\Yosemite\NewPage3.pdf", 3, "master")
pdfDoc.insertPages(r"C:\Projects\Yosemite\NewPages5-7.pdf", 5, "master")
pdfDoc.saveAndClose()
del pdfDoc