Class UserDefinedFieldInfo

Return information about the user defined fields. The information can be used to mirror the layout of the user-defined fields in the user interface.

Carrier object for UserDefinedFieldInfo. Services for the UserDefinedFieldInfo Carrier is available from the UserDefinedFieldInfo Agent.
Inheritance
object
UserDefinedFieldInfo
Namespace: SuperOffice.CRM.Services
Assembly: SuperOffice.Services.dll
Syntax
[DataContract(Namespace = "http://www.superoffice.net/ws/crm/NetServer/11.1.0.0")]
public class UserDefinedFieldInfo : Carrier
Examples

Get UserDefinedFieldInfo 123 using the agent:

using SuperOffice;
using SuperOffice.CRM.Services;

using (SoSession mySession = SoSession.Authenticate("user", "pass"))
{
   var agent = new UserDefinedFieldInfoAgent();
   var userDefinedFieldInfo = agent.GetUserDefinedFieldInfo( 123 );
}

Constructors

UserDefinedFieldInfo()

Default constructor

Declaration
public UserDefinedFieldInfo()
See Also

Properties

ColumnId

The ID of the database column this field corresponds to

Declaration
[DataMember]
public virtual int ColumnId { get; set; }
Property Value
Type Description
int
See Also

FieldDefault

Optional default value for String fields

Declaration
[DataMember]
public virtual string FieldDefault { get; set; }
Property Value
Type Description
string
See Also

FieldHeight

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

Declaration
[DataMember]
public virtual short FieldHeight { get; set; }
Property Value
Type Description
short
See Also

FieldLabel

The label (lead text)

Declaration
[DataMember]
public virtual string FieldLabel { get; set; }
Property Value
Type Description
string
See Also

FieldLeft

X pixel coordinate of field

Declaration
[DataMember]
public virtual short FieldLeft { get; set; }
Property Value
Type Description
short
See Also

FieldTop

Y pixel coordinate of field

Declaration
[DataMember]
public virtual short FieldTop { get; set; }
Property Value
Type Description
short
See Also

FieldType

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

Declaration
[DataMember]
public virtual UDefFieldType FieldType { get; set; }
Property Value
Type Description
UDefFieldType
See Also

FieldWidth

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

Declaration
[DataMember]
public virtual short FieldWidth { get; set; }
Property Value
Type Description
short
See Also

FormatMask

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

Declaration
[DataMember]
public virtual string FormatMask { get; set; }
Property Value
Type Description
string
See Also

HasBeenPublished

Has the udef field been published?

Declaration
[DataMember]
public virtual bool HasBeenPublished { get; set; }
Property Value
Type Description
bool
See Also

HideLabel

Hide the label if 1

Declaration
[DataMember]
public virtual bool HideLabel { get; set; }
Property Value
Type Description
bool
See Also

IsIndexed

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

Declaration
[DataMember]
public virtual bool IsIndexed { get; set; }
Property Value
Type Description
bool
See Also

IsMandatory

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

Declaration
[DataMember]
public virtual bool IsMandatory { get; set; }
Property Value
Type Description
bool
See Also

IsReadOnly

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

Declaration
[DataMember]
public virtual bool IsReadOnly { get; set; }
Property Value
Type Description
bool
See Also

Justification

Justification - 0 = default, left, right, center

Declaration
[DataMember]
public virtual UdefJustification Justification { get; set; }
Property Value
Type Description
UdefJustification
See Also

LabelHeight

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

Declaration
[DataMember]
public virtual short LabelHeight { get; set; }
Property Value
Type Description
short
See Also

LabelLeft

X pixel coordinate of label

Declaration
[DataMember]
public virtual short LabelLeft { get; set; }
Property Value
Type Description
short
See Also

LabelTop

Y pixel coordinate of label

Declaration
[DataMember]
public virtual short LabelTop { get; set; }
Property Value
Type Description
short
See Also

LabelWidth

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

Declaration
[DataMember]
public virtual short LabelWidth { get; set; }
Property Value
Type Description
short
See Also

LastVersionId

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

Declaration
[DataMember]
public virtual int LastVersionId { get; set; }
Property Value
Type Description
int
See Also

ListTableId

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

Declaration
[DataMember]
public virtual short ListTableId { get; set; }
Property Value
Type Description
short
See Also

MdoListName

MDO list name used to populate this list. Derived from UDListDefinitionId and ListTableId. (Read-only)

Declaration
[DataMember]
public virtual string MdoListName { get; set; }
Property Value
Type Description
string
See Also

Page1LineNo

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

Declaration
[DataMember]
public virtual short Page1LineNo { get; set; }
Property Value
Type Description
short
See Also

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
[DataMember]
public virtual string ProgId { get; set; }
Property Value
Type Description
string
See Also

ShortLabel

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

Declaration
[DataMember]
public virtual string ShortLabel { get; set; }
Property Value
Type Description
string
See Also

TabOrder

Tab order value, sets the field processing sequence

Declaration
[DataMember]
public virtual short TabOrder { get; set; }
Property Value
Type Description
short
See Also

TemplateVariableName

Template variable name

Declaration
[DataMember]
public virtual string TemplateVariableName { get; set; }
Property Value
Type Description
string
See Also

TextLength

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

Declaration
[DataMember]
public virtual short TextLength { get; set; }
Property Value
Type Description
short
See Also

Tooltip

Optional tooltip text for this field

Declaration
[DataMember]
public virtual string Tooltip { get; set; }
Property Value
Type Description
string
See Also

Type

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

Declaration
[DataMember]
public virtual UDefType Type { get; set; }
Property Value
Type Description
UDefType
See Also

UDListDefinitionId

List to use for populating dropdown or listbox

Declaration
[DataMember]
public virtual int UDListDefinitionId { get; set; }
Property Value
Type Description
int
See Also

UDefFieldId

Primary key

Declaration
[DataMember]
public virtual int UDefFieldId { get; set; }
Property Value
Type Description
int
See Also

UdefIdentity

Unique number used to track field identity across layout changes

Declaration
[DataMember]
public virtual int UdefIdentity { get; set; }
Property Value
Type Description
int
See Also

Version

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

Declaration
[DataMember]
public virtual short Version { get; set; }
Property Value
Type Description
short
See Also

Methods

ToString()

Returns the carrier contents as a formatted string.

Declaration
public override string ToString()
Returns
Type Description
string

The carrier contents.
See Also

ToString(string)

Returns the carrier contents as a formatted string, useful for debugging. Each line in the output is prefixed with the input value.

Declaration
public string ToString(string prefix)
Parameters
Type Name Description
string prefix

The line prefix (typically used for indenting)
Returns
Type Description
string

The carrier contents.
See Also

See Also