Skip to main content

AddImageToDocument

Structure

AddImageToDocument(sDocFile, sImageFile: String; iTop, iLeft, iMaxHeight, iMaxWidth, iTransparency: Integer; bBox, bDeleteImageAfter: Boolean; sCaption: String; bFirstPageOnly: Boolean): Char

Parameters

| Parameter | Type | Description
| sDocFile | String | the original file to be updatedsImageFile | String | the image file to be addediTop | Integer | position of the image - topiLeft | Integer | position of the image - leftiMaxHeight | Integer | Maximum height of the image - if the image is larger it will be scalediMaxWidth | Integer | Maximum width of the image - if the image is larger it will be scalediTransparency | Integer | Transparency - percentage between 0 and 100bBox | Boolean | True or False - shows a box around the imagebDeleteImageAfter | Boolean | Delete the image file after it is added to the document (deletes from the IndySoft Temp directory)sCaption | String | If populated this text will be shown as a caption beneath the imagebFirstPageOnly | Boolean | True or False - whether you would like the image only added to the first page of the document or all pages |

Return Value

Char

'1' = Success, '0' = Failure. Success means the newly updated file exists

Description

Use this function to automatically add an image to a pdf file previously created. Note: position parameters are in units that are exactly 1/72 inches per unit, which is approximately the same as a "point", a unit used in the printing industry. 25.4 millimetres is one inch. |