IN_PrintDocumentWindow

All Editions image\bltlrgsq_shg.gif Related Functions  image\bltlrgsq_shg.gif Example

The IN_PrintDocumentWindow function prints the contents of the specified document window. It can use either the specified print settings or those set in the Print dialog box.

Syntax

int IN_PrintDocumentWindow( docwinID, printType, useDialog, pageRange, firstPage, lastPage, numCopies, mode, tile, scale, orientation, bBanner )

Parameters

Values

Meaning

IN_DOCWIN docwinID

0 | docwinID

active | specific

SHORT printType

IN_PRN_WINDOW (0)

not used in this release

IN_BOOL useDialog

FALSE  use API settings

TRUE use the Print dialog box settings

SHORT pageRange

IN_PRINT_*

CURRENT_PAGE (1) current page

PAGE_RANGE (2) page range defined by firstPage and lastPage

ALL_PAGES (3) all pages

SHORT firstPage

1 to last page

first page of range. See Remarks.

SHORT lastPage

1 to last page

last page of range. See Remarks.

SHORT numCopies

> 0

number of copies

SHORT mode

IN_PMODE_*

DOCUMENT (1) whole document

LAYERS (2) displayed layers

AS_DISPLAYED (4) as displayed

ACTIVE_RASTER (8) active raster layer

ACTIVE_EDIT (16) active edit layer

RASTERS_DISPLAYED (32)
displayed raster layers

EDITS_DISPLAYED (64) displayed edit layers

SHORT tile

0 | 1

do not tile | tile

SHORT scale

IN_SCALE_MODE_TO_FIT (1)

IN_SCALE_MODE_ACTUAL_SIZE (2)

IN_SCALE_MODE_HALF_PAGE (3)

IN_SCALE_MODE_ NO_SCALE (4)

IN_SCALE_MODE_ACTUAL_SIZE_OR_FIT (5)

SHORT orientation

IN_ORIENT_BEST_FIT (1)

IN_ORIENT_PORTRAIT (2)

IN_ORIENT_LANDSCAPE (3)

IN_ORIENT_MIN_LENGTH (4)

IN_BOOL bBanner

FALSE  do not print the banner

TRUE print the banner

Remarks

The firstPage and lastPage values are ignored unless PAGE_RANGE (2) is selected as the pageRange value.

Release information

Added to Imagenation for Windows in Release 4.00.

The IN_BOOL bBanner parameter was added in Release 4.5.

As of Release 5.1, also available in Imagenation for UNIX.

See also

Printing a document

Defining a banner

Defining print options