Class UserDefinedFieldInfo
Namespace: SuperOffice.WebApi.Data
Assembly: SuperOffice.WebApi.dll
Carrier object for 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.
Inheritance
object ←
Carrier ←
UserDefinedFieldInfo
Inherited Members
Carrier.TableRight,
Carrier.FieldProperties,
object.ToString(),
object.Equals(object),
object.Equals(object, object),
object.ReferenceEquals(object, object),
object.GetHashCode(),
object.GetType(),
object.MemberwiseClone()
Examples
Get UserDefinedFieldInfo 123 using the WebApi client:
var configuration = new WebApiConfiguration(url);
var agent = new UserDefinedFieldInfoAgent(configuration);
var userDefinedFieldInfo = agent.GetUserDefinedFieldInfo( 123 );
Constructors
UserDefinedFieldInfo()
Default constructor - defaults any enum props to 0.
Properties
ColumnId
The ID of the database column this field corresponds to
Property Value
int
FieldDefault
Optional default value for String fields
Property Value
string
FieldHeight
field height in pixels, 0 = ‘enough’ (from font)
Property Value
short
FieldLabel
The label (lead text)
Property Value
string
FieldLeft
X pixel coordinate of field
Property Value
short
FieldTop
Y pixel coordinate of field
Property Value
short
FieldType
Field type: 0 = leadtext only, 1 = Edit, 2 = CheckBox, 3 = dropdown, 4 = listbox
NULL if unknown enum value.
Property Value
UDefFieldType?
See Also
UserDefinedFieldInfo.FieldType_String
FieldType_String
Field type: 0 = leadtext only, 1 = Edit, 2 = CheckBox, 3 = dropdown, 4 = listbox
Raw string enum value.
Property Value
string
See Also
UserDefinedFieldInfo.FieldType
FieldWidth
field width in pixels, 0 = ‘enough’ (from font)
Property Value
short
Formatting mask, can be whatever the controls understand (currently nothing :-))
Property Value
string
HasBeenPublished
Has the udef field been published?
Property Value
bool
HideLabel
Hide the label if 1
Property Value
bool
IsIndexed
Is this field indexed? 0 if no, index no. if yes
Property Value
bool
IsMandatory
0 = no, 1 = yes (field must be filled out)
Property Value
bool
IsReadOnly
0 = read/write, 1 = readonly (don’t combine with mandatory 8-) )
Property Value
bool
Justification
Justification - 0 = default, left, right, center
NULL if unknown enum value.
Property Value
UdefJustification?
See Also
UserDefinedFieldInfo.Justification_String
Justification_String
Justification - 0 = default, left, right, center
Raw string enum value.
Property Value
string
See Also
UserDefinedFieldInfo.Justification
LabelHeight
label height in pixels, 0 = ‘enough’ (from font)
Property Value
short
LabelLeft
X pixel coordinate of label
Property Value
short
LabelTop
Y pixel coordinate of label
Property Value
short
LabelWidth
label width in pixels, 0 = ‘enough’ (from font)
Property Value
short
LastVersionId
UDefFieldId this field had in the previous version, 0 = field is new in this version
Property Value
int
ListTableId
The table ID of the source table for lists: kTableAssoc, kTableContInt or whatever
Property Value
short
MdoListName
MDO list name used to populate this list. Derived from UDListDefinitionId and ListTableId. (Read-only)
Property Value
string
Page1LineNo
Line no on View Page 1, used if MDO flags are OFF. 0 = this field is not visible on page 1
Property Value
short
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.
Property Value
string
ShortLabel
Short name to be used in Archive headings and on page 1. If blank, the fieldLabel will be used everywhere.
Property Value
string
TabOrder
Tab order value, sets the field processing sequence
Property Value
short
TemplateVariableName
Template variable name
Property Value
string
TextLength
Length (in characters) of a text field, 0 for other types
Property Value
short
Optional tooltip text for this field
Property Value
string
Type
ID of owning table (contact, person, project) - this is not the actual tableNumber, rather it’s an enum
NULL if unknown enum value.
Property Value
UDefType?
See Also
UserDefinedFieldInfo.Type_String
Type_String
ID of owning table (contact, person, project) - this is not the actual tableNumber, rather it’s an enum
Raw string enum value.
Property Value
string
See Also
UserDefinedFieldInfo.Type
UDListDefinitionId
List to use for populating dropdown or listbox
Property Value
int
UDefFieldId
Primary key
Property Value
int
UdefIdentity
Unique number used to track field identity across layout changes
Property Value
int
Version
Definition version number; ALL fields get new version whenever layout is updated.
Property Value
short
See Also
UserDefinedFieldInfoAgent
