The form description for user definable forms such as receipts. More...

Inheritance diagram for Ict.Petra.Shared.MFinance.Account.Data.AFormTable:

Public Member Functions
	AFormTable ()
	constructor More...

	AFormTable (string ATablename)
	constructor More...

	AFormTable (System.Runtime.Serialization.SerializationInfo info, System.Runtime.Serialization.StreamingContext context)
	constructor for serialization More...

override void	InitVars ()
	assign columns to properties, set primary key More...

AFormRow	NewRowTyped (bool AWithDefaultValues)
	create a new typed row More...

AFormRow	NewRowTyped ()
	create a new typed row, always with default values More...

AFormTable	GetChangesTyped ()
	get typed set of changes More...

override OdbcParameter	CreateOdbcParameter (Int32 AColumnNr)
	get an odbc parameter for the given column More...

new DataTable	GetChanges ()
	make sure that we use GetChangesType instead of GetChanges More...

virtual string	GetCustomReportPermission ()
	string to indicate which permissions a user needs to access table for custom reports (e.g. "PTNRUSER", "OR(FINANCE-1,DEVUSER)", "AND(PTNRUSER,FINANCE-1)" This should be returned by method in derived class More...

virtual bool	IsAvailableForCustomReport ()
	Is this table generally available in custom reports? More...

virtual List< String >	GetCustomReportFieldList ()
	Return a list of fields that are available for custom reports More...

DataTable	GetChangesTypedInternal ()
	our own version of GetChanges More...

void	RemoveColumnsNotInTableTemplate (DataTable ATableTemplate)
	remove columns that are not needed More...

Static Public Member Functions
static string	GetTableName ()
	return the CamelCase name of the table More...

static string	GetTableDBName ()
	return the name of the table as it is used in the database More...

static string	GetTableDBLabel ()
	static method to return the 'Label' of the table as it is used in the database (the 'Label' is usually a short description of what the db table is about) More...

static string	GetFormCodeDBName ()
	get the name of the field in the database for this column More...

static short	GetFormCodeLength ()
	get character length for column More...

static string	GetFormCodeHelp ()
	get the help text for the field in the database for this column More...

static string	GetFormNameDBName ()
	get the name of the field in the database for this column More...

static short	GetFormNameLength ()
	get character length for column More...

static string	GetFormNameHelp ()
	get the help text for the field in the database for this column More...

static string	GetFormDescriptionDBName ()
	get the name of the field in the database for this column More...

static short	GetFormDescriptionLength ()
	get character length for column More...

static string	GetFormDescriptionHelp ()
	get the help text for the field in the database for this column More...

static string	GetFormFileNameDBName ()
	get the name of the field in the database for this column More...

static short	GetFormFileNameLength ()
	get character length for column More...

static string	GetFormFileNameHelp ()
	get the help text for the field in the database for this column More...

static string	GetFormTypeCodeDBName ()
	get the name of the field in the database for this column More...

static short	GetFormTypeCodeLength ()
	get character length for column More...

static string	GetFormTypeCodeHelp ()
	get the help text for the field in the database for this column More...

static string	GetNumberOfDetailsDBName ()
	get the name of the field in the database for this column More...

static short	GetNumberOfDetailsLength ()
	get character length for column More...

static string	GetNumberOfDetailsHelp ()
	get the help text for the field in the database for this column More...

static string	GetPrintInBoldDBName ()
	get the name of the field in the database for this column More...

static short	GetPrintInBoldLength ()
	get character length for column More...

static string	GetPrintInBoldHelp ()
	get the help text for the field in the database for this column More...

static string	GetLinesOnPageDBName ()
	get the name of the field in the database for this column More...

static short	GetLinesOnPageLength ()
	get character length for column More...

static string	GetLinesOnPageHelp ()
	get the help text for the field in the database for this column More...

static string	GetMinimumAmountDBName ()
	get the name of the field in the database for this column More...

static short	GetMinimumAmountLength ()
	get character length for column More...

static string	GetMinimumAmountHelp ()
	get the help text for the field in the database for this column More...

static string	GetOptionsDBName ()
	get the name of the field in the database for this column More...

static short	GetOptionsLength ()
	get character length for column More...

static string	GetOptionsHelp ()
	get the help text for the field in the database for this column More...

static string	GetDateCreatedDBName ()
	get the name of the field in the database for this column More...

static short	GetDateCreatedLength ()
	get character length for column More...

static string	GetDateCreatedHelp ()
	get the help text for the field in the database for this column More...

static string	GetCreatedByDBName ()
	get the name of the field in the database for this column More...

static short	GetCreatedByLength ()
	get character length for column More...

static string	GetCreatedByHelp ()
	get the help text for the field in the database for this column More...

static string	GetDateModifiedDBName ()
	get the name of the field in the database for this column More...

static short	GetDateModifiedLength ()
	get character length for column More...

static string	GetDateModifiedHelp ()
	get the help text for the field in the database for this column More...

static string	GetModifiedByDBName ()
	get the name of the field in the database for this column More...

static short	GetModifiedByLength ()
	get character length for column More...

static string	GetModifiedByHelp ()
	get the help text for the field in the database for this column More...

static string	GetModificationIdDBName ()
	get the name of the field in the database for this column More...

static short	GetModificationIdLength ()
	get character length for column More...

static string	GetModificationIdHelp ()
	get the help text for the field in the database for this column More...

static OdbcParameter	CreateOdbcParameter (short ATableNumber, TSearchCriteria ASearchCriteria)
	create an odbc parameter for the given column More...

static OdbcParameter	CreateOdbcParameter (short ATableNumber, Int32 AColumnNr)
	create an odbc parameter for the given column More...

static void	ResetStaticVariables ()
	reset the static variables for each Web Request call. More...

static string	GetTableNameSQL (short ATableNumber)
	the table name as it is in the SQL database More...

static string	GetTableName (short ATableNumber)
	the table name in CamelCase More...

static TTypedTableInfo	GetTableByName (string ATableName)
	the table name in CamelCase More...

static string	GetColumnNameSQL (short ATableNumber, short AColumnNr)
	the column name as it is in the SQL database More...

static string	GetLabel (short ATableNumber, short AColumnNr)
	returns the translated label for the column More...

static Int32	GetLength (short ATableNumber, short AColumnNr)
	get the maximum length for the field More...

static Int32	GetLength (string ATableName, string AColumnName)
	get the maximum length for the field More...

static string[]	GetKeyColumnStringList (short ATableNumber, int[] AKeyColumnsOrder)
	get the names of the columns that are part of the key More...

static string[]	GetPrimaryKeyColumnStringList (short ATableNumber)
	get the names of the columns that are part of the primary key More...

static string[]	GetUniqueKeyColumnStringList (short ATableNumber)
	get the names of the columns that are part of the unique key More...

static int[]	GetPrimaryKeyColumnOrdList (short ATableNumber)
	get the order number of the columns that are part of the primary key More...

static int[]	GetUniqueKeyColumnOrdList (short ATableNumber)
	get the order number of the columns that are part of a unique key More...

static string[]	GetColumnStringList (short ATableNumber)
	get the names of the columns in this table More...

Public Attributes
DataColumn	ColumnFormCode
	The code which defines the type of form described in the table. More...

DataColumn	ColumnFormName
	The name of the form being created for the form code. More...

DataColumn	ColumnFormDescription
	Description of the form. More...

DataColumn	ColumnFormFileName
	File name used for the form. Includes path information. More...

DataColumn	ColumnFormTypeCode
	If there are several types of form then it can be specified here. Eg an annual receipt and an individual receipt. More...

DataColumn	ColumnNumberOfDetails
	The number of repeating lines that will be displayed on each page of a form. More...

DataColumn	ColumnPrintInBold
	Is the report to be formatted to print in bold or not. More...

DataColumn	ColumnLinesOnPage
	The total number of lines that can be displayed on the page. More...

DataColumn	ColumnMinimumAmount
	The minimum amount that is acceptable on a receipt. More...

DataColumn	ColumnOptions
	Allows the exclusion of certain records from a report. More...

DataColumn	ColumnDateCreated
	The date the record was created. More...

DataColumn	ColumnCreatedBy
	User ID of who created this record. More...

DataColumn	ColumnDateModified
	The date the record was modified. More...

DataColumn	ColumnModifiedBy
	User ID of who last modified this record. More...

DataColumn	ColumnModificationId
	This identifies the current version of the record. More...

bool	ThrowAwayAfterSubmitChanges = false
	if you want the datatable to be cleared after submitchanges. This will increase the speed significantly: no updating of modificationID, no slow AcceptChanges. More...

bool	DontThrowAwayAfterSubmitChanges = false
	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...

Static Public Attributes
static readonly short	TableId = 137
	TableId for Ict.Common.Data generic functions. More...

static readonly short	ColumnFormCodeId = 0
	used for generic TTypedDataTable functions More...

static readonly short	ColumnFormNameId = 1
	used for generic TTypedDataTable functions More...

static readonly short	ColumnFormDescriptionId = 2
	used for generic TTypedDataTable functions More...

static readonly short	ColumnFormFileNameId = 3
	used for generic TTypedDataTable functions More...

static readonly short	ColumnFormTypeCodeId = 4
	used for generic TTypedDataTable functions More...

static readonly short	ColumnNumberOfDetailsId = 5
	used for generic TTypedDataTable functions More...

static readonly short	ColumnPrintInBoldId = 6
	used for generic TTypedDataTable functions More...

static readonly short	ColumnLinesOnPageId = 7
	used for generic TTypedDataTable functions More...

static readonly short	ColumnMinimumAmountId = 8
	used for generic TTypedDataTable functions More...

static readonly short	ColumnOptionsId = 9
	used for generic TTypedDataTable functions More...

static readonly short	ColumnDateCreatedId = 10
	used for generic TTypedDataTable functions More...

static readonly short	ColumnCreatedById = 11
	used for generic TTypedDataTable functions More...

static readonly short	ColumnDateModifiedId = 12
	used for generic TTypedDataTable functions More...

static readonly short	ColumnModifiedById = 13
	used for generic TTypedDataTable functions More...

static readonly short	ColumnModificationIdId = 14
	used for generic TTypedDataTable functions More...

Protected Member Functions
override void	InitClass ()
	create the columns More...

override System.Data.DataRow	NewRowFromBuilder (System.Data.DataRowBuilder builder)
	new typed row using DataRowBuilder More...

Static Protected Attributes
static SortedList< short, TTypedTableInfo >	TableInfo = new SortedList <short, TTypedTableInfo>()
	stores information about typed tables More...

Properties
AFormRow	this[int i] `[get]`
	Access a typed row by index. More...

override string	TableDBLabel `[get]`
	instance property to get the 'Label' of the table as it is used in the database (the 'Label' is usually a short description of what the db table is about) More...

int	Count `[get]`
	the number of rows in the current table More...

Detailed Description

The form description for user definable forms such as receipts.

Constructor & Destructor Documentation

◆ AFormTable() [1/3]

Ict.Petra.Shared.MFinance.Account.Data.AFormTable.AFormTable ( )

inline

constructor

◆ AFormTable() [2/3]

Ict.Petra.Shared.MFinance.Account.Data.AFormTable.AFormTable ( string ATablename )

inline

constructor

◆ AFormTable() [3/3]

Ict.Petra.Shared.MFinance.Account.Data.AFormTable.AFormTable	(	System.Runtime.Serialization.SerializationInfo	info,
		System.Runtime.Serialization.StreamingContext	context
	)

inline

constructor for serialization

Member Function Documentation

◆ CreateOdbcParameter() [1/3]

override OdbcParameter Ict.Petra.Shared.MFinance.Account.Data.AFormTable.CreateOdbcParameter ( Int32 AColumnNr )

inlinevirtual

get an odbc parameter for the given column

Implements Ict.Common.Data.TTypedDataTable.

◆ CreateOdbcParameter() [2/3]

static OdbcParameter Ict.Common.Data.TTypedDataTable.CreateOdbcParameter	(	short	ATableNumber,
		Int32	AColumnNr
	)

inlinestaticinherited

create an odbc parameter for the given column

◆ CreateOdbcParameter() [3/3]

static OdbcParameter Ict.Common.Data.TTypedDataTable.CreateOdbcParameter	(	short	ATableNumber,
		TSearchCriteria	ASearchCriteria
	)

inlinestaticinherited

create an odbc parameter for the given column

◆ GetChanges()

new DataTable Ict.Common.Data.TTypedDataTable.GetChanges ( )

inlineinherited

make sure that we use GetChangesType instead of GetChanges

Returns: throws an exception

◆ GetChangesTyped()

AFormTable Ict.Petra.Shared.MFinance.Account.Data.AFormTable.GetChangesTyped ( )

inline

get typed set of changes

◆ GetChangesTypedInternal()

DataTable Ict.Common.Data.TTypedDataTable.GetChangesTypedInternal ( )

inlineinherited

our own version of GetChanges

Returns: returns a typed table with the changes

◆ GetColumnNameSQL()

static string Ict.Common.Data.TTypedDataTable.GetColumnNameSQL	(	short	ATableNumber,
		short	AColumnNr
	)

inlinestaticinherited

the column name as it is in the SQL database

◆ GetColumnStringList()

static string[] Ict.Common.Data.TTypedDataTable.GetColumnStringList ( short ATableNumber )

inlinestaticinherited

get the names of the columns in this table

◆ GetCreatedByDBName()

static string Ict.Petra.Shared.MFinance.Account.Data.AFormTable.GetCreatedByDBName ( )

inlinestatic

get the name of the field in the database for this column

◆ GetCreatedByHelp()

static string Ict.Petra.Shared.MFinance.Account.Data.AFormTable.GetCreatedByHelp ( )

inlinestatic

get the help text for the field in the database for this column

◆ GetCreatedByLength()

static short Ict.Petra.Shared.MFinance.Account.Data.AFormTable.GetCreatedByLength ( )

inlinestatic

get character length for column

◆ GetCustomReportFieldList()

virtual List< String > Ict.Common.Data.TTypedDataTable.GetCustomReportFieldList ( )

inlinevirtualinherited

Return a list of fields that are available for custom reports

◆ GetCustomReportPermission()

virtual string Ict.Common.Data.TTypedDataTable.GetCustomReportPermission ( )

inlinevirtualinherited

string to indicate which permissions a user needs to access table for custom reports (e.g. "PTNRUSER", "OR(FINANCE-1,DEVUSER)", "AND(PTNRUSER,FINANCE-1)" This should be returned by method in derived class

◆ GetDateCreatedDBName()

static string Ict.Petra.Shared.MFinance.Account.Data.AFormTable.GetDateCreatedDBName ( )

inlinestatic

get the name of the field in the database for this column

◆ GetDateCreatedHelp()

static string Ict.Petra.Shared.MFinance.Account.Data.AFormTable.GetDateCreatedHelp ( )

inlinestatic

get the help text for the field in the database for this column

◆ GetDateCreatedLength()

static short Ict.Petra.Shared.MFinance.Account.Data.AFormTable.GetDateCreatedLength ( )

inlinestatic

get character length for column

◆ GetDateModifiedDBName()

static string Ict.Petra.Shared.MFinance.Account.Data.AFormTable.GetDateModifiedDBName ( )

inlinestatic

get the name of the field in the database for this column

◆ GetDateModifiedHelp()

static string Ict.Petra.Shared.MFinance.Account.Data.AFormTable.GetDateModifiedHelp ( )

inlinestatic

get the help text for the field in the database for this column

◆ GetDateModifiedLength()

static short Ict.Petra.Shared.MFinance.Account.Data.AFormTable.GetDateModifiedLength ( )

inlinestatic

get character length for column

◆ GetFormCodeDBName()

static string Ict.Petra.Shared.MFinance.Account.Data.AFormTable.GetFormCodeDBName ( )

inlinestatic

get the name of the field in the database for this column

◆ GetFormCodeHelp()

static string Ict.Petra.Shared.MFinance.Account.Data.AFormTable.GetFormCodeHelp ( )

inlinestatic

get the help text for the field in the database for this column

◆ GetFormCodeLength()

static short Ict.Petra.Shared.MFinance.Account.Data.AFormTable.GetFormCodeLength ( )

inlinestatic

get character length for column

◆ GetFormDescriptionDBName()

static string Ict.Petra.Shared.MFinance.Account.Data.AFormTable.GetFormDescriptionDBName ( )

inlinestatic

get the name of the field in the database for this column

◆ GetFormDescriptionHelp()

static string Ict.Petra.Shared.MFinance.Account.Data.AFormTable.GetFormDescriptionHelp ( )

inlinestatic

get the help text for the field in the database for this column

◆ GetFormDescriptionLength()

static short Ict.Petra.Shared.MFinance.Account.Data.AFormTable.GetFormDescriptionLength ( )

inlinestatic

get character length for column

◆ GetFormFileNameDBName()

static string Ict.Petra.Shared.MFinance.Account.Data.AFormTable.GetFormFileNameDBName ( )

inlinestatic

get the name of the field in the database for this column

◆ GetFormFileNameHelp()

static string Ict.Petra.Shared.MFinance.Account.Data.AFormTable.GetFormFileNameHelp ( )

inlinestatic

get the help text for the field in the database for this column

◆ GetFormFileNameLength()

static short Ict.Petra.Shared.MFinance.Account.Data.AFormTable.GetFormFileNameLength ( )

inlinestatic

get character length for column

◆ GetFormNameDBName()

static string Ict.Petra.Shared.MFinance.Account.Data.AFormTable.GetFormNameDBName ( )

inlinestatic

get the name of the field in the database for this column

◆ GetFormNameHelp()

static string Ict.Petra.Shared.MFinance.Account.Data.AFormTable.GetFormNameHelp ( )

inlinestatic

get the help text for the field in the database for this column

◆ GetFormNameLength()

static short Ict.Petra.Shared.MFinance.Account.Data.AFormTable.GetFormNameLength ( )

inlinestatic

get character length for column

◆ GetFormTypeCodeDBName()

static string Ict.Petra.Shared.MFinance.Account.Data.AFormTable.GetFormTypeCodeDBName ( )

inlinestatic

get the name of the field in the database for this column

◆ GetFormTypeCodeHelp()

static string Ict.Petra.Shared.MFinance.Account.Data.AFormTable.GetFormTypeCodeHelp ( )

inlinestatic

get the help text for the field in the database for this column

◆ GetFormTypeCodeLength()

static short Ict.Petra.Shared.MFinance.Account.Data.AFormTable.GetFormTypeCodeLength ( )

inlinestatic

get character length for column

◆ GetKeyColumnStringList()

static string[] Ict.Common.Data.TTypedDataTable.GetKeyColumnStringList	(	short	ATableNumber,
		int[]	AKeyColumnsOrder
	)

inlinestaticinherited

get the names of the columns that are part of the key

◆ GetLabel()

static string Ict.Common.Data.TTypedDataTable.GetLabel	(	short	ATableNumber,
		short	AColumnNr
	)

inlinestaticinherited

returns the translated label for the column

◆ GetLength() [1/2]

static Int32 Ict.Common.Data.TTypedDataTable.GetLength	(	short	ATableNumber,
		short	AColumnNr
	)

inlinestaticinherited

get the maximum length for the field

◆ GetLength() [2/2]

static Int32 Ict.Common.Data.TTypedDataTable.GetLength	(	string	ATableName,
		string	AColumnName
	)

inlinestaticinherited

get the maximum length for the field

◆ GetLinesOnPageDBName()

static string Ict.Petra.Shared.MFinance.Account.Data.AFormTable.GetLinesOnPageDBName ( )

inlinestatic

get the name of the field in the database for this column

◆ GetLinesOnPageHelp()

static string Ict.Petra.Shared.MFinance.Account.Data.AFormTable.GetLinesOnPageHelp ( )

inlinestatic

get the help text for the field in the database for this column

◆ GetLinesOnPageLength()

static short Ict.Petra.Shared.MFinance.Account.Data.AFormTable.GetLinesOnPageLength ( )

inlinestatic

get character length for column

◆ GetMinimumAmountDBName()

static string Ict.Petra.Shared.MFinance.Account.Data.AFormTable.GetMinimumAmountDBName ( )

inlinestatic

get the name of the field in the database for this column

◆ GetMinimumAmountHelp()

static string Ict.Petra.Shared.MFinance.Account.Data.AFormTable.GetMinimumAmountHelp ( )

inlinestatic

get the help text for the field in the database for this column

◆ GetMinimumAmountLength()

static short Ict.Petra.Shared.MFinance.Account.Data.AFormTable.GetMinimumAmountLength ( )

inlinestatic

get character length for column

◆ GetModificationIdDBName()

static string Ict.Petra.Shared.MFinance.Account.Data.AFormTable.GetModificationIdDBName ( )

inlinestatic

get the name of the field in the database for this column

◆ GetModificationIdHelp()

static string Ict.Petra.Shared.MFinance.Account.Data.AFormTable.GetModificationIdHelp ( )

inlinestatic

get the help text for the field in the database for this column

◆ GetModificationIdLength()

static short Ict.Petra.Shared.MFinance.Account.Data.AFormTable.GetModificationIdLength ( )

inlinestatic

get character length for column

◆ GetModifiedByDBName()

static string Ict.Petra.Shared.MFinance.Account.Data.AFormTable.GetModifiedByDBName ( )

inlinestatic

get the name of the field in the database for this column

◆ GetModifiedByHelp()

static string Ict.Petra.Shared.MFinance.Account.Data.AFormTable.GetModifiedByHelp ( )

inlinestatic

get the help text for the field in the database for this column

◆ GetModifiedByLength()

static short Ict.Petra.Shared.MFinance.Account.Data.AFormTable.GetModifiedByLength ( )

inlinestatic

get character length for column

◆ GetNumberOfDetailsDBName()

static string Ict.Petra.Shared.MFinance.Account.Data.AFormTable.GetNumberOfDetailsDBName ( )

inlinestatic

get the name of the field in the database for this column

◆ GetNumberOfDetailsHelp()

static string Ict.Petra.Shared.MFinance.Account.Data.AFormTable.GetNumberOfDetailsHelp ( )

inlinestatic

get the help text for the field in the database for this column

◆ GetNumberOfDetailsLength()

static short Ict.Petra.Shared.MFinance.Account.Data.AFormTable.GetNumberOfDetailsLength ( )

inlinestatic

get character length for column

◆ GetOptionsDBName()

static string Ict.Petra.Shared.MFinance.Account.Data.AFormTable.GetOptionsDBName ( )

inlinestatic

get the name of the field in the database for this column

◆ GetOptionsHelp()

static string Ict.Petra.Shared.MFinance.Account.Data.AFormTable.GetOptionsHelp ( )

inlinestatic

get the help text for the field in the database for this column

◆ GetOptionsLength()

static short Ict.Petra.Shared.MFinance.Account.Data.AFormTable.GetOptionsLength ( )

inlinestatic

get character length for column

◆ GetPrimaryKeyColumnOrdList()

static int[] Ict.Common.Data.TTypedDataTable.GetPrimaryKeyColumnOrdList ( short ATableNumber )

inlinestaticinherited

get the order number of the columns that are part of the primary key

◆ GetPrimaryKeyColumnStringList()

static string[] Ict.Common.Data.TTypedDataTable.GetPrimaryKeyColumnStringList ( short ATableNumber )

inlinestaticinherited

get the names of the columns that are part of the primary key

◆ GetPrintInBoldDBName()

static string Ict.Petra.Shared.MFinance.Account.Data.AFormTable.GetPrintInBoldDBName ( )

inlinestatic

get the name of the field in the database for this column

◆ GetPrintInBoldHelp()

static string Ict.Petra.Shared.MFinance.Account.Data.AFormTable.GetPrintInBoldHelp ( )

inlinestatic

get the help text for the field in the database for this column

◆ GetPrintInBoldLength()

static short Ict.Petra.Shared.MFinance.Account.Data.AFormTable.GetPrintInBoldLength ( )

inlinestatic

get character length for column

◆ GetTableByName()

static TTypedTableInfo Ict.Common.Data.TTypedDataTable.GetTableByName ( string ATableName )

inlinestaticinherited

the table name in CamelCase

◆ GetTableDBLabel()

static string Ict.Petra.Shared.MFinance.Account.Data.AFormTable.GetTableDBLabel ( )

inlinestatic

static method to return the 'Label' of the table as it is used in the database (the 'Label' is usually a short description of what the db table is about)

◆ GetTableDBName()

static string Ict.Petra.Shared.MFinance.Account.Data.AFormTable.GetTableDBName ( )

inlinestatic

return the name of the table as it is used in the database

◆ GetTableName() [1/2]

static string Ict.Petra.Shared.MFinance.Account.Data.AFormTable.GetTableName ( )

inlinestatic

return the CamelCase name of the table

◆ GetTableName() [2/2]

static string Ict.Common.Data.TTypedDataTable.GetTableName ( short ATableNumber )

inlinestaticinherited

the table name in CamelCase

◆ GetTableNameSQL()

static string Ict.Common.Data.TTypedDataTable.GetTableNameSQL ( short ATableNumber )

inlinestaticinherited

the table name as it is in the SQL database

◆ GetUniqueKeyColumnOrdList()

static int[] Ict.Common.Data.TTypedDataTable.GetUniqueKeyColumnOrdList ( short ATableNumber )

inlinestaticinherited

get the order number of the columns that are part of a unique key

◆ GetUniqueKeyColumnStringList()

static string[] Ict.Common.Data.TTypedDataTable.GetUniqueKeyColumnStringList ( short ATableNumber )

inlinestaticinherited

get the names of the columns that are part of the unique key

◆ InitClass()

override void Ict.Petra.Shared.MFinance.Account.Data.AFormTable.InitClass ( )

inlineprotectedvirtual

create the columns

Implements Ict.Common.Data.TTypedDataTable.

◆ InitVars()

override void Ict.Petra.Shared.MFinance.Account.Data.AFormTable.InitVars ( )

inlinevirtual

assign columns to properties, set primary key

Implements Ict.Common.Data.TTypedDataTable.

◆ IsAvailableForCustomReport()

virtual bool Ict.Common.Data.TTypedDataTable.IsAvailableForCustomReport ( )

inlinevirtualinherited

Is this table generally available in custom reports?

◆ NewRowFromBuilder()

override System.Data.DataRow Ict.Petra.Shared.MFinance.Account.Data.AFormTable.NewRowFromBuilder ( System.Data.DataRowBuilder builder )

inlineprotected

new typed row using DataRowBuilder

◆ NewRowTyped() [1/2]

AFormRow Ict.Petra.Shared.MFinance.Account.Data.AFormTable.NewRowTyped ( )

inline

create a new typed row, always with default values

◆ NewRowTyped() [2/2]

AFormRow Ict.Petra.Shared.MFinance.Account.Data.AFormTable.NewRowTyped ( bool AWithDefaultValues )

inline

create a new typed row

◆ RemoveColumnsNotInTableTemplate()

void Ict.Common.Data.TTypedDataTable.RemoveColumnsNotInTableTemplate ( DataTable ATableTemplate )

inlineinherited

remove columns that are not needed

Parameters

ATableTemplate this table only contains the columns that should be kept

◆ ResetStaticVariables()

static void Ict.Common.Data.TTypedDataTable.ResetStaticVariables ( )

inlinestaticinherited

reset the static variables for each Web Request call.

Member Data Documentation

◆ ColumnCreatedBy

DataColumn Ict.Petra.Shared.MFinance.Account.Data.AFormTable.ColumnCreatedBy

User ID of who created this record.

◆ ColumnCreatedById

readonly short Ict.Petra.Shared.MFinance.Account.Data.AFormTable.ColumnCreatedById = 11

static

used for generic TTypedDataTable functions

◆ ColumnDateCreated

DataColumn Ict.Petra.Shared.MFinance.Account.Data.AFormTable.ColumnDateCreated

The date the record was created.

◆ ColumnDateCreatedId

readonly short Ict.Petra.Shared.MFinance.Account.Data.AFormTable.ColumnDateCreatedId = 10

static

used for generic TTypedDataTable functions

◆ ColumnDateModified

DataColumn Ict.Petra.Shared.MFinance.Account.Data.AFormTable.ColumnDateModified

The date the record was modified.

◆ ColumnDateModifiedId

readonly short Ict.Petra.Shared.MFinance.Account.Data.AFormTable.ColumnDateModifiedId = 12

static

used for generic TTypedDataTable functions

◆ ColumnFormCode

DataColumn Ict.Petra.Shared.MFinance.Account.Data.AFormTable.ColumnFormCode

The code which defines the type of form described in the table.

◆ ColumnFormCodeId

readonly short Ict.Petra.Shared.MFinance.Account.Data.AFormTable.ColumnFormCodeId = 0

static

used for generic TTypedDataTable functions

◆ ColumnFormDescription

DataColumn Ict.Petra.Shared.MFinance.Account.Data.AFormTable.ColumnFormDescription

Description of the form.

◆ ColumnFormDescriptionId

readonly short Ict.Petra.Shared.MFinance.Account.Data.AFormTable.ColumnFormDescriptionId = 2

static

used for generic TTypedDataTable functions

◆ ColumnFormFileName

DataColumn Ict.Petra.Shared.MFinance.Account.Data.AFormTable.ColumnFormFileName

File name used for the form. Includes path information.

◆ ColumnFormFileNameId

readonly short Ict.Petra.Shared.MFinance.Account.Data.AFormTable.ColumnFormFileNameId = 3

static

used for generic TTypedDataTable functions

◆ ColumnFormName

DataColumn Ict.Petra.Shared.MFinance.Account.Data.AFormTable.ColumnFormName

The name of the form being created for the form code.

◆ ColumnFormNameId

readonly short Ict.Petra.Shared.MFinance.Account.Data.AFormTable.ColumnFormNameId = 1

static

used for generic TTypedDataTable functions

◆ ColumnFormTypeCode

DataColumn Ict.Petra.Shared.MFinance.Account.Data.AFormTable.ColumnFormTypeCode

If there are several types of form then it can be specified here. Eg an annual receipt and an individual receipt.

◆ ColumnFormTypeCodeId

readonly short Ict.Petra.Shared.MFinance.Account.Data.AFormTable.ColumnFormTypeCodeId = 4

static

used for generic TTypedDataTable functions

◆ ColumnLinesOnPage

DataColumn Ict.Petra.Shared.MFinance.Account.Data.AFormTable.ColumnLinesOnPage

The total number of lines that can be displayed on the page.

◆ ColumnLinesOnPageId

readonly short Ict.Petra.Shared.MFinance.Account.Data.AFormTable.ColumnLinesOnPageId = 7

static

used for generic TTypedDataTable functions

◆ ColumnMinimumAmount

DataColumn Ict.Petra.Shared.MFinance.Account.Data.AFormTable.ColumnMinimumAmount

The minimum amount that is acceptable on a receipt.

◆ ColumnMinimumAmountId

readonly short Ict.Petra.Shared.MFinance.Account.Data.AFormTable.ColumnMinimumAmountId = 8

static

used for generic TTypedDataTable functions

◆ ColumnModificationId

DataColumn Ict.Petra.Shared.MFinance.Account.Data.AFormTable.ColumnModificationId

This identifies the current version of the record.

◆ ColumnModificationIdId

readonly short Ict.Petra.Shared.MFinance.Account.Data.AFormTable.ColumnModificationIdId = 14

static

used for generic TTypedDataTable functions

◆ ColumnModifiedBy

DataColumn Ict.Petra.Shared.MFinance.Account.Data.AFormTable.ColumnModifiedBy

User ID of who last modified this record.

◆ ColumnModifiedById

readonly short Ict.Petra.Shared.MFinance.Account.Data.AFormTable.ColumnModifiedById = 13

static

used for generic TTypedDataTable functions

◆ ColumnNumberOfDetails

DataColumn Ict.Petra.Shared.MFinance.Account.Data.AFormTable.ColumnNumberOfDetails

The number of repeating lines that will be displayed on each page of a form.

◆ ColumnNumberOfDetailsId

readonly short Ict.Petra.Shared.MFinance.Account.Data.AFormTable.ColumnNumberOfDetailsId = 5

static

used for generic TTypedDataTable functions

◆ ColumnOptions

DataColumn Ict.Petra.Shared.MFinance.Account.Data.AFormTable.ColumnOptions

Allows the exclusion of certain records from a report.

◆ ColumnOptionsId

readonly short Ict.Petra.Shared.MFinance.Account.Data.AFormTable.ColumnOptionsId = 9

static

used for generic TTypedDataTable functions

◆ ColumnPrintInBold

DataColumn Ict.Petra.Shared.MFinance.Account.Data.AFormTable.ColumnPrintInBold

Is the report to be formatted to print in bold or not.

◆ ColumnPrintInBoldId

readonly short Ict.Petra.Shared.MFinance.Account.Data.AFormTable.ColumnPrintInBoldId = 6

static

used for generic TTypedDataTable functions

◆ DontThrowAwayAfterSubmitChanges

bool Ict.Common.Data.TTypedDataTable.DontThrowAwayAfterSubmitChanges = false

inherited

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

◆ TableId

readonly short Ict.Petra.Shared.MFinance.Account.Data.AFormTable.TableId = 137

static

TableId for Ict.Common.Data generic functions.

◆ TableInfo

SortedList<short, TTypedTableInfo> Ict.Common.Data.TTypedDataTable.TableInfo = new SortedList <short, TTypedTableInfo>()

staticprotectedinherited

stores information about typed tables

◆ ThrowAwayAfterSubmitChanges

bool Ict.Common.Data.TTypedDataTable.ThrowAwayAfterSubmitChanges = false

inherited

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

Property Documentation

◆ Count

int Ict.Common.Data.TTypedDataTable.Count

getinherited

the number of rows in the current table

◆ TableDBLabel

override string Ict.Petra.Shared.MFinance.Account.Data.AFormTable.TableDBLabel

get

instance property to get the 'Label' of the table as it is used in the database (the 'Label' is usually a short description of what the db table is about)

◆ this[int i]

AFormRow Ict.Petra.Shared.MFinance.Account.Data.AFormTable.this[int i]

get

Access a typed row by index.

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

csharp/ICT/Petra/Shared/lib/data/Account.Tables-generated.cs

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Protected Member Functions

Static Protected Attributes

Properties

Detailed Description

Constructor & Destructor Documentation

◆ AFormTable() [1/3]

◆ AFormTable() [2/3]

◆ AFormTable() [3/3]

Member Function Documentation

◆ CreateOdbcParameter() [1/3]

◆ CreateOdbcParameter() [2/3]

◆ CreateOdbcParameter() [3/3]

◆ GetChanges()

◆ GetChangesTyped()

◆ GetChangesTypedInternal()

◆ GetColumnNameSQL()

◆ GetColumnStringList()

◆ GetCreatedByDBName()

◆ GetCreatedByHelp()

◆ GetCreatedByLength()

◆ GetCustomReportFieldList()

◆ GetCustomReportPermission()

◆ GetDateCreatedDBName()

◆ GetDateCreatedHelp()

◆ GetDateCreatedLength()

◆ GetDateModifiedDBName()

◆ GetDateModifiedHelp()

◆ GetDateModifiedLength()

◆ GetFormCodeDBName()

◆ GetFormCodeHelp()

◆ GetFormCodeLength()

◆ GetFormDescriptionDBName()

◆ GetFormDescriptionHelp()

◆ GetFormDescriptionLength()

◆ GetFormFileNameDBName()

◆ GetFormFileNameHelp()

◆ GetFormFileNameLength()

◆ GetFormNameDBName()

◆ GetFormNameHelp()

◆ GetFormNameLength()

◆ GetFormTypeCodeDBName()

◆ GetFormTypeCodeHelp()

◆ GetFormTypeCodeLength()

◆ GetKeyColumnStringList()

◆ GetLabel()

◆ GetLength() [1/2]

◆ GetLength() [2/2]

◆ GetLinesOnPageDBName()

◆ GetLinesOnPageHelp()

◆ GetLinesOnPageLength()

◆ GetMinimumAmountDBName()

◆ GetMinimumAmountHelp()

◆ GetMinimumAmountLength()

◆ GetModificationIdDBName()

◆ GetModificationIdHelp()

◆ GetModificationIdLength()

◆ GetModifiedByDBName()

◆ GetModifiedByHelp()

◆ GetModifiedByLength()

◆ GetNumberOfDetailsDBName()

◆ GetNumberOfDetailsHelp()

◆ GetNumberOfDetailsLength()

◆ GetOptionsDBName()

◆ GetOptionsHelp()

◆ GetOptionsLength()

◆ GetPrimaryKeyColumnOrdList()

◆ GetPrimaryKeyColumnStringList()

◆ GetPrintInBoldDBName()

◆ GetPrintInBoldHelp()

◆ GetPrintInBoldLength()

◆ GetTableByName()

◆ GetTableDBLabel()

◆ GetTableDBName()

◆ GetTableName() [1/2]

◆ GetTableName() [2/2]

◆ GetTableNameSQL()