Eamon CS  3.1.0
Eamon.Game.Helpers.Generic.Helper< T > Class Template Reference
Inheritance diagram for Eamon.Game.Helpers.Generic.Helper< T >:
Eamon.Framework.Helpers.Generic.IHelper< T >

Public Member Functions

virtual string GetFieldName (string name)
 
virtual string GetFieldName (long listNum)
 
virtual IList< string > GetNameList (Func< string, bool > matchFunc=null)
 
virtual string GetPrintedName (string fieldName)
 
virtual string GetName (string fieldName, bool addToNameList=false)
 
virtual object GetValue (string fieldName)
 
virtual bool ValidateRecord ()
 
virtual bool ValidateField (string fieldName)
 
virtual bool ValidateRecordAfterDatabaseLoaded ()
 
virtual bool ValidateFieldAfterDatabaseLoaded (string fieldName)
 
virtual bool ValidateRecordInterdependencies ()
 
virtual bool ValidateFieldInterdependencies (string fieldName)
 
virtual void PrintFieldDesc (string fieldName, bool editRec, bool editField, FieldDesc fieldDesc)
 
virtual void PrintFieldDesc (string fieldName)
 
virtual void ListRecord (bool fullDetail, bool showDesc, bool resolveEffects, bool lookupMsg, bool numberFields, bool excludeROFields)
 
virtual void ListRecord (bool callClear=true)
 
virtual void ListField (string fieldName)
 
virtual void ListErrorField ()
 
virtual void InputRecord (bool editRec, FieldDesc fieldDesc)
 
virtual void InputRecord (bool callClear=true)
 
virtual void InputField (string fieldName)
 
virtual void Clear ()
 
virtual string GetPrintedNameDesc ()
 
virtual string GetPrintedNameArticleType ()
 
virtual string BuildValue (string fieldName)
 
virtual void SetUidIfInvalid ()
 
 Helper ()
 

Public Attributes

_record
 
Type _lastFieldNameListType
 
IList< string > _fieldNameList
 

Properties

virtual IDbTable< T > RecordTable [get, set]
 
virtual T Record [get, set]
 
virtual long Index [get, set]
 
virtual StringBuilder Buf [get, set]
 
virtual StringBuilder Buf01 [get, set]
 
virtual bool EditRec [get, set]
 
virtual bool EditField [get, set]
 
virtual bool ShowDesc [get, set]
 
virtual FieldDesc FieldDesc [get, set]
 
virtual long BufSize [get, set]
 
virtual char FillChar [get, set]
 
virtual long Offset [get, set]
 
virtual string ErrorFieldName [get, set]
 
virtual string ErrorMessage [get, set]
 
virtual Type RecordType [get, set]
 
virtual IGameBase EditRecord [get, set]
 
virtual long NewRecordUid [get, set]
 
virtual bool FullDetail [get, set]
 
virtual bool ResolveEffects [get, set]
 
virtual bool LookupMsg [get, set]
 
virtual bool NumberFields [get, set]
 
virtual bool ExcludeROFields [get, set]
 
virtual bool AddToListedNames [get, set]
 
virtual long ListNum [get, set]
 
virtual IList< string > FieldNameList [get, set]
 
virtual IList< string > ListedNameList [get, set]
 
virtual IList< string > NameList [get, set]
 
- Properties inherited from Eamon.Framework.Helpers.Generic.IHelper< T >
IDbTable< T > RecordTable [get, set]
 
Record [get, set]
 
long Index [get, set]
 
StringBuilder Buf [get, set]
 
StringBuilder Buf01 [get, set]
 
bool EditRec [get, set]
 
bool EditField [get, set]
 
bool ShowDesc [get, set]
 
FieldDesc FieldDesc [get, set]
 
long BufSize [get, set]
 
char FillChar [get, set]
 
long Offset [get, set]
 
string ErrorFieldName [get, set]
 
string ErrorMessage [get, set]
 
Type RecordType [get, set]
 
IGameBase EditRecord [get, set]
 
long NewRecordUid [get, set]
 
bool FullDetail [get, set]
 
bool ResolveEffects [get, set]
 
bool LookupMsg [get, set]
 
bool NumberFields [get, set]
 
bool ExcludeROFields [get, set]
 
bool AddToListedNames [get, set]
 
long ListNum [get, set]
 

Constructor & Destructor Documentation

◆ Helper()

Member Function Documentation

◆ BuildValue()

virtual string Eamon.Game.Helpers.Generic.Helper< T >.BuildValue ( string  fieldName)
virtual

Parameters
fieldName
Returns

◆ Clear()

◆ GetFieldName() [1/2]

virtual string Eamon.Game.Helpers.Generic.Helper< T >.GetFieldName ( long  listNum)
virtual

Parameters
listNum
Returns

Implements Eamon.Framework.Helpers.Generic.IHelper< T >.

◆ GetFieldName() [2/2]

virtual string Eamon.Game.Helpers.Generic.Helper< T >.GetFieldName ( string  name)
virtual

Parameters
name
Returns

Implements Eamon.Framework.Helpers.Generic.IHelper< T >.

◆ GetName()

virtual string Eamon.Game.Helpers.Generic.Helper< T >.GetName ( string  fieldName,
bool  addToNameList = false 
)
virtual

Parameters
fieldName
addToNameList
Returns

Implements Eamon.Framework.Helpers.Generic.IHelper< T >.

◆ GetNameList()

virtual IList<string> Eamon.Game.Helpers.Generic.Helper< T >.GetNameList ( Func< string, bool >  matchFunc = null)
virtual

Parameters
matchFunc
Returns

Implements Eamon.Framework.Helpers.Generic.IHelper< T >.

◆ GetPrintedName()

virtual string Eamon.Game.Helpers.Generic.Helper< T >.GetPrintedName ( string  fieldName)
virtual

Parameters
fieldName
Returns

Implements Eamon.Framework.Helpers.Generic.IHelper< T >.

◆ GetPrintedNameArticleType()

virtual string Eamon.Game.Helpers.Generic.Helper< T >.GetPrintedNameArticleType ( )
virtual

Returns

◆ GetPrintedNameDesc()

virtual string Eamon.Game.Helpers.Generic.Helper< T >.GetPrintedNameDesc ( )
virtual

Returns

◆ GetValue()

virtual object Eamon.Game.Helpers.Generic.Helper< T >.GetValue ( string  fieldName)
virtual

Parameters
fieldName
Returns

Implements Eamon.Framework.Helpers.Generic.IHelper< T >.

◆ InputField()

virtual void Eamon.Game.Helpers.Generic.Helper< T >.InputField ( string  fieldName)
virtual

Parameters
fieldName

Implements Eamon.Framework.Helpers.Generic.IHelper< T >.

◆ InputRecord() [1/2]

virtual void Eamon.Game.Helpers.Generic.Helper< T >.InputRecord ( bool  callClear = true)
virtual

Parameters
callClear

Implements Eamon.Framework.Helpers.Generic.IHelper< T >.

◆ InputRecord() [2/2]

virtual void Eamon.Game.Helpers.Generic.Helper< T >.InputRecord ( bool  editRec,
FieldDesc  fieldDesc 
)
virtual

Parameters
editRec
fieldDesc

Implements Eamon.Framework.Helpers.Generic.IHelper< T >.

◆ ListErrorField()

◆ ListField()

virtual void Eamon.Game.Helpers.Generic.Helper< T >.ListField ( string  fieldName)
virtual

Parameters
fieldName

Implements Eamon.Framework.Helpers.Generic.IHelper< T >.

◆ ListRecord() [1/2]

virtual void Eamon.Game.Helpers.Generic.Helper< T >.ListRecord ( bool  callClear = true)
virtual

Parameters
callClear

Implements Eamon.Framework.Helpers.Generic.IHelper< T >.

◆ ListRecord() [2/2]

virtual void Eamon.Game.Helpers.Generic.Helper< T >.ListRecord ( bool  fullDetail,
bool  showDesc,
bool  resolveEffects,
bool  lookupMsg,
bool  numberFields,
bool  excludeROFields 
)
virtual

Parameters
fullDetail
showDesc
resolveEffects
lookupMsg
numberFields
excludeROFields

Implements Eamon.Framework.Helpers.Generic.IHelper< T >.

◆ PrintFieldDesc() [1/2]

virtual void Eamon.Game.Helpers.Generic.Helper< T >.PrintFieldDesc ( string  fieldName)
virtual

Parameters
fieldName

Implements Eamon.Framework.Helpers.Generic.IHelper< T >.

◆ PrintFieldDesc() [2/2]

virtual void Eamon.Game.Helpers.Generic.Helper< T >.PrintFieldDesc ( string  fieldName,
bool  editRec,
bool  editField,
FieldDesc  fieldDesc 
)
virtual

Parameters
fieldName
editRec
editField
fieldDesc

Implements Eamon.Framework.Helpers.Generic.IHelper< T >.

◆ SetUidIfInvalid()

◆ ValidateField()

virtual bool Eamon.Game.Helpers.Generic.Helper< T >.ValidateField ( string  fieldName)
virtual

Parameters
fieldName
Returns

Implements Eamon.Framework.Helpers.Generic.IHelper< T >.

◆ ValidateFieldAfterDatabaseLoaded()

virtual bool Eamon.Game.Helpers.Generic.Helper< T >.ValidateFieldAfterDatabaseLoaded ( string  fieldName)
virtual

Parameters
fieldName
Returns

Implements Eamon.Framework.Helpers.Generic.IHelper< T >.

◆ ValidateFieldInterdependencies()

virtual bool Eamon.Game.Helpers.Generic.Helper< T >.ValidateFieldInterdependencies ( string  fieldName)
virtual

Parameters
fieldName
Returns

Implements Eamon.Framework.Helpers.Generic.IHelper< T >.

◆ ValidateRecord()

virtual bool Eamon.Game.Helpers.Generic.Helper< T >.ValidateRecord ( )
virtual

◆ ValidateRecordAfterDatabaseLoaded()

◆ ValidateRecordInterdependencies()

virtual bool Eamon.Game.Helpers.Generic.Helper< T >.ValidateRecordInterdependencies ( )
virtual

Member Data Documentation

◆ _fieldNameList

IList<string> Eamon.Game.Helpers.Generic.Helper< T >._fieldNameList

◆ _lastFieldNameListType

Type Eamon.Game.Helpers.Generic.Helper< T >._lastFieldNameListType

◆ _record

Property Documentation

◆ AddToListedNames

virtual bool Eamon.Game.Helpers.Generic.Helper< T >.AddToListedNames
getset

◆ Buf

virtual StringBuilder Eamon.Game.Helpers.Generic.Helper< T >.Buf
getset

◆ Buf01

virtual StringBuilder Eamon.Game.Helpers.Generic.Helper< T >.Buf01
getset

◆ BufSize

virtual long Eamon.Game.Helpers.Generic.Helper< T >.BufSize
getset

◆ EditField

virtual bool Eamon.Game.Helpers.Generic.Helper< T >.EditField
getset

◆ EditRec

virtual bool Eamon.Game.Helpers.Generic.Helper< T >.EditRec
getset

◆ EditRecord

virtual IGameBase Eamon.Game.Helpers.Generic.Helper< T >.EditRecord
getset

◆ ErrorFieldName

virtual string Eamon.Game.Helpers.Generic.Helper< T >.ErrorFieldName
getset

◆ ErrorMessage

virtual string Eamon.Game.Helpers.Generic.Helper< T >.ErrorMessage
getset

◆ ExcludeROFields

virtual bool Eamon.Game.Helpers.Generic.Helper< T >.ExcludeROFields
getset

◆ FieldDesc

◆ FieldNameList

virtual IList<string> Eamon.Game.Helpers.Generic.Helper< T >.FieldNameList
getset

◆ FillChar

virtual char Eamon.Game.Helpers.Generic.Helper< T >.FillChar
getset

◆ FullDetail

virtual bool Eamon.Game.Helpers.Generic.Helper< T >.FullDetail
getset

◆ Index

virtual long Eamon.Game.Helpers.Generic.Helper< T >.Index
getset

◆ ListedNameList

virtual IList<string> Eamon.Game.Helpers.Generic.Helper< T >.ListedNameList
getset

◆ ListNum

virtual long Eamon.Game.Helpers.Generic.Helper< T >.ListNum
getset

◆ LookupMsg

virtual bool Eamon.Game.Helpers.Generic.Helper< T >.LookupMsg
getset

◆ NameList

virtual IList<string> Eamon.Game.Helpers.Generic.Helper< T >.NameList
getset

◆ NewRecordUid

virtual long Eamon.Game.Helpers.Generic.Helper< T >.NewRecordUid
getset

◆ NumberFields

virtual bool Eamon.Game.Helpers.Generic.Helper< T >.NumberFields
getset

◆ Offset

virtual long Eamon.Game.Helpers.Generic.Helper< T >.Offset
getset

◆ Record

◆ RecordTable

virtual IDbTable<T> Eamon.Game.Helpers.Generic.Helper< T >.RecordTable
getset

◆ RecordType

virtual Type Eamon.Game.Helpers.Generic.Helper< T >.RecordType
getset

◆ ResolveEffects

virtual bool Eamon.Game.Helpers.Generic.Helper< T >.ResolveEffects
getset

◆ ShowDesc

virtual bool Eamon.Game.Helpers.Generic.Helper< T >.ShowDesc
getset

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