PDFKit.AddImageFilePage
Adds a new page to PDF document with given image file.
Component |
Version |
macOS |
Windows |
Linux |
Server |
iOS SDK |
PDFKit
|
7.2 |
✅ Yes |
❌ No |
❌ No |
✅ Yes, on macOS |
✅ Yes |
MBS( "PDFKit.AddImageFilePage"; PDF; FilePath { ; Width; Height } )
More
MBS(
"PDFKit.AddImageFilePage"; /* Adds a new page to PDF document with given image file. */
$PDF; /* A PDF reference number from
PDFKit.Open.e.g. $ref */
$FilePath; /* The file path to the image file to use.e.g. "/Users/cs/Desktop/test.png" */
$Width; /* Optional; The width for the new PDF page.e.g. 600 */
$Height) /* Optional; The height of the new PDF page.e.g. 800 */
Less
Parameters
Parameter |
Description |
Example |
Flags |
PDF |
A PDF reference number from PDFKit.Open. |
$ref |
|
FilePath |
The file path to the image file to use. |
"/Users/cs/Desktop/test.png" |
|
Width |
The width for the new PDF page. |
600 |
Optional |
Height |
The height of the new PDF page. |
800 |
Optional |
Result
Returns OK or error.
Description
Adds a new page to PDF document with given image file.
If you need more control about details, you may want to check DynaPDF functions.
Your changes are only done in memory, so please remember to write modified pdf back to disk, e.g. by using PDFKit.WriteToPath. Or use PDFKit.GetPDFDocument to get a PDF for storing in a container.
This function requires a native path. Use Path.FileMakerPathToNativePath to convert a FileMaker path to a native path if required. If you like to have the user choose the path, you can use FileDialog functions.
For Server be aware that server has limited permissions and may not be able to access all files on a computer.
Examples
Create PDF from image file:
Set Variable [$ref; Value:MBS("PDFKit.NewPDFDocument")]
Set Variable [$r; Value:MBS("PDFKit.AddImageFilePage"; $ref; "/Users/cs/Desktop/test.jpg"; 640; 480)]
Set Variable [$r; Value:MBS("PDFKit.WriteToPath"; $ref; "/Users/cs/Desktop/test.pdf")]
Set Variable [$result; Value:MBS("PDFKit.Release"; $ref)]
See also
Release notes
Blog Entries
This function checks for a license.
Created 9th May 2017, last changed 9th May 2017
PDFKit.AddEmptyPage
-
PDFKit.AddImagePage