Class PrefDescTableInfo

Table 'PrefDesc': Preference description, drives the Preference GUI. Maintenance client - controls all preferences in SuperOffice. You find an overview off all standard preference on http://techdoc.superoffice.com. May be used by third-party developers to add system preferences to be updated from SuperOffice Maintenance client, instead of ini-files.

Inheritance

System.Object

TableInfo

PrefDescTableInfo

Implements

System.ICloneable

Inherited Members

TableInfo.ToString()

TableInfo.RegisterFields(FieldInfo[])

TableInfo.FieldInfoFromSoField(SoField)

TableInfo.Clone()

TableInfo.IsSameTable(TableInfo)

TableInfo.FindField(String)

TableInfo.ProtAll

TableInfo.HashCheckFields

TableInfo.TableName

TableInfo.DbName

TableInfo.IsDictionaryTable

TableInfo.All

TableInfo.Item[String]

TableInfo.PrimaryKeyField

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

Namespace: SuperOffice.CRM.Data

Assembly: SoDataBase.dll

Syntax

[DatabaseTable("PrefDesc")]
public class PrefDescTableInfo : TableInfo, ICloneable

Remarks

An instance of this class represents one instance of this table in an SQL statement. In most cases each table appears only once in a SELECT, but in cases where you need to self-join, or there are multiple occurrences for other reasons (typically additional restrictions in the joins), then you will need multiple instances.
Instances of this class are created by calling .

Fields

DictionaryTableName

Conceptual name of table PrefDesc in the database dictionary: PrefDesc

Declaration

public const string DictionaryTableName = "PrefDesc"

Field Value

Type	Description
System.String

Properties

AccessFlags

Field 'accessFlags' in table 'PrefDesc': Dictionary type Enum, .NET type: PrefDescAccessFlags

1=wizard mode, 2=level 0, 4=admin gui, 8=crm gui

Declaration

public PrefDescAccessFlagsFieldInfo AccessFlags { get; }

Property Value

Type	Description
PrefDescAccessFlagsFieldInfo

Definition

Definition of the table as described in the deployed runtime dictionary

Declaration

public override SoTable Definition { get; }

Property Value

Type	Description
SoTable

Overrides

TableInfo.Definition

Description

Field 'description' in table 'PrefDesc': Dictionary type String[2048], .NET type: System.String

Description of preference, multi-language parsed

Declaration

public StringFieldInfo Description { get; }

Property Value

Type	Description
StringFieldInfo

DictionaryTableNumber

Table number for table PrefDesc in the database dictionary; potentially changes between databases, but always the same over the lifetime of any single database

Declaration

public int DictionaryTableNumber { get; }

Property Value

Type	Description
System.Int32

IsBuiltin

Field 'isBuiltin' in table 'PrefDesc': Dictionary type UShort, .NET type: System.Int16

1 = This row populated and maintained by SuperOffice

Declaration

public UInt16FieldInfo IsBuiltin { get; }

Property Value

Type	Description
UInt16FieldInfo

LeftOuterJoin_PrefDescLine_PrefDescId

Generated left outer join from the primary key PrefDescId on this table, to PrefDescLine.PrefDescId.

Declaration

public TargetedLeftOuterJoin<PrefDescLineTableInfo> LeftOuterJoin_PrefDescLine_PrefDescId { get; }

Property Value

Type	Description
TargetedLeftOuterJoin<PrefDescLineTableInfo>

MaxLevel

Field 'maxLevel' in table 'PrefDesc': Dictionary type Enum, .NET type: PreferenceLevel

Lowest allowed setting level, set by user, but not lower than sysMaxLevel

Declaration

public PreferenceLevelFieldInfo MaxLevel { get; }

Property Value

Type	Description
PreferenceLevelFieldInfo

MaxValue

Field 'maxValue' in table 'PrefDesc': Dictionary type Int, .NET type: System.Int32

Max value (if type 1); list table ID (if type 5)

Declaration

public Int32FieldInfo MaxValue { get; }

Property Value

Type	Description
Int32FieldInfo

MinLevel

Field 'minLevel' in table 'PrefDesc': Dictionary type Int, .NET type: System.Int32

The minimum (furthest away from User) level this preference can be set for

Declaration

public Int32FieldInfo MinLevel { get; }

Property Value

Type	Description
Int32FieldInfo

MinValue

Field 'minValue' in table 'PrefDesc': Dictionary type Int, .NET type: System.Int32

Min value (if type 1); list extra id (if type 5)

Declaration

public Int32FieldInfo MinValue { get; }

Property Value

Type	Description
Int32FieldInfo

Name

Field 'name' in table 'PrefDesc': Dictionary type String[255], .NET type: System.String

Multi-language name

Declaration

public StringFieldInfo Name { get; }

Property Value

Type	Description
StringFieldInfo

PrefDescId

Field 'PrefDesc_id' in table 'PrefDesc': Dictionary type PK, .NET type: System.Int32

Primary key

Declaration

public Int32FieldInfo PrefDescId { get; }

Property Value

Type	Description
Int32FieldInfo

Prefkey

Field 'prefkey' in table 'PrefDesc': Dictionary type String[200], .NET type: System.String

Preference key name

Declaration

public StringFieldInfo Prefkey { get; }

Property Value

Type	Description
StringFieldInfo

Prefsection

Field 'prefsection' in table 'PrefDesc': Dictionary type String[200], .NET type: System.String

Preference section name

Declaration

public StringFieldInfo Prefsection { get; }

Property Value

Type	Description
StringFieldInfo

Rank

Field 'rank' in table 'PrefDesc': Dictionary type Int, .NET type: System.Int32

Rank field for ordering sections, and keys within sections

Declaration

public Int32FieldInfo Rank { get; }

Property Value

Type	Description
Int32FieldInfo

Registered

Field 'registered' in table 'PrefDesc': Dictionary type UtcDateTime, .NET type: System.DateTime

Registered when

Declaration

public DateTimeFieldInfo Registered { get; }

Property Value

Type	Description
DateTimeFieldInfo

RegisteredAssociateId

Field 'registered_associate_id' in table 'PrefDesc': Dictionary type FK, .NET type: System.Int32

Registered by whom

Declaration

public Int32FieldInfo RegisteredAssociateId { get; }

Property Value

Type	Description
Int32FieldInfo

RegisteredAssociateId_InnerJoin_Associate

Generated join from the foreign key RegisteredAssociateId in this table, to its target table AssociateTableInfo.

Declaration

public TargetedInnerJoin<AssociateTableInfo> RegisteredAssociateId_InnerJoin_Associate { get; }

Property Value

Type	Description
TargetedInnerJoin<AssociateTableInfo>

RequiredLicense

Field 'requiredLicense' in table 'PrefDesc': Dictionary type String[255], .NET type: System.String

Licenses the user/installation must have if this reference is to be shown. Comma-separated list of owner.module pairs

Declaration

public StringFieldInfo RequiredLicense { get; }

Property Value

Type	Description
StringFieldInfo

RuntimeDefinition

Definition of the table as described in the deployed runtime dictionary

Declaration

[Obsolete("Use instance property Definition or static member DictionaryTableNumber", true)]
public static SoTable RuntimeDefinition { get; }

Property Value

Type	Description
SoTable

SubGroup

Field 'subGroup' in table 'PrefDesc': Dictionary type String[129], .NET type: System.String

Keys that share a value (including NULL) in this field are shown together; a visual spacer is shown between groups

Declaration

public StringFieldInfo SubGroup { get; }

Property Value

Type	Description
StringFieldInfo

SysMaxLevel

Field 'sysMaxLevel' in table 'PrefDesc': Dictionary type Enum, .NET type: PreferenceLevel

Lowest allowed setting level, set by SuperOffice

Declaration

public PreferenceLevelFieldInfo SysMaxLevel { get; }

Property Value

Type	Description
PreferenceLevelFieldInfo

Updated

Field 'updated' in table 'PrefDesc': Dictionary type UtcDateTime, .NET type: System.DateTime

Last updated when

Declaration

public DateTimeFieldInfo Updated { get; }

Property Value

Type	Description
DateTimeFieldInfo

UpdatedAssociateId

Field 'updated_associate_id' in table 'PrefDesc': Dictionary type FK, .NET type: System.Int32

Last updated by whom

Declaration

public Int32FieldInfo UpdatedAssociateId { get; }

Property Value

Type	Description
Int32FieldInfo

UpdatedAssociateId_InnerJoin_Associate

Generated join from the foreign key UpdatedAssociateId in this table, to its target table AssociateTableInfo.

Declaration

public TargetedInnerJoin<AssociateTableInfo> UpdatedAssociateId_InnerJoin_Associate { get; }

Property Value

Type	Description
TargetedInnerJoin<AssociateTableInfo>

UpdatedCount

Field 'updatedCount' in table 'PrefDesc': Dictionary type UShort, .NET type: System.Int16

Number of updates made to this record

Declaration

public UInt16FieldInfo UpdatedCount { get; }

Property Value

Type	Description
UInt16FieldInfo

ValueType

Field 'valueType' in table 'PrefDesc': Dictionary type Enum, .NET type: PrefDescValueType

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 PrefDescValueTypeFieldInfo ValueType { get; }

Property Value

Type	Description
PrefDescValueTypeFieldInfo

Implements

System.ICloneable

Extension Methods

EnumUtil.MapEnums<From, To>(From)

Converters.MapEnums<From, To>(From)