управлять свойствами отображения PDF-файла

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

Обратите внимание, что мы можем управлять свойствами отображения просмотрщиков PDF. Это включает в себя управление отображением заголовка документа PDF, скрытие или отображение строки меню, скрытие/показ строки состояния, скрытие/отображение пользовательского интерфейса окна. Управление настройкой макета страницы, режима страницы и макета страницы. Большинство приложений для обработки PDF поддерживают эти операции. Но для операций массового обновления программное решение является эффективным решением. В этой статье мы рассмотрим детали и шаги по управлению свойствами отображения PDF с помощью Python.

SDK для работы с PDF-файлами

Aspose.PDF Cloud — это API на основе REST, позволяющий разработчикам реализовывать функции создания, обработки и рендеринга PDF в своих приложениях. С меньшим количеством строк кода вы можете разрабатывать впечатляющие приложения для обработки PDF. Установка специального программного обеспечения не требуется, и вы можете выполнять все операции по обработке PDF в облаке. Чтобы еще больше облегчить работу наших разработчиков, мы создали Aspose.PDF Cloud SDK для Python, который является оболочкой вокруг Aspose.PDF Cloud. Поэтому для начала работы с этим SDK первым шагом является его установка. SDK доступен для бесплатной загрузки через репозитории PIP и GitHub. Теперь нам нужно выполнить следующую команду в терминале/командной строке, чтобы выполнить установку.

pip install asposepdfcloud

Бесплатная учетная запись Cloud Dashboard

Следующий важный шаг — бесплатная подписка на наши облачные сервисы через панель управления Aspose.Cloud. Цель этой подписки — разрешить доступ к нашим сервисам обработки файлов только авторизованным лицам. Если у вас есть учетная запись GitHub или Google, просто зарегистрируйтесь или нажмите кнопку Создать новую учетную запись и укажите необходимую информацию. Теперь войдите в панель управления, используя учетные данные, разверните раздел «Приложения» на панели управления и прокрутите вниз до раздела «Учетные данные клиента», чтобы увидеть данные Client ID и Client Secret.

Учетные данные клиента

Изображение 1: Учетные данные клиента на панели управления Aspose.Cloud.

Чтение свойств отображения PDF с помощью Python

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

  • Во-первых, создайте экземпляр класса ApiClient, указав Client ID и Client Secret в качестве аргументов.
  • Во-вторых, создайте экземпляр класса PdfApi, который принимает объект ApiClient в качестве входного аргумента.
  • Наконец, вызовите метод getdocumentdisplayproperties(…) для получения настроек просмотра PDF-файла.
def readPDFDisplayProperties():
    try:
        #Client credentials
        client_secret = "1c9379bb7d701c26cc87e741a29987bb"
        client_id = "bbf94a2c-6d7e-4020-b4d2-b9809741374e"

        #initialize PdfApi client instance using client credetials
        pdf_api_client = asposepdfcloud.api_client.ApiClient(client_secret, client_id)

        # создать экземпляр PdfApi, передав PdfApiClient в качестве аргумента
        pdf_api = PdfApi(pdf_api_client)

        #source PDF file
        input_file = 'PdfWithEmbeddedFiles.pdf'

        # вызов API для чтения свойств отображения PDF с помощью Python
        response = pdf_api.get_document_display_properties(name = input_file)
        
        # распечатать ответ в консоли
        print(response)
        
        # вывести сообщение в консоль (необязательно)
        print('PDF Display preferences successfully retrieved !')    
    except ApiException as e:
        print("Exception while calling PdfApi: {0}".format(e))
        print("Code:" + str(e.code))
        print("Message:" + e.message)

Образец PDF-документа, использованный в приведенном выше примере, можно загрузить с PdfWithEmbeddedFiles.pdf.

Обновление свойств отображения PDF с помощью Python

В этом разделе мы обсудим шаги и сопутствующие детали того, как задать свойства отображения PDF с помощью Python SDK. Однако, прежде чем двигаться дальше, нам нужно сначала изучить свойства и конкретные значения, которые можно им присвоить.

Поддерживаемые свойства

| Недвижимость | Описание |

| —————– | ———————— |

| HideToolbar | Флаг, указывающий, следует ли скрывать панели инструментов приложения для просмотра PDF-файлов, когда документ активен |

| HideMenuBar | Флаг, указывающий, скрывать ли строку меню приложения для просмотра PDF-файлов, когда документ активен. |

| HideWindowUI | Флаг, указывающий, следует ли скрывать элементы пользовательского интерфейса в окне документа (например, полосы прокрутки и элементы управления навигацией), оставляя на экране только содержимое документа. |

| FitWindow | Флаг, указывающий, следует ли изменять размер окна документа, чтобы он соответствовал размеру первой отображаемой страницы. |

| CenterWindow | Флаг, указывающий, следует ли размещать окно документа в центре экрана. |

| DisplayDocTitle | Флаг, указывающий, должна ли строка заголовка окна отображать заголовок документа. |

| PageMode | Режим страницы документа, когда документ PDF открывается в средстве просмотра PDF. Возможные значения: UseNone — не видны ни контур документа (закладки), ни миниатюры изображений. UseOutlines — видны контур документа (закладки).UseThumbs — видны миниатюры изображений. FullScreenFull — экранный режим, в котором не отображается строка меню, элементы управления окнами или какие-либо другие окна. UseOC — видна панель дополнительной группы содержимого. UseAttachments — видны вложения документа. |

| PageLayout | Макет страницы, который будет использоваться при открытии документа. Возможные значения: SinglePage — отображает одну страницу за раз. OneColumn — отображает страницы в одном столбце. TwoColumnLeft — отображает страницы в двух столбцах, нечетные страницы слева. TwoColumnRight — отображает страницы в двух столбцах, нечетные страницы справа. |

| NonFullScreenPageMode | Режим страницы документа, когда приложение для просмотра PDF-файлов выходит из полноэкранного режима. Возможные значения: UseNone — не видны ни контур документа (закладки), ни миниатюры изображений. UseOutlines — видны контур документа (закладки).UseThumbs — видны миниатюры изображений. UseOC — видна панель дополнительной группы содержимого. |

  • Создайте экземпляр класса ApiClient, указав в качестве аргументов Client ID и Client Secret.
  • Затем создайте экземпляр класса PdfApi, который принимает объект ApiClient в качестве входного аргумента.
  • Теперь создайте экземпляр DocumentProperties, который определяет новые свойства отображения для отображения PDF-файла.
  • Наконец, вызовите putdocumentdisplayproperties(…), чтобы задать новые свойства отображения для PDF-файла.
def updatePDFDisplayProperties():
    try:
        #Client credentials
        client_secret = "1c9379bb7d701c26cc87e741a29987bb"
        client_id = "bbf94a2c-6d7e-4020-b4d2-b9809741374e"

        #initialize PdfApi client instance using client credetials
        pdf_api_client = asposepdfcloud.api_client.ApiClient(client_secret, client_id)

        # создать экземпляр PdfApi, передав PdfApiClient в качестве аргумента
        pdf_api = PdfApi(pdf_api_client)

        #source PDF file
        input_file = 'PdfWithEmbeddedFiles.pdf'
        
        # Свойства отображения документа
        newDocumentProperties = asposepdfcloud.DocumentProperties
        {
          "Links": [
            {
               "Href": '/PdfWithEmbeddedFiles.pdf/displayproperties',
                "Rel": 'self',
                "Type": None,
                "Title": None    }
          ],
          "CenterWindow": True,
          "Direction": 'L2R',
          "DisplayDocTitle": True,
          "HideMenuBar": True,
          "HideToolBar": False,
          "HideWindowUI": True,
          "NonFullScreenPageMode": 'UseOutlines',
          "PageLayout":'TwoColumnRight',
          "PageMode": 'UseThumbs'
        }

        # вызов API для обновления свойств отображения PDF
        response = pdf_api.put_document_display_properties(name = input_file, display_properties=newDocumentProperties)
        
        # распечатать ответ в консоли
        print(response)
        
        # вывести сообщение в консоль (необязательно)
        print('PDF Display preferences successfully updated !')    
    except ApiException as e:
        print("Exception while calling PdfApi: {0}".format(e))
        print("Code:" + str(e.code))
        print("Message:" + e.message)
обновленные настройки отображения PDF-файлов

Изображение 2: Предварительный просмотр обновленных настроек отображения PDF-файла.

Чтение свойств отображения PDF-файла с помощью cURL

REST API также можно получить через команды cURL, и поскольку Aspose.PDF Cloud разработан в соответствии с архитектурой REST, мы также можем получить доступ к API с помощью команды cURL. Однако перед выполнением любой операции по манипулированию документами нам необходимо сгенерировать JSON Web Token (JWT) на основе ваших индивидуальных учетных данных клиента, указанных на панели управления Aspose.Cloud. Это обязательно, поскольку наши API доступны только зарегистрированным пользователям. Пожалуйста, выполните следующую команду, чтобы сгенерировать JWT-токен.

curl -v "https://api.aspose.cloud/connect/token" \
-X POST \
-d "grant_type=client_credentials&client_id=bbf94a2c-6d7e-4020-b4d2-b9809741374e&client_secret=1c9379bb7d701c26cc87e741a29987bb" \
-H "Content-Type: application/x-www-form-urlencoded" \
-H "Accept: application/json"

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

curl -v -X GET "https://api.aspose.cloud/v3.0/pdf/PdfWithEmbeddedFiles.pdf/displayproperties" \
-H  "accept: application/json" \
-H  "authorization: Bearer <JWT Token>"

Обновление свойств отображения PDF-файла с помощью cURL

Команду cURL также можно использовать для обновления свойств отображения PDF-документов, а полученный файл снова сохраняется в облачном хранилище.

curl -v -X PUT "https://api.aspose.cloud/v3.0/pdf/PdfWithEmbeddedFiles.pdf/displayproperties" \
-H  "accept: application/json" \
-H  "authorization: Bearer <JWT Token>" \
-H  "Content-Type: application/json" \
-d "{  \"Links\": [    {       \"Href\": \"/PdfWithEmbeddedFiles.pdf/displayproperties\",        \"Rel\": \"self\",        \"Type\": null,        \"Title\": null    }  ],  \"CenterWindow\": true,  \"Direction\": \"L2R\",  \"DisplayDocTitle\": true,  \"HideMenuBar\": true,  \"HideToolBar\": false,  \"HideWindowUI\": true,  \"NonFullScreenPageMode\": \"UseOutlines\",  \"PageLayout\": \"TwoColumnRight\",  \"PageMode\": \"UseThumbs\"}"

Заключение

В этой статье мы изучили подробности и шаги по чтению и управлению свойствами отображения PDF. Эти требования могут быть выполнены с использованием фрагментов кода Python, а также с использованием команд cURL. Мы также рекомендуем изучить Руководство разработчика, чтобы узнать о других интересных функциях, предлагаемых API. Кроме того, полный исходный код Aspose.PDF Cloud SDK для Python доступен для загрузки через GitHub. Если у вас возникнут какие-либо проблемы при использовании API или у вас возникнут дополнительные вопросы, свяжитесь с нами через Бесплатный форум поддержки продукта.

Похожие статьи

Мы также рекомендуем посетить следующие ссылки, чтобы узнать больше о: