Repository / FormLayout

Overview

The API of TFORMer SDK unifies the access to the information stored in a Repository and in a stand-alone FormLayout.

TFORMer Designer offers two possibilities to organize and use FormLayouts

• Stand-alone FormLayout
  A stand-alone FormLayout is represented by a single file (extension *.tff) stored in an arbitrary folder in the file system. A stand-alone FormLayout can be imagined like a very simple type of Repository which contains exactly one GlobalProject which stores the DataField definitions, DataSource definitions and - of course - the FormLayout itself.

• Repository
  A Repository is represented by a master file (extension *.tfr) and a subfolder structure on the file system. It references an arbitrary number of user defined Project objects containing one or multiple FormLayouts. Such user-defined Projects are used to divide a Repository into logical areas.

When to use a Repository?

The use of a Repository is recommended if you prefer to organize your FormLayouts and DataFields in a structured way or if you plan to create multiple FormLayouts which use the same data basis (e.g. same DataField definitions).

When to use a Stand-Alone FormLayouts?

You should use stand-alone FormLayouts if you are dealing with forms and label layouts which are not related to each other (e.g. using different DataFields).

The Repository API

TFORMer SDK provides an extensive set of API functions to access and modify the information stored in a Repository. With respect to the Repository API, a stand-alone FormLayout is treated like a simple Repository.

Note:

Please take in mind, that the Repository API does not allow you to modify or create the design of FormLayouts. This is only possible by using TFORMer Designer.

Additional Information

• Repository
  • Project
    • FormLayout
    • DataField
    • DataSource
    • JobTrayControl