The following Application Programming Interface functions to Image to PDF affect the make-up of a page in the produced PDF document:
I2PDF_ImageStamp | |
---|---|
Parameters: | image - must be one of the following image types: JPG, TIF, PNG, GIF, BMP, EMF, WMF, PCX or TGA verticalPosition - must be one of the following: VERTICAL_ALIGNMENT_TOP (1), VERTICAL_ALIGNMENT_MIDDLE (2) or VERTICAL_ALIGNMENT_BOTTOM (3) horizontalPosition - must be one of the following: HORIZONTAL_ALIGNMENT_LEFT (1), HORIZONTAL_ALIGNMENT_CENTER (2) or HORIZONTAL_ALIGNMENT_RIGHT (3) margin - must be a value between 0.0 and 100.0 points inclusive |
Return Value: | 0 - success 1 - invalid image parameter 2 - invalid verticalPosition parameter 3 - invalid horizontalPosition parameter 3 - invalid margin parameter |
Notes: |
I2PDF_ImageStamp_Int | |
---|---|
Parameters: | image - must be one of the following image types: JPG, TIF, PNG, GIF, BMP, EMF, WMF, PCX or TGA verticalPosition - must be one of the following: VERTICAL_ALIGNMENT_TOP (1), VERTICAL_ALIGNMENT_MIDDLE (2) or VERTICAL_ALIGNMENT_BOTTOM (3) horizontalPosition - must be one of the following: HORIZONTAL_ALIGNMENT_LEFT (1), HORIZONTAL_ALIGNMENT_CENTER (2) or HORIZONTAL_ALIGNMENT_RIGHT (3) margin - must be an integer value between 0 and 100 points inclusive |
Return Value: | 0 - success 1 - invalid image parameter 2 - invalid verticalPosition parameter 3 - invalid horizontalPosition parameter 3 - invalid margin parameter |
Notes: |
I2PDF_StampURL | |
---|---|
Parameters: | url - can be up to 128 characters long and should include the Internet protocol, eg http:// |
Return Value: | 0 - success 1 - invalid url parameter |
Notes: |
I2PDF_SetBorder | |
---|---|
Parameters: | left - amount of space (from 0.0 to 500.0 points) between the image left hand side and the edge of the PDF page top - amount of space (from 0.0 to 500.0 points) between the image top side and the edge of the PDF page right - amount of space (from 0.0 to 500.0 points) between the image right hand side and the edge of the PDF page bottom - amount of space (from 0.0 to 500.0 points) between the image bottom side and the edge of the PDF page |
Return Value: | 0 - success 1 - left value is invalid 2 - top value is invalid 3 - right value is invalid 4 - bottom value is invalid |
Notes: |
I2PDF_SetBorder_Int | |
---|---|
Parameters: | left - amount of space (from 0 to 500 points) between the image left hand side and the edge of the PDF page top - amount of space (from 0 to 500 points) between the image top side and the edge of the PDF page right - amount of space (from 0 to 500 points) between the image right hand side and the edge of the PDF page bottom - amount of space (from 0 to 500 points) between the image bottom side and the edge of the PDF page |
Return Value: | 0 - success 1 - left value is invalid 2 - top value is invalid 3 - right value is invalid 4 - bottom value is invalid |
Notes: |
I2PDF_SetBorderColor_Real | |
---|---|
Parameters: | red - red color component (from 0.0 to 1.0) green - green color component (from 0.0 to 1.0) blue - blue color component (from 0.0 to 1.0) |
Return Value: | 0 - success 1 - red value is invalid 2 - green value is invalid 3 - blue value is invalid |
Notes: |
I2PDF_SetBorderColor_Int | |
---|---|
Parameters: | red - red color component (from 0 to 255) green - green color component (from 0 to 255) blue - blue color component (from 0 to 255) |
Return Value: | 0 - success 1 - red value is invalid 2 - green value is invalid 3 - blue value is invalid |
Notes: |
I2PDF_SetBorderColor_Web | |
---|---|
Parameters: | color - specified as a hexadecimal string (from #000000 to #FFFFFF) |
Return Value: | 0 - success 1 - color value is invalid |
Notes: |