Componente PrintForm (Visual Basic)

Actualización: noviembre 2007

El componente PrintForm para Visual Basic 2008 habilita para imprimir en tiempo de ejecución una imagen de un formulario Windows Forms. Este comportamiento reemplaza el comportamiento del método PrintForm en versiones anteriores de Visual Basic.

Información general del componente PrintForm

Un escenario común para formularios Windows Forms sería crear un formulario con un formato parecido a un formulario en papel o a un informe y, a continuación, imprimir una imagen del formulario. Aunque se puede usar un componente PrintDocument para ello, requeriría mucho código. El componente PrintForm habilita para imprimir una imagen de un formulario en una impresora, a una ventana de la vista previa de impresión o a un archivo sin usar un componente PrintDocument.

El componente PrintForm se encuentra en la ficha Visual Basic PowerPacks del Cuadro de herramientas. Cuando se arrastra a un formulario, el componente aparece en la bandeja de componentes, el área pequeña debajo el borde inferior del formulario. Cuando el componente está seleccionado, las propiedades que definen su comportamiento se pueden establecer en la ventana Propiedades. Todas estas propiedades también se pueden establecer en código. También se puede crear una instancia del componente en código PrintForm sin agregarlo en tiempo de diseño.

Al imprimir un formulario, se imprime todo en el área de cliente del formulario. Esto incluye todos los controles y cualquier texto o gráficos dibujados por métodos gráficos en el formulario. De forma predeterminada, no se imprimen la barra de título del formulario, las barras de desplazamiento y el borde. También de forma predeterminada, el componente PrintForm imprime únicamente la parte visible del formulario. Por ejemplo, si el usuario cambia el tamaño del formulario en tiempo de ejecución, se imprimen únicamente los controles y gráficos que estén visibles actualmente.

Las configuración del Panel de control del sistema operativo determina la impresora predeterminada que usa el componente PrintForm.

Una vez iniciada la impresión, aparece un cuadro de diálogo de impresión PrintDocument estándar. Este cuadro de diálogo habilita a los usuarios para que puedan cancelar el trabajo de impresión.

Métodos, propiedades y eventos principales

El método principal del componente PrintForm es el método Print, que imprime una imagen del formulario en una impresora, en una ventana de la vista previa de impresión o en un archivo. Existen dos versiones del método Print:

  • Una versión básica sin parámetros: Print()

  • Una versión sobrecargada con parámetros que especifican el comportamiento de la impresión: Print(printForm As Form, printFormOption As PrintOption)

    El parámetro PrintOption del método sobrecargado determina la implementación subyacente usada para imprimir el formulario, si se imprimen la barra de título del formulario, las barras de desplazamiento y el borde, así como si se imprimen las partes desplazables del formulario.

La propiedad PrintAction es una propiedad principal del componente PrintForm. Esta propiedad determina si el resultado se envía a una impresora, se muestra en una ventana de la vista previa de impresión o se guarda como un archivo PostScript encapsulado. Si la propiedad PrintAction está establecida en PrintToFile, la propiedad PrintFileName especifica la ruta de acceso y el nombre de archivo.

La propiedad PrinterSettings proporciona el acceso a un objeto PrinterSettings subyacente que habilita para especificar valores tales como la impresora que se usa y el número de copias que se imprimen. También puede consultar las funciones de la impresora, como el color o la compatibilidad dúplex. Esta propiedad no aparece en la ventana Propiedades; se puede tener acceso a esta propiedad únicamente por código.

La propiedad Form se usa para especificar el formulario para imprimir al invocar mediante programación al componente PrintForm. Si el componente se agrega a un formulario en tiempo de diseño, ese formulario es el valor predeterminado.

Los eventos principales para el componente PrintForm incluyen los siguientes:

  • Evento BeginPrint. Se produce cuando se llama al método Print y antes de que se imprima la primera página del documento.

  • Evento EndPrint. Se produce después de que se imprima la última página.

  • Evento QueryPageSettings. Se produce inmediatamente antes de que se imprima cada página.

Comentarios

Si un formulario contiene texto o gráficos dibujados por métodos Graphics, use el método Print (Print()) básico para imprimirlo. Puede que los gráficos no se representen en algunos sistemas operativos cuando se usa el método Print sobrecargado.

Si el ancho de un formulario es más ancho que el ancho del papel en la impresora, puede aparecer cortado el lado derecho del formulario. Al diseñar formularios para imprimir, asegúrese de que el formulario se ajusta al tamaño de papel estándar.

Ejemplo

En el ejemplo siguiente se muestra un uso común del componente PrintForm.

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

Vea también

Tareas

Cómo: Imprimir un formulario mediante el componente PrintForm (Visual Basic)

Cómo: Imprimir el área de cliente de un formulario (Visual Basic)

Cómo: Imprimir áreas de cliente y áreas que no son de cliente de un formulario (Visual Basic)

Cómo: Imprimir un formulario con desplazamiento (Visual Basic)

Referencia

Print

PrintAction