controlar propriedades de exibição de PDF

Os arquivos PDF têm um recurso exclusivo para manter as preferências de visualização que nos permitem controlar como o aplicativo visualizador exibirá o documento PDF. Portanto, o dicionário de preferências do visualizador de um documento PDF permite que você controle a maneira como o documento será apresentado na tela ou impresso.

Observe que podemos controlar as propriedades de exibição dos visualizadores de PDF. Isso inclui controlar a exibição do título do documento PDF, ocultar ou mostrar a barra de menus, ocultar/mostrar a barra de status, ocultar/exibir a interface do usuário do Windows. Controle como configurar o layout da página, o modo da página e o layout da página. A maioria dos aplicativos de processamento de PDF oferece suporte a essas operações. Mas, para operações de atualização em massa, uma solução programática é uma solução eficaz. Neste artigo, discutiremos os detalhes e as etapas sobre como controlar as propriedades de exibição do PDF usando Python.

SDK de manipulação de PDF

Aspose.PDF Cloud é uma API baseada em REST que permite aos desenvolvedores implementar recursos de criação, manipulação e renderização de PDF em seus aplicativos. Com menos linhas de código, você pode desenvolver aplicativos de processamento de PDF impressionantes. Nenhuma instalação de software específica é necessária e você pode executar todas as operações de processamento de PDF na nuvem. Para facilitar ainda mais nossos desenvolvedores, criamos o Aspose.PDF Cloud SDK para Python que é um wrapper em torno do Aspose.PDF Cloud. Então, para começar a usar este SDK, o primeiro passo é sua instalação. O SDK está disponível para download gratuito no repositório PIP e GitHub. Agora precisamos executar o seguinte comando no terminal/prompt de comando para executar a instalação.

pip install asposepdfcloud

Conta gratuita do Cloud Dashboard

O próximo passo importante é uma assinatura gratuita dos nossos serviços de nuvem via Aspose.Cloud dashboard. O objetivo desta assinatura é permitir que apenas pessoas autorizadas acessem nossos serviços de processamento de arquivos. Se você tem uma conta GitHub ou Google, basta se inscrever ou clicar no botão Create a new Account e fornecer as informações necessárias. Agora faça login no painel usando credenciais e expanda a seção Applications do painel e role para baixo em direção à seção Client Credentials para ver os detalhes do Client ID e do Client Secret.

Credenciais do cliente

Imagem 1: Credenciais do cliente no painel do Aspose.Cloud.

Ler propriedades de exibição de PDF usando Python

Use o trecho de código fornecido abaixo para ler as preferências do visualizador de PDF e exibi-las no console.

  • Primeiro, crie uma instância da classe ApiClient, fornecendo o ID do cliente e o segredo do cliente como argumentos
  • Em segundo lugar, crie uma instância da classe PdfApi que recebe o objeto ApiClient como argumento de entrada
  • Por fim, chame o método getdocumentdisplayproperties(…) para recuperar as preferências do visualizador de 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)

        # crie uma instância PdfApi enquanto passa PdfApiClient como argumento
        pdf_api = PdfApi(pdf_api_client)

        #source PDF file
        input_file = 'PdfWithEmbeddedFiles.pdf'

        # chamar API para ler propriedades de exibição de PDF usando Python
        response = pdf_api.get_document_display_properties(name = input_file)
        
        # imprimir resposta no console
        print(response)
        
        # imprimir mensagem no console (opcional)
        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)

O documento PDF de amostra usado no exemplo acima pode ser baixado de PdfWithEmbeddedFiles.pdf.

Atualizar propriedades de exibição de PDF usando Python

Nesta seção, discutiremos as etapas e detalhes relacionados sobre como definir propriedades de exibição de PDF usando o Python SDK. No entanto, antes de prosseguir, precisamos primeiro aprender as propriedades e os valores específicos que podem ser atribuídos a elas.

Propriedades suportadas

| Propriedade | Descrição |

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

| HideToolbar | Um sinalizador que especifica se as barras de ferramentas do aplicativo visualizador de PDF devem ser ocultadas quando o documento estiver ativo |

| HideMenuBar | Um sinalizador que especifica se a barra de menu do aplicativo visualizador de PDF deve ser ocultada quando o documento estiver ativo. |

| HideWindowUI | Um sinalizador que especifica se deve ocultar elementos da interface do usuário na janela do documento (como barras de rolagem e controles de navegação), deixando apenas o conteúdo do documento exibido. |

| FitWindow | Um sinalizador que especifica se a janela do documento deve ser redimensionada para se ajustar ao tamanho da primeira página exibida. |

| CenterWindow | Um sinalizador que especifica se a janela do documento deve ser posicionada no centro da tela. |

| DisplayDocTitle | Um sinalizador que especifica se a barra de título da janela deve exibir o título do documento. |

| PageMode | O modo de página do documento quando o documento PDF é aberto em um visualizador de PDF. Valores possíveis: UseNone – Nem o esboço do documento (marcadores) nem as imagens em miniatura são visíveis. UseOutlines – O esboço do documento (marcadores) são visíveis. UseThumbs – As imagens em miniatura são visíveis. FullScreenFull – modo de tela, sem barra de menu, controles de janela ou qualquer outra janela visível. UseOC – O painel de grupo de conteúdo opcional é visível. UseAttachments – Os anexos do documento são visíveis. |

| PageLayout | O layout da página deve ser usado quando o documento for aberto. Valores possíveis: SinglePage – Exibe uma página por vez. OneColumn – Exibe as páginas em uma coluna. TwoColumnLeft – Exibe as páginas em duas colunas, com páginas ímpares à esquerda. TwoColumnRight – Exibe as páginas em duas colunas, com páginas ímpares à direita. |

| NonFullScreenPageMode | O modo de página do documento quando o aplicativo visualizador de PDF sai do modo de tela cheia. Valores possíveis: UseNone – Nem o contorno do documento (marcadores) nem as imagens em miniatura são visíveis. UseOutlines – O contorno do documento (marcadores) são visíveis. UseThumbs – As imagens em miniatura são visíveis. UseOC – O painel de grupo de conteúdo opcional é visível. |

  • Crie uma instância da classe ApiClient fornecendo o ID do cliente e o segredo do cliente como argumentos.
  • Em seguida, crie uma instância da classe PdfApi que recebe o objeto ApiClient como argumento de entrada.
  • Agora crie uma instância de DocumentProperties que define novas propriedades de exibição para exibição de PDF.
  • Por fim, chame putdocumentdisplayproperties(…) para definir novas propriedades de exibição para o arquivo 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)

        # crie uma instância PdfApi enquanto passa PdfApiClient como argumento
        pdf_api = PdfApi(pdf_api_client)

        #source PDF file
        input_file = 'PdfWithEmbeddedFiles.pdf'
        
        # Propriedades de exibição do documento
        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'
        }

        # chamar API para atualizar propriedades de exibição de PDF
        response = pdf_api.put_document_display_properties(name = input_file, display_properties=newDocumentProperties)
        
        # imprimir resposta no console
        print(response)
        
        # imprimir mensagem no console (opcional)
        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)
preferências de exibição de pdf atualizadas

Imagem 2:- Visualização das preferências de exibição de PDF atualizadas.

Ler propriedades de exibição de PDF usando cURL

As APIs REST também podem ser acessadas por meio de comandos cURL e, como o Aspose.PDF Cloud é desenvolvido de acordo com a arquitetura REST, também podemos acessar a API usando o comando cURL. No entanto, antes de executar qualquer operação de manipulação de documento, precisamos gerar um JSON Web Token (JWT) com base em suas credenciais de cliente individuais especificadas no painel do Aspose.Cloud. É obrigatório porque nossas APIs são acessíveis apenas a usuários registrados. Execute o seguinte comando para gerar o token 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"

Depois que o token JWT for gerado, precisamos executar o seguinte comando cURL para ler as propriedades de exibição do PDF.

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

Atualizar propriedades de exibição de PDF usando cURL

O comando cURL também pode ser usado para atualizar as propriedades de exibição de documentos PDF e o arquivo resultante é salvo novamente no armazenamento em nuvem.

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\"}"

Conclusão

Neste artigo, exploramos os detalhes e as etapas sobre como ler e controlar as propriedades de exibição do PDF. Esses requisitos podem ser realizados usando snippets de código Python, bem como usando os comandos cURL. Também recomendamos explorar o Guia do desenvolvedor para aprender sobre outros recursos interessantes oferecidos pela API. Além disso, o código-fonte completo do Aspose.PDF Cloud SDK para Python foi disponibilizado para download no GitHub. Caso você encontre algum problema ao usar a API ou tenha alguma dúvida, sinta-se à vontade para entrar em contato conosco por meio do Fórum de suporte gratuito ao produto.

Artigos relacionados

Recomendamos também que você visite os seguintes links para saber mais sobre: