SET PRINT OPTION

4D v19.8

SET PRINT OPTION


SET PRINT OPTION ( option ; valeur1 {; valeur2} )

Paramètre	Type	Description
option	Entier long	Numéro d’option ou Code d'option PDF
valeur1	Entier long, Texte	Valeur 1 de l’option
valeur2	Entier long, Texte	Valeur 2 de l’option

Description

La commande SET PRINT OPTION permet de modifier par programmation la valeur d’une option d’impression. Chaque option définie à l’aide de cette commande est appliquée dans toute la base et durant toute la session tant qu’aucune autre commande modifiant les paramètres d’impression (PRINT SETTINGS, PRINT SELECTION sans le paramètre >, etc.) n’est appelée. Si une tâche d'impression a été ouverte (ex : avec OPEN PRINTING JOB), l'option est définie pour la tâche et n'est pas modifiable tant que la tâche n'est pas terminée (à l'exception de Orientation option, voir ci-dessous) .

Le paramètre option vous permet de désigner l’option à modifier. Vous pouvez passer soit une des constantes prédéfinies du thème Options d'impression, soit un code d'option PDF (utilisable avec le pilote PDFCreator sous Windows uniquement).

Passez dans les paramètres valeur1 et (facultativement) valeur2 la ou les nouvelle(s) valeur(s) de l’option spécifiée. Le nombre et la nature des valeurs à passer dépend du type d’option spécifiée.

Utiliser un numéro d'option (constante)

Le tableau suivant liste les options et leurs valeurs possibles :

Constante	Type	Valeur	Comment
Paper option	Entier long	1	Si vous passez uniquement valeur1, il contient le nom du papier. Si vous passez les deux paramètres, valeur1 contient la largeur du papier et valeur2 contient la hauteur du papier. La largeur et la hauteur sont exprimées en pixels écran. Utilisez la commande PRINT OPTION VALUES pour connaître le nom, la hauteur et la largeur de tous les formats de papier proposés par l’imprimante.
Orientation option	Entier long	2	valeur1 uniquement : 1=Portrait, 2=Paysage. Si une option d’orientation différente est utilisée, GET PRINT OPTION retourne 0 dans valeur1. Versions 64 bits : Cette option peut être appelée au sein d'une tâche d'impression, ce qui signifie que vous pouvez passer du mode portrait au mode paysage et inversement dans la même tâche d'impression.
Scale option	Entier long	3	valeur1 uniquement : valeur d'échelle en pourcentage. Attention, certaines imprimantes ne permettent pas de modifier l’échelle. Si vous passez une valeur invalide, la propriété est remise à 100% au moment de l'impression.
Number of copies option	Entier long	4	valeur1 uniquement : nombre de copies à imprimer
Paper source option	Entier long	5	(Windows uniqument) valeur1 uniquement : numéro correspondant à l’indice, dans le tableau des bacs retourné par la commande PRINT OPTION VALUES, du bac papier à utiliser. Cette option est utilisable sous Windows uniquement.
Color option	Entier long	8	(Windows uniquement) valeur1 uniquement : code indiquant le mode de prise en charge de la couleur : 1=Noir et blanc (monochrome), 2=Couleur. Versions 64 bits : Cette option n'est pas prise en charge dans les versions 64 bits de 4D (obsolète).
Destination option	Entier long	9	valeur1: code indiquant le type de destination de l’impression : 1=Imprimante, 2=Fichier (PC)/PS (Mac), 3=Fichier PDF, 5=Ecran (option du pilote OS X) Si valeur1 est différent de 1 ou de 5, valeur2 contient un chemin d’accès pour le document résultant. Ce chemin sera utilisé jusqu’à ce qu’un autre chemin soit spécifié. Si un fichier du même nom existe déjà à l’emplacement de destination, il est remplacé. Avec GET PRINT OPTION, si la valeur courante n’est pas dans la liste prédéfinie, valeur1 contient -1 et la variable système OK vaut 1. Si une erreur se produit, valeur1 et la variable système OK valent 0. Note (sous Windows) : Pour imprimer un PDF sous Windows, vous devez appeler SET CURRENT PRINTER(Generic PDF driver) et définir la destination d'impression 2 (Fichier) ou 3 (Fichier PDF). La destination d'impression 3 vous permet d'écrire du code multi-plate-forme. De plus, si le pilote PDF Creator a été installé et si une imprimante standard a été sélectionnée, lorsque les valeurs (9;3;chemin) sont passées, 4D lance automatiquement une impression PDF "silencieuse" et prend en compte les codes d'options éventuellement passés (à noter que si vous passez une chaîne vide dans valeur2 ou omettez ce paramètre, une boîte de dialogue d’enregistrement de fichier apparaît au moment de l’impression). A l'issue de l'impression, les paramétrages courants sont restaurés.
Double sided option	Entier long	11	valeur1: 0=Recto ou standard, 1=Recto-verso. Si valeur1=1, valeur2 contient la reliure à appliquer : 0=Reliure à gauche (valeur par défaut), 1=Reliure en haut.
Spooler document name option	Entier long	12	valeur1 uniquement : nom du document d’impression, qui apparaît dans la liste des documents du serveur d’impression. Le nom défini par cette instruction sera utilisé pour tous les documents d’impression de la session tant qu’un nouveau nom ou une chaîne vide ne sera pas passé(e). Pour utiliser ou rétablir le fonctionnement standard (utilisation du nom de la méthode dans le cas d’une méthode, nom de la table pour un enregistrement, etc.), passez une chaîne vide dans valeur1.
Mac spool file format option	Entier long	13	(Mac uniquement) valeur1 uniquement : 0=impression en mode PDF (valeur par défaut), 1=impression en mode Postscript. Notes : - Cette option n’a pas d’effet sous Windows. - Sous OS X, les impressions sont effectuées par défaut en mode PDF. Or, le pilote d’impression PDF ne prend pas en charge les images PICT encapsulant des informations Postscript — ces images sont générées notamment par des logiciels de dessin vectoriel. Pour résoudre ce problème, cette option permet de modifier le mode d’impression sous OS X pour la session courante. Attention, l'impression en mode Postscript peut entraîner des effets de bords indésirables. Versions 64 bits : Cette option n'est pas prise en charge ; elle est remplacée par l'utilisation de l'option Driver PDF générique de la commande SET CURRENT PRINTER.
Hide printing progress option	Entier long	14	(Mac 32 bits uniquement) valeur1 uniquement : 1=masquer toutes les fenêtres de progression d'impression, 0=afficher les fenêtres de progression d'impression (fonctionnement par défaut). Cette option est particulièrement utile dans le cadre des impressions en PDF sous OS X. Note : Il existe déjà une option d’affichage Progression de l’impression accessible via la boîte de dialogue des Propriétés de la base (page Interface). Toutefois, elle est globale à l’application et ne masque pas toutes les fenêtres sous OS X.
Page range option	Entier long	15	valeur1=numéro de la première page à imprimer (valeur par défaut 1) et (optionnel) valeur2=numéro de la dernière page à imprimer (valeur par défaut -1 = fin du document).
Legacy printing layer option	Entier long	16	(Versions 4D 64 bits pour Windows uniquement) valeur1 uniquement : 1=sélectionner l'ancienne couche d'impression GDI pour toutes les tâches d'impression suivantes, 0=sélectionner la couche d'impression D2D (défaut). Versions 64 bits : Ce sélecteur est pris en charge dans les applications 4D 64 bits monopostes sous Windows uniquement, et est ignoré pour les autres plates-formes. Il est principalement destiné, dans ces applications, à permettre aux plug-ins d'ancienne génération d'imprimer dans des tâches d'impression 4D.

Une fois fixée à l’aide de cette commande, une option d’impression sera conservée durant toute la session pour l’application 4D entière. Elle sera utilisée par les commandes PRINT SELECTION, PRINT RECORD, Print form, QR REPORT et par toutes les impressions de 4D, y compris en mode Développement.

Notes :

Il est impératif d’utiliser le paramètre optionnel > avec les commandes PRINT SELECTION, PRINT RECORD et PAGE BREAK afin de ne pas réinitialiser les options d’impression définies à l’aide de la commande SET PRINT OPTION.
La commande SET PRINT OPTION prend principalement en charge les imprimantes PostScript. Elle peut être utilisée avec d'autres types d'imprimantes, telles que PCL ou Ink, mais dans ce cas il est possible que certaines options ne soient pas disponibles.

Utiliser un code d'option PDF (Windows)

Pour pouvoir utiliser un code d'option PDF dans le paramètre option, vous devez avoir installé le pilote PDFCreator dans votre environnement 4D (pour plus d’informations, reportez-vous à la section Intégration du pilote PDFCreator sous Windows). De plus, pour que le code d'option soit pris en compte, vous devez avoir activé le pilotage de l'impression PDF par 4D via l'instruction suivante :

SET PRINT OPTION(Destination option;3;nomFichier)

Dans le cas contraire, les codes d'options sont ignorés.

Un code d'option PDF est une valeur de type texte constituée de deux parties, TypeOption et NomOption, assemblées sous la forme "TypeOption:NomOption". Voici la description de ce code :

TypeOption indique si vous désignez une option native de PDFCreator ou une option d’administration PDF de 4D. Deux valeurs sont acceptées :
- PDFOptions = option native
- PDFInfo = option interne.
NomOption désigne l’option à définir (dépend de la valeur de TypeOption).
- Si TypeOption = PDFOptions, vous pouvez passer dans NomOption l’une des nombreuses options natives de PDFCreator. Par exemple, l’option UseAutosave agit sur la sauvegarde automatique. Pour pouvoir modifier cette option, passez "PDFOptions:UseAutosave" dans le paramètre option et la valeur à utiliser dans le paramètre valeur1. Pour une description complète des options natives de PDFCreator, reportez-vous à la documentation livrée avec le pilote PDFCreator.
- Si TypeOption = PDFInfo, vous pouvez passer dans NomOption un des sélecteurs spécifiques suivants :

Note : Après chaque impression, 4D rétablit automatiquement les paramètres précédents du pilote PDFCreator afin d’éviter toute interférence avec les autres programmes utilisant PDFCreator.

Exemple 1

La méthode suivante active le pilotage PDF de manière à imprimer tous les enregistrements de la table à l'emplacement C:\Test\Test_PDF_N où N est le numéro de séquence de l’enregistrement :

 SET CURRENT PRINTER(PDFCreator Printer Name)

        // Sous Windows, sélectionner l’imprimante virtuelle installée par PDFCreator

 If(OK=1)  // Si PDFCreator est bien installé

 

    ALL RECORDS([Table_1])

    For($i;1;Records in selection([Table_1]))

       SET PRINT OPTION(Destination option;3;"C:\\Test\\Test_PDF_"+String($i))

           // L'option de destination 3 déclenche une tâche d'impression PDFCreator

       PRINT RECORD([Table_1];*)

       NEXT RECORD([Table_1])

    End for

           // Réinitialisation des options du pilote PDFCreator

    SET PRINT OPTION("PDFInfo:Reset standard options";0)

 End if

Exemple 2

La valeur de l'option Orientation option peut être modifiée à l'intérieur d'une même tâche d'impression. A noter que l'option doit être définie avant la commande PAGE BREAK :

 ALL RECORDS([Personnes])

 PRINT SETTINGS

 If(OK=1)

    OPEN PRINTING JOB

    SET PRINT OPTION(Orientation option;1) //portrait

    Print form([Personnes];"Form_Vert")

 

    SET PRINT OPTION(Orientation option;2) //paysage

    PAGE BREAK //doit être impérativement appelé APRES l'option

    Print form([Personnes];"Form_Hor")

    CLOSE PRINTING JOB

 End if

Variables et ensembles système

La variable système OK prend la valeur 1 si la commande a été exécutée correctement, sinon elle prend la valeur 0.
Si vous passez un code d'option invalide (option non reconnue par PDFCreator par exemple), OK prend la valeur 0.

Gestion des erreurs

Si la valeur passée pour une option est invalide ou si elle n'est pas disponible sur l'imprimante, la commande retourne une erreur (que vous pouvez intercepter à l’aide d’une méthode de gestion d’erreur installée par la commande ON ERR CALL) et la valeur courante de l’option est inchangée.

Voir aussi

GET PRINT OPTION
Options d'impression
PRINT OPTION VALUES
SET CURRENT PRINTER