Topics   All   MacOS (Only)   Windows (Only)   Linux (Only, Not)   iOS (Only, Not)  
Components   Crossplatform Mac & Win   Server   Client   Old   Deprecated   Guides   Examples   Videos
New in version: 12.2   12.3   12.4   12.5   13.0   13.1   13.2   13.3   13.4   13.5    Statistic    FMM    Blog  

DynaPDF.AttachFileContainer

Attaches a data from container to the document.

Component Version macOS Windows Linux Server iOS SDK
DynaPDF 6.0 ✅ Yes ✅ Yes ✅ Yes ✅ Yes ✅ Yes
MBS( "DynaPDF.AttachFileContainer"; PDF; Container; FileName { ; Description; Compress } )   More

Parameters

Parameter Description Example Flags
PDF The PDF reference returned from DynaPDF.New. $pdf
Container The container value to use. $xmlContainer
FileName The file name to display in PDF viewer. "ZUGfERD-invoice.xml"
Description The description for the file. "invoice.xml" Optional
Compress Pass 1 to compress or 0 to not compress.
You should pass 1 for text data like XML or JSON.
0 Optional

Result

Returns OK or error.

Description

Attaches a data from container 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.

See also AttachFileContainer function in DynaPDF manual.

See also

Release notes

Example Databases

Blog Entries

This function checks for a license.

Created 15th December 2015, last changed 15th August 2016


DynaPDF.AttachFile - DynaPDF.AttachFileText

💬 Ask a question or report a problem