Passing Files

Methods for passing files to TFORMer SDK.

Overview

TFORMer SDK provides various methods for passing files to the SDK. The developer can choose between passing files (the usual method) or passing BASE64 encoded strings. BASE64 strings are the perfect way to transfer file contents via web to TFORMer SDK. Files or BASE64 strings may also be zipped to save space and/or bandwidth. In addition, BASE64 strings may be embedded directly in HTML code. This is especially of interest if using the COM component with Microsoft Internet Explorer for client side printing.

If properties or methods of TFORMer SDK are requesting filenames (e.g. FormLayouts, configuration file or file-based DataSources like XML or CSV files), these files may be passed in the following ways:

• Specify the filename directly.
• Specify the filename of a ZIP-file containing this file
  In order to minimize file sizes you may use WinZip (or a similar tool) to compress the file in question. When zipping a Repository take care to zip all subdirectories as well. When zipping a stand-alone FormLayout take care to include required image files.
• BASE64-encode the content of the required file
  Pass the BASE64 encoded string instead of a filename. The string must start with the sequence BASE64:. When using this method the FormLayout must not use embedded images.
• BASE64-encode the content of a ZIP-file
  Pass the BASE64 encoded string instead of a filename. The string must start with the sequence BASE64:. When zipping a Repository take care to zip all subdirectories as well. When zipping a stand-alone FormLayout take care to include required image files.

Attention:

• BASE64 encoded strings must start with the sequence BASE64:.
• When passing a zipped file TFORMer expects a real WinZip compatible format. A zipped stream is not suitable!

More Information

For more details please refer to TFORMer Developer Manual.

See also:

TFORMer.XML Configuration File, DataSource