TFORMer SDK - NET 8
|
Provides access to a FormLayout which is referenced by a Repository or available as stand-alone FormLayout. More...
Public Member Functions | |
void | Design (string designer, bool showSplashScreen, bool maximizeWindow, bool useExistingInstance, string extraParameters) |
Opens the FormLayout with TFORMer Designer. More... | |
void | Dispose () |
Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. More... | |
DataFieldUsage | GetDataFieldUsage (string dataFieldName) |
Retrieves the usage of a specific DataField in a FormLayout. More... | |
override string | ToString () |
Returns a string representation of the instance. More... | |
Properties | |
string | Comment [get, set] |
Gets/Sets the comment for the FormLayout. More... | |
string | Description [get, set] |
Gets/Sets the description of the FormLayout. More... | |
string | Filename [get, set] |
Gets/Sets the filename of the FormLayout. More... | |
string | Name [get, set] |
Gets/Sets the name of the FormLayout. More... | |
FormLayout | Next [get] |
Gets the next FormLayout in the Project. More... | |
Provides access to a FormLayout which is referenced by a Repository or available as stand-alone FormLayout.
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).
*.tfr
.When printing a specific FormLayout within a Repository 3 parameters must be specified to identify the FormLayout:
*.tff
.When printing a Job using a stand-alone FormLayout 1 parameter must be specified:
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.
To retrieve the FormLayout object within a stand-alone FormLayout do the following:
To retrieve all FormLayout objects within a Repository do the following:
void Design | ( | string | designer, |
bool | showSplashScreen, | ||
bool | maximizeWindow, | ||
bool | useExistingInstance, | ||
string | extraParameters | ||
) |
Opens the FormLayout with TFORMer Designer.
TFORMer SDK on its own cannot be used for editing a FormLayout. Use this method to invoke TFORMer Designer.
designer | The path and name of the TFORMer Designer executable. If null then the method tries to find the executable automatically |
showSplashScreen | If set to true the splash screen is shown |
maximizeWindow | If set to true the TFORMer Designer windows is maximized |
useExistingInstance | If set to true the form-layout will be opened in an already running TFORMer Designer instance |
extraParameters | Additional parameters that will be passed to TFORMer Designer |
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.
dataFieldName | Name of the DataField to be queried. |
null
Sample: To query all DataField-objects within a stand-alone FormLayout refer to the code below. The same principle can be used for a Repository-based FormLayout.
override string ToString | ( | ) |
Returns a string representation of the instance.
|
getset |
Gets/Sets the comment for the FormLayout.
|
getset |
Gets/Sets the description of the FormLayout.
|
getset |
Gets/Sets the filename of the FormLayout.
|
getset |
Gets/Sets the name of the FormLayout.
|
get |
Gets the next FormLayout in the Project.
To retrieve the first FormLayout within a Project (or the GlobalProject) refer to Project.FirstFormLayout. When using a stand-alone FormLayout this property always returns null
. In this case only one FormLayout is available - it can be retrieved via Repository.GlobalProject.
null
.© 2006-2023 - all rights reserved by TEC-IT Datenverarbeitung GmbH | |
Generated on Thu Dec 28 2023 18:45:19 for TFORMer SDK - NET with doxygen 1.9.4 |