Specialized DataSource for ODBC data. More...

Public Member Functions
ComputedField	AddComputedField (string name)
	Creates and adds a ComputedField to the DataSource.
DSFieldMapping	AddFieldMapping (string name)
	Creates and adds a DSFieldMapping to the DataSource.
DataSourceParameter	AddParameter (string name)
	Creates and adds a DataSourceParameter to the DataSource.
void	Dispose ()
	Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
ComputedField	GetComputedField (string name)
	Gets a ComputedField defined in the DataSource.
DSFieldMapping	GetFieldMapping (string name)
	Gets a DSFieldMapping defined in the DataSource.
DataSourceParameter	GetParameter (string name)
	Gets a DataSourceParameter defined in the DataSource.
void	RemoveComputedField (string name)
	Removes the ComputedField from the DataSource.
void	RemoveComputedField (ComputedField computedField)
	Removes the ComputedField from the DataSource.
void	RemoveFieldMapping (string name)
	Removes the DSFieldMapping from the DataSource.
void	RemoveFieldMapping (DSFieldMapping fieldMapping)
	Removes the DSFieldMapping from the DataSource.
void	RemoveParameter (string name)
	Removes the DataSourceParameter from the DataSource.
void	RemoveParameter (DataSourceParameter datasourceParameter)
	Removes the DataSourceParameter from the DataSource.
override string	ToString ()
	Returns a string representation of the instance.
Properties
string	Comment `[get, set]`
	Gets/Sets the comment for the DataSource.
string	CopyColumnName `[get, set]`
	Gets/Sets the CopyColumnName of the DataSource.
string	Description `[get, set]`
	Gets/Sets the description of the DataSource.
string	Dsn `[get, set]`
	Gets/Sets the DSN of the DataSourceOdbc.
ComputedField	FirstComputedField `[get]`
	Gets the first ComputedField defined in the DataSource.
DSFieldMapping	FirstFieldMapping `[get]`
	Gets the first DSFieldMapping defined in the DataSource.
DataSourceParameter	FirstParameter `[get]`
	Gets the first DataSourceParameter defined in the DataSource.
bool	HandleEscapeSequences `[get, set]`
	Gets/Sets if escape sequences should be translated on data retrieval or not.
bool	IsDefault `[get]`
	Gets a value indicating whether this object stores the default DataSource.
string	Name `[get, set]`
	Gets/Sets the name of the DataSource.
DataSource	Next `[get]`
	Gets the next DataSource instance defined in the Project.
int	NumberOfComputedFields `[get]`
	Gets the number of ComputedFields defined in the DataSource.
int	NumberOfFieldMappings `[get]`
	Gets the number of DSFieldMappings defined in the DataSource.
int	NumberOfParameters `[get]`
	Gets the number of DataSourceParameters defined in the DataSource.
string	Password `[get, set]`
	Gets/Sets the password for the database connection.
string	SqlSelect `[get, set]`
	Gets/Sets the SQL SELECT statement of the DataSourceOdbc.
DataSourceType	Type `[get]`
	Gets the type of the DataSource.
string	User `[get, set]`
	Gets/Sets the user-name for the database connection.

Detailed Description

Specialized DataSource for ODBC data.

Overview

DataSourceOdbc is a specialized DataSource for importing data from an ODBC database. This class is used to manipulate existing DataSourceOdbc objects. To create a new DataSource use TFORMer Designer or Project.AddDataSource.

The main properties to characterize a DataSourceOdbc are:

The DSN
The DSN represents the name of the database connection as defined in the Microsoft Windows Control Panel. Please keep in mind that the DSN is a part of the connection string and thus a complete specification is required.
The user name
It depends on the database connection if the user-name is required or not.
The password
It depends on the database connection if the password is required or not.
The SQL SELECT statement
The column names returned by the SQL SELECT statement should match the names of the DataFields in the FormLayout. Use SQL aliases if required.

Modifying an Existing ODBC DataSource

Sample source code for modifying an existing ODBC-DataSource:

  // Retrieve the global Project
  // DataSources are defined in a Project or a global Project
  Project project = repository.GlobalProject;

  // Retrieve the DataSource by name
  // Since we know the type of the DataSource, we can cast it to DataSourceOdbc
  DataSourceOdbc dataSource = (DataSourceOdbc) (project.GetDataSource("ODBC"));

  // Modify some DataSource properties  
  dataSource.User = "";
  dataSource.Password = "";

Member Function Documentation

ComputedField AddComputedField ( string name ) [inherited]

Creates and adds a ComputedField to the DataSource.

Parameters:

name	The name of the ComputedField

Returns:: A new ComputedField

See also:: ComputedField

DSFieldMapping AddFieldMapping ( string name ) [inherited]

Creates and adds a DSFieldMapping to the DataSource.

Parameters:

name	The name of the DataField for which a DSFieldMapping should be created.

Returns:: A new DSFieldMapping

DataSourceParameter AddParameter ( string name ) [inherited]

Creates and adds a DataSourceParameter to the DataSource.

Parameters:

name	The name of the DataSourceParameter

Returns:: A new DataSourceParameter

See also:: DataSourceParameter

void Dispose ( ) [inherited]

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

ComputedField GetComputedField ( string name ) [inherited]

Gets a ComputedField defined in the DataSource.

Parameters:

name	The name of the ComputedField

Returns:: A valid object instance or null

See also:: ComputedField

DSFieldMapping GetFieldMapping ( string name ) [inherited]

Gets a DSFieldMapping defined in the DataSource.

Retrieves the DSFieldMapping for a given DataField name from the DataSource

Parameters:

name	The name of a DataField

Returns:: A valid object instance or null

DataSourceParameter GetParameter ( string name ) [inherited]

Gets a DataSourceParameter defined in the DataSource.

Parameters:

name	The name of the DataSourceParameter

Returns:: A valid object instance or null

See also:: DataSourceParameter

void RemoveComputedField ( string name ) [inherited]

Removes the ComputedField from the DataSource.

Parameters:

name	The name of the ComputedField

See also:: ComputedField

void RemoveComputedField ( ComputedField computedField ) [inherited]

Removes the ComputedField from the DataSource.

Parameters:

computedField The ComputedField

See also:: ComputedField

void RemoveFieldMapping ( string name ) [inherited]

Removes the DSFieldMapping from the DataSource.

Parameters:

name	The name of the DataField for which the mapping should be deleted

void RemoveFieldMapping ( DSFieldMapping fieldMapping ) [inherited]

Removes the DSFieldMapping from the DataSource.

Parameters:

fieldMapping The DSFieldMapping

void RemoveParameter ( string name ) [inherited]

Removes the DataSourceParameter from the DataSource.

Parameters:

name	The name of the DataSourceParameter

See also:: DataSourceParameter

void RemoveParameter ( DataSourceParameter datasourceParameter ) [inherited]

Removes the DataSourceParameter from the DataSource.

Parameters:

datasourceParameter The DataSourceParameter

See also:: DataSourceParameter

override string ToString ( )

Returns a string representation of the instance.

Returns:: A string representation of the instance

Reimplemented from DataSource.

Property Documentation

string Comment [get, set, inherited]

Gets/Sets the comment for the DataSource.

Returns:: The comment for the DataSource

string CopyColumnName [get, set, inherited]

Gets/Sets the CopyColumnName of the DataSource.

Returns:: The CopyColumnName of the DataSource

See also:: DataSource

string Description [get, set, inherited]

Gets/Sets the description of the DataSource.

Returns:: The description of the DataSource

string Dsn [get, set]

Gets/Sets the DSN of the DataSourceOdbc.

The DSN represents the name of the database connection as defined in the Microsoft Windows Control Panel. Please keep in mind that the DSN is a part of the connection string and thus a complete specification is required.

Returns:: The DSN of the DataSourceOdbc

ComputedField FirstComputedField [get, inherited]

Gets the first ComputedField defined in the DataSource.

Returns:: The first ComputedField object in the list or null

See also:: ComputedField

DSFieldMapping FirstFieldMapping [get, inherited]

Gets the first DSFieldMapping defined in the DataSource.

Returns:: The first DSFieldMapping in the list or null

DataSourceParameter FirstParameter [get, inherited]

Gets the first DataSourceParameter defined in the DataSource.

Returns:: The first DataSourceParameter defined in the DataSource or null

See also:: DataSourceParameter

bool HandleEscapeSequences [get, set, inherited]

Gets/Sets if escape sequences should be translated on data retrieval or not.

Returns:: true if escape sequences should be translated.

See also:: Escape Sequences, DataSource

bool IsDefault [get, inherited]

Gets a value indicating whether this object stores the default DataSource.

Returns:: true if this DataSource is the default DataSource.

See also:: DataSource

string Name [get, set, inherited]

Gets/Sets the name of the DataSource.

Returns:: The name of the DataSource

DataSource Next [get, inherited]

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.

Returns:: null if there aren't other instances in the Project, otherwise a valid instance of this class (DataSourceCsv, DataSourceOdbc or DataSourceXml)

See also:: Project

int NumberOfComputedFields [get, inherited]

Gets the number of ComputedFields defined in the DataSource.

Returns:: The number of ComputedFields defined in the DataSource

See also:: ComputedField

int NumberOfFieldMappings [get, inherited]

Gets the number of DSFieldMappings defined in the DataSource.

Returns:: The number of DSFieldMappings defined in the DataSource

int NumberOfParameters [get, inherited]

Gets the number of DataSourceParameters defined in the DataSource.

Returns:: The number of DataSourceParameters defined in the DataSource

See also:: DataSourceParameter

string Password [get, set]

Gets/Sets the password for the database connection.

It depends on the database connection if the password is required or not.

Returns:: The password for the DSN

string SqlSelect [get, set]

Gets/Sets the SQL SELECT statement of the DataSourceOdbc.

Returns:: The SQL SELECT statement of the DataSourceOdbc

DataSourceType Type [get, inherited]

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).

Returns:: The DataSourceType of the DataSource

string User [get, set]

Gets/Sets the user-name for the database connection.

It depends on the database connection if the user-name is required or not.

Returns:: The user-name for the DSN

© 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

Public Member Functions

Properties

Detailed Description

Overview

Modifying an Existing ODBC DataSource

Member Function Documentation

Property Documentation