Ict.Common.Data.TTypedDataSet Class Reference

our own Typed Dataset base class More...

Inheritance diagram for Ict.Common.Data.TTypedDataSet:

Classes
class	TOtherDataSet
	helper class to be able to use the standard serialization constructor More...

Public Member Functions
abstract void	InitVars ()
	for initialising the columns implemented by generated code More...
	TTypedDataSet ()
	default constructor More...
	TTypedDataSet (string ADatasetName)
	constructor with dataset name More...
override DataSet	Clone ()
	also copy the constraints and relations arrays More...
void	InitClass ()
	Initialise the class, calling abstract routines in the right order More...
new void	Merge (DataTable ATable)
	overload that makes sure that the typed tables are mapped again More...
new void	Merge (DataSet ADataSet)
	overload that makes sure that the typed tables are mapped again More...
new void	Merge (DataSet ADataSet, bool APreserveChanges)
	overload that makes sure that the typed tables are mapped again More...
DataColumn[]	GetDataColumnArrayFromString (DataTable ATable, string[] AKeys)
	This returns an array of DataColumns, based on a Array of strings of column names of a given table More...
void	EnableConstraint (TTypedConstraint AConstraint)
	enable a specific constraint More...
void	EnableConstraints ()
	Will add the constraints to the tables. The constraints should have been before added to FConstraints. Constraints will only be added if they don't exist already More...
void	DisableConstraints ()
	disable all the constraints More...
void	EnableConstraint (String AName)
	Enable a specific constraint More...
void	DisableConstraint (String AName)
	Disable a specific constraint More...
void	DisableRelationConstraints ()
	Disable all constraints created because of a relation More...
void	EnableRelations ()
	Will add the relations to the tables. The relations should have been before added to FRelations. Relations will only be added if they don't exist already More...
void	EnableRelation (String AName)
	Enable a specific relation More...
void	DisableRelation (String AName)
	Disable a specific relation More...
virtual TTypedDataSet	GetChangesTyped (Boolean removeEmptyTables)
	returns a dataset with only necessary data depending on the parameter removeEmptyTables, the empty tables are not returned all rows that are not changed are not returned More...
void	RemoveTable (String ATableName)
	Remove a table fromt the dataset, and all constraints and references refering to it More...
void	RemoveTables (StringCollection ATableNames)
	remove a list of tables from the dataset (StringCollection) More...
void	RemoveTables (string[] ATableNames)
	remove a list of tables from the dataset (array of string) More...
void	RemoveEmptyTables ()
	remove all tables from the dataset that are empty More...

Protected Member Functions
abstract void	InitTables ()
	for initialising the tables implemented by generated code More...
abstract void	InitTables (DataSet ds)
	for initialising the tables, of a specific dataset implemented by generated code More...
abstract void	InitConstraints ()
	for initialising the constraints implemented by generated code More...
virtual void	MapTables ()
	make sure that the typed variables are all referencing to the dataset More...
void	EnableRelation (TTypedRelation ARelation)
	enable a specific relation More...

Protected Attributes
ArrayList	FConstraints
	constraints in this dataset More...
ArrayList	FRelations
	relations in this dataset More...

Properties
bool	ThrowAwayAfterSubmitChanges [get, set]
	if you want the dataset to be cleared after submitchanges. This will increase the speed significantly: no updating of modificationID, no slow AcceptChanges. More...
bool	DontThrowAwayAfterSubmitChanges [get, set]
	if you want no warning about that the datatable should be cleared after submitchanges. in some cases you must keep the data, eg when you need the new keys after INSERT More...

Detailed Description

our own Typed Dataset base class

Constructor & Destructor Documentation

TTypedDataSet() [1/2]

Ict.Common.Data.TTypedDataSet.TTypedDataSet ( )

inline

default constructor

TTypedDataSet() [2/2]

Ict.Common.Data.TTypedDataSet.TTypedDataSet ( string  ADatasetName )

inline

constructor with dataset name

Parameters

ADatasetName

name for the new typed dataset

Member Function Documentation

Clone()

override DataSet Ict.Common.Data.TTypedDataSet.Clone ( )

inline

also copy the constraints and relations arrays

Returns

cloned Dataset

DisableConstraint()

void Ict.Common.Data.TTypedDataSet.DisableConstraint ( String  AName )

inline

Disable a specific constraint

Returns

void

DisableConstraints()

void Ict.Common.Data.TTypedDataSet.DisableConstraints ( )

inline

disable all the constraints

DisableRelation()

void Ict.Common.Data.TTypedDataSet.DisableRelation ( String  AName )

inline

Disable a specific relation

Returns

void

DisableRelationConstraints()

void Ict.Common.Data.TTypedDataSet.DisableRelationConstraints ( )

inline

Disable all constraints created because of a relation

Returns

void

EnableConstraint() [1/2]

void Ict.Common.Data.TTypedDataSet.EnableConstraint ( String  AName )

inline

Enable a specific constraint

Returns

void

EnableConstraint() [2/2]

void Ict.Common.Data.TTypedDataSet.EnableConstraint ( TTypedConstraint  AConstraint )

inline

enable a specific constraint

Returns

void

EnableConstraints()

void Ict.Common.Data.TTypedDataSet.EnableConstraints ( )

inline

Will add the constraints to the tables. The constraints should have been before added to FConstraints. Constraints will only be added if they don't exist already

Returns

void

EnableRelation() [1/2]

void Ict.Common.Data.TTypedDataSet.EnableRelation ( String  AName )

inline

Enable a specific relation

Returns

void

EnableRelation() [2/2]

void Ict.Common.Data.TTypedDataSet.EnableRelation ( TTypedRelation  ARelation )

inlineprotected

enable a specific relation

Returns

void

EnableRelations()

void Ict.Common.Data.TTypedDataSet.EnableRelations ( )

inline

Will add the relations to the tables. The relations should have been before added to FRelations. Relations will only be added if they don't exist already

Returns

void

GetChangesTyped()

virtual TTypedDataSet Ict.Common.Data.TTypedDataSet.GetChangesTyped ( Boolean  removeEmptyTables )

inlinevirtual

returns a dataset with only necessary data depending on the parameter removeEmptyTables, the empty tables are not returned all rows that are not changed are not returned

Returns

a new dataset with only modified data

GetDataColumnArrayFromString()

DataColumn[] Ict.Common.Data.TTypedDataSet.GetDataColumnArrayFromString ( DataTable  ATable, string[]  AKeys  )

inline

This returns an array of DataColumns, based on a Array of strings of column names of a given table

Returns

void

InitClass()

void Ict.Common.Data.TTypedDataSet.InitClass ( )

inline

Initialise the class, calling abstract routines in the right order

InitConstraints()

abstract void Ict.Common.Data.TTypedDataSet.InitConstraints ( )

protectedpure virtual

for initialising the constraints implemented by generated code

Implemented in Ict.Petra.Shared.MCommon.Data.OfficeSpecificDataLabelsTDS, Ict.Petra.Shared.MCommon.Data.CacheableTablesTDS, Ict.Petra.Shared.MCommon.Data.SampleDataConstructorTDS, Ict.Petra.Shared.MCommon.Data.PartnerAddressTDS, Ict.Petra.Shared.MConference.Data.SelectConferenceTDS, Ict.Petra.Shared.MConference.Data.ConferenceSetupTDS, Ict.Petra.Shared.MConference.Data.ConferenceApplicationTDS, Ict.Petra.Shared.MFinance.AP.Data.AccountsPayableTDS, Ict.Petra.Shared.MFinance.BankImport.Data.BankImportTDS, Ict.Petra.Shared.MFinance.CrossLedger.Data.ExchangeRateTDS, Ict.Petra.Shared.MFinance.Gift.Data.GiftBatchTDS, Ict.Petra.Shared.MFinance.GL.Data.GLBatchTDS, Ict.Petra.Shared.MFinance.GL.Data.GLPostingTDS, Ict.Petra.Shared.MFinance.GL.Data.GLReportingTDS, Ict.Petra.Shared.MFinance.GL.Data.GLSetupTDS, Ict.Petra.Shared.MFinance.GL.Data.GLStewardshipCalculationTDS, Ict.Petra.Shared.MFinance.GL.Data.BudgetTDS, Ict.Petra.Shared.MFinance.GL.Data.SuspenseAccountTDS, Ict.Petra.Shared.MFinance.GL.Data.CorporateExchangeSetupTDS, Ict.Petra.Shared.MHospitality.Data.HospitalityTDS, Ict.Petra.Shared.MPartner.Partner.Data.PartnerEditTDS, Ict.Petra.Shared.MPartner.Partner.Data.PartnerAddressAggregateTDS, Ict.Petra.Shared.MPartner.Partner.Data.PartnerInfoTDS, Ict.Petra.Shared.MPartner.Partner.Data.PartnerFindTDS, Ict.Petra.Shared.MPartner.Partner.Data.PartnerSetupTDS, Ict.Petra.Shared.MPartner.Partner.Data.PartnerImportExportTDS, Ict.Petra.Shared.MPartner.Partner.Data.ExtractTDS, Ict.Petra.Shared.MPartner.Partner.Data.ContactTDS, Ict.Petra.Shared.MPartner.Partner.Data.PostcodeRegionsTDS, Ict.Petra.Shared.MPartner.Partner.Data.BankTDS, Ict.Petra.Shared.MPartner.Partner.Data.PartnerContactSetupTDS, Ict.Petra.Shared.MPartner.Partner.Data.DataConsentTDS, Ict.Petra.Shared.MPersonnel.Personnel.Data.PersonnelTDS, Ict.Petra.Shared.MPersonnel.Personnel.Data.IndividualDataTDS, Ict.Petra.Shared.MPersonnel.Personnel.Data.ApplicationTDS, Ict.Petra.Shared.MPersonnel.Personnel.Data.LengthOfCommitmentReportTDS, Ict.Petra.Shared.MSponsorship.Data.SponsorshipTDS, Ict.Petra.Shared.MSponsorship.Data.SponsorshipFindTDS, and Ict.Petra.Shared.MSysMan.Data.MaintainUsersTDS.

InitTables() [1/2]

abstract void Ict.Common.Data.TTypedDataSet.InitTables ( )

protectedpure virtual

for initialising the tables implemented by generated code

Implemented in Ict.Petra.Shared.MCommon.Data.OfficeSpecificDataLabelsTDS, Ict.Petra.Shared.MCommon.Data.CacheableTablesTDS, Ict.Petra.Shared.MCommon.Data.SampleDataConstructorTDS, Ict.Petra.Shared.MCommon.Data.PartnerAddressTDS, Ict.Petra.Shared.MConference.Data.SelectConferenceTDS, Ict.Petra.Shared.MConference.Data.ConferenceSetupTDS, Ict.Petra.Shared.MConference.Data.ConferenceApplicationTDS, Ict.Petra.Shared.MFinance.AP.Data.AccountsPayableTDS, Ict.Petra.Shared.MFinance.BankImport.Data.BankImportTDS, Ict.Petra.Shared.MFinance.CrossLedger.Data.ExchangeRateTDS, Ict.Petra.Shared.MFinance.Gift.Data.GiftBatchTDS, Ict.Petra.Shared.MFinance.GL.Data.GLBatchTDS, Ict.Petra.Shared.MFinance.GL.Data.GLPostingTDS, Ict.Petra.Shared.MFinance.GL.Data.GLReportingTDS, Ict.Petra.Shared.MFinance.GL.Data.GLSetupTDS, Ict.Petra.Shared.MFinance.GL.Data.GLStewardshipCalculationTDS, Ict.Petra.Shared.MFinance.GL.Data.BudgetTDS, Ict.Petra.Shared.MFinance.GL.Data.SuspenseAccountTDS, Ict.Petra.Shared.MFinance.GL.Data.CorporateExchangeSetupTDS, Ict.Petra.Shared.MHospitality.Data.HospitalityTDS, Ict.Petra.Shared.MPartner.Partner.Data.PartnerEditTDS, Ict.Petra.Shared.MPartner.Partner.Data.PartnerAddressAggregateTDS, Ict.Petra.Shared.MPartner.Partner.Data.PartnerInfoTDS, Ict.Petra.Shared.MPartner.Partner.Data.PartnerFindTDS, Ict.Petra.Shared.MPartner.Partner.Data.PartnerSetupTDS, Ict.Petra.Shared.MPartner.Partner.Data.PartnerImportExportTDS, Ict.Petra.Shared.MPartner.Partner.Data.ExtractTDS, Ict.Petra.Shared.MPartner.Partner.Data.ContactTDS, Ict.Petra.Shared.MPartner.Partner.Data.PostcodeRegionsTDS, Ict.Petra.Shared.MPartner.Partner.Data.BankTDS, Ict.Petra.Shared.MPartner.Partner.Data.PartnerContactSetupTDS, Ict.Petra.Shared.MPartner.Partner.Data.DataConsentTDS, Ict.Petra.Shared.MPersonnel.Personnel.Data.PersonnelTDS, Ict.Petra.Shared.MPersonnel.Personnel.Data.IndividualDataTDS, Ict.Petra.Shared.MPersonnel.Personnel.Data.ApplicationTDS, Ict.Petra.Shared.MPersonnel.Personnel.Data.LengthOfCommitmentReportTDS, Ict.Petra.Shared.MSponsorship.Data.SponsorshipTDS, Ict.Petra.Shared.MSponsorship.Data.SponsorshipFindTDS, and Ict.Petra.Shared.MSysMan.Data.MaintainUsersTDS.

InitTables() [2/2]

abstract void Ict.Common.Data.TTypedDataSet.InitTables ( DataSet  ds )

protectedpure virtual

for initialising the tables, of a specific dataset implemented by generated code

Parameters

ds	the dataset

InitVars()

abstract void Ict.Common.Data.TTypedDataSet.InitVars ( )

pure virtual

for initialising the columns implemented by generated code

Implemented in Ict.Petra.Shared.MCommon.Data.OfficeSpecificDataLabelsTDS, Ict.Petra.Shared.MCommon.Data.CacheableTablesTDS, Ict.Petra.Shared.MCommon.Data.SampleDataConstructorTDS, Ict.Petra.Shared.MCommon.Data.PartnerAddressTDS, Ict.Petra.Shared.MConference.Data.SelectConferenceTDS, Ict.Petra.Shared.MConference.Data.ConferenceSetupTDS, Ict.Petra.Shared.MConference.Data.ConferenceApplicationTDS, Ict.Petra.Shared.MFinance.AP.Data.AccountsPayableTDS, Ict.Petra.Shared.MFinance.BankImport.Data.BankImportTDS, Ict.Petra.Shared.MFinance.CrossLedger.Data.ExchangeRateTDS, Ict.Petra.Shared.MFinance.Gift.Data.GiftBatchTDS, Ict.Petra.Shared.MFinance.GL.Data.GLBatchTDS, Ict.Petra.Shared.MFinance.GL.Data.GLPostingTDS, Ict.Petra.Shared.MFinance.GL.Data.GLReportingTDS, Ict.Petra.Shared.MFinance.GL.Data.GLSetupTDS, Ict.Petra.Shared.MFinance.GL.Data.GLStewardshipCalculationTDS, Ict.Petra.Shared.MFinance.GL.Data.BudgetTDS, Ict.Petra.Shared.MFinance.GL.Data.SuspenseAccountTDS, Ict.Petra.Shared.MFinance.GL.Data.CorporateExchangeSetupTDS, Ict.Petra.Shared.MHospitality.Data.HospitalityTDS, Ict.Petra.Shared.MPartner.Partner.Data.PartnerEditTDS, Ict.Petra.Shared.MPartner.Partner.Data.PartnerAddressAggregateTDS, Ict.Petra.Shared.MPartner.Partner.Data.PartnerInfoTDS, Ict.Petra.Shared.MPartner.Partner.Data.PartnerFindTDS, Ict.Petra.Shared.MPartner.Partner.Data.PartnerSetupTDS, Ict.Petra.Shared.MPartner.Partner.Data.PartnerImportExportTDS, Ict.Petra.Shared.MPartner.Partner.Data.ExtractTDS, Ict.Petra.Shared.MPartner.Partner.Data.ContactTDS, Ict.Petra.Shared.MPartner.Partner.Data.PostcodeRegionsTDS, Ict.Petra.Shared.MPartner.Partner.Data.BankTDS, Ict.Petra.Shared.MPartner.Partner.Data.PartnerContactSetupTDS, Ict.Petra.Shared.MPartner.Partner.Data.DataConsentTDS, Ict.Petra.Shared.MPersonnel.Personnel.Data.PersonnelTDS, Ict.Petra.Shared.MPersonnel.Personnel.Data.IndividualDataTDS, Ict.Petra.Shared.MPersonnel.Personnel.Data.ApplicationTDS, Ict.Petra.Shared.MPersonnel.Personnel.Data.LengthOfCommitmentReportTDS, Ict.Petra.Shared.MSponsorship.Data.SponsorshipTDS, Ict.Petra.Shared.MSponsorship.Data.SponsorshipFindTDS, and Ict.Petra.Shared.MSysMan.Data.MaintainUsersTDS.

MapTables()

virtual void Ict.Common.Data.TTypedDataSet.MapTables ( )

inlineprotectedvirtual

make sure that the typed variables are all referencing to the dataset

Reimplemented in Ict.Petra.Shared.MCommon.Data.OfficeSpecificDataLabelsTDS, Ict.Petra.Shared.MCommon.Data.CacheableTablesTDS, Ict.Petra.Shared.MCommon.Data.SampleDataConstructorTDS, Ict.Petra.Shared.MCommon.Data.PartnerAddressTDS, Ict.Petra.Shared.MConference.Data.SelectConferenceTDS, Ict.Petra.Shared.MConference.Data.ConferenceSetupTDS, Ict.Petra.Shared.MConference.Data.ConferenceApplicationTDS, Ict.Petra.Shared.MFinance.AP.Data.AccountsPayableTDS, Ict.Petra.Shared.MFinance.BankImport.Data.BankImportTDS, Ict.Petra.Shared.MFinance.CrossLedger.Data.ExchangeRateTDS, Ict.Petra.Shared.MFinance.Gift.Data.GiftBatchTDS, Ict.Petra.Shared.MFinance.GL.Data.GLBatchTDS, Ict.Petra.Shared.MFinance.GL.Data.GLPostingTDS, Ict.Petra.Shared.MFinance.GL.Data.GLReportingTDS, Ict.Petra.Shared.MFinance.GL.Data.GLSetupTDS, Ict.Petra.Shared.MFinance.GL.Data.GLStewardshipCalculationTDS, Ict.Petra.Shared.MFinance.GL.Data.BudgetTDS, Ict.Petra.Shared.MFinance.GL.Data.SuspenseAccountTDS, Ict.Petra.Shared.MFinance.GL.Data.CorporateExchangeSetupTDS, Ict.Petra.Shared.MHospitality.Data.HospitalityTDS, Ict.Petra.Shared.MPartner.Partner.Data.PartnerEditTDS, Ict.Petra.Shared.MPartner.Partner.Data.PartnerAddressAggregateTDS, Ict.Petra.Shared.MPartner.Partner.Data.PartnerInfoTDS, Ict.Petra.Shared.MPartner.Partner.Data.PartnerFindTDS, Ict.Petra.Shared.MPartner.Partner.Data.PartnerSetupTDS, Ict.Petra.Shared.MPartner.Partner.Data.PartnerImportExportTDS, Ict.Petra.Shared.MPartner.Partner.Data.ExtractTDS, Ict.Petra.Shared.MPartner.Partner.Data.ContactTDS, Ict.Petra.Shared.MPartner.Partner.Data.PostcodeRegionsTDS, Ict.Petra.Shared.MPartner.Partner.Data.BankTDS, Ict.Petra.Shared.MPartner.Partner.Data.PartnerContactSetupTDS, Ict.Petra.Shared.MPartner.Partner.Data.DataConsentTDS, Ict.Petra.Shared.MPersonnel.Personnel.Data.PersonnelTDS, Ict.Petra.Shared.MPersonnel.Personnel.Data.IndividualDataTDS, Ict.Petra.Shared.MPersonnel.Personnel.Data.ApplicationTDS, Ict.Petra.Shared.MPersonnel.Personnel.Data.LengthOfCommitmentReportTDS, Ict.Petra.Shared.MSponsorship.Data.SponsorshipTDS, Ict.Petra.Shared.MSponsorship.Data.SponsorshipFindTDS, and Ict.Petra.Shared.MSysMan.Data.MaintainUsersTDS.

Merge() [1/3]

new void Ict.Common.Data.TTypedDataSet.Merge ( DataSet  ADataSet )

inline

overload that makes sure that the typed tables are mapped again

Parameters

ADataSet

Merge() [2/3]

new void Ict.Common.Data.TTypedDataSet.Merge ( DataSet  ADataSet, bool  APreserveChanges  )

inline

overload that makes sure that the typed tables are mapped again

Merge() [3/3]

new void Ict.Common.Data.TTypedDataSet.Merge ( DataTable  ATable )

inline

overload that makes sure that the typed tables are mapped again

Parameters

ATable

RemoveEmptyTables()

void Ict.Common.Data.TTypedDataSet.RemoveEmptyTables ( )

inline

remove all tables from the dataset that are empty

RemoveTable()

void Ict.Common.Data.TTypedDataSet.RemoveTable ( String  ATableName )

inline

Remove a table fromt the dataset, and all constraints and references refering to it

Parameters

ATableName

table to remove

RemoveTables() [1/2]

void Ict.Common.Data.TTypedDataSet.RemoveTables ( string[]  ATableNames )

inline

remove a list of tables from the dataset (array of string)

Parameters

ATableNames

names of tables to be removed

RemoveTables() [2/2]

void Ict.Common.Data.TTypedDataSet.RemoveTables ( StringCollection  ATableNames )

inline

remove a list of tables from the dataset (StringCollection)

Parameters

ATableNames

names of tables to be removed

Member Data Documentation

FConstraints

ArrayList Ict.Common.Data.TTypedDataSet.FConstraints

protected

constraints in this dataset

FRelations

ArrayList Ict.Common.Data.TTypedDataSet.FRelations

protected

relations in this dataset

Property Documentation

DontThrowAwayAfterSubmitChanges

bool Ict.Common.Data.TTypedDataSet.DontThrowAwayAfterSubmitChanges

getset

if you want no warning about that the datatable should be cleared after submitchanges. in some cases you must keep the data, eg when you need the new keys after INSERT

ThrowAwayAfterSubmitChanges

bool Ict.Common.Data.TTypedDataSet.ThrowAwayAfterSubmitChanges

getset

if you want the dataset to be cleared after submitchanges. This will increase the speed significantly: no updating of modificationID, no slow AcceptChanges.

---

The documentation for this class was generated from the following file:

• csharp/ICT/Common/Data/TypedDataSet.cs