DataSourceParameter Class Reference

Provides access to properties of a DataSourceParameter. More...

Public Member Functions
void	Dispose ()
	Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. More...
override string	ToString ()
	Returns a string representation of the instance. More...

Properties
string	Comment [get, set]
	Gets/Sets the comment of the DataSourceParameter. More...
string	DefValue [get, set]
	Gets/Sets the default value of the DataSourceParameter. More...
string	Description [get, set]
	Gets/Sets the description of the DataSourceParameter. More...
string	DisplayOrder [get, set]
	Gets/Sets the display order of the DataSourceParameter. More...
string	Name [get, set]
	Gets/Sets the name of the DataSourceParameter. More...
DataSourceParameter	Next [get]
	Gets the next DataSourceParameter defined in the DataSource. More...

Detailed Description

Provides access to properties of a DataSourceParameter.

Overview

A DataSourceParameter controls certain aspects of a DataSource during runtime (e.g. the filename of a DataSourceCsv, the SELECT statement of a DataSourceOdbc).

DataSourceParameters provide an elegant way to implement dynamic DataSources, without modifying the DataSource definition. They can be used to parameterize ODBC DataSources (DataSourceOdbc) and file-based DataSources (DataSourceCsv, DataSourceXml).

A typical scenario is the use of DataSourceParameters in the SQL SELECT statement of an DataSourceOdbc.
By this technique TFORMer can be instructed to fetch only specific records of a table or to change the sorting order via parameters.

DataSourceParameters can also be used in ComputedFields.

Example

Sample for using a data source parameter named parOrder:

Assume we have a Parameter named parOrder and want to use it in an SQL select statement.

SELECT * FROM tblOrders WHERE Order = [GetDSParam("parOrder")] 

Providing a parameter value of 4711 would result in the following statement:

SELECT * FROM tblOrders WHERE Order = 4711 

Member Function Documentation

Dispose()

void Dispose

(

)

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

ToString()

override string ToString

(

)

Returns a string representation of the instance.

Returns

A string representation of the instance

Property Documentation

Comment

string Comment

getset

Gets/Sets the comment of the DataSourceParameter.

Returns

The comment of the DataSourceParameter

DefValue

string DefValue

getset

Gets/Sets the default value of the DataSourceParameter.

Returns

The default value of the DataSourceParameter

Description

string Description

getset

Gets/Sets the description of the DataSourceParameter.

Returns

The description of the DataSourceParameter

DisplayOrder

string DisplayOrder

getset

Gets/Sets the display order of the DataSourceParameter.

Returns

The display order of the DataSourceParameter

Name

string Name

getset

Gets/Sets the name of the DataSourceParameter.

Returns

The name of the DataSourceParameter

Next

DataSourceParameter Next

get

Gets the next DataSourceParameter defined in the DataSource.

A DataSource stores a list of DataSourceParameter objects. You can use this method to iterate through the list. To retrieve the first DataSourceParameter in the Project see DataSource.FirstParameter.

Returns

The next DataSourceParameter object in the list or null