Click or drag to resize

IUDefField Properties

The IUDefField type exposes the following members.

Properties
  NameDescription
Public propertyCode exampleDefaultValue
Default Value A user defined field may be defined with a default value, this returns the default value if there is any defined, else it returns an empty string.
Public propertyCode exampleFieldId
The column id the value is stored in. Use the dictionary object to convert the id to a table.field name. The fieldId is shown on the User defined tables in the database manual as the columnId, this is an internal constant and refers to where the value of this User defined field is stored.
Public propertyCode exampleFieldIdentity
Version-independent field Identity. Assigned by system. Unlike FieldId this value does not change when the type changes from string to checkbox. The fieldId is shown on the User defined tables in the database manual as the columnId, this is an internal constant and refers to where the value of this User defined field is stored. The FieldIdentity is a unique value for this field, stored in the database field crm5.udeffield.udefIdentity.
Public propertyCode exampleFieldType
Type of field when displayed: list, text, checkbox What type of field is this?
Public propertyCode exampleHideLabel
Show the label?
Public propertyCode exampleIsIndexed
Is this field indexed for faster searching? If the field set as searchable in the admin client, it means that this is an indexed field.
Public propertyCode exampleIsMandatory
Is this field Mandatory? (can not be blank/empty) Do you have to add a value to this field before you may save the model?
Public propertyCode exampleIsReadOnly
Can the user edit this field? Is the user-defined field a read only field?
Public propertyCode exampleLabel
Text in front of the field. The fields label. A user defined field may have a hidden label in the CRM GUI, but the value will be returned trough SuperCOM, the label is hidden if LabelW = 0
Public propertyCode exampleLabelH
Size of field label in pixels. The fields label. A user defined field may have a hidden label in the CRM GUI, but the value will be returned trough SuperCOM, the label is hidden if LabelW = 0 The height of the label
Public propertyCode exampleLabelW
Size of field label in pixels. The fields label. A user defined field may have a hidden label in the CRM GUI, but the value will be returned trough SuperCOM, the label is hidden if LabelW = 0 The width of the label.
Public propertyCode exampleLabelX
Position of field label in pixels. The fields label. A user defined field may have a hidden label in the CRM GUI, but the value will be returned trough SuperCOM, the label is hidden if LabelW = 0 Horizontal position for the label. The higher the number, the further to the right.
Public propertyCode exampleLabelY
Position of field label in pixels. The fields label. A user defined field may have a hidden label in the CRM GUI, but the value will be returned trough SuperCOM, the label is hidden if LabelW = 0 Vertical position for the label. The higher the number, the further down
Public propertyCode exampleListTableId
If field is listbox, then which list is it populated from.

This return the value that may be used to get the list that is used if FieldType = 7.

If ListTableID>1000, then this is a userdefined list. If ListTableID<1000 then this is one of SuperOffice core tables.

Public propertyCode exampleProgId
Version-independent field identifier. For use by 3rd party programs/NetServer. Not yet implemented in GUI. May be used by third party products to identify their user defined fields. If you have logged in to the database via NetServer (e.g using 6.web) the default value SuperOffice:n would automatically be set, starting with the first as SuperOffice:1
Public propertyCode exampleShortLabel
Short version of label used in archive multi-column list-views. Not yet implemented in GUI, but used by NetServer.
Public propertyCode exampleShowOnPage1
Is the field displayed on the front page in the GUI? Returns true if the field should be shown on page 1.
Public propertyCode exampleTabOrder
Edit sequence of fields. Rank of fields in admin tool. The tab order of this field.
Public propertyCode exampleTextLength
Number of characters in the field. The data fields length
Public propertyCode exampleTooltip
Tooltip shown over field The tool tip may be used to give extra information to the users. If the field is not defined, an empty string is returned
Public propertyCode exampleValue
The contents of the field on this particular object. The value of this user defined field. If FieldType = 7, the Udef.Value will be the udList_id.
Public propertyCode exampleValueH
Size of edit field in pixels. The value of this user defined field. If FieldType = 7, the Udef.Value will be the udList_id. The height of the data field.
Public propertyCode exampleValueW
Size of edit field in pixels. The value of this user defined field. If FieldType = 7, the Udef.Value will be the udList_id. The width of the data field
Public propertyCode exampleValueX
Position of edit field in pixels. The value of this user defined field. If FieldType = 7, the Udef.Value will be the udList_id. Horizontal position for the data field. The higher the number, the further to the right.
Public propertyCode exampleValueY
Position of edit field in pixels. The value of this user defined field. If FieldType = 7, the Udef.Value will be the udList_id. Horizontal position for the data field. The higher the number, the further to the right.
Top
See Also