appendPages
Краткая информация
Позволяет управлять документами 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.
Синтаксис
appendPages()
Свойства
| Имя | Объяснение | Тип данных |
|---|---|---|
|
pageCount (Только для чтения) |
Возвращает целое число, отображающее общее число страниц в документе PDF. |
Long |
Методы
appendPages(pdf_path, {input_pdf_password})
Добавляет один документ PDF в конце другого.
| Имя | Объяснение | Тип данных |
|---|---|---|
|
pdf_path |
Необходимо вставить строку с указанием расположения и имени присоединяемого документа PDF. |
String |
|
input_pdf_password (Дополнительный) |
Строка, определяющая главный пароль для защищенного файла. Это должен быть главный пароль: пользовательский пароль не подойдет. (Значение по умолчанию — None) |
String |
deletePages(page_range)
Позволяет удалить одну или несколько страниц из документа PDF.
| Имя | Объяснение | Тип данных |
|---|---|---|
|
page_range |
Строка, задающая страницы для удаления. Для удаления одной страницы в строке указывается одно значение (например, "3"). Несколько страниц можно удалить, задав их номера через запятую (например, "3, 5, 7"). Кроме того, можно задать диапазоны страниц (например, "1, 3, 5-12" ). |
String |
insertPages(pdf_path, {before_page_number}, {input_pdf_password})
Позволяет вставлять содержимое одного документа PDF в начало или в середину другого PDF.
| Имя | Объяснение | Тип данных |
|---|---|---|
|
pdf_path |
Необходимо вставить строку с указанием расположения и имени вставляемого документа PDF. |
String |
|
before_page_number (Дополнительный) |
Целое число, определяющее номер страницы в ссылаемом (Значение по умолчанию — 1) |
Integer |
|
input_pdf_password (Дополнительный) |
Строка, определяющая главный пароль для защищенного файла. Это должен быть главный пароль: пользовательский пароль не подойдет. (Значение по умолчанию — None) |
String |
saveAndClose()
Сохраняет изменения, внесенные в текущий PDFDocument.
updateDocProperties({pdf_title}, {pdf_author}, {pdf_subject}, {pdf_keywords}, {pdf_open_view}, {pdf_layout})
Обновляет метаданные PDF. С помощью этого метода можно также задать параметры поведения, которые будут срабатывать при открытии документа в Adobe Reader или Adobe Acrobat, например, начальный вид или вид эскизов страниц.
| Имя | Объяснение | Тип данных |
|---|---|---|
|
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.
(Значение по умолчанию — USE_THUMBS) |
String |
|
pdf_layout (Дополнительный) |
Specifies the Adobe Reader layout mode that will be used.
(Значение по умолчанию — SINGLE_PAGE) |
String |
updateDocSecurity(new_master_password, {new_user_password}, {encryption}, {permissions[permissions,...]})
Устанавливает для PDF-файла пароль, шифрование и ограничения безопасности.
| Имя | Объяснение | Тип данных |
|---|---|---|
|
new_master_password |
The primary document password. |
String |
|
new_user_password (Дополнительный) |
The user password needed to open the PDF for viewing. (Значение по умолчанию — None) |
String |
|
encryption (Дополнительный) |
Specifies the encryption technique that will be used for the PDF.
(Значение по умолчанию — AES-256) |
String |
|
permissions[permissions,...] (Дополнительный) |
A string or list of strings that specifies the permissions that will be granted by the document security settings.
(Значение по умолчанию — ALL) |
String |
Пример кода
Этот скрипт создает новый документ 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
Следующий скрипт изменяет свойства метаданных документа 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
Следующий скрипт задает пароли 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
Следующий скрипт заменяет все четыре страницы в существующем 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