This function adds an image when the PDF document is created.
Parameters
Name | Explanation |
---|---|
PSFSetInfo | Structure (user-defined type) variable that sets the conditions for PDF creation |
ImageHandle | The RAW data image handle for the image (only JPEG and PNG formats are supported) |
x | The horizontal coordinate where the image will be added. (The bottom left corner of the image is added at the x,y coordinate. Units are in millimeter) |
y | The vertical coordinate where the image will be added. (The bottom left corner of the image is added at the x,y coordinate. Units are in millimeter) |
size | Sets the text displayed in the title bar of the progress dialog box |
Return Value
Returns True (nonzero) if successful. Returns False (0) if unsuccessful.
Explanation
The IKPDFAddImage function adds an image when the PDF document is created. PDFSetInfo is also used with the IKPDFStart, IKPDFAddPage, IKPDFEndPage, and IKPDFEnd functions. Regarding SAVE_PDF_INFO, see the description of the member variables of SAVE_PDF_INFO in Ik10File.dll, Ik10FileA.dll, Ik10File64.dll, Ik10File64A.dll.
Set the image location using the x, y paramters. The bottom left corner of the image is attached to the x,y location. Set the length of the image's largest dimension, either the vertical or horizontal dimension, into the size parameter. The units are in millimeters. The aspect ratio of the original image will be maintained. It is possible to add multiple images in one page by repeating the IKPDFAddImage function, changing the ImageHandle, x,y, and size parameters and executing this function again.