Class UDefFieldRecordData

POCO (Plain Old CLR Object) class that can be used to hold data corresponding to a row from the UDefField table.

Inheritance
object
UDefFieldRecordData
Inherited Members
Namespace: SuperOffice.CRM.Rows
Assembly: SoDataBase.dll
Syntax
public class UDefFieldRecordData
Remarks

Please use this class instead of a full UDefFieldRow object when you do not need to create or update a value in the database. Row objects have a large overhead since they carry the corresponding UDefFieldTableInfo object, which in turn defines fields and aliases; there may be a Sentry on a row, and various other helper objects.

Constructors

UDefFieldRecordData()

POCO (Plain Old CLR Object) class that can be used to hold data corresponding to a row from the UDefField table.

Declaration
public UDefFieldRecordData()
Remarks

Please use this class instead of a full UDefFieldRow object when you do not need to create or update a value in the database. Row objects have a large overhead since they carry the corresponding UDefFieldTableInfo object, which in turn defines fields and aliases; there may be a Sentry on a row, and various other helper objects.

Fields

ColumnId

The ID of the database column this field corresponds to

Declaration
public int ColumnId
Field Value
Type Description
int
Remarks

Please use this class instead of a full UDefFieldRow object when you do not need to create or update a value in the database. Row objects have a large overhead since they carry the corresponding UDefFieldTableInfo object, which in turn defines fields and aliases; there may be a Sentry on a row, and various other helper objects.

FieldDefault

Optional default value for String fields

Declaration
public string FieldDefault
Field Value
Type Description
string
Remarks

Please use this class instead of a full UDefFieldRow object when you do not need to create or update a value in the database. Row objects have a large overhead since they carry the corresponding UDefFieldTableInfo object, which in turn defines fields and aliases; there may be a Sentry on a row, and various other helper objects.

FieldHeight

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

Declaration
public short FieldHeight
Field Value
Type Description
short
Remarks

Please use this class instead of a full UDefFieldRow object when you do not need to create or update a value in the database. Row objects have a large overhead since they carry the corresponding UDefFieldTableInfo object, which in turn defines fields and aliases; there may be a Sentry on a row, and various other helper objects.

FieldLabel

The label (lead text)

Declaration
public string FieldLabel
Field Value
Type Description
string
Remarks

Please use this class instead of a full UDefFieldRow object when you do not need to create or update a value in the database. Row objects have a large overhead since they carry the corresponding UDefFieldTableInfo object, which in turn defines fields and aliases; there may be a Sentry on a row, and various other helper objects.

FieldLeft

X pixel coordinate of field

Declaration
public short FieldLeft
Field Value
Type Description
short
Remarks

Please use this class instead of a full UDefFieldRow object when you do not need to create or update a value in the database. Row objects have a large overhead since they carry the corresponding UDefFieldTableInfo object, which in turn defines fields and aliases; there may be a Sentry on a row, and various other helper objects.

FieldTop

Y pixel coordinate of field

Declaration
public short FieldTop
Field Value
Type Description
short
Remarks

Please use this class instead of a full UDefFieldRow object when you do not need to create or update a value in the database. Row objects have a large overhead since they carry the corresponding UDefFieldTableInfo object, which in turn defines fields and aliases; there may be a Sentry on a row, and various other helper objects.

FieldType

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

Declaration
public short FieldType
Field Value
Type Description
short
Remarks

Please use this class instead of a full UDefFieldRow object when you do not need to create or update a value in the database. Row objects have a large overhead since they carry the corresponding UDefFieldTableInfo object, which in turn defines fields and aliases; there may be a Sentry on a row, and various other helper objects.

FieldWidth

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

Declaration
public short FieldWidth
Field Value
Type Description
short
Remarks

Please use this class instead of a full UDefFieldRow object when you do not need to create or update a value in the database. Row objects have a large overhead since they carry the corresponding UDefFieldTableInfo object, which in turn defines fields and aliases; there may be a Sentry on a row, and various other helper objects.

FormatMask

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

Declaration
public string FormatMask
Field Value
Type Description
string
Remarks

Please use this class instead of a full UDefFieldRow object when you do not need to create or update a value in the database. Row objects have a large overhead since they carry the corresponding UDefFieldTableInfo object, which in turn defines fields and aliases; there may be a Sentry on a row, and various other helper objects.

HideLabel

Hide the label if 1

Declaration
public short HideLabel
Field Value
Type Description
short
Remarks

Please use this class instead of a full UDefFieldRow object when you do not need to create or update a value in the database. Row objects have a large overhead since they carry the corresponding UDefFieldTableInfo object, which in turn defines fields and aliases; there may be a Sentry on a row, and various other helper objects.

Indexed

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

Declaration
public short Indexed
Field Value
Type Description
short
Remarks

Please use this class instead of a full UDefFieldRow object when you do not need to create or update a value in the database. Row objects have a large overhead since they carry the corresponding UDefFieldTableInfo object, which in turn defines fields and aliases; there may be a Sentry on a row, and various other helper objects.

Justification

Justification - 0 = default, left, right, center

Declaration
public UdefJustification Justification
Field Value
Type Description
UdefJustification
Remarks

Please use this class instead of a full UDefFieldRow object when you do not need to create or update a value in the database. Row objects have a large overhead since they carry the corresponding UDefFieldTableInfo object, which in turn defines fields and aliases; there may be a Sentry on a row, and various other helper objects.

LabelHeight

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

Declaration
public short LabelHeight
Field Value
Type Description
short
Remarks

Please use this class instead of a full UDefFieldRow object when you do not need to create or update a value in the database. Row objects have a large overhead since they carry the corresponding UDefFieldTableInfo object, which in turn defines fields and aliases; there may be a Sentry on a row, and various other helper objects.

LabelLeft

X pixel coordinate of label

Declaration
public short LabelLeft
Field Value
Type Description
short
Remarks

Please use this class instead of a full UDefFieldRow object when you do not need to create or update a value in the database. Row objects have a large overhead since they carry the corresponding UDefFieldTableInfo object, which in turn defines fields and aliases; there may be a Sentry on a row, and various other helper objects.

LabelTop

Y pixel coordinate of label

Declaration
public short LabelTop
Field Value
Type Description
short
Remarks

Please use this class instead of a full UDefFieldRow object when you do not need to create or update a value in the database. Row objects have a large overhead since they carry the corresponding UDefFieldTableInfo object, which in turn defines fields and aliases; there may be a Sentry on a row, and various other helper objects.

LabelWidth

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

Declaration
public short LabelWidth
Field Value
Type Description
short
Remarks

Please use this class instead of a full UDefFieldRow object when you do not need to create or update a value in the database. Row objects have a large overhead since they carry the corresponding UDefFieldTableInfo object, which in turn defines fields and aliases; there may be a Sentry on a row, and various other helper objects.

LastVersionId

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

Declaration
public int LastVersionId
Field Value
Type Description
int
Remarks

Please use this class instead of a full UDefFieldRow object when you do not need to create or update a value in the database. Row objects have a large overhead since they carry the corresponding UDefFieldTableInfo object, which in turn defines fields and aliases; there may be a Sentry on a row, and various other helper objects.

ListTableId

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

Declaration
public short ListTableId
Field Value
Type Description
short
Remarks

Please use this class instead of a full UDefFieldRow object when you do not need to create or update a value in the database. Row objects have a large overhead since they carry the corresponding UDefFieldTableInfo object, which in turn defines fields and aliases; there may be a Sentry on a row, and various other helper objects.

Mandatory

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

Declaration
public short Mandatory
Field Value
Type Description
short
Remarks

Please use this class instead of a full UDefFieldRow object when you do not need to create or update a value in the database. Row objects have a large overhead since they carry the corresponding UDefFieldTableInfo object, which in turn defines fields and aliases; there may be a Sentry on a row, and various other helper objects.

OwnerTableId

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

Declaration
public short OwnerTableId
Field Value
Type Description
short
Remarks

Please use this class instead of a full UDefFieldRow object when you do not need to create or update a value in the database. Row objects have a large overhead since they carry the corresponding UDefFieldTableInfo object, which in turn defines fields and aliases; there may be a Sentry on a row, and various other helper objects.

Page1LineNo

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

Declaration
public short Page1LineNo
Field Value
Type Description
short
Remarks

Please use this class instead of a full UDefFieldRow object when you do not need to create or update a value in the database. Row objects have a large overhead since they carry the corresponding UDefFieldTableInfo object, which in turn defines fields and aliases; there may be a Sentry on a row, and various other helper objects.

ProgId

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 string ProgId
Field Value
Type Description
string
Remarks

Please use this class instead of a full UDefFieldRow object when you do not need to create or update a value in the database. Row objects have a large overhead since they carry the corresponding UDefFieldTableInfo object, which in turn defines fields and aliases; there may be a Sentry on a row, and various other helper objects.

ReadOnly

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

Declaration
public short ReadOnly
Field Value
Type Description
short
Remarks

Please use this class instead of a full UDefFieldRow object when you do not need to create or update a value in the database. Row objects have a large overhead since they carry the corresponding UDefFieldTableInfo object, which in turn defines fields and aliases; there may be a Sentry on a row, and various other helper objects.

Registered

Registered when in UTC.

Declaration
public DateTime Registered
Field Value
Type Description
DateTime
Remarks

Please use this class instead of a full UDefFieldRow object when you do not need to create or update a value in the database. Row objects have a large overhead since they carry the corresponding UDefFieldTableInfo object, which in turn defines fields and aliases; there may be a Sentry on a row, and various other helper objects.

RegisteredAssociateId

Registered by whom

Declaration
public int RegisteredAssociateId
Field Value
Type Description
int
Remarks

Please use this class instead of a full UDefFieldRow object when you do not need to create or update a value in the database. Row objects have a large overhead since they carry the corresponding UDefFieldTableInfo object, which in turn defines fields and aliases; there may be a Sentry on a row, and various other helper objects.

ShortLabel

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

Declaration
public string ShortLabel
Field Value
Type Description
string
Remarks

Please use this class instead of a full UDefFieldRow object when you do not need to create or update a value in the database. Row objects have a large overhead since they carry the corresponding UDefFieldTableInfo object, which in turn defines fields and aliases; there may be a Sentry on a row, and various other helper objects.

TabOrder

Tab order value, sets the field processing sequence

Declaration
public short TabOrder
Field Value
Type Description
short
Remarks

Please use this class instead of a full UDefFieldRow object when you do not need to create or update a value in the database. Row objects have a large overhead since they carry the corresponding UDefFieldTableInfo object, which in turn defines fields and aliases; there may be a Sentry on a row, and various other helper objects.

TextLength

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

Declaration
public short TextLength
Field Value
Type Description
short
Remarks

Please use this class instead of a full UDefFieldRow object when you do not need to create or update a value in the database. Row objects have a large overhead since they carry the corresponding UDefFieldTableInfo object, which in turn defines fields and aliases; there may be a Sentry on a row, and various other helper objects.

Tooltip

Optional tooltip text for this field

Declaration
public string Tooltip
Field Value
Type Description
string
Remarks

Please use this class instead of a full UDefFieldRow object when you do not need to create or update a value in the database. Row objects have a large overhead since they carry the corresponding UDefFieldTableInfo object, which in turn defines fields and aliases; there may be a Sentry on a row, and various other helper objects.

UDListDefinitionId

List to use for populating dropdown or listbox

Declaration
public int UDListDefinitionId
Field Value
Type Description
int
Remarks

Please use this class instead of a full UDefFieldRow object when you do not need to create or update a value in the database. Row objects have a large overhead since they carry the corresponding UDefFieldTableInfo object, which in turn defines fields and aliases; there may be a Sentry on a row, and various other helper objects.

UDefFieldId

Primary key

Declaration
public int UDefFieldId
Field Value
Type Description
int
Remarks

Please use this class instead of a full UDefFieldRow object when you do not need to create or update a value in the database. Row objects have a large overhead since they carry the corresponding UDefFieldTableInfo object, which in turn defines fields and aliases; there may be a Sentry on a row, and various other helper objects.

UdefIdentity

Unique number used to track field identity across layout changes

Declaration
public int UdefIdentity
Field Value
Type Description
int
Remarks

Please use this class instead of a full UDefFieldRow object when you do not need to create or update a value in the database. Row objects have a large overhead since they carry the corresponding UDefFieldTableInfo object, which in turn defines fields and aliases; there may be a Sentry on a row, and various other helper objects.

Updated

Last updated when in UTC.

Declaration
public DateTime Updated
Field Value
Type Description
DateTime
Remarks

Please use this class instead of a full UDefFieldRow object when you do not need to create or update a value in the database. Row objects have a large overhead since they carry the corresponding UDefFieldTableInfo object, which in turn defines fields and aliases; there may be a Sentry on a row, and various other helper objects.

UpdatedAssociateId

Last updated by whom

Declaration
public int UpdatedAssociateId
Field Value
Type Description
int
Remarks

Please use this class instead of a full UDefFieldRow object when you do not need to create or update a value in the database. Row objects have a large overhead since they carry the corresponding UDefFieldTableInfo object, which in turn defines fields and aliases; there may be a Sentry on a row, and various other helper objects.

UpdatedCount

Number of updates made to this record

Declaration
public short UpdatedCount
Field Value
Type Description
short
Remarks

Please use this class instead of a full UDefFieldRow object when you do not need to create or update a value in the database. Row objects have a large overhead since they carry the corresponding UDefFieldTableInfo object, which in turn defines fields and aliases; there may be a Sentry on a row, and various other helper objects.

Version

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

Declaration
public short Version
Field Value
Type Description
short
Remarks

Please use this class instead of a full UDefFieldRow object when you do not need to create or update a value in the database. Row objects have a large overhead since they carry the corresponding UDefFieldTableInfo object, which in turn defines fields and aliases; there may be a Sentry on a row, and various other helper objects.

Extension Methods