Show / Hide Table of Contents

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

Fields

DictionaryTableName

Conceptual name of table LocaleText in the database dictionary: LocaleText

Declaration
public const string DictionaryTableName = "LocaleText"
Field Value
Type Description
String

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

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
Int32

IsBuiltin

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

1 = this row is populated and maintained by SuperOffice

Declaration
public UInt16FieldInfo IsBuiltin { get; }
Property Value
Type Description
UInt16FieldInfo

LanguageId

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

Language ID

Declaration
public Int32FieldInfo LanguageId { get; }
Property Value
Type Description
Int32FieldInfo

LocaleTextId

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

Primary key

Declaration
public Int32FieldInfo LocaleTextId { get; }
Property Value
Type Description
Int32FieldInfo

Registered

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

Registered when

Declaration
public DateTimeFieldInfo Registered { get; }
Property Value
Type Description
DateTimeFieldInfo

RegisteredAssociateId

Field 'registered_associate_id' in table 'LocaleText': Dictionary type FK, .NET type: 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>

ResourceId

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

Resource ID

Declaration
public Int32FieldInfo ResourceId { get; }
Property Value
Type Description
Int32FieldInfo

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

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

TypeId

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

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

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

UpdatedAssociateId

Field 'updated_associate_id' in table 'LocaleText': Dictionary type FK, .NET type: 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 'LocaleText': Dictionary type UShort, .NET type: Int16

Number of updates made to this record

Declaration
public UInt16FieldInfo UpdatedCount { get; }
Property Value
Type Description
UInt16FieldInfo

Methods

IdxLanguageId(Int32)

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

FieldDescription
LanguageIdLanguage ID
Declaration
public Restriction IdxLanguageId(int languageId)
Parameters
Type Name Description
Int32 languageId
Returns
Type Description
Restriction

IdxLanguageIdTypeId(Int32, Int16)

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

FieldDescription
LanguageIdLanguage ID
TypeId1=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
Int32 languageId
Int16 typeId
Returns
Type Description
Restriction

Implements

System.ICloneable

Extension Methods

EnumUtil.MapEnums<From, To>(From)
Converters.MapEnums<From, To>(From)
© SuperOffice. All rights reserved.
SuperOffice |  Community |  Release Notes |  Privacy |  Site feedback |  Search Docs |  About Docs |  Contribute |  Back to top