Defining stamps

 

A stamp is a text string that is placed on the first layer rendered. No other types of objects can appear on this layer. The end user or integrator has access to this layer only through defined stamp transactions--the regular "layer" transactions do not apply to it.

To define stamps:

1. Use the SetStampFont(-1, 0, "fontName", fontSize, units, rgbColor) transaction to specify which font to use at which size, and the font color. Fonts must be globally defined for all stamps.

2. Use the SetStampString(-1, stampID, "stampText") transaction to specify the text for a stamp at one of eight possible positions. This transaction can be used to define different text for each possible stamp. To use a variable as stamp text, use the syntax &[variable]. The UserID and other variables can be defined through SetUserAttribute.

3. Use the SetStampParameter(-1, 0, parameterID, value) transaction to specify whether or not stamps are displayed on-screen by default, or on printed documents.

The stamps appear as defined. Note that you must display (or print) either all defined stamps, or none. You cannot, for example, choose to display the top left one and hide the bottom right one.

You can also request each of these stamp options using GetStampFont(-1, 0), GetStampString(-1, stampID), and GetStampParameter(-1, 0, parameterID).

See also