This table is used to define data labels for individual use in each office. More...

Inheritance diagram for Ict.Petra.Shared.MPartner.Partner.Data.PDataLabelTable:

Public Member Functions
	PDataLabelTable ()
	constructor More...

	PDataLabelTable (string ATablename)
	constructor More...

	PDataLabelTable (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...

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

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

PDataLabelTable	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	GetKeyDBName ()
	get the name of the field in the database for this column More...

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

static string	GetRestrictedHelp ()
	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	ColumnKey
	A sequence key for data labels. More...

DataColumn	ColumnText
	Label Text. More...

DataColumn	ColumnGroup
	Data Label Group. More...

DataColumn	ColumnDescription
	Description (Help Text) for the label that the user will see. More...

DataColumn	ColumnDataType
	Data Type (char \| integer \| float \| currency \| boolean \| date \| time \| partnerkey \| lookup) More...

DataColumn	ColumnCharLength
	Maximum length of data string if data type is set to character. More...

DataColumn	ColumnNumDecimalPlaces
	Number of decimal places if data type is set to numeric. More...

DataColumn	ColumnCurrencyCode
	This defines which currency is being used (if data type is currency) More...

DataColumn	ColumnLookupCategoryCode
	If a lookup category is selected then the values can be chosen from a drop down box. More...

DataColumn	ColumnEntryMandatory
	If TRUE then a value for this label has to be set. More...

DataColumn	ColumnDisplayed
	If TRUE then this data label will be displayed. Gives a chance to hide but keep labels for historical reasons. More...

DataColumn	ColumnNotDisplayedFrom
	Data label will not be displayed any longer from this date on. More...

DataColumn	ColumnEditable
	if FALSE then the values will be displayed but are not editable. More...

DataColumn	ColumnNotEditableFrom
	Data label values will not be editable any longer from this date on. More...

DataColumn	ColumnRestricted
	Indicates whether or not the data label has restricted access. If it does then the access will be controlled by s_group_data_label. 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 = 221
	TableId for Ict.Common.Data generic functions. More...

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Properties
PDataLabelRow	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

This table is used to define data labels for individual use in each office.

Constructor & Destructor Documentation

◆ PDataLabelTable() [1/3]

Ict.Petra.Shared.MPartner.Partner.Data.PDataLabelTable.PDataLabelTable ( )

inline

constructor

◆ PDataLabelTable() [2/3]

Ict.Petra.Shared.MPartner.Partner.Data.PDataLabelTable.PDataLabelTable ( string ATablename )

inline

constructor

◆ PDataLabelTable() [3/3]

Ict.Petra.Shared.MPartner.Partner.Data.PDataLabelTable.PDataLabelTable	(	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.MPartner.Partner.Data.PDataLabelTable.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()

PDataLabelTable Ict.Petra.Shared.MPartner.Partner.Data.PDataLabelTable.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

◆ GetCharLengthDBName()

static string Ict.Petra.Shared.MPartner.Partner.Data.PDataLabelTable.GetCharLengthDBName ( )

inlinestatic

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

◆ GetCharLengthHelp()

static string Ict.Petra.Shared.MPartner.Partner.Data.PDataLabelTable.GetCharLengthHelp ( )

inlinestatic

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

◆ GetCharLengthLength()

static short Ict.Petra.Shared.MPartner.Partner.Data.PDataLabelTable.GetCharLengthLength ( )

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.MPartner.Partner.Data.PDataLabelTable.GetCreatedByDBName ( )

inlinestatic

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

◆ GetCreatedByHelp()

static string Ict.Petra.Shared.MPartner.Partner.Data.PDataLabelTable.GetCreatedByHelp ( )

inlinestatic

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

◆ GetCreatedByLength()

static short Ict.Petra.Shared.MPartner.Partner.Data.PDataLabelTable.GetCreatedByLength ( )

inlinestatic

get character length for column

◆ GetCurrencyCodeDBName()

static string Ict.Petra.Shared.MPartner.Partner.Data.PDataLabelTable.GetCurrencyCodeDBName ( )

inlinestatic

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

◆ GetCurrencyCodeHelp()

static string Ict.Petra.Shared.MPartner.Partner.Data.PDataLabelTable.GetCurrencyCodeHelp ( )

inlinestatic

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

◆ GetCurrencyCodeLength()

static short Ict.Petra.Shared.MPartner.Partner.Data.PDataLabelTable.GetCurrencyCodeLength ( )

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

◆ GetDataTypeDBName()

static string Ict.Petra.Shared.MPartner.Partner.Data.PDataLabelTable.GetDataTypeDBName ( )

inlinestatic

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

◆ GetDataTypeHelp()

static string Ict.Petra.Shared.MPartner.Partner.Data.PDataLabelTable.GetDataTypeHelp ( )

inlinestatic

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

◆ GetDataTypeLength()

static short Ict.Petra.Shared.MPartner.Partner.Data.PDataLabelTable.GetDataTypeLength ( )

inlinestatic

get character length for column

◆ GetDateCreatedDBName()

static string Ict.Petra.Shared.MPartner.Partner.Data.PDataLabelTable.GetDateCreatedDBName ( )

inlinestatic

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

◆ GetDateCreatedHelp()

static string Ict.Petra.Shared.MPartner.Partner.Data.PDataLabelTable.GetDateCreatedHelp ( )

inlinestatic

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

◆ GetDateCreatedLength()

static short Ict.Petra.Shared.MPartner.Partner.Data.PDataLabelTable.GetDateCreatedLength ( )

inlinestatic

get character length for column

◆ GetDateModifiedDBName()

static string Ict.Petra.Shared.MPartner.Partner.Data.PDataLabelTable.GetDateModifiedDBName ( )

inlinestatic

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

◆ GetDateModifiedHelp()

static string Ict.Petra.Shared.MPartner.Partner.Data.PDataLabelTable.GetDateModifiedHelp ( )

inlinestatic

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

◆ GetDateModifiedLength()

static short Ict.Petra.Shared.MPartner.Partner.Data.PDataLabelTable.GetDateModifiedLength ( )

inlinestatic

get character length for column

◆ GetDescriptionDBName()

static string Ict.Petra.Shared.MPartner.Partner.Data.PDataLabelTable.GetDescriptionDBName ( )

inlinestatic

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

◆ GetDescriptionHelp()

static string Ict.Petra.Shared.MPartner.Partner.Data.PDataLabelTable.GetDescriptionHelp ( )

inlinestatic

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

◆ GetDescriptionLength()

static short Ict.Petra.Shared.MPartner.Partner.Data.PDataLabelTable.GetDescriptionLength ( )

inlinestatic

get character length for column

◆ GetDisplayedDBName()

static string Ict.Petra.Shared.MPartner.Partner.Data.PDataLabelTable.GetDisplayedDBName ( )

inlinestatic

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

◆ GetDisplayedHelp()

static string Ict.Petra.Shared.MPartner.Partner.Data.PDataLabelTable.GetDisplayedHelp ( )

inlinestatic

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

◆ GetDisplayedLength()

static short Ict.Petra.Shared.MPartner.Partner.Data.PDataLabelTable.GetDisplayedLength ( )

inlinestatic

get character length for column

◆ GetEditableDBName()

static string Ict.Petra.Shared.MPartner.Partner.Data.PDataLabelTable.GetEditableDBName ( )

inlinestatic

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

◆ GetEditableHelp()

static string Ict.Petra.Shared.MPartner.Partner.Data.PDataLabelTable.GetEditableHelp ( )

inlinestatic

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

◆ GetEditableLength()

static short Ict.Petra.Shared.MPartner.Partner.Data.PDataLabelTable.GetEditableLength ( )

inlinestatic

get character length for column

◆ GetEntryMandatoryDBName()

static string Ict.Petra.Shared.MPartner.Partner.Data.PDataLabelTable.GetEntryMandatoryDBName ( )

inlinestatic

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

◆ GetEntryMandatoryHelp()

static string Ict.Petra.Shared.MPartner.Partner.Data.PDataLabelTable.GetEntryMandatoryHelp ( )

inlinestatic

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

◆ GetEntryMandatoryLength()

static short Ict.Petra.Shared.MPartner.Partner.Data.PDataLabelTable.GetEntryMandatoryLength ( )

inlinestatic

get character length for column

◆ GetGroupDBName()

static string Ict.Petra.Shared.MPartner.Partner.Data.PDataLabelTable.GetGroupDBName ( )

inlinestatic

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

◆ GetGroupHelp()

static string Ict.Petra.Shared.MPartner.Partner.Data.PDataLabelTable.GetGroupHelp ( )

inlinestatic

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

◆ GetGroupLength()

static short Ict.Petra.Shared.MPartner.Partner.Data.PDataLabelTable.GetGroupLength ( )

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

◆ GetKeyDBName()

static string Ict.Petra.Shared.MPartner.Partner.Data.PDataLabelTable.GetKeyDBName ( )

inlinestatic

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

◆ GetKeyHelp()

static string Ict.Petra.Shared.MPartner.Partner.Data.PDataLabelTable.GetKeyHelp ( )

inlinestatic

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

◆ GetKeyLength()

static short Ict.Petra.Shared.MPartner.Partner.Data.PDataLabelTable.GetKeyLength ( )

inlinestatic

get character length for column

◆ 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

◆ GetLookupCategoryCodeDBName()

static string Ict.Petra.Shared.MPartner.Partner.Data.PDataLabelTable.GetLookupCategoryCodeDBName ( )

inlinestatic

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

◆ GetLookupCategoryCodeHelp()

static string Ict.Petra.Shared.MPartner.Partner.Data.PDataLabelTable.GetLookupCategoryCodeHelp ( )

inlinestatic

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

◆ GetLookupCategoryCodeLength()

static short Ict.Petra.Shared.MPartner.Partner.Data.PDataLabelTable.GetLookupCategoryCodeLength ( )

inlinestatic

get character length for column

◆ GetModificationIdDBName()

static string Ict.Petra.Shared.MPartner.Partner.Data.PDataLabelTable.GetModificationIdDBName ( )

inlinestatic

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

◆ GetModificationIdHelp()

static string Ict.Petra.Shared.MPartner.Partner.Data.PDataLabelTable.GetModificationIdHelp ( )

inlinestatic

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

◆ GetModificationIdLength()

static short Ict.Petra.Shared.MPartner.Partner.Data.PDataLabelTable.GetModificationIdLength ( )

inlinestatic

get character length for column

◆ GetModifiedByDBName()

static string Ict.Petra.Shared.MPartner.Partner.Data.PDataLabelTable.GetModifiedByDBName ( )

inlinestatic

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

◆ GetModifiedByHelp()

static string Ict.Petra.Shared.MPartner.Partner.Data.PDataLabelTable.GetModifiedByHelp ( )

inlinestatic

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

◆ GetModifiedByLength()

static short Ict.Petra.Shared.MPartner.Partner.Data.PDataLabelTable.GetModifiedByLength ( )

inlinestatic

get character length for column

◆ GetNotDisplayedFromDBName()

static string Ict.Petra.Shared.MPartner.Partner.Data.PDataLabelTable.GetNotDisplayedFromDBName ( )

inlinestatic

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

◆ GetNotDisplayedFromHelp()

static string Ict.Petra.Shared.MPartner.Partner.Data.PDataLabelTable.GetNotDisplayedFromHelp ( )

inlinestatic

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

◆ GetNotDisplayedFromLength()

static short Ict.Petra.Shared.MPartner.Partner.Data.PDataLabelTable.GetNotDisplayedFromLength ( )

inlinestatic

get character length for column

◆ GetNotEditableFromDBName()

static string Ict.Petra.Shared.MPartner.Partner.Data.PDataLabelTable.GetNotEditableFromDBName ( )

inlinestatic

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

◆ GetNotEditableFromHelp()

static string Ict.Petra.Shared.MPartner.Partner.Data.PDataLabelTable.GetNotEditableFromHelp ( )

inlinestatic

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

◆ GetNotEditableFromLength()

static short Ict.Petra.Shared.MPartner.Partner.Data.PDataLabelTable.GetNotEditableFromLength ( )

inlinestatic

get character length for column

◆ GetNumDecimalPlacesDBName()

static string Ict.Petra.Shared.MPartner.Partner.Data.PDataLabelTable.GetNumDecimalPlacesDBName ( )

inlinestatic

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

◆ GetNumDecimalPlacesHelp()

static string Ict.Petra.Shared.MPartner.Partner.Data.PDataLabelTable.GetNumDecimalPlacesHelp ( )

inlinestatic

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

◆ GetNumDecimalPlacesLength()

static short Ict.Petra.Shared.MPartner.Partner.Data.PDataLabelTable.GetNumDecimalPlacesLength ( )

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

◆ GetRestrictedDBName()

static string Ict.Petra.Shared.MPartner.Partner.Data.PDataLabelTable.GetRestrictedDBName ( )

inlinestatic

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

◆ GetRestrictedHelp()

static string Ict.Petra.Shared.MPartner.Partner.Data.PDataLabelTable.GetRestrictedHelp ( )

inlinestatic

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

◆ GetRestrictedLength()

static short Ict.Petra.Shared.MPartner.Partner.Data.PDataLabelTable.GetRestrictedLength ( )

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.MPartner.Partner.Data.PDataLabelTable.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.MPartner.Partner.Data.PDataLabelTable.GetTableDBName ( )

inlinestatic

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

◆ GetTableName() [1/2]

static string Ict.Petra.Shared.MPartner.Partner.Data.PDataLabelTable.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

◆ GetTextDBName()

static string Ict.Petra.Shared.MPartner.Partner.Data.PDataLabelTable.GetTextDBName ( )

inlinestatic

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

◆ GetTextHelp()

static string Ict.Petra.Shared.MPartner.Partner.Data.PDataLabelTable.GetTextHelp ( )

inlinestatic

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

◆ GetTextLength()

static short Ict.Petra.Shared.MPartner.Partner.Data.PDataLabelTable.GetTextLength ( )

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

◆ InitClass()

override void Ict.Petra.Shared.MPartner.Partner.Data.PDataLabelTable.InitClass ( )

inlineprotectedvirtual

create the columns

Implements Ict.Common.Data.TTypedDataTable.

◆ InitVars()

override void Ict.Petra.Shared.MPartner.Partner.Data.PDataLabelTable.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.MPartner.Partner.Data.PDataLabelTable.NewRowFromBuilder ( System.Data.DataRowBuilder builder )

inlineprotected

new typed row using DataRowBuilder

◆ NewRowTyped() [1/2]

PDataLabelRow Ict.Petra.Shared.MPartner.Partner.Data.PDataLabelTable.NewRowTyped ( )

inline

create a new typed row, always with default values

◆ NewRowTyped() [2/2]

PDataLabelRow Ict.Petra.Shared.MPartner.Partner.Data.PDataLabelTable.NewRowTyped ( bool AWithDefaultValues )

inline

create a new typed row

◆ RemoveColumnsNotInTableTemplate()

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

inlineinherited

remove columns that are not needed

Parameters

ATableTemplate this table only contains the columns that should be kept

◆ ResetStaticVariables()

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

inlinestaticinherited

reset the static variables for each Web Request call.

Member Data Documentation

◆ ColumnCharLength

DataColumn Ict.Petra.Shared.MPartner.Partner.Data.PDataLabelTable.ColumnCharLength

Maximum length of data string if data type is set to character.

◆ ColumnCharLengthId

readonly short Ict.Petra.Shared.MPartner.Partner.Data.PDataLabelTable.ColumnCharLengthId = 5

static

used for generic TTypedDataTable functions

◆ ColumnCreatedBy

DataColumn Ict.Petra.Shared.MPartner.Partner.Data.PDataLabelTable.ColumnCreatedBy

User ID of who created this record.

◆ ColumnCreatedById

readonly short Ict.Petra.Shared.MPartner.Partner.Data.PDataLabelTable.ColumnCreatedById = 16

static

used for generic TTypedDataTable functions

◆ ColumnCurrencyCode

DataColumn Ict.Petra.Shared.MPartner.Partner.Data.PDataLabelTable.ColumnCurrencyCode

This defines which currency is being used (if data type is currency)

◆ ColumnCurrencyCodeId

readonly short Ict.Petra.Shared.MPartner.Partner.Data.PDataLabelTable.ColumnCurrencyCodeId = 7

static

used for generic TTypedDataTable functions

◆ ColumnDataType

DataColumn Ict.Petra.Shared.MPartner.Partner.Data.PDataLabelTable.ColumnDataType

◆ ColumnDataTypeId

readonly short Ict.Petra.Shared.MPartner.Partner.Data.PDataLabelTable.ColumnDataTypeId = 4

static

used for generic TTypedDataTable functions

◆ ColumnDateCreated

DataColumn Ict.Petra.Shared.MPartner.Partner.Data.PDataLabelTable.ColumnDateCreated

The date the record was created.

◆ ColumnDateCreatedId

readonly short Ict.Petra.Shared.MPartner.Partner.Data.PDataLabelTable.ColumnDateCreatedId = 15

static

used for generic TTypedDataTable functions

◆ ColumnDateModified

DataColumn Ict.Petra.Shared.MPartner.Partner.Data.PDataLabelTable.ColumnDateModified

The date the record was modified.

◆ ColumnDateModifiedId

readonly short Ict.Petra.Shared.MPartner.Partner.Data.PDataLabelTable.ColumnDateModifiedId = 17

static

used for generic TTypedDataTable functions

◆ ColumnDescription

DataColumn Ict.Petra.Shared.MPartner.Partner.Data.PDataLabelTable.ColumnDescription

Description (Help Text) for the label that the user will see.

◆ ColumnDescriptionId

readonly short Ict.Petra.Shared.MPartner.Partner.Data.PDataLabelTable.ColumnDescriptionId = 3

static

used for generic TTypedDataTable functions

◆ ColumnDisplayed

DataColumn Ict.Petra.Shared.MPartner.Partner.Data.PDataLabelTable.ColumnDisplayed

If TRUE then this data label will be displayed. Gives a chance to hide but keep labels for historical reasons.

◆ ColumnDisplayedId

readonly short Ict.Petra.Shared.MPartner.Partner.Data.PDataLabelTable.ColumnDisplayedId = 10

static

used for generic TTypedDataTable functions

◆ ColumnEditable

DataColumn Ict.Petra.Shared.MPartner.Partner.Data.PDataLabelTable.ColumnEditable

if FALSE then the values will be displayed but are not editable.

◆ ColumnEditableId

readonly short Ict.Petra.Shared.MPartner.Partner.Data.PDataLabelTable.ColumnEditableId = 12

static

used for generic TTypedDataTable functions

◆ ColumnEntryMandatory

DataColumn Ict.Petra.Shared.MPartner.Partner.Data.PDataLabelTable.ColumnEntryMandatory

If TRUE then a value for this label has to be set.

◆ ColumnEntryMandatoryId

readonly short Ict.Petra.Shared.MPartner.Partner.Data.PDataLabelTable.ColumnEntryMandatoryId = 9

static

used for generic TTypedDataTable functions

◆ ColumnGroup

DataColumn Ict.Petra.Shared.MPartner.Partner.Data.PDataLabelTable.ColumnGroup

Data Label Group.

◆ ColumnGroupId

readonly short Ict.Petra.Shared.MPartner.Partner.Data.PDataLabelTable.ColumnGroupId = 2

static

used for generic TTypedDataTable functions

◆ ColumnKey

DataColumn Ict.Petra.Shared.MPartner.Partner.Data.PDataLabelTable.ColumnKey

A sequence key for data labels.

◆ ColumnKeyId

readonly short Ict.Petra.Shared.MPartner.Partner.Data.PDataLabelTable.ColumnKeyId = 0

static

used for generic TTypedDataTable functions

◆ ColumnLookupCategoryCode

DataColumn Ict.Petra.Shared.MPartner.Partner.Data.PDataLabelTable.ColumnLookupCategoryCode

If a lookup category is selected then the values can be chosen from a drop down box.

◆ ColumnLookupCategoryCodeId

readonly short Ict.Petra.Shared.MPartner.Partner.Data.PDataLabelTable.ColumnLookupCategoryCodeId = 8

static

used for generic TTypedDataTable functions

◆ ColumnModificationId

DataColumn Ict.Petra.Shared.MPartner.Partner.Data.PDataLabelTable.ColumnModificationId

This identifies the current version of the record.

◆ ColumnModificationIdId

readonly short Ict.Petra.Shared.MPartner.Partner.Data.PDataLabelTable.ColumnModificationIdId = 19

static

used for generic TTypedDataTable functions

◆ ColumnModifiedBy

DataColumn Ict.Petra.Shared.MPartner.Partner.Data.PDataLabelTable.ColumnModifiedBy

User ID of who last modified this record.

◆ ColumnModifiedById

readonly short Ict.Petra.Shared.MPartner.Partner.Data.PDataLabelTable.ColumnModifiedById = 18

static

used for generic TTypedDataTable functions

◆ ColumnNotDisplayedFrom

DataColumn Ict.Petra.Shared.MPartner.Partner.Data.PDataLabelTable.ColumnNotDisplayedFrom

Data label will not be displayed any longer from this date on.

◆ ColumnNotDisplayedFromId

readonly short Ict.Petra.Shared.MPartner.Partner.Data.PDataLabelTable.ColumnNotDisplayedFromId = 11

static

used for generic TTypedDataTable functions

◆ ColumnNotEditableFrom

DataColumn Ict.Petra.Shared.MPartner.Partner.Data.PDataLabelTable.ColumnNotEditableFrom

Data label values will not be editable any longer from this date on.

◆ ColumnNotEditableFromId

readonly short Ict.Petra.Shared.MPartner.Partner.Data.PDataLabelTable.ColumnNotEditableFromId = 13

static

used for generic TTypedDataTable functions

◆ ColumnNumDecimalPlaces

DataColumn Ict.Petra.Shared.MPartner.Partner.Data.PDataLabelTable.ColumnNumDecimalPlaces

Number of decimal places if data type is set to numeric.

◆ ColumnNumDecimalPlacesId

readonly short Ict.Petra.Shared.MPartner.Partner.Data.PDataLabelTable.ColumnNumDecimalPlacesId = 6

static

used for generic TTypedDataTable functions

◆ ColumnRestricted

DataColumn Ict.Petra.Shared.MPartner.Partner.Data.PDataLabelTable.ColumnRestricted

Indicates whether or not the data label has restricted access. If it does then the access will be controlled by s_group_data_label.

◆ ColumnRestrictedId

readonly short Ict.Petra.Shared.MPartner.Partner.Data.PDataLabelTable.ColumnRestrictedId = 14

static

used for generic TTypedDataTable functions

◆ ColumnText

DataColumn Ict.Petra.Shared.MPartner.Partner.Data.PDataLabelTable.ColumnText

Label Text.

◆ ColumnTextId

readonly short Ict.Petra.Shared.MPartner.Partner.Data.PDataLabelTable.ColumnTextId = 1

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.MPartner.Partner.Data.PDataLabelTable.TableId = 221

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.MPartner.Partner.Data.PDataLabelTable.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]

PDataLabelRow Ict.Petra.Shared.MPartner.Partner.Data.PDataLabelTable.this[int i]

get

Access a typed row by index.

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

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

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Protected Member Functions

Static Protected Attributes

Properties

Detailed Description

Constructor & Destructor Documentation

◆ PDataLabelTable() [1/3]

◆ PDataLabelTable() [2/3]

◆ PDataLabelTable() [3/3]

Member Function Documentation

◆ CreateOdbcParameter() [1/3]

◆ CreateOdbcParameter() [2/3]

◆ CreateOdbcParameter() [3/3]

◆ GetChanges()

◆ GetChangesTyped()

◆ GetChangesTypedInternal()

◆ GetCharLengthDBName()

◆ GetCharLengthHelp()

◆ GetCharLengthLength()

◆ GetColumnNameSQL()

◆ GetColumnStringList()

◆ GetCreatedByDBName()

◆ GetCreatedByHelp()

◆ GetCreatedByLength()

◆ GetCurrencyCodeDBName()

◆ GetCurrencyCodeHelp()

◆ GetCurrencyCodeLength()

◆ GetCustomReportFieldList()

◆ GetCustomReportPermission()

◆ GetDataTypeDBName()

◆ GetDataTypeHelp()

◆ GetDataTypeLength()

◆ GetDateCreatedDBName()

◆ GetDateCreatedHelp()

◆ GetDateCreatedLength()

◆ GetDateModifiedDBName()

◆ GetDateModifiedHelp()

◆ GetDateModifiedLength()

◆ GetDescriptionDBName()

◆ GetDescriptionHelp()

◆ GetDescriptionLength()

◆ GetDisplayedDBName()

◆ GetDisplayedHelp()

◆ GetDisplayedLength()

◆ GetEditableDBName()

◆ GetEditableHelp()

◆ GetEditableLength()

◆ GetEntryMandatoryDBName()

◆ GetEntryMandatoryHelp()

◆ GetEntryMandatoryLength()

◆ GetGroupDBName()

◆ GetGroupHelp()

◆ GetGroupLength()

◆ GetKeyColumnStringList()

◆ GetKeyDBName()

◆ GetKeyHelp()

◆ GetKeyLength()

◆ GetLabel()

◆ GetLength() [1/2]

◆ GetLength() [2/2]

◆ GetLookupCategoryCodeDBName()

◆ GetLookupCategoryCodeHelp()

◆ GetLookupCategoryCodeLength()

◆ GetModificationIdDBName()

◆ GetModificationIdHelp()

◆ GetModificationIdLength()

◆ GetModifiedByDBName()

◆ GetModifiedByHelp()

◆ GetModifiedByLength()

◆ GetNotDisplayedFromDBName()

◆ GetNotDisplayedFromHelp()

◆ GetNotDisplayedFromLength()

◆ GetNotEditableFromDBName()

◆ GetNotEditableFromHelp()

◆ GetNotEditableFromLength()

◆ GetNumDecimalPlacesDBName()

◆ GetNumDecimalPlacesHelp()