OpenPetra
Free Administration Software for Non-Profits
Ict.Petra.Shared.MSysMan.Data.SFormTable Class Reference

List of forms for printers. More...

Inheritance diagram for Ict.Petra.Shared.MSysMan.Data.SFormTable:
Ict.Common.Data.TTypedDataTable

Public Member Functions

 SFormTable ()
 constructor More...
 
 SFormTable (string ATablename)
 constructor More...
 
 SFormTable (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...
 
SFormRow NewRowTyped (bool AWithDefaultValues)
 create a new typed row More...
 
SFormRow NewRowTyped ()
 create a new typed row, always with default values More...
 
SFormTable 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 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 GetDefaultFontDBName ()
 get the name of the field in the database for this column More...
 
static short GetDefaultFontLength ()
 get character length for column More...
 
static string GetDefaultFontHelp ()
 get the help text for the field in the database for this column More...
 
static string GetDefaultFontSizeDBName ()
 get the name of the field in the database for this column More...
 
static short GetDefaultFontSizeLength ()
 get character length for column More...
 
static string GetDefaultFontSizeHelp ()
 get the help text for the field in the database for this column More...
 
static string GetDefaultLpiDBName ()
 get the name of the field in the database for this column More...
 
static short GetDefaultLpiLength ()
 get character length for column More...
 
static string GetDefaultLpiHelp ()
 get the help text for the field in the database for this column More...
 
static string GetDefaultCpiDBName ()
 get the name of the field in the database for this column More...
 
static short GetDefaultCpiLength ()
 get character length for column More...
 
static string GetDefaultCpiHelp ()
 get the help text for the field in the database for this column More...
 
static string GetFormLengthDBName ()
 get the name of the field in the database for this column More...
 
static short GetFormLengthLength ()
 get character length for column More...
 
static string GetFormLengthHelp ()
 get the help text for the field in the database for this column More...
 
static string GetFormWidthDBName ()
 get the name of the field in the database for this column More...
 
static short GetFormWidthLength ()
 get character length for column More...
 
static string GetFormWidthHelp ()
 get the help text for the field in the database for this column More...
 
static string GetFormOrientationDBName ()
 get the name of the field in the database for this column More...
 
static short GetFormOrientationLength ()
 get character length for column More...
 
static string GetFormOrientationHelp ()
 get the help text for the field in the database for this column More...
 
static string GetUnitOfMeasureDBName ()
 get the name of the field in the database for this column More...
 
static short GetUnitOfMeasureLength ()
 get character length for column More...
 
static string GetUnitOfMeasureHelp ()
 get the help text for the field in the database for this column More...
 
static string GetTopMarginDBName ()
 get the name of the field in the database for this column More...
 
static short GetTopMarginLength ()
 get character length for column More...
 
static string GetTopMarginHelp ()
 get the help text for the field in the database for this column More...
 
static string GetBottomMarginDBName ()
 get the name of the field in the database for this column More...
 
static short GetBottomMarginLength ()
 get character length for column More...
 
static string GetBottomMarginHelp ()
 get the help text for the field in the database for this column More...
 
static string GetLeftMarginDBName ()
 get the name of the field in the database for this column More...
 
static short GetLeftMarginLength ()
 get character length for column More...
 
static string GetLeftMarginHelp ()
 get the help text for the field in the database for this column More...
 
static string GetRightMarginDBName ()
 get the name of the field in the database for this column More...
 
static short GetRightMarginLength ()
 get character length for column More...
 
static string GetRightMarginHelp ()
 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 ColumnFormName
 This identifies the form. More...
 
DataColumn ColumnFormDescription
 This is a description of the form. More...
 
DataColumn ColumnDefaultFont
 
DataColumn ColumnDefaultFontSize
 Default font size (points) More...
 
DataColumn ColumnDefaultLpi
 Number of lines per unit of measure. More...
 
DataColumn ColumnDefaultCpi
 Number of characters per unit of measure. More...
 
DataColumn ColumnFormLength
 Height of the page. More...
 
DataColumn ColumnFormWidth
 Width of the page. More...
 
DataColumn ColumnFormOrientation
 
DataColumn ColumnUnitOfMeasure
 Unit of measure for the form. True if inches, false if centimeters. More...
 
DataColumn ColumnTopMargin
 Top margin. More...
 
DataColumn ColumnBottomMargin
 Bottom margin. More...
 
DataColumn ColumnLeftMargin
 Left margin. More...
 
DataColumn ColumnRightMargin
 Right margin. 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 = 9
 TableId for Ict.Common.Data generic functions. More...
 
static readonly short ColumnFormNameId = 0
 used for generic TTypedDataTable functions More...
 
static readonly short ColumnFormDescriptionId = 1
 used for generic TTypedDataTable functions More...
 
static readonly short ColumnDefaultFontId = 2
 used for generic TTypedDataTable functions More...
 
static readonly short ColumnDefaultFontSizeId = 3
 used for generic TTypedDataTable functions More...
 
static readonly short ColumnDefaultLpiId = 4
 used for generic TTypedDataTable functions More...
 
static readonly short ColumnDefaultCpiId = 5
 used for generic TTypedDataTable functions More...
 
static readonly short ColumnFormLengthId = 6
 used for generic TTypedDataTable functions More...
 
static readonly short ColumnFormWidthId = 7
 used for generic TTypedDataTable functions More...
 
static readonly short ColumnFormOrientationId = 8
 used for generic TTypedDataTable functions More...
 
static readonly short ColumnUnitOfMeasureId = 9
 used for generic TTypedDataTable functions More...
 
static readonly short ColumnTopMarginId = 10
 used for generic TTypedDataTable functions More...
 
static readonly short ColumnBottomMarginId = 11
 used for generic TTypedDataTable functions More...
 
static readonly short ColumnLeftMarginId = 12
 used for generic TTypedDataTable functions More...
 
static readonly short ColumnRightMarginId = 13
 used for generic TTypedDataTable functions More...
 
static readonly short ColumnDateCreatedId = 14
 used for generic TTypedDataTable functions More...
 
static readonly short ColumnCreatedById = 15
 used for generic TTypedDataTable functions More...
 
static readonly short ColumnDateModifiedId = 16
 used for generic TTypedDataTable functions More...
 
static readonly short ColumnModifiedById = 17
 used for generic TTypedDataTable functions More...
 
static readonly short ColumnModificationIdId = 18
 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

SFormRow 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

List of forms for printers.

Constructor & Destructor Documentation

◆ SFormTable() [1/3]

Ict.Petra.Shared.MSysMan.Data.SFormTable.SFormTable ( )
inline

constructor

◆ SFormTable() [2/3]

Ict.Petra.Shared.MSysMan.Data.SFormTable.SFormTable ( string  ATablename)
inline

constructor

◆ SFormTable() [3/3]

Ict.Petra.Shared.MSysMan.Data.SFormTable.SFormTable ( 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.MSysMan.Data.SFormTable.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

◆ GetBottomMarginDBName()

static string Ict.Petra.Shared.MSysMan.Data.SFormTable.GetBottomMarginDBName ( )
inlinestatic

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

◆ GetBottomMarginHelp()

static string Ict.Petra.Shared.MSysMan.Data.SFormTable.GetBottomMarginHelp ( )
inlinestatic

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

◆ GetBottomMarginLength()

static short Ict.Petra.Shared.MSysMan.Data.SFormTable.GetBottomMarginLength ( )
inlinestatic

get character length for column

◆ GetChanges()

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

make sure that we use GetChangesType instead of GetChanges

Returns
throws an exception

◆ GetChangesTyped()

SFormTable Ict.Petra.Shared.MSysMan.Data.SFormTable.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.MSysMan.Data.SFormTable.GetCreatedByDBName ( )
inlinestatic

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

◆ GetCreatedByHelp()

static string Ict.Petra.Shared.MSysMan.Data.SFormTable.GetCreatedByHelp ( )
inlinestatic

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

◆ GetCreatedByLength()

static short Ict.Petra.Shared.MSysMan.Data.SFormTable.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.MSysMan.Data.SFormTable.GetDateCreatedDBName ( )
inlinestatic

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

◆ GetDateCreatedHelp()

static string Ict.Petra.Shared.MSysMan.Data.SFormTable.GetDateCreatedHelp ( )
inlinestatic

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

◆ GetDateCreatedLength()

static short Ict.Petra.Shared.MSysMan.Data.SFormTable.GetDateCreatedLength ( )
inlinestatic

get character length for column

◆ GetDateModifiedDBName()

static string Ict.Petra.Shared.MSysMan.Data.SFormTable.GetDateModifiedDBName ( )
inlinestatic

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

◆ GetDateModifiedHelp()

static string Ict.Petra.Shared.MSysMan.Data.SFormTable.GetDateModifiedHelp ( )
inlinestatic

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

◆ GetDateModifiedLength()

static short Ict.Petra.Shared.MSysMan.Data.SFormTable.GetDateModifiedLength ( )
inlinestatic

get character length for column

◆ GetDefaultCpiDBName()

static string Ict.Petra.Shared.MSysMan.Data.SFormTable.GetDefaultCpiDBName ( )
inlinestatic

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

◆ GetDefaultCpiHelp()

static string Ict.Petra.Shared.MSysMan.Data.SFormTable.GetDefaultCpiHelp ( )
inlinestatic

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

◆ GetDefaultCpiLength()

static short Ict.Petra.Shared.MSysMan.Data.SFormTable.GetDefaultCpiLength ( )
inlinestatic

get character length for column

◆ GetDefaultFontDBName()

static string Ict.Petra.Shared.MSysMan.Data.SFormTable.GetDefaultFontDBName ( )
inlinestatic

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

◆ GetDefaultFontHelp()

static string Ict.Petra.Shared.MSysMan.Data.SFormTable.GetDefaultFontHelp ( )
inlinestatic

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

◆ GetDefaultFontLength()

static short Ict.Petra.Shared.MSysMan.Data.SFormTable.GetDefaultFontLength ( )
inlinestatic

get character length for column

◆ GetDefaultFontSizeDBName()

static string Ict.Petra.Shared.MSysMan.Data.SFormTable.GetDefaultFontSizeDBName ( )
inlinestatic

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

◆ GetDefaultFontSizeHelp()

static string Ict.Petra.Shared.MSysMan.Data.SFormTable.GetDefaultFontSizeHelp ( )
inlinestatic

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

◆ GetDefaultFontSizeLength()

static short Ict.Petra.Shared.MSysMan.Data.SFormTable.GetDefaultFontSizeLength ( )
inlinestatic

get character length for column

◆ GetDefaultLpiDBName()

static string Ict.Petra.Shared.MSysMan.Data.SFormTable.GetDefaultLpiDBName ( )
inlinestatic

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

◆ GetDefaultLpiHelp()

static string Ict.Petra.Shared.MSysMan.Data.SFormTable.GetDefaultLpiHelp ( )
inlinestatic

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

◆ GetDefaultLpiLength()

static short Ict.Petra.Shared.MSysMan.Data.SFormTable.GetDefaultLpiLength ( )
inlinestatic

get character length for column

◆ GetFormDescriptionDBName()

static string Ict.Petra.Shared.MSysMan.Data.SFormTable.GetFormDescriptionDBName ( )
inlinestatic

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

◆ GetFormDescriptionHelp()

static string Ict.Petra.Shared.MSysMan.Data.SFormTable.GetFormDescriptionHelp ( )
inlinestatic

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

◆ GetFormDescriptionLength()

static short Ict.Petra.Shared.MSysMan.Data.SFormTable.GetFormDescriptionLength ( )
inlinestatic

get character length for column

◆ GetFormLengthDBName()

static string Ict.Petra.Shared.MSysMan.Data.SFormTable.GetFormLengthDBName ( )
inlinestatic

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

◆ GetFormLengthHelp()

static string Ict.Petra.Shared.MSysMan.Data.SFormTable.GetFormLengthHelp ( )
inlinestatic

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

◆ GetFormLengthLength()

static short Ict.Petra.Shared.MSysMan.Data.SFormTable.GetFormLengthLength ( )
inlinestatic

get character length for column

◆ GetFormNameDBName()

static string Ict.Petra.Shared.MSysMan.Data.SFormTable.GetFormNameDBName ( )
inlinestatic

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

◆ GetFormNameHelp()

static string Ict.Petra.Shared.MSysMan.Data.SFormTable.GetFormNameHelp ( )
inlinestatic

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

◆ GetFormNameLength()

static short Ict.Petra.Shared.MSysMan.Data.SFormTable.GetFormNameLength ( )
inlinestatic

get character length for column

◆ GetFormOrientationDBName()

static string Ict.Petra.Shared.MSysMan.Data.SFormTable.GetFormOrientationDBName ( )
inlinestatic

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

◆ GetFormOrientationHelp()

static string Ict.Petra.Shared.MSysMan.Data.SFormTable.GetFormOrientationHelp ( )
inlinestatic

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

◆ GetFormOrientationLength()

static short Ict.Petra.Shared.MSysMan.Data.SFormTable.GetFormOrientationLength ( )
inlinestatic

get character length for column

◆ GetFormWidthDBName()

static string Ict.Petra.Shared.MSysMan.Data.SFormTable.GetFormWidthDBName ( )
inlinestatic

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

◆ GetFormWidthHelp()

static string Ict.Petra.Shared.MSysMan.Data.SFormTable.GetFormWidthHelp ( )
inlinestatic

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

◆ GetFormWidthLength()

static short Ict.Petra.Shared.MSysMan.Data.SFormTable.GetFormWidthLength ( )
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

◆ GetLeftMarginDBName()

static string Ict.Petra.Shared.MSysMan.Data.SFormTable.GetLeftMarginDBName ( )
inlinestatic

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

◆ GetLeftMarginHelp()

static string Ict.Petra.Shared.MSysMan.Data.SFormTable.GetLeftMarginHelp ( )
inlinestatic

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

◆ GetLeftMarginLength()

static short Ict.Petra.Shared.MSysMan.Data.SFormTable.GetLeftMarginLength ( )
inlinestatic

get character length for 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

◆ GetModificationIdDBName()

static string Ict.Petra.Shared.MSysMan.Data.SFormTable.GetModificationIdDBName ( )
inlinestatic

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

◆ GetModificationIdHelp()

static string Ict.Petra.Shared.MSysMan.Data.SFormTable.GetModificationIdHelp ( )
inlinestatic

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

◆ GetModificationIdLength()

static short Ict.Petra.Shared.MSysMan.Data.SFormTable.GetModificationIdLength ( )
inlinestatic

get character length for column

◆ GetModifiedByDBName()

static string Ict.Petra.Shared.MSysMan.Data.SFormTable.GetModifiedByDBName ( )
inlinestatic

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

◆ GetModifiedByHelp()

static string Ict.Petra.Shared.MSysMan.Data.SFormTable.GetModifiedByHelp ( )
inlinestatic

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

◆ GetModifiedByLength()

static short Ict.Petra.Shared.MSysMan.Data.SFormTable.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

◆ GetRightMarginDBName()

static string Ict.Petra.Shared.MSysMan.Data.SFormTable.GetRightMarginDBName ( )
inlinestatic

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

◆ GetRightMarginHelp()

static string Ict.Petra.Shared.MSysMan.Data.SFormTable.GetRightMarginHelp ( )
inlinestatic

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

◆ GetRightMarginLength()

static short Ict.Petra.Shared.MSysMan.Data.SFormTable.GetRightMarginLength ( )
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.MSysMan.Data.SFormTable.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.MSysMan.Data.SFormTable.GetTableDBName ( )
inlinestatic

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

◆ GetTableName() [1/2]

static string Ict.Petra.Shared.MSysMan.Data.SFormTable.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

◆ GetTopMarginDBName()

static string Ict.Petra.Shared.MSysMan.Data.SFormTable.GetTopMarginDBName ( )
inlinestatic

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

◆ GetTopMarginHelp()

static string Ict.Petra.Shared.MSysMan.Data.SFormTable.GetTopMarginHelp ( )
inlinestatic

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

◆ GetTopMarginLength()

static short Ict.Petra.Shared.MSysMan.Data.SFormTable.GetTopMarginLength ( )
inlinestatic

get character length for column

◆ 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

◆ GetUnitOfMeasureDBName()

static string Ict.Petra.Shared.MSysMan.Data.SFormTable.GetUnitOfMeasureDBName ( )
inlinestatic

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

◆ GetUnitOfMeasureHelp()

static string Ict.Petra.Shared.MSysMan.Data.SFormTable.GetUnitOfMeasureHelp ( )
inlinestatic

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

◆ GetUnitOfMeasureLength()

static short Ict.Petra.Shared.MSysMan.Data.SFormTable.GetUnitOfMeasureLength ( )
inlinestatic

get character length for column

◆ InitClass()

override void Ict.Petra.Shared.MSysMan.Data.SFormTable.InitClass ( )
inlineprotectedvirtual

create the columns

Implements Ict.Common.Data.TTypedDataTable.

◆ InitVars()

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

new typed row using DataRowBuilder

◆ NewRowTyped() [1/2]

SFormRow Ict.Petra.Shared.MSysMan.Data.SFormTable.NewRowTyped ( )
inline

create a new typed row, always with default values

◆ NewRowTyped() [2/2]

SFormRow Ict.Petra.Shared.MSysMan.Data.SFormTable.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

◆ ColumnBottomMargin

DataColumn Ict.Petra.Shared.MSysMan.Data.SFormTable.ColumnBottomMargin

Bottom margin.

◆ ColumnBottomMarginId

readonly short Ict.Petra.Shared.MSysMan.Data.SFormTable.ColumnBottomMarginId = 11
static

used for generic TTypedDataTable functions

◆ ColumnCreatedBy

DataColumn Ict.Petra.Shared.MSysMan.Data.SFormTable.ColumnCreatedBy

User ID of who created this record.

◆ ColumnCreatedById

readonly short Ict.Petra.Shared.MSysMan.Data.SFormTable.ColumnCreatedById = 15
static

used for generic TTypedDataTable functions

◆ ColumnDateCreated

DataColumn Ict.Petra.Shared.MSysMan.Data.SFormTable.ColumnDateCreated

The date the record was created.

◆ ColumnDateCreatedId

readonly short Ict.Petra.Shared.MSysMan.Data.SFormTable.ColumnDateCreatedId = 14
static

used for generic TTypedDataTable functions

◆ ColumnDateModified

DataColumn Ict.Petra.Shared.MSysMan.Data.SFormTable.ColumnDateModified

The date the record was modified.

◆ ColumnDateModifiedId

readonly short Ict.Petra.Shared.MSysMan.Data.SFormTable.ColumnDateModifiedId = 16
static

used for generic TTypedDataTable functions

◆ ColumnDefaultCpi

DataColumn Ict.Petra.Shared.MSysMan.Data.SFormTable.ColumnDefaultCpi

Number of characters per unit of measure.

◆ ColumnDefaultCpiId

readonly short Ict.Petra.Shared.MSysMan.Data.SFormTable.ColumnDefaultCpiId = 5
static

used for generic TTypedDataTable functions

◆ ColumnDefaultFont

DataColumn Ict.Petra.Shared.MSysMan.Data.SFormTable.ColumnDefaultFont

◆ ColumnDefaultFontId

readonly short Ict.Petra.Shared.MSysMan.Data.SFormTable.ColumnDefaultFontId = 2
static

used for generic TTypedDataTable functions

◆ ColumnDefaultFontSize

DataColumn Ict.Petra.Shared.MSysMan.Data.SFormTable.ColumnDefaultFontSize

Default font size (points)

◆ ColumnDefaultFontSizeId

readonly short Ict.Petra.Shared.MSysMan.Data.SFormTable.ColumnDefaultFontSizeId = 3
static

used for generic TTypedDataTable functions

◆ ColumnDefaultLpi

DataColumn Ict.Petra.Shared.MSysMan.Data.SFormTable.ColumnDefaultLpi

Number of lines per unit of measure.

◆ ColumnDefaultLpiId

readonly short Ict.Petra.Shared.MSysMan.Data.SFormTable.ColumnDefaultLpiId = 4
static

used for generic TTypedDataTable functions

◆ ColumnFormDescription

DataColumn Ict.Petra.Shared.MSysMan.Data.SFormTable.ColumnFormDescription

This is a description of the form.

◆ ColumnFormDescriptionId

readonly short Ict.Petra.Shared.MSysMan.Data.SFormTable.ColumnFormDescriptionId = 1
static

used for generic TTypedDataTable functions

◆ ColumnFormLength

DataColumn Ict.Petra.Shared.MSysMan.Data.SFormTable.ColumnFormLength

Height of the page.

◆ ColumnFormLengthId

readonly short Ict.Petra.Shared.MSysMan.Data.SFormTable.ColumnFormLengthId = 6
static

used for generic TTypedDataTable functions

◆ ColumnFormName

DataColumn Ict.Petra.Shared.MSysMan.Data.SFormTable.ColumnFormName

This identifies the form.

◆ ColumnFormNameId

readonly short Ict.Petra.Shared.MSysMan.Data.SFormTable.ColumnFormNameId = 0
static

used for generic TTypedDataTable functions

◆ ColumnFormOrientation

DataColumn Ict.Petra.Shared.MSysMan.Data.SFormTable.ColumnFormOrientation

◆ ColumnFormOrientationId

readonly short Ict.Petra.Shared.MSysMan.Data.SFormTable.ColumnFormOrientationId = 8
static

used for generic TTypedDataTable functions

◆ ColumnFormWidth

DataColumn Ict.Petra.Shared.MSysMan.Data.SFormTable.ColumnFormWidth

Width of the page.

◆ ColumnFormWidthId

readonly short Ict.Petra.Shared.MSysMan.Data.SFormTable.ColumnFormWidthId = 7
static

used for generic TTypedDataTable functions

◆ ColumnLeftMargin

DataColumn Ict.Petra.Shared.MSysMan.Data.SFormTable.ColumnLeftMargin

Left margin.

◆ ColumnLeftMarginId

readonly short Ict.Petra.Shared.MSysMan.Data.SFormTable.ColumnLeftMarginId = 12
static

used for generic TTypedDataTable functions

◆ ColumnModificationId

DataColumn Ict.Petra.Shared.MSysMan.Data.SFormTable.ColumnModificationId

This identifies the current version of the record.

◆ ColumnModificationIdId

readonly short Ict.Petra.Shared.MSysMan.Data.SFormTable.ColumnModificationIdId = 18
static

used for generic TTypedDataTable functions

◆ ColumnModifiedBy

DataColumn Ict.Petra.Shared.MSysMan.Data.SFormTable.ColumnModifiedBy

User ID of who last modified this record.

◆ ColumnModifiedById

readonly short Ict.Petra.Shared.MSysMan.Data.SFormTable.ColumnModifiedById = 17
static

used for generic TTypedDataTable functions

◆ ColumnRightMargin

DataColumn Ict.Petra.Shared.MSysMan.Data.SFormTable.ColumnRightMargin

Right margin.

◆ ColumnRightMarginId

readonly short Ict.Petra.Shared.MSysMan.Data.SFormTable.ColumnRightMarginId = 13
static

used for generic TTypedDataTable functions

◆ ColumnTopMargin

DataColumn Ict.Petra.Shared.MSysMan.Data.SFormTable.ColumnTopMargin

Top margin.

◆ ColumnTopMarginId

readonly short Ict.Petra.Shared.MSysMan.Data.SFormTable.ColumnTopMarginId = 10
static

used for generic TTypedDataTable functions

◆ ColumnUnitOfMeasure

DataColumn Ict.Petra.Shared.MSysMan.Data.SFormTable.ColumnUnitOfMeasure

Unit of measure for the form. True if inches, false if centimeters.

◆ ColumnUnitOfMeasureId

readonly short Ict.Petra.Shared.MSysMan.Data.SFormTable.ColumnUnitOfMeasureId = 9
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.MSysMan.Data.SFormTable.TableId = 9
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.MSysMan.Data.SFormTable.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]

SFormRow Ict.Petra.Shared.MSysMan.Data.SFormTable.this[int i]
get

Access a typed row by index.


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