SetBannerPrintOptions

All Editions $image\bltlrgss.gif$ Related Transactions $image\bltlrgss.gif$ Example

The SetBannerPrintOptions transaction sets options for banners that can be used when printing or faxing documents through the API, or when rasterizing layers through the user interface.

Type XTYP_EXECUTE

Syntax [SetBannerPrintOptions(bannerLocation, fontSize, units, "fontName", "bannerText", writeToINI)]

Parameter	Data type	Values	Meaning
bannerLocation	WORD	0 \| 1 \| 2 \| 3 \| 4 \| 5 \| 6 \| 7	bottom \| top \| top left \| top center \| top right \| bottom left \| bottom center \| bottom right
fontSize	float	font size in units
units	WORD	1 \| 2 \| 3 \| 4 \| 5 \| 6 \| 7 \| 8 \| 9 \| 10 \| 11 \| 12	centimeters \| inches \| pixels \| millimeters \| meters \| feet \| points \| twips \| custom 1 \| custom 2 \| custom 3 \| default
fontName	string	Windows font name
bannerText	string	text for banner, up to 256 bytes. See Remarks.
writeToINI	BOOL	whether options are written to INI file:
		0 \| 1	no \| yes

Remarks

You can use variables as part of the banner text, using the following syntax: &[variable]. Most of the variables that you can use are described in the Imagenation Help (Image.hlp): $image\bookopns.gif$ Banners and Stamps, $image\pages.gif$ Defining a banner, "Banner Variables" link. You can also use the UserID variable. This and other variables can be defined through SetUserAttribute.

Release information

Added in Release 4.10.