TFORMer SDK - NET
8
|
Provides access to Project information of a Repository or a stand-alone link FormLayout. More...
Public Member Functions | |
DataField | AddDataField (string name) |
Creates and adds a DataField to the Project. | |
DataSource | AddDataSource (DataSourceType type, string name) |
Creates and adds a DataSource to the Project. | |
FormLayout | AddFormLayout (string name) |
Creates and adds a FormLayout to the Project. | |
void | Dispose () |
Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. | |
DataField | GetDataField (string name) |
Gets the DataField information from the Project. | |
DataSource | GetDataSource (string name) |
Gets the DataSource information from the Project. | |
FormLayout | GetFormLayout (string name) |
Gets the FormLayout information from the Project. | |
void | RemoveDataField (DataField field) |
Removes a DataField from the Project. | |
void | RemoveDataField (string name) |
Removes a DataField from the Project. | |
void | RemoveDataSource (DataSource dataSource) |
Removes the DataSource from the Project. | |
void | RemoveDataSource (string name) |
Removes the DataSource from the Project. | |
void | RemoveFormLayout (FormLayout form) |
Removes a FormLayout from the Project. | |
void | RemoveFormLayout (string name) |
Removes a FormLayout from the Project. | |
override string | ToString () |
Returns a string representation of the instance. | |
Properties | |
string | Comment [get, set] |
Gets/Sets the comment for the Project. | |
string | DefaultDirectory [get] |
Gets the default directory of the Project. | |
string | Description [get, set] |
Gets/Sets the description of the Project. | |
DataField | FirstDataField [get] |
Gets the first DataField of the Project. | |
DataSource | FirstDataSource [get] |
Gets the first DataSource defined in the Project. | |
FormLayout | FirstFormLayout [get] |
Gets the first FormLayout of the Project. | |
string | Name [get, set] |
Gets/Sets the name of the Project. | |
Project | Next [get] |
Gets the next Project defined in the Repository. | |
int | NumberOfDataFields [get] |
Gets the number of DataFields defined in the Project. | |
int | NumberOfDataSources [get] |
Gets the number of DataSources defined in the Project. | |
int | NumberOfFormLayouts [get] |
Gets the number of FormLayouts defined in this Project. |
Provides access to Project information of a Repository or a stand-alone link FormLayout.
This class is used to retrieve or set information belonging to a user-defined Project or to the GlobalProject.
A Project is a logical container for related FormLayout, DataSource and DataField definitions. It divides a Repository into logical units.
Exactly one GlobalProject is available for both a Repository or a stand-alone FormLayout. In the case of a Repository additional Project objects can be created by the user.
In order to access the DataFields in a Project you may either use the method Project.GetDataField or you may iterate through all available DataFields using Project.FirstDataField and DataField.Next. If you want to know, whether the returned DataField is actually used in a FormLayout you can use the method FormLayout.GetDataFieldUsage.
To retrieve all Project objects within a Repository do the following:
// Retrieve the first Project Project project = repository.FirstProject; while (project != null) { Console.Write(project.ToString()); // Get the next Project project = project.Next; }
DataField AddDataField | ( | string | name | ) |
DataSource AddDataSource | ( | DataSourceType | type, |
string | name | ||
) |
Creates and adds a DataSource to the Project.
type | The type of the DataSource |
name | The name of the DataSource to be added to the Project |
FormLayout AddFormLayout | ( | string | name | ) |
Creates and adds a FormLayout to the Project.
name | The name of the FormLayout to be added to the Project |
void Dispose | ( | ) |
Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
DataField GetDataField | ( | string | name | ) |
DataSource GetDataSource | ( | string | name | ) |
Gets the DataSource information from the Project.
name | The name of the DataSource to be retrieved from the Project |
null
FormLayout GetFormLayout | ( | string | name | ) |
Gets the FormLayout information from the Project.
name | The name of the FormLayout to be retrieved from the Project |
null
void RemoveDataField | ( | DataField | field | ) |
void RemoveDataField | ( | string | name | ) |
void RemoveDataSource | ( | DataSource | dataSource | ) |
Removes the DataSource from the Project.
dataSource | The DataSource to be removed from the Project |
void RemoveDataSource | ( | string | name | ) |
Removes the DataSource from the Project.
name | The name of the DataSource to be removed from the Project |
void RemoveFormLayout | ( | FormLayout | form | ) |
void RemoveFormLayout | ( | string | name | ) |
Removes a FormLayout from the Project.
name | Name of the FormLayout to be removed |
override string ToString | ( | ) |
Returns a string representation of the instance.
string Comment [get, set] |
string DefaultDirectory [get] |
string Description [get, set] |
DataField FirstDataField [get] |
DataSource FirstDataSource [get] |
Gets the first DataSource defined in the Project.
FormLayout FirstFormLayout [get] |
Gets the first FormLayout of the Project.
null
if no FormLayout existsGets the next Project defined in the Repository.
A Repository stores a list of Project objects. You can use this method to iterate through the list. To retrieve the first Project in the Repository see Repository.FirstProject.
null
. int NumberOfDataFields [get] |
int NumberOfDataSources [get] |
Gets the number of DataSources defined in the Project.
int NumberOfFormLayouts [get] |
Gets the number of FormLayouts defined in this Project.
© 2006-2024 - all rights reserved by TEC-IT Datenverarbeitung GmbH | |
Generated on Wed Aug 7 2024 17:29:42 for TFORMer SDK - NET with doxygen 1.7.6.1 |