Public Member Functions |
void | Design (string designer, bool showSplashScreen, bool maximizeWindow, bool useExistingInstance, string extraParameters) |
| Opens the FormLayout with <em>TFORMer Designer</em>.
|
void | Dispose () |
| Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
|
DataFieldUsage | GetDataFieldUsage (string dataFieldName) |
| Retrieves the usage of a specific DataField in a FormLayout.
|
override string | ToString () |
| Returns a string representation of the instance.
|
Properties |
string | Comment [get, set] |
| Gets/Sets the comment for the FormLayout.
|
string | Description [get, set] |
| Gets/Sets the description of the FormLayout.
|
string | Filename [get, set] |
| Gets/Sets the filename of the FormLayout.
|
string | Name [get, set] |
| Gets/Sets the name of the FormLayout.
|
FormLayout | Next [get] |
| Gets the next FormLayout in the Project.
|
Provides access to a FormLayout which is referenced by a \link TECIT.TFORMer.Repository Repository\endlink 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).
- Note:
- It is not possible to change the appearance of the FormLayout (like adding new elements or bands) with this class. Design tasks are supported by TFORMer Designer only.
Repository-based FormLayouts
General
Printing
When printing a specific
FormLayout within a
Repository 3 parameters must be specified to identify the
FormLayout:
Stand-Alone FormLayout
General
Printing
When printing a
Job using a stand-alone
FormLayout 1 parameter must be specified:
- Note:
- Do not use Job.ProjectName and Job.FormName when using a stand-alone FormLayout!
Determining Used DataFields
In order to access the data-fields in a
FormLayout you may either use the method
Project.GetDataField or you may iterate through all available data-fields using
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:
Project project = repository.GlobalProject;
if (project != null)
{
Console.Write(project.ToString());
FormLayout formlayout = project.FirstFormLayout;
if (formlayout != null)
{
Console.Write(formlayout.ToString());
}
}
To retrieve all FormLayout objects within a Repository do the following:
Project project = repository.FirstProject;
while (project != null)
{
Console.Write(project.ToString());
FormLayout formlayout = project.FirstFormLayout;
while (formlayout != null)
{
Console.Write(formlayout.ToString());
formlayout = formlayout.Next;
}
project = project.Next;
}
@attention
The FormLayout is only valid as long as it is available in the \link TECIT.TFORMer.Project Project\endlink. If it is removed from the Project all instances of the FormLayout become invalid immediately.
@note
Thread-safety: A single instance of this class must not be used by different threads.