Overlays

<< Click to Display Table of Contents >>

Navigation:  Drivers API > IPXCPrinter Interface > Properties > Property Options >

Overlays


 

PRO SDK Icon Overlays

 


 

The Overlays properties determine how existing PDF files are used to overlay new documents. Please note that overlays and the PDF/A format are not compatible, and properties are case-sensitive:

 

 

NAME

 

 

VALUES

 

DEFINITION

Enabled

Boolean Value

 

Enables/disables overlay properties. If set to False then no further properties from this section are used.

 

Default value: False

 

OverlayFile

String

 

Specifies the file used as the overlay. The value must be a fully-qualified path name.

 

Default value: empty string

 

OverlayPassword

String

 

If the file specified as the OverlayFile property is encrypted then this property must contain the password.

 

Default value: empty string

 

AsForeground

Boolean Value

 

Defines the location of overlay pages. If this property is set to True then the default location is the document background.

 

Default value: False

 

Repeat

0 (NoRepeat)

1 (RepeatLastPage)

2 (RepeatContinuous)

 

Specifies the repeat option used for the overlay:

 

0 (NoRepeat): applies each page of the overlay file to the corresponding page of the new file. If the new file has a greater number of pages than the overlay file then the additional pages will not feature an overlay.

 

1 (RepeatLastPage): applies each page of the overlay file to the corresponding page of the new PDF file. If the new file has a greater number of pages than the overlay file then the additional pages will all feature the last page of the overlay file. If the overlay file features only one page then it will be placed on all the pages of the new file.

 

2 (RepeatContinuous):  applies each page of the overlay file to the corresponding page of the new PDF file. If the new file has a greater number of pages than the overlay file then the overlay file will repeat from the beginning for the remaining pages. If the overlay file features only one page then it will be placed on all the pages of the new file.

 

Default value: 0 (NoRepeat)

 

AlignH

0 (Left)

1 (Center)

2 (Right)

 

Specifies (relative to printed pages) the horizontal alignment of overlay pages.

 

Default value: 1 (Center)

 

AlignV

0 (Top)

1 (Middle)

2 (Bottom)

 

Specifies (relative to printed pages) the vertical alignment of overlay pages.

 

Default value: 1 (Middle)

 

Fit

Boolean Value

 

Fits the pages of the overlay to match those of the printed file.

 

Default value: False

 

KeepAspect

Boolean Value

 

Retains the proportions of the overlay file when using the options detailed above.

 

Default value: False