Class FieldInfoBase
Abstract basic information about database fields. May be custom or user-defined fields. The information can be used to build a user interface.
Carrier object for FieldInfoBase. Services for the FieldInfoBase Carrier is available from the UserDefinedFieldInfo Agent.Inheritance
Inherited Members
Namespace: SuperOffice.CRM.Services
Assembly: SuperOffice.Services.dll
Syntax
[DataContract(Namespace = "http://www.superoffice.net/ws/crm/NetServer/11.1.0.0")]
public class FieldInfoBaseConstructors
FieldInfoBase()
Default constructor
Declaration
public FieldInfoBase()See Also
Properties
Description
Optional tooltip text for this field
Declaration
[DataMember]
public virtual string Description { get; set; }Property Value
| Type | Description |
|---|---|
| string |
See Also
DisplayName
Label for field. May be multi-lang string encoded.
Declaration
[DataMember]
public virtual string DisplayName { get; set; }Property Value
| Type | Description |
|---|---|
| string |
See Also
FieldName
Database name or prog-id: 'x_foobar' or 'SuperOffice:2'.
Declaration
[DataMember]
public virtual string FieldName { get; set; }Property Value
| Type | Description |
|---|---|
| string |
See Also
FieldType
What sort of data does this field contain. 1 = int, 2 = short text, ...
Declaration
[DataMember]
public virtual CustomFieldType FieldType { get; set; }Property Value
| Type | Description |
|---|---|
| CustomFieldType |
See Also
HideField
Hide the field from the UI. Only allow API access.
Declaration
[DataMember]
public virtual bool HideField { 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
IsDisplayField
Flag indicating that this field is chosen as DisplayField for a table it belongs
Declaration
[DataMember]
public virtual bool IsDisplayField { get; set; }Property Value
| Type | Description |
|---|---|
| bool |
See Also
IsExternal
Should this field be shown to external users via customer center?
Declaration
[DataMember]
public virtual bool IsExternal { 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
Rank
Tab order, ranking within the custom fields.
Declaration
[DataMember]
public virtual int Rank { get; set; }Property Value
| Type | Description |
|---|---|
| int |
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
TemplateVariableName
Template variable name: 'cs01', 'cl02' etc. Null for extra fields.
Declaration
[DataMember]
public virtual string TemplateVariableName { get; set; }Property Value
| Type | Description |
|---|---|
| string |
See Also
Methods
ToString()
Returns the carrier contents as a formatted string.
Declaration
public override string ToString()Returns
| Type | Description |
|---|---|
| string | The carrier contents. |
Overrides
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 virtual string ToString(string prefix)Parameters
| Type | Name | Description |
|---|---|---|
| string | prefix | The line prefix (typically used for indenting) |
Returns
| Type | Description |
|---|---|
| string | The carrier contents. |