TFORMer SDK - NET 8
|
Specialized DataSource for XML data. More...
Public Member Functions | |
ComputedField | AddComputedField (string name) |
Creates and adds a ComputedField to the DataSource. More... | |
DSFieldMapping | AddFieldMapping (string name) |
Creates and adds a DSFieldMapping to the DataSource. More... | |
DataSourceParameter | AddParameter (string name) |
Creates and adds a DataSourceParameter to the DataSource. More... | |
void | Dispose () |
Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. More... | |
ComputedField | GetComputedField (string name) |
Gets a ComputedField defined in the DataSource. More... | |
DSFieldMapping | GetFieldMapping (string name) |
Gets a DSFieldMapping defined in the DataSource. More... | |
DataSourceParameter | GetParameter (string name) |
Gets a DataSourceParameter defined in the DataSource. More... | |
void | RemoveComputedField (ComputedField computedField) |
Removes the ComputedField from the DataSource. More... | |
void | RemoveComputedField (string name) |
Removes the ComputedField from the DataSource. More... | |
void | RemoveFieldMapping (DSFieldMapping fieldMapping) |
Removes the DSFieldMapping from the DataSource. More... | |
void | RemoveFieldMapping (string name) |
Removes the DSFieldMapping from the DataSource. More... | |
void | RemoveParameter (DataSourceParameter datasourceParameter) |
Removes the DataSourceParameter from the DataSource. More... | |
void | RemoveParameter (string name) |
Removes the DataSourceParameter from the DataSource. More... | |
override string | ToString () |
Returns a string representation of the instance. More... | |
Properties | |
string | Comment [get, set] |
Gets/Sets the comment for the DataSource. More... | |
string | CopyColumnName [get, set] |
Gets/Sets the CopyColumnName of the DataSource. More... | |
string | Description [get, set] |
Gets/Sets the description of the DataSource. More... | |
string | Filename [get, set] |
Gets/Sets the filename of the XML-file. More... | |
ComputedField | FirstComputedField [get] |
Gets the first ComputedField defined in the DataSource. More... | |
DSFieldMapping | FirstFieldMapping [get] |
Gets the first DSFieldMapping defined in the DataSource. More... | |
DataSourceParameter | FirstParameter [get] |
Gets the first DataSourceParameter defined in the DataSource. More... | |
bool | HandleEscapeSequences [get, set] |
Gets/Sets if escape sequences should be translated on data retrieval or not. More... | |
bool | IsDefault [get] |
Gets a value indicating whether this object stores the default DataSource. More... | |
string | Name [get, set] |
Gets/Sets the name of the DataSource. More... | |
DataSource | Next [get] |
Gets the next DataSource instance defined in the Project. More... | |
int | NumberOfComputedFields [get] |
Gets the number of ComputedFields defined in the DataSource. More... | |
int | NumberOfFieldMappings [get] |
Gets the number of DSFieldMappings defined in the DataSource. More... | |
int | NumberOfParameters [get] |
Gets the number of DataSourceParameters defined in the DataSource. More... | |
DataSourceType | Type [get] |
Gets the type of the DataSource. More... | |
string | XsltFilename [get, set] |
Gets/Sets the filename of the XSLT file for transforming the XML file. More... | |
Specialized DataSource for XML data.
DataSourceXml is a specialized DataSource for importing data from XML-Files. This class is used to manipulate existing DataSourceXml objects.
To create a new DataSource use TFORMer Designer or Project.AddDataSource.
The main properties to characterize a DataSourceXml are:
Sample source code for modifying an existing DataSourceXml:
|
inherited |
Creates and adds a ComputedField to the DataSource.
name | The name of the ComputedField |
|
inherited |
Creates and adds a DSFieldMapping to the DataSource.
name | The name of the DataField for which a DSFieldMapping should be created. |
|
inherited |
Creates and adds a DataSourceParameter to the DataSource.
name | The name of the DataSourceParameter |
|
inherited |
Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
|
inherited |
Gets a ComputedField defined in the DataSource.
name | The name of the ComputedField |
null
|
inherited |
Gets a DSFieldMapping defined in the DataSource.
Retrieves the DSFieldMapping for a given DataField name from the DataSource
name | The name of a DataField |
null
|
inherited |
Gets a DataSourceParameter defined in the DataSource.
name | The name of the DataSourceParameter |
null
|
inherited |
Removes the ComputedField from the DataSource.
computedField | The ComputedField |
|
inherited |
Removes the ComputedField from the DataSource.
name | The name of the ComputedField |
|
inherited |
Removes the DSFieldMapping from the DataSource.
fieldMapping | The DSFieldMapping |
|
inherited |
Removes the DSFieldMapping from the DataSource.
name | The name of the DataField for which the mapping should be deleted |
|
inherited |
Removes the DataSourceParameter from the DataSource.
datasourceParameter | The DataSourceParameter |
|
inherited |
Removes the DataSourceParameter from the DataSource.
name | The name of the DataSourceParameter |
override string ToString | ( | ) |
Returns a string representation of the instance.
|
getsetinherited |
Gets/Sets the comment for the DataSource.
|
getsetinherited |
Gets/Sets the CopyColumnName of the DataSource.
|
getsetinherited |
Gets/Sets the description of the DataSource.
|
getset |
Gets/Sets the filename of the XML-file.
|
getinherited |
Gets the first ComputedField defined in the DataSource.
null
|
getinherited |
Gets the first DSFieldMapping defined in the DataSource.
null
|
getinherited |
Gets the first DataSourceParameter defined in the DataSource.
null
|
getsetinherited |
Gets/Sets if escape sequences should be translated on data retrieval or not.
true
if escape sequences should be translated.
|
getinherited |
Gets a value indicating whether this object stores the default DataSource.
true
if this DataSource is the default DataSource.
|
getsetinherited |
Gets/Sets the name of the DataSource.
|
getinherited |
Gets the next DataSource instance defined in the Project.
A Project stores a list of DataSource objects. To retrieve the first DataSource in the Project see Project.FirstDataSource.
null
if there aren't other instances in the Project, otherwise a valid instance of this class (DataSourceCsv, DataSourceOdbc or DataSourceXml)
|
getinherited |
Gets the number of ComputedFields defined in the DataSource.
|
getinherited |
Gets the number of DSFieldMappings defined in the DataSource.
|
getinherited |
Gets the number of DataSourceParameters defined in the DataSource.
|
getinherited |
Gets the type of the DataSource.
The DataSourceType is read-only, and is set on creation. It specifies the type of a DataSource (e.g. DataSourceOdbc, DataSourceCsv, DataSourceXml).
|
getset |
Gets/Sets the filename of the XSLT file for transforming the XML file.
© 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 |