Class PrefDescRecordData
POCO (Plain Old CLR Object) class that can be used to hold data corresponding to a row from the PrefDesc table.
Namespace: SuperOffice.CRM.Rows
Assembly: SoDataBase.dll
Syntax
public class PrefDescRecordData : Object
Remarks
Please use this class instead of a full PrefDescRow object when you do not need to create or update a value in the database. Row objects have a large overhead since they carry the corresponding PrefDescTableInfo object, which in turn defines fields and aliases; there may be a Sentry on a row, and various other helper objects.
Constructors
PrefDescRecordData()
POCO (Plain Old CLR Object) class that can be used to hold data corresponding to a row from the PrefDesc table.
Declaration
public PrefDescRecordData()
Remarks
Please use this class instead of a full PrefDescRow object when you do not need to create or update a value in the database. Row objects have a large overhead since they carry the corresponding PrefDescTableInfo object, which in turn defines fields and aliases; there may be a Sentry on a row, and various other helper objects.
Fields
AccessFlags
1=wizard mode, 2=level 0, 4=admin gui, 8=crm gui
Declaration
public PrefDescAccessFlags AccessFlags
Field Value
Type | Description |
---|---|
PrefDescAccessFlags |
Remarks
Please use this class instead of a full PrefDescRow object when you do not need to create or update a value in the database. Row objects have a large overhead since they carry the corresponding PrefDescTableInfo object, which in turn defines fields and aliases; there may be a Sentry on a row, and various other helper objects.
Description
Description of preference, multi-language parsed
Declaration
public string Description
Field Value
Type | Description |
---|---|
String |
Remarks
Please use this class instead of a full PrefDescRow object when you do not need to create or update a value in the database. Row objects have a large overhead since they carry the corresponding PrefDescTableInfo object, which in turn defines fields and aliases; there may be a Sentry on a row, and various other helper objects.
IsBuiltin
1 = This row populated and maintained by SuperOffice
Declaration
public short IsBuiltin
Field Value
Type | Description |
---|---|
Int16 |
Remarks
Please use this class instead of a full PrefDescRow object when you do not need to create or update a value in the database. Row objects have a large overhead since they carry the corresponding PrefDescTableInfo object, which in turn defines fields and aliases; there may be a Sentry on a row, and various other helper objects.
MaxLevel
Lowest allowed setting level, set by user, but not lower than sysMaxLevel
Declaration
public PreferenceLevel MaxLevel
Field Value
Type | Description |
---|---|
PreferenceLevel |
Remarks
Please use this class instead of a full PrefDescRow object when you do not need to create or update a value in the database. Row objects have a large overhead since they carry the corresponding PrefDescTableInfo object, which in turn defines fields and aliases; there may be a Sentry on a row, and various other helper objects.
MaxValue
Max value (if type 1); list table ID (if type 5)
Declaration
public int MaxValue
Field Value
Type | Description |
---|---|
Int32 |
Remarks
Please use this class instead of a full PrefDescRow object when you do not need to create or update a value in the database. Row objects have a large overhead since they carry the corresponding PrefDescTableInfo object, which in turn defines fields and aliases; there may be a Sentry on a row, and various other helper objects.
MinLevel
The minimum (furthest away from User) level this preference can be set for
Declaration
public int MinLevel
Field Value
Type | Description |
---|---|
Int32 |
Remarks
Please use this class instead of a full PrefDescRow object when you do not need to create or update a value in the database. Row objects have a large overhead since they carry the corresponding PrefDescTableInfo object, which in turn defines fields and aliases; there may be a Sentry on a row, and various other helper objects.
MinValue
Min value (if type 1); list extra id (if type 5)
Declaration
public int MinValue
Field Value
Type | Description |
---|---|
Int32 |
Remarks
Please use this class instead of a full PrefDescRow object when you do not need to create or update a value in the database. Row objects have a large overhead since they carry the corresponding PrefDescTableInfo object, which in turn defines fields and aliases; there may be a Sentry on a row, and various other helper objects.
Name
Multi-language name
Declaration
public string Name
Field Value
Type | Description |
---|---|
String |
Remarks
Please use this class instead of a full PrefDescRow object when you do not need to create or update a value in the database. Row objects have a large overhead since they carry the corresponding PrefDescTableInfo object, which in turn defines fields and aliases; there may be a Sentry on a row, and various other helper objects.
PrefDescId
Primary key
Declaration
public int PrefDescId
Field Value
Type | Description |
---|---|
Int32 |
Remarks
Please use this class instead of a full PrefDescRow object when you do not need to create or update a value in the database. Row objects have a large overhead since they carry the corresponding PrefDescTableInfo object, which in turn defines fields and aliases; there may be a Sentry on a row, and various other helper objects.
Prefkey
Preference key name
Declaration
public string Prefkey
Field Value
Type | Description |
---|---|
String |
Remarks
Please use this class instead of a full PrefDescRow object when you do not need to create or update a value in the database. Row objects have a large overhead since they carry the corresponding PrefDescTableInfo object, which in turn defines fields and aliases; there may be a Sentry on a row, and various other helper objects.
Prefsection
Preference section name
Declaration
public string Prefsection
Field Value
Type | Description |
---|---|
String |
Remarks
Please use this class instead of a full PrefDescRow object when you do not need to create or update a value in the database. Row objects have a large overhead since they carry the corresponding PrefDescTableInfo object, which in turn defines fields and aliases; there may be a Sentry on a row, and various other helper objects.
Rank
Rank field for ordering sections, and keys within sections
Declaration
public int Rank
Field Value
Type | Description |
---|---|
Int32 |
Remarks
Please use this class instead of a full PrefDescRow object when you do not need to create or update a value in the database. Row objects have a large overhead since they carry the corresponding PrefDescTableInfo object, which in turn defines fields and aliases; there may be a Sentry on a row, and various other helper objects.
Registered
Registered when in UTC.
Declaration
public DateTime Registered
Field Value
Type | Description |
---|---|
DateTime |
Remarks
Please use this class instead of a full PrefDescRow object when you do not need to create or update a value in the database. Row objects have a large overhead since they carry the corresponding PrefDescTableInfo object, which in turn defines fields and aliases; there may be a Sentry on a row, and various other helper objects.
RegisteredAssociateId
Registered by whom
Declaration
public int RegisteredAssociateId
Field Value
Type | Description |
---|---|
Int32 |
Remarks
Please use this class instead of a full PrefDescRow object when you do not need to create or update a value in the database. Row objects have a large overhead since they carry the corresponding PrefDescTableInfo object, which in turn defines fields and aliases; there may be a Sentry on a row, and various other helper objects.
RequiredLicense
Licenses the user/installation must have if this reference is to be shown. Comma-separated list of owner.module pairs
Declaration
public string RequiredLicense
Field Value
Type | Description |
---|---|
String |
Remarks
Please use this class instead of a full PrefDescRow object when you do not need to create or update a value in the database. Row objects have a large overhead since they carry the corresponding PrefDescTableInfo object, which in turn defines fields and aliases; there may be a Sentry on a row, and various other helper objects.
SubGroup
Keys that share a value (including NULL) in this field are shown together; a visual spacer is shown between groups
Declaration
public string SubGroup
Field Value
Type | Description |
---|---|
String |
Remarks
Please use this class instead of a full PrefDescRow object when you do not need to create or update a value in the database. Row objects have a large overhead since they carry the corresponding PrefDescTableInfo object, which in turn defines fields and aliases; there may be a Sentry on a row, and various other helper objects.
SysMaxLevel
Lowest allowed setting level, set by SuperOffice
Declaration
public PreferenceLevel SysMaxLevel
Field Value
Type | Description |
---|---|
PreferenceLevel |
Remarks
Please use this class instead of a full PrefDescRow object when you do not need to create or update a value in the database. Row objects have a large overhead since they carry the corresponding PrefDescTableInfo object, which in turn defines fields and aliases; there may be a Sentry on a row, and various other helper objects.
Updated
Last updated when in UTC.
Declaration
public DateTime Updated
Field Value
Type | Description |
---|---|
DateTime |
Remarks
Please use this class instead of a full PrefDescRow object when you do not need to create or update a value in the database. Row objects have a large overhead since they carry the corresponding PrefDescTableInfo object, which in turn defines fields and aliases; there may be a Sentry on a row, and various other helper objects.
UpdatedAssociateId
Last updated by whom
Declaration
public int UpdatedAssociateId
Field Value
Type | Description |
---|---|
Int32 |
Remarks
Please use this class instead of a full PrefDescRow object when you do not need to create or update a value in the database. Row objects have a large overhead since they carry the corresponding PrefDescTableInfo object, which in turn defines fields and aliases; there may be a Sentry on a row, and various other helper objects.
UpdatedCount
Number of updates made to this record
Declaration
public short UpdatedCount
Field Value
Type | Description |
---|---|
Int16 |
Remarks
Please use this class instead of a full PrefDescRow object when you do not need to create or update a value in the database. Row objects have a large overhead since they carry the corresponding PrefDescTableInfo object, which in turn defines fields and aliases; there may be a Sentry on a row, and various other helper objects.
ValueType
1=number, 2=text, 3=bool, 4=list of values; 5=list table ref; 6=contact ID, 7=Person ID, 8=Project ID, 9=Selection ID
Declaration
public PrefDescValueType ValueType
Field Value
Type | Description |
---|---|
PrefDescValueType |
Remarks
Please use this class instead of a full PrefDescRow object when you do not need to create or update a value in the database. Row objects have a large overhead since they carry the corresponding PrefDescTableInfo object, which in turn defines fields and aliases; there may be a Sentry on a row, and various other helper objects.