contrôler les propriétés d'affichage du PDF

Les fichiers PDF ont une fonction unique qui permet de gérer les préférences d’affichage qui nous permettent de contrôler la manière dont l’application de visualisation affichera le document PDF. Par conséquent, le dictionnaire des préférences de visualisation d’un document PDF vous permet de contrôler la manière dont le document doit être présenté à l’écran ou sur papier.

Veuillez noter que nous pouvons contrôler les propriétés d’affichage des visionneuses PDF. Cela inclut le contrôle de l’affichage du titre du document PDF, le masquage ou l’affichage de la barre de menus, le masquage/affichage de la barre d’état, le masquage/affichage de l’interface utilisateur de la fenêtre. Contrôlez la configuration de la mise en page, du mode de page et de la mise en page. La majorité des applications de traitement PDF prennent en charge ces opérations. Mais, pour les opérations de mise à jour en masse, une solution programmatique est une solution efficace. Dans cet article, nous allons discuter des détails et des étapes à suivre pour contrôler les propriétés d’affichage PDF à l’aide de Python.

Kit de développement logiciel (SDK) de manipulation de PDF

Aspose.PDF Cloud est une API basée sur REST qui permet aux développeurs d’implémenter des fonctionnalités de création, de manipulation et de rendu de PDF dans leurs applications. Avec moins de lignes de code, vous pouvez développer des applications de traitement PDF impressionnantes. Aucune installation de logiciel spécifique n’est requise et vous pouvez effectuer toutes les opérations de traitement PDF dans le Cloud. Pour faciliter davantage nos développeurs, nous avons créé Aspose.PDF Cloud SDK pour Python qui est un wrapper autour d’Aspose.PDF Cloud. Donc, pour commencer à utiliser ce SDK, la première étape est son installation. Le SDK est disponible en téléchargement gratuit sur PIP et GitHub. Nous devons maintenant exécuter la commande suivante dans le terminal/invite de commande pour effectuer l’installation.

pip install asposepdfcloud

Compte Cloud Dashboard gratuit

La prochaine étape importante est un abonnement gratuit à nos services cloud via tableau de bord Aspose.Cloud. Le but de cet abonnement est de permettre uniquement aux personnes autorisées d’accéder à nos services de traitement de fichiers. Si vous avez un compte GitHub ou Google, inscrivez-vous simplement ou cliquez sur le bouton Créer un nouveau compte et fournissez les informations requises. Connectez-vous maintenant au tableau de bord à l’aide des informations d’identification et développez la section Applications du tableau de bord et faites défiler vers le bas jusqu’à la section Informations d’identification du client pour voir les détails de l’ID client et du secret client.

Informations d'identification du client

Image 1 : Informations d’identification du client sur le tableau de bord Aspose.Cloud.

Lire les propriétés d’affichage PDF à l’aide de Python

Veuillez utiliser l’extrait de code ci-dessous pour lire les préférences de la visionneuse PDF et les afficher dans la console.

  • Tout d’abord, créez une instance de la classe ApiClient tout en fournissant l’ID client et le secret client comme arguments
  • Deuxièmement, créez une instance de la classe PdfApi qui prend l’objet ApiClient comme argument d’entrée
  • Enfin, appelez la méthode getdocumentdisplayproperties(…) pour récupérer les préférences de la visionneuse 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)

        # créer une instance PdfApi en passant PdfApiClient comme argument
        pdf_api = PdfApi(pdf_api_client)

        #source PDF file
        input_file = 'PdfWithEmbeddedFiles.pdf'

        # appeler l'API pour lire les propriétés d'affichage PDF à l'aide de Python
        response = pdf_api.get_document_display_properties(name = input_file)
        
        # imprimer la réponse dans la console
        print(response)
        
        # imprimer un message dans la console (facultatif)
        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)

L’exemple de document PDF utilisé dans l’exemple ci-dessus peut être téléchargé à partir de PdfWithEmbeddedFiles.pdf.

Mettre à jour les propriétés d’affichage PDF à l’aide de Python

Dans cette section, nous allons aborder les étapes et les détails associés à la définition des propriétés d’affichage PDF à l’aide du SDK Python. Cependant, avant de continuer, nous devons d’abord connaître les propriétés et les valeurs spécifiques qui peuvent leur être attribuées.

Propriétés prises en charge

| Propriété | Description |

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

| HideToolbar | Un indicateur spécifiant s’il faut masquer les barres d’outils de l’application de visualisation PDF lorsque le document est actif |

| HideMenuBar | Un indicateur spécifiant s’il faut masquer la barre de menus de l’application de visualisation PDF lorsque le document est actif.

| HideWindowUI | Un indicateur spécifiant s’il faut masquer les éléments de l’interface utilisateur dans la fenêtre du document (tels que les barres de défilement et les contrôles de navigation), laissant uniquement le contenu du document affiché.

| FitWindow | Un indicateur spécifiant s’il faut redimensionner la fenêtre du document pour l’adapter à la taille de la première page affichée.

| CenterWindow | Un indicateur spécifiant s’il faut positionner la fenêtre du document au centre de l’écran. |

| DisplayDocTitle | Un indicateur spécifiant si la barre de titre de la fenêtre doit afficher le titre du document.

| PageMode | Le mode de page du document lorsque le document PDF est ouvert dans une visionneuse PDF. Valeurs possibles : UseNone – Ni le plan du document (signets) ni les images miniatures ne sont visibles. UseOutlines – Le plan du document (signets) est visible. UseThumbs – Les images miniatures sont visibles. FullScreenFull – mode écran, sans barre de menu, commandes de fenêtre ou toute autre fenêtre visible. UseOC – Le panneau de groupe de contenu facultatif est visible. UseAttachments – Les pièces jointes du document sont visibles. |

| PageLayout | La mise en page doit être utilisée lors de l’ouverture du document. Valeurs possibles : SinglePage – Affiche une page à la fois. OneColumn – Affiche les pages sur une colonne. TwoColumnLeft – Affiche les pages sur deux colonnes, avec les pages impaires à gauche. TwoColumnRight – Affiche les pages sur deux colonnes, avec les pages impaires à droite. |

| NonFullScreenPageMode | Le mode de page du document lorsque l’application de visualisation PDF quitte le mode plein écran. Valeurs possibles : UseNone – Ni le plan du document (signets) ni les images miniatures ne sont visibles. UseOutlines – Le plan du document (signets) est visible. UseThumbs – Les images miniatures sont visibles. UseOC – Le panneau de groupe de contenu facultatif est visible. |

  • Créez une instance de la classe ApiClient tout en fournissant l’ID client et le secret client comme arguments.
  • Créez ensuite une instance de la classe PdfApi qui prend l’objet ApiClient comme argument d’entrée.
  • Créez maintenant une instance de DocumentProperties qui définit de nouvelles propriétés d’affichage pour l’affichage PDF.
  • Enfin, appelez putdocumentdisplayproperties(…) pour définir de nouvelles propriétés d’affichage pour le fichier 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)

        # créer une instance PdfApi en passant PdfApiClient comme argument
        pdf_api = PdfApi(pdf_api_client)

        #source PDF file
        input_file = 'PdfWithEmbeddedFiles.pdf'
        
        # Propriétés d'affichage du document
        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'
        }

        # appeler l'API pour mettre à jour les propriétés d'affichage du PDF
        response = pdf_api.put_document_display_properties(name = input_file, display_properties=newDocumentProperties)
        
        # imprimer la réponse dans la console
        print(response)
        
        # imprimer un message dans la console (facultatif)
        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)
préférences d'affichage PDF mises à jour

Image 2 : Aperçu des préférences d’affichage PDF mises à jour.

Lire les propriétés d’affichage PDF à l’aide de cURL

Les API REST sont également accessibles via les commandes cURL et comme Aspose.PDF Cloud est développé selon l’architecture REST, nous pouvons également accéder à l’API à l’aide de la commande cURL. Cependant, avant d’effectuer toute opération de manipulation de document, nous devons générer un jeton Web JSON (JWT) basé sur vos informations d’identification client individuelles spécifiées sur le tableau de bord Aspose.Cloud. Cela est obligatoire car nos API ne sont accessibles qu’aux utilisateurs enregistrés. Veuillez exécuter la commande suivante pour générer le jeton 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"

Une fois le jeton JWT généré, nous pouvons avoir besoin d’exécuter la commande cURL suivante pour lire les propriétés d’affichage PDF.

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

Mettre à jour les propriétés d’affichage PDF à l’aide de cURL

La commande cURL peut également être utilisée pour mettre à jour les propriétés d’affichage des documents PDF et le fichier résultant est à nouveau enregistré dans le stockage cloud.

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

Conclusion

Dans cet article, nous avons exploré les détails et les étapes permettant de lire et de contrôler les propriétés d’affichage PDF. Ces exigences peuvent être satisfaites à l’aide d’extraits de code Python ainsi qu’à l’aide des commandes cURL. Nous vous recommandons également d’explorer le Guide du développeur pour en savoir plus sur d’autres fonctionnalités intéressantes offertes par l’API. De plus, le code source complet d’Aspose.PDF Cloud SDK pour Python est disponible en téléchargement sur GitHub. Si vous rencontrez des problèmes lors de l’utilisation de l’API ou si vous avez d’autres questions, n’hésitez pas à nous contacter via le Forum d’assistance produit gratuit.

Articles connexes

Nous vous recommandons également de visiter les liens suivants pour en savoir plus sur :