OpenPetra
Free Administration Software for Non-Profits
Ict.Petra.Shared.MFinance.Account.Data.AFormElementTable Class Reference

Each element that can be displayed on a form is defined on this table. More...

Inheritance diagram for Ict.Petra.Shared.MFinance.Account.Data.AFormElementTable:
Ict.Common.Data.TTypedDataTable

Public Member Functions

 AFormElementTable ()
 constructor More...
 
 AFormElementTable (string ATablename)
 constructor More...
 
 AFormElementTable (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...
 
AFormElementRow NewRowTyped (bool AWithDefaultValues)
 create a new typed row More...
 
AFormElementRow NewRowTyped ()
 create a new typed row, always with default values More...
 
AFormElementTable 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 GetFormSequenceDBName ()
 get the name of the field in the database for this column More...
 
static short GetFormSequenceLength ()
 get character length for column More...
 
static string GetFormSequenceHelp ()
 get the help text for the field in the database for this column More...
 
static string GetFormElementTypeCodeDBName ()
 get the name of the field in the database for this column More...
 
static short GetFormElementTypeCodeLength ()
 get character length for column More...
 
static string GetFormElementTypeCodeHelp ()
 get the help text for the field in the database for this column More...
 
static string GetColumnDBName ()
 get the name of the field in the database for this column More...
 
static short GetColumnLength ()
 get character length for column More...
 
static string GetColumnHelp ()
 get the help text for the field in the database for this column More...
 
static string GetRowDBName ()
 get the name of the field in the database for this column More...
 
static short GetRowLength ()
 get character length for column More...
 
static string GetRowHelp ()
 get the help text for the field in the database for this column More...
 
static string GetLengthDBName ()
 get the name of the field in the database for this column More...
 
static short GetLengthLength ()
 get character length for column More...
 
static string GetLengthHelp ()
 get the help text for the field in the database for this column More...
 
static string GetSkipDBName ()
 get the name of the field in the database for this column More...
 
static short GetSkipLength ()
 get character length for column More...
 
static string GetSkipHelp ()
 get the help text for the field in the database for this column More...
 
static string GetWhenPrintDBName ()
 get the name of the field in the database for this column More...
 
static short GetWhenPrintLength ()
 get character length for column More...
 
static string GetWhenPrintHelp ()
 get the help text for the field in the database for this column More...
 
static string GetLiteralTextDBName ()
 get the name of the field in the database for this column More...
 
static short GetLiteralTextLength ()
 get character length for column More...
 
static string GetLiteralTextHelp ()
 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 ColumnFormSequence
 Unique identifier of each form element within a form. More...
 
DataColumn ColumnFormElementTypeCode
 The code of an element type that can be possitioned for use on a form. More...
 
DataColumn ColumnColumn
 The column that the element is to be displayed at on the form. More...
 
DataColumn ColumnRow
 The row on the page that the element is to be displayed at. More...
 
DataColumn ColumnLength
 The display length for the element. e.g. it may be necessary to truncate fields. More...
 
DataColumn ColumnSkip
 This stores the number of characters to skip prior to printing. It can be used to spread a description over two lines. More...
 
DataColumn ColumnWhenPrint
 Indicates when the element is printed. This would indicate detail lines, first, last page etc. More...
 
DataColumn ColumnLiteralText
 Text to be displayed if the element is defined as a literal. 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 = 139
 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 ColumnFormSequenceId = 2
 used for generic TTypedDataTable functions More...
 
static readonly short ColumnFormElementTypeCodeId = 3
 used for generic TTypedDataTable functions More...
 
static readonly short ColumnColumnId = 4
 used for generic TTypedDataTable functions More...
 
static readonly short ColumnRowId = 5
 used for generic TTypedDataTable functions More...
 
static readonly short ColumnLengthId = 6
 used for generic TTypedDataTable functions More...
 
static readonly short ColumnSkipId = 7
 used for generic TTypedDataTable functions More...
 
static readonly short ColumnWhenPrintId = 8
 used for generic TTypedDataTable functions More...
 
static readonly short ColumnLiteralTextId = 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, TTypedTableInfoTableInfo = new SortedList <short, TTypedTableInfo>()
 stores information about typed tables More...
 

Properties

AFormElementRow 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

Each element that can be displayed on a form is defined on this table.

Constructor & Destructor Documentation

◆ AFormElementTable() [1/3]

Ict.Petra.Shared.MFinance.Account.Data.AFormElementTable.AFormElementTable ( )
inline

constructor

◆ AFormElementTable() [2/3]

Ict.Petra.Shared.MFinance.Account.Data.AFormElementTable.AFormElementTable ( string  ATablename)
inline

constructor

◆ AFormElementTable() [3/3]

Ict.Petra.Shared.MFinance.Account.Data.AFormElementTable.AFormElementTable ( 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.AFormElementTable.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()

AFormElementTable Ict.Petra.Shared.MFinance.Account.Data.AFormElementTable.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

◆ GetColumnDBName()

static string Ict.Petra.Shared.MFinance.Account.Data.AFormElementTable.GetColumnDBName ( )
inlinestatic

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

◆ GetColumnHelp()

static string Ict.Petra.Shared.MFinance.Account.Data.AFormElementTable.GetColumnHelp ( )
inlinestatic

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

◆ GetColumnLength()

static short Ict.Petra.Shared.MFinance.Account.Data.AFormElementTable.GetColumnLength ( )
inlinestatic

get character length for column

◆ 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.AFormElementTable.GetCreatedByDBName ( )
inlinestatic

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

◆ GetCreatedByHelp()

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

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

◆ GetCreatedByLength()

static short Ict.Petra.Shared.MFinance.Account.Data.AFormElementTable.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.AFormElementTable.GetDateCreatedDBName ( )
inlinestatic

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

◆ GetDateCreatedHelp()

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

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

◆ GetDateCreatedLength()

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

get character length for column

◆ GetDateModifiedDBName()

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

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

◆ GetDateModifiedHelp()

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

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

◆ GetDateModifiedLength()

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

get character length for column

◆ GetFormCodeDBName()

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

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

◆ GetFormCodeHelp()

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

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

◆ GetFormCodeLength()

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

get character length for column

◆ GetFormElementTypeCodeDBName()

static string Ict.Petra.Shared.MFinance.Account.Data.AFormElementTable.GetFormElementTypeCodeDBName ( )
inlinestatic

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

◆ GetFormElementTypeCodeHelp()

static string Ict.Petra.Shared.MFinance.Account.Data.AFormElementTable.GetFormElementTypeCodeHelp ( )
inlinestatic

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

◆ GetFormElementTypeCodeLength()

static short Ict.Petra.Shared.MFinance.Account.Data.AFormElementTable.GetFormElementTypeCodeLength ( )
inlinestatic

get character length for column

◆ GetFormNameDBName()

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

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

◆ GetFormNameHelp()

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

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

◆ GetFormNameLength()

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

get character length for column

◆ GetFormSequenceDBName()

static string Ict.Petra.Shared.MFinance.Account.Data.AFormElementTable.GetFormSequenceDBName ( )
inlinestatic

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

◆ GetFormSequenceHelp()

static string Ict.Petra.Shared.MFinance.Account.Data.AFormElementTable.GetFormSequenceHelp ( )
inlinestatic

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

◆ GetFormSequenceLength()

static short Ict.Petra.Shared.MFinance.Account.Data.AFormElementTable.GetFormSequenceLength ( )
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

◆ GetLengthDBName()

static string Ict.Petra.Shared.MFinance.Account.Data.AFormElementTable.GetLengthDBName ( )
inlinestatic

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

◆ GetLengthHelp()

static string Ict.Petra.Shared.MFinance.Account.Data.AFormElementTable.GetLengthHelp ( )
inlinestatic

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

◆ GetLengthLength()

static short Ict.Petra.Shared.MFinance.Account.Data.AFormElementTable.GetLengthLength ( )
inlinestatic

get character length for column

◆ GetLiteralTextDBName()

static string Ict.Petra.Shared.MFinance.Account.Data.AFormElementTable.GetLiteralTextDBName ( )
inlinestatic

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

◆ GetLiteralTextHelp()

static string Ict.Petra.Shared.MFinance.Account.Data.AFormElementTable.GetLiteralTextHelp ( )
inlinestatic

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

◆ GetLiteralTextLength()

static short Ict.Petra.Shared.MFinance.Account.Data.AFormElementTable.GetLiteralTextLength ( )
inlinestatic

get character length for column

◆ GetModificationIdDBName()

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

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

◆ GetModificationIdHelp()

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

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

◆ GetModificationIdLength()

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

get character length for column

◆ GetModifiedByDBName()

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

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

◆ GetModifiedByHelp()

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

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

◆ GetModifiedByLength()

static short Ict.Petra.Shared.MFinance.Account.Data.AFormElementTable.GetModifiedByLength ( )
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

◆ GetRowDBName()

static string Ict.Petra.Shared.MFinance.Account.Data.AFormElementTable.GetRowDBName ( )
inlinestatic

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

◆ GetRowHelp()

static string Ict.Petra.Shared.MFinance.Account.Data.AFormElementTable.GetRowHelp ( )
inlinestatic

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

◆ GetRowLength()

static short Ict.Petra.Shared.MFinance.Account.Data.AFormElementTable.GetRowLength ( )
inlinestatic

get character length for column

◆ GetSkipDBName()

static string Ict.Petra.Shared.MFinance.Account.Data.AFormElementTable.GetSkipDBName ( )
inlinestatic

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

◆ GetSkipHelp()

static string Ict.Petra.Shared.MFinance.Account.Data.AFormElementTable.GetSkipHelp ( )
inlinestatic

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

◆ GetSkipLength()

static short Ict.Petra.Shared.MFinance.Account.Data.AFormElementTable.GetSkipLength ( )
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.AFormElementTable.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.AFormElementTable.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.AFormElementTable.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

◆ GetWhenPrintDBName()

static string Ict.Petra.Shared.MFinance.Account.Data.AFormElementTable.GetWhenPrintDBName ( )
inlinestatic

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

◆ GetWhenPrintHelp()

static string Ict.Petra.Shared.MFinance.Account.Data.AFormElementTable.GetWhenPrintHelp ( )
inlinestatic

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

◆ GetWhenPrintLength()

static short Ict.Petra.Shared.MFinance.Account.Data.AFormElementTable.GetWhenPrintLength ( )
inlinestatic

get character length for column

◆ InitClass()

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

create the columns

Implements Ict.Common.Data.TTypedDataTable.

◆ InitVars()

override void Ict.Petra.Shared.MFinance.Account.Data.AFormElementTable.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.AFormElementTable.NewRowFromBuilder ( System.Data.DataRowBuilder  builder)
inlineprotected

new typed row using DataRowBuilder

◆ NewRowTyped() [1/2]

AFormElementRow Ict.Petra.Shared.MFinance.Account.Data.AFormElementTable.NewRowTyped ( )
inline

create a new typed row, always with default values

◆ NewRowTyped() [2/2]

AFormElementRow Ict.Petra.Shared.MFinance.Account.Data.AFormElementTable.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
ATableTemplatethis 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

◆ ColumnColumn

DataColumn Ict.Petra.Shared.MFinance.Account.Data.AFormElementTable.ColumnColumn

The column that the element is to be displayed at on the form.

◆ ColumnColumnId

readonly short Ict.Petra.Shared.MFinance.Account.Data.AFormElementTable.ColumnColumnId = 4
static

used for generic TTypedDataTable functions

◆ ColumnCreatedBy

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

User ID of who created this record.

◆ ColumnCreatedById

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

used for generic TTypedDataTable functions

◆ ColumnDateCreated

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

The date the record was created.

◆ ColumnDateCreatedId

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

used for generic TTypedDataTable functions

◆ ColumnDateModified

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

The date the record was modified.

◆ ColumnDateModifiedId

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

used for generic TTypedDataTable functions

◆ ColumnFormCode

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

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

◆ ColumnFormCodeId

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

used for generic TTypedDataTable functions

◆ ColumnFormElementTypeCode

DataColumn Ict.Petra.Shared.MFinance.Account.Data.AFormElementTable.ColumnFormElementTypeCode

The code of an element type that can be possitioned for use on a form.

◆ ColumnFormElementTypeCodeId

readonly short Ict.Petra.Shared.MFinance.Account.Data.AFormElementTable.ColumnFormElementTypeCodeId = 3
static

used for generic TTypedDataTable functions

◆ ColumnFormName

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

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

◆ ColumnFormNameId

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

used for generic TTypedDataTable functions

◆ ColumnFormSequence

DataColumn Ict.Petra.Shared.MFinance.Account.Data.AFormElementTable.ColumnFormSequence

Unique identifier of each form element within a form.

◆ ColumnFormSequenceId

readonly short Ict.Petra.Shared.MFinance.Account.Data.AFormElementTable.ColumnFormSequenceId = 2
static

used for generic TTypedDataTable functions

◆ ColumnLength

DataColumn Ict.Petra.Shared.MFinance.Account.Data.AFormElementTable.ColumnLength

The display length for the element. e.g. it may be necessary to truncate fields.

◆ ColumnLengthId

readonly short Ict.Petra.Shared.MFinance.Account.Data.AFormElementTable.ColumnLengthId = 6
static

used for generic TTypedDataTable functions

◆ ColumnLiteralText

DataColumn Ict.Petra.Shared.MFinance.Account.Data.AFormElementTable.ColumnLiteralText

Text to be displayed if the element is defined as a literal.

◆ ColumnLiteralTextId

readonly short Ict.Petra.Shared.MFinance.Account.Data.AFormElementTable.ColumnLiteralTextId = 9
static

used for generic TTypedDataTable functions

◆ ColumnModificationId

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

This identifies the current version of the record.

◆ ColumnModificationIdId

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

used for generic TTypedDataTable functions

◆ ColumnModifiedBy

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

User ID of who last modified this record.

◆ ColumnModifiedById

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

used for generic TTypedDataTable functions

◆ ColumnRow

DataColumn Ict.Petra.Shared.MFinance.Account.Data.AFormElementTable.ColumnRow

The row on the page that the element is to be displayed at.

◆ ColumnRowId

readonly short Ict.Petra.Shared.MFinance.Account.Data.AFormElementTable.ColumnRowId = 5
static

used for generic TTypedDataTable functions

◆ ColumnSkip

DataColumn Ict.Petra.Shared.MFinance.Account.Data.AFormElementTable.ColumnSkip

This stores the number of characters to skip prior to printing. It can be used to spread a description over two lines.

◆ ColumnSkipId

readonly short Ict.Petra.Shared.MFinance.Account.Data.AFormElementTable.ColumnSkipId = 7
static

used for generic TTypedDataTable functions

◆ ColumnWhenPrint

DataColumn Ict.Petra.Shared.MFinance.Account.Data.AFormElementTable.ColumnWhenPrint

Indicates when the element is printed. This would indicate detail lines, first, last page etc.

◆ ColumnWhenPrintId

readonly short Ict.Petra.Shared.MFinance.Account.Data.AFormElementTable.ColumnWhenPrintId = 8
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.AFormElementTable.TableId = 139
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.AFormElementTable.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]

AFormElementRow Ict.Petra.Shared.MFinance.Account.Data.AFormElementTable.this[int i]
get

Access a typed row by index.


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