Class UDefFieldTableInfo

Table 'UDefField': Definition table for user-defined fields; one row in this table corresponds to one generation of one field. The user defined fields that are in use, and earlier versions of user defined fields. ColumnId refers to the field type; see UDXXXSmall or UDXXXLarge for the referring ID. Preferences prefsection='System', prefkey='CurrentUdefVersioncontact' (or CurrentUdefVersionperson, project, sale), gives you the current version of user defined fields. prefkey='AdminUdefVersion<...>' gives you the current version that's being edited. If Current version = admin version, no editing has been done since the last Publish of user defined field was performed.

Inheritance
Object
TableInfo
UDefFieldTableInfo
Implements
Inherited Members
Namespace: SuperOffice.CRM.Data
Assembly: SoDataBase.dll
Syntax
[DatabaseTable("UDefField")]
public class UDefFieldTableInfo : 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 UDefField in the database dictionary: UDefField

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

Properties

ColumnId

Field 'columnId' in table 'UDefField': Dictionary type FieldId, .NET type: Int32

The ID of the database column this field corresponds to

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

Definition

Definition of the table as described in the deployed runtime dictionary

Declaration
public override SoTable Definition { get; }
Property Value
Type Description
SoTable
Overrides

DictionaryTableNumber

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

FieldDefault

Field 'fieldDefault' in table 'UDefField': Dictionary type String[255], .NET type: String

Optional default value for String fields

Declaration
public StringFieldInfo FieldDefault { get; }
Property Value
Type Description
StringFieldInfo

FieldHeight

Field 'fieldHeight' in table 'UDefField': Dictionary type UShort, .NET type: Int16

field height in pixels, 0 = 'enough' (from font)

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

FieldLabel

Field 'fieldLabel' in table 'UDefField': Dictionary type String[255], .NET type: String

The label (lead text)

Declaration
public StringFieldInfo FieldLabel { get; }
Property Value
Type Description
StringFieldInfo

FieldLeft

Field 'fieldLeft' in table 'UDefField': Dictionary type UShort, .NET type: Int16

X pixel coordinate of field

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

FieldTop

Field 'fieldTop' in table 'UDefField': Dictionary type UShort, .NET type: Int16

Y pixel coordinate of field

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

FieldType

Field 'fieldType' in table 'UDefField': Dictionary type UShort, .NET type: Int16

Field type: 0 = leadtext only, 1 = Edit, 2 = CheckBox, 3 = dropdown, 4 = listbox

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

FieldWidth

Field 'fieldWidth' in table 'UDefField': Dictionary type UShort, .NET type: Int16

field width in pixels, 0 = 'enough' (from font)

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

FormatMask

Field 'formatMask' in table 'UDefField': Dictionary type String[255], .NET type: String

Formatting mask, can be whatever the controls understand (currently nothing :-))

Declaration
public StringFieldInfo FormatMask { get; }
Property Value
Type Description
StringFieldInfo

HideLabel

Field 'hideLabel' in table 'UDefField': Dictionary type Bool, .NET type: Int16

Hide the label if 1

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

Indexed

Field 'indexed' in table 'UDefField': Dictionary type Bool, .NET type: Int16

Is this field indexed? 0 if no, index no. if yes

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

Justification

Field 'justification' in table 'UDefField': Dictionary type Enum, .NET type: UdefJustification

Justification - 0 = default, left, right, center

Declaration
public UdefJustificationFieldInfo Justification { get; }
Property Value
Type Description
UdefJustificationFieldInfo

LabelHeight

Field 'labelHeight' in table 'UDefField': Dictionary type UShort, .NET type: Int16

label height in pixels, 0 = 'enough' (from font)

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

LabelLeft

Field 'labelLeft' in table 'UDefField': Dictionary type UShort, .NET type: Int16

X pixel coordinate of label

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

LabelTop

Field 'labelTop' in table 'UDefField': Dictionary type UShort, .NET type: Int16

Y pixel coordinate of label

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

LabelWidth

Field 'labelWidth' in table 'UDefField': Dictionary type UShort, .NET type: Int16

label width in pixels, 0 = 'enough' (from font)

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

LastVersionId

Field 'lastVersionId' in table 'UDefField': Dictionary type FK, .NET type: Int32

UDefFieldId this field had in the previous version, 0 = field is new in this version

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

LastVersionId_InnerJoin_UDefField

Generated join from the foreign key LastVersionId in this table, to its target table UDefFieldTableInfo.

Declaration
public TargetedInnerJoin<UDefFieldTableInfo> LastVersionId_InnerJoin_UDefField { get; }
Property Value
Type Description
TargetedInnerJoin<UDefFieldTableInfo>

LeftOuterJoin_UDefFieldGL_UDefFieldId

Generated left outer join from the primary key UDefFieldId on this table, to UDefFieldGL.UDefFieldId.

Declaration
public TargetedLeftOuterJoin<UDefFieldGLTableInfo> LeftOuterJoin_UDefFieldGL_UDefFieldId { get; }
Property Value
Type Description
TargetedLeftOuterJoin<UDefFieldGLTableInfo>

ListTableId

Field 'listTableId' in table 'UDefField': Dictionary type TableNumber, .NET type: Int16

The table ID of the source table for lists: kTableAssoc, kTableContInt or whatever

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

Mandatory

Field 'mandatory' in table 'UDefField': Dictionary type Bool, .NET type: Int16

0 = no, 1 = yes (field must be filled out)

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

OwnerTableId

Field 'ownerTable_id' in table 'UDefField': Dictionary type UShort, .NET type: Int16

ID of owning table (contact, person, project) - this is not the actual tableNumber, rather it's an enum

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

Page1LineNo

Field 'page1LineNo' in table 'UDefField': Dictionary type UShort, .NET type: Int16

Line no on View Page 1, used if MDO flags are OFF. 0 = this field is not visible on page 1

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

ProgId

Field 'progId' in table 'UDefField': Dictionary type String[255], .NET type: String

Programmatic ID, for use by software that needs to find a particular field. Carried over like udefIdentity across generations. Use a Company.Product.Field format to avoid naming conflicts; the Company name SuperOffice is reserved.

Declaration
public StringFieldInfo ProgId { get; }
Property Value
Type Description
StringFieldInfo

ReadOnly

Field 'readOnly' in table 'UDefField': Dictionary type UShort, .NET type: Int16

0 = read/write, 1 = readonly (don't combine with mandatory 8-) )

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

Registered

Field 'registered' in table 'UDefField': 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 'UDefField': 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>

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

ShortLabel

Field 'shortLabel' in table 'UDefField': Dictionary type String[255], .NET type: String

Short name to be used in Archive headings and on page 1. If blank, the fieldLabel will be used everywhere.

Declaration
public StringFieldInfo ShortLabel { get; }
Property Value
Type Description
StringFieldInfo

TabOrder

Field 'tabOrder' in table 'UDefField': Dictionary type UShort, .NET type: Int16

Tab order value, sets the field processing sequence

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

TextLength

Field 'textLength' in table 'UDefField': Dictionary type UShort, .NET type: Int16

Length (in characters) of a text field, 0 for other types

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

Tooltip

Field 'tooltip' in table 'UDefField': Dictionary type String[255], .NET type: String

Optional tooltip text for this field

Declaration
public StringFieldInfo Tooltip { get; }
Property Value
Type Description
StringFieldInfo

UDefFieldId

Field 'UDefField_Id' in table 'UDefField': Dictionary type PK, .NET type: Int32

Primary key

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

UdefIdentity

Field 'udefIdentity' in table 'UDefField': Dictionary type Id, .NET type: Int32

Unique number used to track field identity across layout changes

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

UDListDefinitionId

Field 'UDListDefinition_id' in table 'UDefField': Dictionary type FK, .NET type: Int32

List to use for populating dropdown or listbox

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

UDListDefinitionId_InnerJoin_UDListDefinition

Generated join from the foreign key UDListDefinitionId in this table, to its target table UDListDefinitionTableInfo.

Declaration
public TargetedInnerJoin<UDListDefinitionTableInfo> UDListDefinitionId_InnerJoin_UDListDefinition { get; }
Property Value
Type Description
TargetedInnerJoin<UDListDefinitionTableInfo>

Updated

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

Number of updates made to this record

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

Version

Field 'version' in table 'UDefField': Dictionary type UShort, .NET type: Int16

Definition version number; ALL fields get new version whenever layout is updated.

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

Implements

Extension Methods

EnumUtil.MapEnums<From, To>(From)