PrintForm, composant (Visual Basic)

Mise à jour : novembre 2007

Le composant PrintForm pour Visual Basic 2008 vous permet d'imprimer une image d'un Windows Form au moment de l'exécution. Son comportement remplace celui de la méthode PrintForm dans les versions antérieures de Visual Basic.

Vue d'ensemble du composant PrintForm

Un scénario courant pour les Windows Forms est de créer un formulaire mis en forme pour ressembler à un feuillet ou un rapport, puis d'imprimer une image du formulaire. Même si vous pouvez utiliser un composant PrintDocument pour ce faire, il requerrait beaucoup de code. Le composant PrintForm vous permet d'imprimer une image d'un formulaire vers une imprimante, une fenêtre d'aperçu avant impression ou un fichier sans utiliser de composant PrintDocument.

Le composant PrintForm est localisé sur l'onglet Visual Basic PowerPacks de la Boîte à outils. Lorsque vous le faites glisser sur un formulaire, il apparaît dans la barre d'état des composants, la petite zone sous la bordure inférieure du formulaire. Lorsque le composant est sélectionné, les propriétés qui définissent son comportement peuvent être définies dans la fenêtre Propriétés. Toutes ces propriétés peuvent également être définies dans le code. Vous pouvez également créer une instance du composant PrintForm dans le code sans ajouter le composant au moment du design.

Lorsque vous imprimez un formulaire, tout ce qui se situe dans la zone cliente du formulaire est imprimé. Cela inclut tous les contrôles et tout texte ou graphiques dessinés sur le formulaire à l'aide de méthodes graphiques. Par défaut, la barre de titre, les barres de défilement et la bordure du formulaire ne sont pas imprimées. Également par défaut, le composant PrintForm imprime uniquement la partie visible du formulaire. Par exemple, si l'utilisateur redimensionne le formulaire au moment de l'exécution, seuls les contrôles et graphiques qui sont visibles actuellement sont imprimés.

L'imprimante par défaut utilisée par le composant PrintForm est déterminée par les paramètres du Panneau de configuration du système d'exploitation.

Une fois l'impression initialisée, une boîte de dialogue d'impression PrintDocument standard s'affiche. Cette boîte de dialogue permet aux utilisateurs d'annuler le travail d'impression.

Méthodes, propriétés et événements clés

La méthode principale du composant PrintForm est la méthode Print, qui imprime une image du formulaire vers une imprimante, une fenêtre d'aperçu avant impression ou un fichier. Il existe deux versions de la méthode Print :

  • Une version de base sans paramètres : Print()

  • Une version surchargée avec des paramètres qui spécifient le comportement d'impression : Print(printForm As Form, printFormOption As PrintOption)

    Le paramètre PrintOption de la méthode surchargée détermine l'implémentation sous-jacente utilisée pour imprimer le formulaire, si la barre de titre, les barres de défilement et la bordure du formulaire sont imprimées, et si les parties déroulantes du formulaire sont imprimées.

La propriété PrintAction est une propriété principale du composant PrintForm. Cette propriété détermine si la sortie est envoyée à une imprimante, affichée dans une fenêtre d'aperçu avant impression ou enregistrée comme fichier PostScript encapsulé. Si la propriété PrintAction a la valeur PrintToFile, la propriété PrintFileName spécifie le chemin d'accès et le nom de fichier.

La propriété PrinterSettings fournit l'accès à un objet PrinterSettings sous-jacent qui vous permet de spécifier des paramètres tels que l'imprimante à utiliser et le nombre de copies à imprimer. Vous pouvez également interroger les fonctionnalités de l'imprimante, telles que la couleur ou la prise en charge de l'impression en duplex. Cette propriété n'apparaît pas dans la fenêtre Propriétés ; il est possible d'y accéder à partir du code uniquement.

La propriété Form est utilisée pour spécifier le formulaire à imprimer lorsque vous appelez le composant PrintForm par programme. Si le composant est ajouté à un formulaire au moment du design, ce formulaire est la valeur par défaut.

Les événements principaux pour le composant PrintForm incluent les événements suivants :

  • Événement BeginPrint. Se produit lorsque la méthode Print est appelée et avant l'impression de la première page du document.

  • Événement EndPrint. Se produit après l'impression de la dernière page.

  • Événement QueryPageSettings. Se produit juste avant l'impression de chaque page.

Notes

Si un formulaire contient du texte ou des graphiques dessinés à l'aide des méthodes Graphics, utilisez la méthode Print (Print()) de base pour l'imprimer. Il est possible que les graphiques ne soient pas rendus sur certains systèmes d'exploitation lorsque la méthode Print surchargée est utilisée.

Si la largeur d'un formulaire est supérieure à la largeur du papier dans l'imprimante, le côté droit du formulaire peut être tronqué. Lorsque vous concevez des formulaires destinés à l'impression, assurez-vous que le formulaire est ajusté à du papier de taille standard.

Exemple

L'exemple suivant montre une utilisation classique du composant PrintForm.

' Visual Basic.
Dim pf As New PrintForm
pf.Form = Me
pf.PrintAction = PrintToPrinter
pf.Print()

Voir aussi

Tâches

Comment : imprimer un formulaire à l'aide du composant PrintForm (Visual Basic)

Comment : imprimer la zone cliente d'un formulaire (Visual Basic)

Comment : imprimer des zones clientes et non clientes d'un formulaire (Visual Basic)

Comment : imprimer un formulaire à défilement variable (Visual Basic)

Référence

Print

PrintAction