PrintImage Method

Example-VB Example-VC++

Prints the image specified in the Image property.

Available With

Ö Imaging for Windows Professional Edition V1.0, V1.1, and V2.0
Ö Imaging for Windows 95 and 98
Ö Imaging for Windows NT 4.0

Applies To

Image Edit control

Syntax

object.PrintImage [StartPage,EndPage,OutputFormat,Annotations,Printer,Driver,PortNumber]

Arguments

Parameter Data Type Setting

StartPage Long The starting page in a range of pages to be printed
EndPage Long The ending page in a range of pages to be printed
OutputFormat Integer
(enumerated)
The output format to be used:

0 Pixel to pixel
1 Inch to inch
2 Fit to page
3 Best fit

Annotations Boolean Whether annotations and OCR zones will be printed with the image:

True Annotations and OCR zones will be printed
False Annotations and OCR zones will not be printed

Printer String
or
The name of the printer
Long The Printer Device Context (HDC) value (C++ only see "Binder Printing").
Driver String The name of the printer driver (applicable only when the Printer parameter is specified as a string)
PortNumber String The name of the output port (applicable only when the Printer parameter is specified as a string)

The OutputFormat parameter setting of 3 (Best fit) is available with Imaging for Windows Professional Edition V2.0 only.

The Printer Device Context (HDC) Printer parameter setting is available with Imaging for Windows Professional Edition V1.0, V1.1, and V2.0 only.

OutputFormat Default Settings By Product Version

Product Version Default Setting

Imaging for Windows Professional Edition V1.0 and V1.1
Imaging for Windows 98
1 Inch to inch
Imaging for Windows 95 and NT 4.0 2 Fit to page
Imaging for Windows Professional Edition V2.0 3 Best fit

Return Value

None

Remarks

If an image is displayed when the PrintImage method is invoked, the image is printed as it appears, including any changes made.

If an image is not being displayed, the PrintImage method prints the image specified in the Image property.  If an image is not being displayed and the Image property does not contain the name of an image, the PrintImage method generates an error.

If the StartPage and EndPage parameters are not entered, this method prints all pages by default.

If the Annotations parameter is not specified, all annotations are printed by default.

Binder Printing

This option is intended for use when printing images from Microsoft Binder.

If you use a hardware device context (HDC) value to specify the Printer parameter, you must call StartDoc and StartPage prior to passing the HDC value.  And you must call EndPage and EndDoc after passing the HDC value.

HDC is a C++ interface only; it is generated through C++ calls.  StartDoc and StartPage are C++ calls that must be executed prior to calling the PrintImage method.  EndPage and EndDoc are C++ calls that must be executed after calling the PrintImage method.  Note that if you specify an HDC value for the Printer parameter, you do not have to specify the Driver and PortNumber parameters.