AnnotateImage

Syntax

bool AnnotateImage (string displayText, string xCoordinate, string yCoordinate)

Parameters

string displayText

string xCoordinate

string yCoordinate

Parameters

Three parameters:

• displayText smart parameter supported string to be placed onto the image. The displayText can combine plain text along with smart parameters.
• xCoordinate The X coordinate for the starting position of the text on the image. Smart parameter supported.
• yCoordinate The Y coordinate for the starting position of the text on the image. Smart parameter supported.

Returns

False, if parameters are missing, or the X or Y parameters are not Numeric. Otherwise, True.

Level

Page level only.

Details

Imprints the text you specify onto the current page's image file. By default, the text's font size is 12, and font's style Times New Roman, with an adjusted width of 30.

Example:

SetFontName("Arial")
SetFontSize("10")
SetAdjustedWidth("100")
AnnotateImage("@BATCHID+ Page:+@ID","0","0")

This example places the Batch ID followed by Page: and the calling object ID at the top of the image using the Arial font with a point size of 10 and a width of 100.