Class LocaleTextTableInfo

Table 'LocaleText': Multi-language text items. Used for user-defined field labels. Must be assigned correct name to match the language they start SuperOffice in. This table should be viewed in conjunction with FieldLabel. If a row in FieldLable has active = 1 this table will need to contain at least one row with the same resourceId as the FieldLabel row. The language id can be either 0 or one of the Windows language ID's; SuperOffice will pick the correct language on startup according to the user settings. If a label cannot be found with the given language and also not with language 0, it will not be substituted.

Inheritance

object

TableInfo

LocaleTextTableInfo

Implements

ICloneable

Inherited Members

TableInfo.ToString()

TableInfo.RegisterFields(params 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.this[string]

TableInfo.PrimaryKeyField

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Namespace: SuperOffice.CRM.Data

Assembly: SoDataBase.dll

Syntax

[DatabaseTable("LocaleText")]
public class LocaleTextTableInfo : 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 TablesInfo.GetLocaleTextInfo().

Fields

DictionaryTableName

Conceptual name of table LocaleText in the database dictionary: LocaleText

Declaration

public const string DictionaryTableName = "LocaleText"

Field Value

Type	Description
string

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 TablesInfo.GetLocaleTextInfo().

Properties

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

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 TablesInfo.GetLocaleTextInfo().

DictionaryTableNumber

Table number for table LocaleText 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
int

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 TablesInfo.GetLocaleTextInfo().

IsBuiltin

Field 'isBuiltin' in table 'LocaleText': Dictionary type UShort, .NET type: short

1 = this row is populated and maintained by SuperOffice

Declaration

public UInt16FieldInfo IsBuiltin { get; }

Property Value

Type	Description
UInt16FieldInfo

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 TablesInfo.GetLocaleTextInfo().

LanguageId

Field 'languageId' in table 'LocaleText': Dictionary type Id, .NET type: int

Language ID

Declaration

public Int32FieldInfo LanguageId { get; }

Property Value

Type	Description
Int32FieldInfo

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 TablesInfo.GetLocaleTextInfo().

LocaleTextId

Field 'LocaleText_id' in table 'LocaleText': Dictionary type PK, .NET type: int

Primary key

Declaration

public Int32FieldInfo LocaleTextId { get; }

Property Value

Type	Description
Int32FieldInfo

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 TablesInfo.GetLocaleTextInfo().

Registered

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

Registered when

Declaration

public DateTimeFieldInfo Registered { get; }

Property Value

Type	Description
DateTimeFieldInfo

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 TablesInfo.GetLocaleTextInfo().

RegisteredAssociateId

Field 'registered_associate_id' in table 'LocaleText': Dictionary type FK, target: Associate, .NET type: int

Registered by whom

Declaration

public Int32FieldInfo RegisteredAssociateId { get; }

Property Value

Type	Description
Int32FieldInfo

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 TablesInfo.GetLocaleTextInfo().

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>

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 TablesInfo.GetLocaleTextInfo().

ResourceId

Field 'resourceId' in table 'LocaleText': Dictionary type Id, .NET type: int

Resource ID

Declaration

public Int32FieldInfo ResourceId { get; }

Property Value

Type	Description
Int32FieldInfo

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 TablesInfo.GetLocaleTextInfo().

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

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 TablesInfo.GetLocaleTextInfo().

Text

Field 'text' in table 'LocaleText': Dictionary type String[255], .NET type: string

The text string itself

Declaration

public StringFieldInfo Text { get; }

Property Value

Type	Description
StringFieldInfo

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 TablesInfo.GetLocaleTextInfo().

TypeId

Field 'typeId' in table 'LocaleText': Dictionary type UShort, .NET type: short

1=label 2=table 3=column 4=import field 5=import object 6=import GUI category 7=contact udef label 8=role name, 9 = role tooltip, 10 = functionright label, 11 = functionright descriptionid; 12=function right description; 16=status monitor name; 19=contact udef label; 20=person udef label; 21=project udef label; 22=sale udef label; 23=appointment udef label; 24=document udef label; 31=tzlocation city

Declaration

public UInt16FieldInfo TypeId { get; }

Property Value

Type	Description
UInt16FieldInfo

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 TablesInfo.GetLocaleTextInfo().

Updated

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

Last updated when

Declaration

public DateTimeFieldInfo Updated { get; }

Property Value

Type	Description
DateTimeFieldInfo

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 TablesInfo.GetLocaleTextInfo().

UpdatedAssociateId

Field 'updated_associate_id' in table 'LocaleText': Dictionary type FK, target: Associate, .NET type: int

Last updated by whom

Declaration

public Int32FieldInfo UpdatedAssociateId { get; }

Property Value

Type	Description
Int32FieldInfo

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 TablesInfo.GetLocaleTextInfo().

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>

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 TablesInfo.GetLocaleTextInfo().

UpdatedCount

Field 'updatedCount' in table 'LocaleText': Dictionary type UShort, .NET type: short

Number of updates made to this record

Declaration

public UInt16FieldInfo UpdatedCount { get; }

Property Value

Type	Description
UInt16FieldInfo

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 TablesInfo.GetLocaleTextInfo().

Methods

IdxLanguageId(int)

Shortcut method for looking up using the database index LanguageId, which spans the following fields:

Field	Description
LanguageId	Language ID

Declaration

public Restriction IdxLanguageId(int languageId)

Parameters

Type	Name	Description
int	languageId

Returns

Type	Description
Restriction

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 TablesInfo.GetLocaleTextInfo().

IdxLanguageIdTypeId(int, short)

Shortcut method for looking up using the database index LanguageIdTypeId, which spans the following fields:

Field	Description
LanguageId	Language ID
TypeId	1=label 2=table 3=column 4=import field 5=import object 6=import GUI category 7=contact udef label 8=role name, 9 = role tooltip, 10 = functionright label, 11 = functionright descriptionid; 12=function right description; 16=status monitor name; 19=contact udef label; 20=person udef label; 21=project udef label; 22=sale udef label; 23=appointment udef label; 24=document udef label; 31=tzlocation city

Declaration

public Restriction IdxLanguageIdTypeId(int languageId, short typeId)

Parameters

Type	Name	Description
int	languageId
short	typeId

Returns

Type	Description
Restriction

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 TablesInfo.GetLocaleTextInfo().

Implements

ICloneable

Extension Methods

EnumUtil.MapEnums<From, To>(From)

Converters.MapEnums<From, To>(From)