this describes a column of a table More...

Public Member Functions
	TTableField ()
	constructor More...

	TTableField (TTableField t)
	copy constructor More...

string	GetDotNetType ()
	get the fitting type in dot net for the field More...

string	ToOdbcTypeString ()
	convert the type from the xml file to an ODBC type More...

OdbcType	ToOdbcType ()
	convert the type from the xml file to an ODBC type More...

Public Attributes
string	strName
	the name of the column More...

string	strTableName
	the name of the table, that this column belongs to More...

string	strType
	SQL type of the column More...

string	strTypeDotNet
	.net type that should be used for this column More...

string	strHelp
	help for this column for the user More...

string	strLabel
	label for this column; could be used by GUI generator More...

string	strDescription
	description of this column More...

String	strCheck
	special check for enforcing certain conditions; not used at the moment More...

Int32	iOrder
	the order of this field in the table More...

bool	bPartOfPrimKey = false
	is this field part of the primary key of the table More...

bool	bPartOfFirstUniqueKey = false
	is this field part of the first unique key of the table More...

string	strSequence
	name of the sequence that is used to fill this field More...

string	strDefault
	this is calculated from strInitialValue and strFormat More...

string	strInitialValue
	this is taken from petra.xml More...

Boolean	ExistsStrInitialValue
	whether there exists an initial value More...

Boolean	ExistsStrColLabel
	whether there exists a label for the column when it is displayed in a grid More...

Boolean	ExistsStrLabel
	whether there exists a label for this column (eg. in front of a text field) More...

Boolean	ExistsStrHelp
	is there a help text? More...

Boolean	ExistsStrCheck
	has a check been defined? More...

string	strFormat
	a format; used to be in Progress notation More...

Int32	iCharLength
	number of characters; if it does not exists, it is calculated from strFormat More...

int	iLength
	length in byte? More...

int	iDecimals
	how many decimals does the number have (allowed places after the decimal point) More...

Boolean	bAutoIncrement
	will this field automatically have a unique value More...

Boolean	bNotNull
	can this field be null? More...

string	strColLabel
	a label that is used when this column is displayed in a grid; can be used for GUI generation More...

string	strValExp
	can be used to define input validation (not used at the moment) More...

string	strValMsg
	can be used to define input validation, and show an error message (not used at the moment) More...

Boolean	bAvailableForCustomReport
	is this field available for use in custom report More...

Properties
string	strNameDotNet `[get, set]`
	property for dynamically calculating the .net name for the column More...

Detailed Description

this describes a column of a table

Constructor & Destructor Documentation

◆ TTableField() [1/2]

Ict.Tools.DBXML.TTableField.TTableField ( )

inline

constructor

◆ TTableField() [2/2]

Ict.Tools.DBXML.TTableField.TTableField ( TTableField t )

inline

copy constructor

Parameters

t

Member Function Documentation

◆ GetDotNetType()

string Ict.Tools.DBXML.TTableField.GetDotNetType ( )

inline

get the fitting type in dot net for the field

Returns

◆ ToOdbcType()

OdbcType Ict.Tools.DBXML.TTableField.ToOdbcType ( )

inline

convert the type from the xml file to an ODBC type

◆ ToOdbcTypeString()

string Ict.Tools.DBXML.TTableField.ToOdbcTypeString ( )

inline

convert the type from the xml file to an ODBC type

Member Data Documentation

◆ bAutoIncrement

Boolean Ict.Tools.DBXML.TTableField.bAutoIncrement

will this field automatically have a unique value

◆ bAvailableForCustomReport

Boolean Ict.Tools.DBXML.TTableField.bAvailableForCustomReport

is this field available for use in custom report

◆ bNotNull

Boolean Ict.Tools.DBXML.TTableField.bNotNull

can this field be null?

◆ bPartOfFirstUniqueKey

bool Ict.Tools.DBXML.TTableField.bPartOfFirstUniqueKey = false

is this field part of the first unique key of the table

◆ bPartOfPrimKey

bool Ict.Tools.DBXML.TTableField.bPartOfPrimKey = false

is this field part of the primary key of the table

◆ ExistsStrCheck

Boolean Ict.Tools.DBXML.TTableField.ExistsStrCheck

has a check been defined?

◆ ExistsStrColLabel

Boolean Ict.Tools.DBXML.TTableField.ExistsStrColLabel

whether there exists a label for the column when it is displayed in a grid

◆ ExistsStrHelp

Boolean Ict.Tools.DBXML.TTableField.ExistsStrHelp

is there a help text?

◆ ExistsStrInitialValue

Boolean Ict.Tools.DBXML.TTableField.ExistsStrInitialValue

whether there exists an initial value

◆ ExistsStrLabel

Boolean Ict.Tools.DBXML.TTableField.ExistsStrLabel

whether there exists a label for this column (eg. in front of a text field)

◆ iCharLength

Int32 Ict.Tools.DBXML.TTableField.iCharLength

number of characters; if it does not exists, it is calculated from strFormat

◆ iDecimals

int Ict.Tools.DBXML.TTableField.iDecimals

how many decimals does the number have (allowed places after the decimal point)

◆ iLength

int Ict.Tools.DBXML.TTableField.iLength

length in byte?

◆ iOrder

Int32 Ict.Tools.DBXML.TTableField.iOrder

the order of this field in the table

◆ strCheck

String Ict.Tools.DBXML.TTableField.strCheck

special check for enforcing certain conditions; not used at the moment

◆ strColLabel

string Ict.Tools.DBXML.TTableField.strColLabel

a label that is used when this column is displayed in a grid; can be used for GUI generation

◆ strDefault

string Ict.Tools.DBXML.TTableField.strDefault

this is calculated from strInitialValue and strFormat

◆ strDescription

string Ict.Tools.DBXML.TTableField.strDescription

description of this column

◆ strFormat

string Ict.Tools.DBXML.TTableField.strFormat

a format; used to be in Progress notation

◆ strHelp

string Ict.Tools.DBXML.TTableField.strHelp

help for this column for the user

◆ strInitialValue

string Ict.Tools.DBXML.TTableField.strInitialValue

this is taken from petra.xml

◆ strLabel

string Ict.Tools.DBXML.TTableField.strLabel

label for this column; could be used by GUI generator

◆ strName

string Ict.Tools.DBXML.TTableField.strName

the name of the column

◆ strSequence

string Ict.Tools.DBXML.TTableField.strSequence

name of the sequence that is used to fill this field

◆ strTableName

string Ict.Tools.DBXML.TTableField.strTableName

the name of the table, that this column belongs to

◆ strType

string Ict.Tools.DBXML.TTableField.strType

SQL type of the column

◆ strTypeDotNet

string Ict.Tools.DBXML.TTableField.strTypeDotNet

.net type that should be used for this column

◆ strValExp

string Ict.Tools.DBXML.TTableField.strValExp

can be used to define input validation (not used at the moment)

◆ strValMsg

string Ict.Tools.DBXML.TTableField.strValMsg

can be used to define input validation, and show an error message (not used at the moment)

Property Documentation

◆ strNameDotNet

string Ict.Tools.DBXML.TTableField.strNameDotNet

getset

property for dynamically calculating the .net name for the column

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

csharp/ICT/BuildTools/DBXML/dataDefinitionStore.cs

Public Member Functions

Public Attributes

Properties

Detailed Description

Constructor & Destructor Documentation

◆ TTableField() [1/2]

◆ TTableField() [2/2]

Member Function Documentation

◆ GetDotNetType()

◆ ToOdbcType()

◆ ToOdbcTypeString()

Member Data Documentation

◆ bAutoIncrement

◆ bAvailableForCustomReport

◆ bNotNull

◆ bPartOfFirstUniqueKey

◆ bPartOfPrimKey

◆ ExistsStrCheck

◆ ExistsStrColLabel

◆ ExistsStrHelp

◆ ExistsStrInitialValue

◆ ExistsStrLabel

◆ iCharLength

◆ iDecimals

◆ iLength

◆ iOrder

◆ strCheck

◆ strColLabel

◆ strDefault

◆ strDescription

◆ strFormat

◆ strHelp

◆ strInitialValue

◆ strLabel

◆ strName

◆ strSequence

◆ strTableName

◆ strType

◆ strTypeDotNet

◆ strValExp

◆ strValMsg

Property Documentation

◆ strNameDotNet