SetStampString

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

The SetStampString transaction sets one of the eight possible stamp text strings.

Type XTYP_EXECUTE

Syntax [SetStampString(objectID, stampID, "stampText")]

Parameter	Data type	Values	Meaning
objectID	DWORD	-1	Imagenation
stampID	DWORD	1	top left stamp
		2	top center
		3	top right
		4	top left to bottom right diagonal
		5	bottom left to top right diagonal. See Remarks.
		6	bottom left
		7	bottom center
		8	bottom right
stampText	string	text string "" (empty string)	contents of the specified stamp. See Remarks. remove string

Remarks

Only one diagonal stamp can be defined at a time--either top left to bottom right, or bottom left to top right, but not both. The last one set will be used.

You can use variables as part of the stamp 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 stamp, "Stamp Variables" link. You can also use the UserID variable. This and other variables can be defined through SetUserAttribute.

Using this transaction causes any displayed stamps to be regenerated with the new text.

This transaction is identical to the old SetWatermarkString. Its name has simply been changed for consistency with the standard Imagenation user interface. SetWatermarkString will continue to work in existing integrations.

Release information

Added in Release 5.10.