FormLayout class

Provides access to a FormLayout which is referenced by a Repository or available as stand-alone FormLayout.

Overview

A FormLayout is a document which was created with TFORMer Designer. This class is used to retrieve or set information belonging to a FormLayout.

A typical FormLayout contains static content (like a logo), dynamic content (like a DataField) and a number of properties which are used to describe the FormLayout and its behavior during print-time. Each FormLayout is member of exactly one Project (in the case of a Repository) or the GlobalProject (in the case of a stand-alone FormLayout).

Repository-based FormLayouts

General

• Each FormLayout referenced from within a Repository is a member of exactly one Project.

• DataFields defined within a Project are only usable by FormLayouts which are member of this Project.

• The so-called GlobalProject is allocated by default and is exclusively used to define DataFields and DataSources which are available for all FormLayouts (regardless of their actual Project membership). It can not store references to a FormLayout.

• The Repository also stores JobTrayControl objects (see Job.JobTrayControlName).

• A Repository uses the file extension *.tfr.

Printing

When printing a specific FormLayout within a Repository 3 parameters must be specified to identify the FormLayout:

• The Repository name (which is identical to the filename of the Repository, see Job.RepositoryName)

• The Project name as defined by the user in TFORMer Designer (see Job.ProjectName)

• The FormLayout name as defined by the user in TFORMer Designer (see Job.FormName)

Stand-Alone FormLayout

General

• A stand-alone FormLayout can be used on its own and can be imagined like a very simple type of Repository which contains exactly one Project (namely the GlobalProject).

• A stand-alone FormLayout stores the DataField definitions, JobTrayControl definitions, DataSource definitions as well as the FormLayout itself. It is not able to share DataField definitions with other FormLayouts and can not contain user-defined Project objects.

• A stand-alone FormLayout uses the file extension *.tff.

Printing

When printing a Job using a stand-alone FormLayout 1 parameter must be specified:

• The Repository name (which is identical to the filename of the stand-alone FormLayout, see Job.RepositoryName)

Determining Used DataFields

To find a data-field by name, use Project.GetDataField. To iterate through the available data-fields, use Project.FirstDataField and DataField.Next. If you want to know, whether the returned DataField is actually used you can use the method FormLayout.GetDataFieldUsage.

Sample

To retrieve the FormLayout object within a stand-alone FormLayout do the following:

  // Retrieve the global Project 
  // A stand-alone FormLayout contains only the global Project, the global Project contains the FormLayout
  Project project = repository.GlobalProject;

  if (project != null)
  {
    Console.Write(project.ToString());

    // Retrieve the first (and only) FormLayout
    FormLayout formlayout = project.FirstFormLayout;
    if (formlayout != null)
    {
      Console.Write(formlayout.ToString());
    }
  }

To retrieve all FormLayout objects within a Repository do the following:

  // Retrieve the first Project 
  Project project = repository.FirstProject;

  while (project != null)
  {
    Console.Write(project.ToString());

    // Retrieve the first FormLayout in this Project
    FormLayout formlayout = project.FirstFormLayout;

    while (formlayout != null)
    {
      Console.Write(formlayout.ToString());

      // Get the next FormLayout in this Project
      formlayout = formlayout.Next;
    }

    // Get the next Project
    project = project.Next;
  }