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

Attributes for label paper. More...

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

Public Member Functions

 SLabelTable ()
 constructor More...
 
 SLabelTable (string ATablename)
 constructor More...
 
 SLabelTable (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...
 
SLabelRow NewRowTyped (bool AWithDefaultValues)
 create a new typed row More...
 
SLabelRow NewRowTyped ()
 create a new typed row, always with default values More...
 
SLabelTable 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 GetLabelNameDBName ()
 get the name of the field in the database for this column More...
 
static short GetLabelNameLength ()
 get character length for column More...
 
static string GetLabelNameHelp ()
 get the help text for the field in the database for this column More...
 
static string GetLabelDescriptionDBName ()
 get the name of the field in the database for this column More...
 
static short GetLabelDescriptionLength ()
 get character length for column More...
 
static string GetLabelDescriptionHelp ()
 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 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 GetSideMarginDBName ()
 get the name of the field in the database for this column More...
 
static short GetSideMarginLength ()
 get character length for column More...
 
static string GetSideMarginHelp ()
 get the help text for the field in the database for this column More...
 
static string GetVerticalPitchDBName ()
 get the name of the field in the database for this column More...
 
static short GetVerticalPitchLength ()
 get character length for column More...
 
static string GetVerticalPitchHelp ()
 get the help text for the field in the database for this column More...
 
static string GetHorizontalPitchDBName ()
 get the name of the field in the database for this column More...
 
static short GetHorizontalPitchLength ()
 get character length for column More...
 
static string GetHorizontalPitchHelp ()
 get the help text for the field in the database for this column More...
 
static string GetLabelHeightDBName ()
 get the name of the field in the database for this column More...
 
static short GetLabelHeightLength ()
 get character length for column More...
 
static string GetLabelHeightHelp ()
 get the help text for the field in the database for this column More...
 
static string GetLabelWidthDBName ()
 get the name of the field in the database for this column More...
 
static short GetLabelWidthLength ()
 get character length for column More...
 
static string GetLabelWidthHelp ()
 get the help text for the field in the database for this column More...
 
static string GetLabelsAcrossDBName ()
 get the name of the field in the database for this column More...
 
static short GetLabelsAcrossLength ()
 get character length for column More...
 
static string GetLabelsAcrossHelp ()
 get the help text for the field in the database for this column More...
 
static string GetLabelsDownDBName ()
 get the name of the field in the database for this column More...
 
static short GetLabelsDownLength ()
 get character length for column More...
 
static string GetLabelsDownHelp ()
 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 ColumnLabelName
 
DataColumn ColumnLabelDescription
 
DataColumn ColumnFormName
 The form the label is designed for. More...
 
DataColumn ColumnTopMargin
 The disance from the top of the page to the top of the first label. More...
 
DataColumn ColumnSideMargin
 The distance from the left edge of the page to the left edge of the first label. More...
 
DataColumn ColumnVerticalPitch
 The distance from the top of the first label to the top of the next label. More...
 
DataColumn ColumnHorizontalPitch
 The distance from the left edge of the first label to the left edge of the next label. More...
 
DataColumn ColumnLabelHeight
 The height of each label. More...
 
DataColumn ColumnLabelWidth
 The width of each label. More...
 
DataColumn ColumnLabelsAcross
 The number of labels across a page. More...
 
DataColumn ColumnLabelsDown
 The number of labels down a page. 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 = 296
 TableId for Ict.Common.Data generic functions. More...
 
static readonly short ColumnLabelNameId = 0
 used for generic TTypedDataTable functions More...
 
static readonly short ColumnLabelDescriptionId = 1
 used for generic TTypedDataTable functions More...
 
static readonly short ColumnFormNameId = 2
 used for generic TTypedDataTable functions More...
 
static readonly short ColumnTopMarginId = 3
 used for generic TTypedDataTable functions More...
 
static readonly short ColumnSideMarginId = 4
 used for generic TTypedDataTable functions More...
 
static readonly short ColumnVerticalPitchId = 5
 used for generic TTypedDataTable functions More...
 
static readonly short ColumnHorizontalPitchId = 6
 used for generic TTypedDataTable functions More...
 
static readonly short ColumnLabelHeightId = 7
 used for generic TTypedDataTable functions More...
 
static readonly short ColumnLabelWidthId = 8
 used for generic TTypedDataTable functions More...
 
static readonly short ColumnLabelsAcrossId = 9
 used for generic TTypedDataTable functions More...
 
static readonly short ColumnLabelsDownId = 10
 used for generic TTypedDataTable functions More...
 
static readonly short ColumnDateCreatedId = 11
 used for generic TTypedDataTable functions More...
 
static readonly short ColumnCreatedById = 12
 used for generic TTypedDataTable functions More...
 
static readonly short ColumnDateModifiedId = 13
 used for generic TTypedDataTable functions More...
 
static readonly short ColumnModifiedById = 14
 used for generic TTypedDataTable functions More...
 
static readonly short ColumnModificationIdId = 15
 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

SLabelRow 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

Attributes for label paper.

Constructor & Destructor Documentation

◆ SLabelTable() [1/3]

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

constructor

◆ SLabelTable() [2/3]

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

constructor

◆ SLabelTable() [3/3]

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

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

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

◆ GetCreatedByHelp()

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

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

◆ GetCreatedByLength()

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

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

◆ GetDateCreatedHelp()

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

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

◆ GetDateCreatedLength()

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

get character length for column

◆ GetDateModifiedDBName()

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

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

◆ GetDateModifiedHelp()

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

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

◆ GetDateModifiedLength()

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

get character length for column

◆ GetFormNameDBName()

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

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

◆ GetFormNameHelp()

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

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

◆ GetFormNameLength()

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

get character length for column

◆ GetHorizontalPitchDBName()

static string Ict.Petra.Shared.MSysMan.Data.SLabelTable.GetHorizontalPitchDBName ( )
inlinestatic

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

◆ GetHorizontalPitchHelp()

static string Ict.Petra.Shared.MSysMan.Data.SLabelTable.GetHorizontalPitchHelp ( )
inlinestatic

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

◆ GetHorizontalPitchLength()

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

◆ GetLabelDescriptionDBName()

static string Ict.Petra.Shared.MSysMan.Data.SLabelTable.GetLabelDescriptionDBName ( )
inlinestatic

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

◆ GetLabelDescriptionHelp()

static string Ict.Petra.Shared.MSysMan.Data.SLabelTable.GetLabelDescriptionHelp ( )
inlinestatic

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

◆ GetLabelDescriptionLength()

static short Ict.Petra.Shared.MSysMan.Data.SLabelTable.GetLabelDescriptionLength ( )
inlinestatic

get character length for column

◆ GetLabelHeightDBName()

static string Ict.Petra.Shared.MSysMan.Data.SLabelTable.GetLabelHeightDBName ( )
inlinestatic

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

◆ GetLabelHeightHelp()

static string Ict.Petra.Shared.MSysMan.Data.SLabelTable.GetLabelHeightHelp ( )
inlinestatic

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

◆ GetLabelHeightLength()

static short Ict.Petra.Shared.MSysMan.Data.SLabelTable.GetLabelHeightLength ( )
inlinestatic

get character length for column

◆ GetLabelNameDBName()

static string Ict.Petra.Shared.MSysMan.Data.SLabelTable.GetLabelNameDBName ( )
inlinestatic

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

◆ GetLabelNameHelp()

static string Ict.Petra.Shared.MSysMan.Data.SLabelTable.GetLabelNameHelp ( )
inlinestatic

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

◆ GetLabelNameLength()

static short Ict.Petra.Shared.MSysMan.Data.SLabelTable.GetLabelNameLength ( )
inlinestatic

get character length for column

◆ GetLabelsAcrossDBName()

static string Ict.Petra.Shared.MSysMan.Data.SLabelTable.GetLabelsAcrossDBName ( )
inlinestatic

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

◆ GetLabelsAcrossHelp()

static string Ict.Petra.Shared.MSysMan.Data.SLabelTable.GetLabelsAcrossHelp ( )
inlinestatic

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

◆ GetLabelsAcrossLength()

static short Ict.Petra.Shared.MSysMan.Data.SLabelTable.GetLabelsAcrossLength ( )
inlinestatic

get character length for column

◆ GetLabelsDownDBName()

static string Ict.Petra.Shared.MSysMan.Data.SLabelTable.GetLabelsDownDBName ( )
inlinestatic

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

◆ GetLabelsDownHelp()

static string Ict.Petra.Shared.MSysMan.Data.SLabelTable.GetLabelsDownHelp ( )
inlinestatic

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

◆ GetLabelsDownLength()

static short Ict.Petra.Shared.MSysMan.Data.SLabelTable.GetLabelsDownLength ( )
inlinestatic

get character length for column

◆ GetLabelWidthDBName()

static string Ict.Petra.Shared.MSysMan.Data.SLabelTable.GetLabelWidthDBName ( )
inlinestatic

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

◆ GetLabelWidthHelp()

static string Ict.Petra.Shared.MSysMan.Data.SLabelTable.GetLabelWidthHelp ( )
inlinestatic

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

◆ GetLabelWidthLength()

static short Ict.Petra.Shared.MSysMan.Data.SLabelTable.GetLabelWidthLength ( )
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.SLabelTable.GetModificationIdDBName ( )
inlinestatic

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

◆ GetModificationIdHelp()

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

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

◆ GetModificationIdLength()

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

get character length for column

◆ GetModifiedByDBName()

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

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

◆ GetModifiedByHelp()

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

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

◆ GetModifiedByLength()

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

◆ GetSideMarginDBName()

static string Ict.Petra.Shared.MSysMan.Data.SLabelTable.GetSideMarginDBName ( )
inlinestatic

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

◆ GetSideMarginHelp()

static string Ict.Petra.Shared.MSysMan.Data.SLabelTable.GetSideMarginHelp ( )
inlinestatic

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

◆ GetSideMarginLength()

static short Ict.Petra.Shared.MSysMan.Data.SLabelTable.GetSideMarginLength ( )
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.SLabelTable.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.SLabelTable.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.SLabelTable.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.SLabelTable.GetTopMarginDBName ( )
inlinestatic

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

◆ GetTopMarginHelp()

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

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

◆ GetTopMarginLength()

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

◆ GetVerticalPitchDBName()

static string Ict.Petra.Shared.MSysMan.Data.SLabelTable.GetVerticalPitchDBName ( )
inlinestatic

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

◆ GetVerticalPitchHelp()

static string Ict.Petra.Shared.MSysMan.Data.SLabelTable.GetVerticalPitchHelp ( )
inlinestatic

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

◆ GetVerticalPitchLength()

static short Ict.Petra.Shared.MSysMan.Data.SLabelTable.GetVerticalPitchLength ( )
inlinestatic

get character length for column

◆ InitClass()

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

create the columns

Implements Ict.Common.Data.TTypedDataTable.

◆ InitVars()

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

new typed row using DataRowBuilder

◆ NewRowTyped() [1/2]

SLabelRow Ict.Petra.Shared.MSysMan.Data.SLabelTable.NewRowTyped ( )
inline

create a new typed row, always with default values

◆ NewRowTyped() [2/2]

SLabelRow Ict.Petra.Shared.MSysMan.Data.SLabelTable.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

◆ ColumnCreatedBy

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

User ID of who created this record.

◆ ColumnCreatedById

readonly short Ict.Petra.Shared.MSysMan.Data.SLabelTable.ColumnCreatedById = 12
static

used for generic TTypedDataTable functions

◆ ColumnDateCreated

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

The date the record was created.

◆ ColumnDateCreatedId

readonly short Ict.Petra.Shared.MSysMan.Data.SLabelTable.ColumnDateCreatedId = 11
static

used for generic TTypedDataTable functions

◆ ColumnDateModified

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

The date the record was modified.

◆ ColumnDateModifiedId

readonly short Ict.Petra.Shared.MSysMan.Data.SLabelTable.ColumnDateModifiedId = 13
static

used for generic TTypedDataTable functions

◆ ColumnFormName

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

The form the label is designed for.

◆ ColumnFormNameId

readonly short Ict.Petra.Shared.MSysMan.Data.SLabelTable.ColumnFormNameId = 2
static

used for generic TTypedDataTable functions

◆ ColumnHorizontalPitch

DataColumn Ict.Petra.Shared.MSysMan.Data.SLabelTable.ColumnHorizontalPitch

The distance from the left edge of the first label to the left edge of the next label.

◆ ColumnHorizontalPitchId

readonly short Ict.Petra.Shared.MSysMan.Data.SLabelTable.ColumnHorizontalPitchId = 6
static

used for generic TTypedDataTable functions

◆ ColumnLabelDescription

DataColumn Ict.Petra.Shared.MSysMan.Data.SLabelTable.ColumnLabelDescription

◆ ColumnLabelDescriptionId

readonly short Ict.Petra.Shared.MSysMan.Data.SLabelTable.ColumnLabelDescriptionId = 1
static

used for generic TTypedDataTable functions

◆ ColumnLabelHeight

DataColumn Ict.Petra.Shared.MSysMan.Data.SLabelTable.ColumnLabelHeight

The height of each label.

◆ ColumnLabelHeightId

readonly short Ict.Petra.Shared.MSysMan.Data.SLabelTable.ColumnLabelHeightId = 7
static

used for generic TTypedDataTable functions

◆ ColumnLabelName

DataColumn Ict.Petra.Shared.MSysMan.Data.SLabelTable.ColumnLabelName

◆ ColumnLabelNameId

readonly short Ict.Petra.Shared.MSysMan.Data.SLabelTable.ColumnLabelNameId = 0
static

used for generic TTypedDataTable functions

◆ ColumnLabelsAcross

DataColumn Ict.Petra.Shared.MSysMan.Data.SLabelTable.ColumnLabelsAcross

The number of labels across a page.

◆ ColumnLabelsAcrossId

readonly short Ict.Petra.Shared.MSysMan.Data.SLabelTable.ColumnLabelsAcrossId = 9
static

used for generic TTypedDataTable functions

◆ ColumnLabelsDown

DataColumn Ict.Petra.Shared.MSysMan.Data.SLabelTable.ColumnLabelsDown

The number of labels down a page.

◆ ColumnLabelsDownId

readonly short Ict.Petra.Shared.MSysMan.Data.SLabelTable.ColumnLabelsDownId = 10
static

used for generic TTypedDataTable functions

◆ ColumnLabelWidth

DataColumn Ict.Petra.Shared.MSysMan.Data.SLabelTable.ColumnLabelWidth

The width of each label.

◆ ColumnLabelWidthId

readonly short Ict.Petra.Shared.MSysMan.Data.SLabelTable.ColumnLabelWidthId = 8
static

used for generic TTypedDataTable functions

◆ ColumnModificationId

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

This identifies the current version of the record.

◆ ColumnModificationIdId

readonly short Ict.Petra.Shared.MSysMan.Data.SLabelTable.ColumnModificationIdId = 15
static

used for generic TTypedDataTable functions

◆ ColumnModifiedBy

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

User ID of who last modified this record.

◆ ColumnModifiedById

readonly short Ict.Petra.Shared.MSysMan.Data.SLabelTable.ColumnModifiedById = 14
static

used for generic TTypedDataTable functions

◆ ColumnSideMargin

DataColumn Ict.Petra.Shared.MSysMan.Data.SLabelTable.ColumnSideMargin

The distance from the left edge of the page to the left edge of the first label.

◆ ColumnSideMarginId

readonly short Ict.Petra.Shared.MSysMan.Data.SLabelTable.ColumnSideMarginId = 4
static

used for generic TTypedDataTable functions

◆ ColumnTopMargin

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

The disance from the top of the page to the top of the first label.

◆ ColumnTopMarginId

readonly short Ict.Petra.Shared.MSysMan.Data.SLabelTable.ColumnTopMarginId = 3
static

used for generic TTypedDataTable functions

◆ ColumnVerticalPitch

DataColumn Ict.Petra.Shared.MSysMan.Data.SLabelTable.ColumnVerticalPitch

The distance from the top of the first label to the top of the next label.

◆ ColumnVerticalPitchId

readonly short Ict.Petra.Shared.MSysMan.Data.SLabelTable.ColumnVerticalPitchId = 5
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.SLabelTable.TableId = 296
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.SLabelTable.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]

SLabelRow Ict.Petra.Shared.MSysMan.Data.SLabelTable.this[int i]
get

Access a typed row by index.


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