Mac OS X
Components Crossplatform Mac & Win Server Client Old Guides Examples
New in version: 7.1 7.2 7.3 7.4 7.5 8.0 8.1 8.2 8.3 8.4 Statistic
Attaches a file to the document.
|Component||Version||macOS||Windows||Server||FileMaker Cloud||FileMaker iOS SDK|
|The PDF reference returned from DynaPDF.New.|
|FilePath||The native file path for the file to attach.||"/Users/cs/Desktop/invoice.xml"|
The description for the file.
Pass 1 to compress or 0 to not compress.
You should pass 1 for text data like XML or JSON.
Returns handle for embedded file or error.
DescriptionAttaches a file to the document.
The description is optional, the parameter can be set to "". The embedded file is compressed if the parameter Compress is set to 1. Otherwise it is left uncompressed. It is not always useful to compress embedded files especially if the file is already compressed, e.g. Zip files or already compressed image formats require no further compression. In the worst case the compressed file becomes larger as the uncompressed version. However, text files and most document formats should be compressed to reduce the file size.
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.
See also AttachFile function in DynaPDF manual.
Created 15th December 2015, last changed 15th August 2016
Feedback: Report problem or ask question.
MBS Xojo PDF Plugins