Show / Hide Table of Contents

Class AddressFormatTableInfo

Table 'AddressFormat': Address formats for GUI and labels. See more information: Addressformat on http://techdoc.superoffice.com

Inheritance
Object
TableInfo
AddressFormatTableInfo
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("AddressFormat")]
public class AddressFormatTableInfo : 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 AddressFormat in the database dictionary: AddressFormat

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

Properties

Address1Flags

Field 'address1_flags' in table 'AddressFormat': Dictionary type UShort, .NET type: Int16

Field flags for address1 field: See EAddrFormatFlags enum

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

Address1Leadtext

Field 'address1_leadtext' in table 'AddressFormat': Dictionary type Id, .NET type: Int32

Lead text resource ID for address1 field, 0 = no leadtext

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

Address1Length

Field 'address1_length' in table 'AddressFormat': Dictionary type UShort, .NET type: Int16

Field length in characters for address1 field

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

Address1Line

Field 'address1_line' in table 'AddressFormat': Dictionary type UShort, .NET type: Int16

Line no. for address1 field, 0 if not shown

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

Address1Mask

Field 'address1_mask' in table 'AddressFormat': Dictionary type String[10], .NET type: String

Formatting mask for address1 field

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

Address1Subpos

Field 'address1_subpos' in table 'AddressFormat': Dictionary type UShort, .NET type: Int16

Position within line for address1 field

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

Address1Zip

Field 'address1_zip' in table 'AddressFormat': Dictionary type UShort, .NET type: Int16

Zip lookup functionality for address1 field: 0 = none, 1 = source, 2 = target

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

Address2Flags

Field 'address2_flags' in table 'AddressFormat': Dictionary type UShort, .NET type: Int16

Field flags for address2 field: See EAddrFormatFlags enum

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

Address2Leadtext

Field 'address2_leadtext' in table 'AddressFormat': Dictionary type Id, .NET type: Int32

Lead text resource ID for address2 field, 0 = no leadtext

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

Address2Length

Field 'address2_length' in table 'AddressFormat': Dictionary type UShort, .NET type: Int16

Field length in characters for address2 field

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

Address2Line

Field 'address2_line' in table 'AddressFormat': Dictionary type UShort, .NET type: Int16

Line no. for address2 field, 0 if not shown

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

Address2Mask

Field 'address2_mask' in table 'AddressFormat': Dictionary type String[10], .NET type: String

Formatting mask for address2 field

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

Address2Subpos

Field 'address2_subpos' in table 'AddressFormat': Dictionary type UShort, .NET type: Int16

Position within line for address2 field

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

Address2Zip

Field 'address2_zip' in table 'AddressFormat': Dictionary type UShort, .NET type: Int16

Zip lookup functionality for address2 field: 0 = none, 1 = source, 2 = target

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

Address3Flags

Field 'address3_flags' in table 'AddressFormat': Dictionary type UShort, .NET type: Int16

Field flags for address3 field: See EAddrFormatFlags enum

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

Address3Leadtext

Field 'address3_leadtext' in table 'AddressFormat': Dictionary type Id, .NET type: Int32

Lead text resource ID for address3 field, 0 = no leadtext

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

Address3Length

Field 'address3_length' in table 'AddressFormat': Dictionary type UShort, .NET type: Int16

Field length in characters for address3 field

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

Address3Line

Field 'address3_line' in table 'AddressFormat': Dictionary type UShort, .NET type: Int16

Line no. for address3 field, 0 if not shown

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

Address3Mask

Field 'address3_mask' in table 'AddressFormat': Dictionary type String[10], .NET type: String

Formatting mask for address3 field

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

Address3Subpos

Field 'address3_subpos' in table 'AddressFormat': Dictionary type UShort, .NET type: Int16

Position within line for address3 field

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

Address3Zip

Field 'address3_zip' in table 'AddressFormat': Dictionary type UShort, .NET type: Int16

Zip lookup functionality for address3 field: 0 = none, 1 = source, 2 = target

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

AddressformatId

Field 'addressformat_id' in table 'AddressFormat': Dictionary type PK, .NET type: Int32

Primary key

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

AtypeIdx

Field 'atype_idx' in table 'AddressFormat': Dictionary type UShort, .NET type: Int16

Corresponds to Address.atype_idx

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

CityFlags

Field 'city_flags' in table 'AddressFormat': Dictionary type UShort, .NET type: Int16

Field flags for city field: See EAddrFormatFlags enum

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

CityLeadtext

Field 'city_leadtext' in table 'AddressFormat': Dictionary type Id, .NET type: Int32

Lead text resource ID for city field, 0 = no leadtext

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

CityLength

Field 'city_length' in table 'AddressFormat': Dictionary type UShort, .NET type: Int16

Field length in characters for city field

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

CityLine

Field 'city_line' in table 'AddressFormat': Dictionary type UShort, .NET type: Int16

Line no. for city field, 0 if not shown

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

CityMask

Field 'city_mask' in table 'AddressFormat': Dictionary type String[10], .NET type: String

Formatting mask for city field

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

CitySubpos

Field 'city_subpos' in table 'AddressFormat': Dictionary type UShort, .NET type: Int16

Position within line for city field

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

CityZip

Field 'city_zip' in table 'AddressFormat': Dictionary type UShort, .NET type: Int16

Zip lookup functionality for city field: 0 = none, 1 = source, 2 = target

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

CountyFlags

Field 'county_flags' in table 'AddressFormat': Dictionary type UShort, .NET type: Int16

Field flags for county field: See EAddrFormatFlags enum

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

CountyLeadtext

Field 'county_leadtext' in table 'AddressFormat': Dictionary type Id, .NET type: Int32

Lead text resource ID for county field, 0 = no leadtext

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

CountyLength

Field 'county_length' in table 'AddressFormat': Dictionary type UShort, .NET type: Int16

Field length in characters for county field

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

CountyLine

Field 'county_line' in table 'AddressFormat': Dictionary type UShort, .NET type: Int16

Line no. for county field, 0 if not shown

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

CountyMask

Field 'county_mask' in table 'AddressFormat': Dictionary type String[10], .NET type: String

Formatting mask for county field

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

CountySubpos

Field 'county_subpos' in table 'AddressFormat': Dictionary type UShort, .NET type: Int16

Position within line for county field

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

CountyZip

Field 'county_zip' in table 'AddressFormat': Dictionary type UShort, .NET type: Int16

Zip lookup functionality for county field: 0 = none, 1 = source, 2 = target

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

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 AddressFormat 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

ExtraFlags

Field 'extraFlags' in table 'AddressFormat': Dictionary type UInt, .NET type: UInt32

OBSOLETE: Extra flags for tag substitution mechanism, see idb.h. This function has been taken over by the tag-based formatting, controlled by the labelLayout and labelLayout2 fields

Declaration
public FieldInfo ExtraFlags { get; }
Property Value
Type Description
FieldInfo

IsBuiltIn

Field 'isBuiltIn' in table 'AddressFormat': Dictionary type Bool, .NET type: Int16

Is this row populated by SuperOffice?

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

LabelLayout

Field 'labelLayout' in table 'AddressFormat': Dictionary type String[255], .NET type: String

Format specification for labels, uses standard tags

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

LabelLayout2

Field 'labelLayout2' in table 'AddressFormat': Dictionary type String[255], .NET type: String

Part two of format specification, concatenated with part one above

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

LayoutId

Field 'layout_id' in table 'AddressFormat': Dictionary type ShortId, .NET type: Int16

Corresponds to Country.layout_id

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

Name

Field 'name' in table 'AddressFormat': Dictionary type String[240], .NET type: String

Name of address format (descriptive, multi-language)

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

Registered

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

StateFlags

Field 'state_flags' in table 'AddressFormat': Dictionary type UShort, .NET type: Int16

Field flags for state field: See EAddrFormatFlags enum

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

StateLeadtext

Field 'state_leadtext' in table 'AddressFormat': Dictionary type Id, .NET type: Int32

Lead text resource ID for state field, 0 = no leadtext

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

StateLength

Field 'state_length' in table 'AddressFormat': Dictionary type UShort, .NET type: Int16

Field length in characters for state field

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

StateLine

Field 'state_line' in table 'AddressFormat': Dictionary type UShort, .NET type: Int16

Line no. for state field, 0 if not shown

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

StateMask

Field 'state_mask' in table 'AddressFormat': Dictionary type String[10], .NET type: String

Formatting mask for state field

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

StateSubpos

Field 'state_subpos' in table 'AddressFormat': Dictionary type UShort, .NET type: Int16

Position within line for state field

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

StateZip

Field 'state_zip' in table 'AddressFormat': Dictionary type UShort, .NET type: Int16

Zip lookup functionality for state field: 0 = none, 1 = source, 2 = target

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

Updated

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

Number of updates made to this record

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

ZipFlags

Field 'zip_flags' in table 'AddressFormat': Dictionary type UShort, .NET type: Int16

Field flags for zip field: See EAddrFormatFlags enum

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

ZipLeadtext

Field 'zip_leadtext' in table 'AddressFormat': Dictionary type Id, .NET type: Int32

Lead text resource ID for zip field, 0 = no leadtext

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

ZipLength

Field 'zip_length' in table 'AddressFormat': Dictionary type UShort, .NET type: Int16

Field length in characters for zip field

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

ZipLine

Field 'zip_line' in table 'AddressFormat': Dictionary type UShort, .NET type: Int16

Line no. for zip field, 0 if not shown

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

ZipMask

Field 'zip_mask' in table 'AddressFormat': Dictionary type String[10], .NET type: String

Formatting mask for zip field

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

ZipSubpos

Field 'zip_subpos' in table 'AddressFormat': Dictionary type UShort, .NET type: Int16

Position within line for zip field

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

ZipZip

Field 'zip_zip' in table 'AddressFormat': Dictionary type UShort, .NET type: Int16

Zip lookup functionality for zip field: 0 = none, 1 = source, 2 = target

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

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