Class CustomObjectField
Describes one field on a Custom Object Definition.
Carrier object for CustomObjectField. Services for the CustomObjectField Carrier is available from the CustomObject Agent.Inherited Members
Namespace: SuperOffice.CRM.Services
Assembly: SuperOffice.Services.dll
Syntax
[DataContract(Namespace = "http://www.superoffice.net/ws/crm/NetServer/12.2.0.0")]
public class CustomObjectFieldConstructors
CustomObjectField()
Default constructor
Declaration
public CustomObjectField()See Also
Properties
DefaultValue
Default value, formatted with CultureDataFormatter (e.g. '[I:1]' for an integer).
Declaration
[DataMember]
public virtual string DefaultValue { get; set; }Property Value
| Type | Description |
|---|---|
| string |
See Also
Description
Description of the field.
Declaration
[DataMember]
public virtual string Description { get; set; }Property Value
| Type | Description |
|---|---|
| string |
See Also
DisplayName
User-visible name of the field.
Declaration
[DataMember]
public virtual string DisplayName { get; set; }Property Value
| Type | Description |
|---|---|
| string |
See Also
FieldName
Database column name of the field, e.g. 'x_equipment_type'.
Declaration
[DataMember]
public virtual string FieldName { get; set; }Property Value
| Type | Description |
|---|---|
| string |
See Also
FieldType
Field type, formatted as the string value of ExtraFieldType (e.g. 'string', 'int', 'datetime').
Declaration
[DataMember]
public virtual string FieldType { get; set; }Property Value
| Type | Description |
|---|---|
| string |
See Also
IsDefault
True if the field is shown by default in list views (mirrors the ViewInList extra-field flag).
Declaration
[DataMember]
public virtual bool IsDefault { get; set; }Property Value
| Type | Description |
|---|---|
| bool |
See Also
Rank
Display order of the field within the Custom Object Definition.
Declaration
[DataMember]
public virtual int Rank { get; set; }Property Value
| Type | Description |
|---|---|
| int |
See Also
UseDefaultValue
True if the field has a default value that should be used when creating new rows.
Declaration
[DataMember]
public virtual bool UseDefaultValue { get; set; }Property Value
| Type | Description |
|---|---|
| bool |
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 string ToString(string prefix)Parameters
| Type | Name | Description |
|---|---|---|
| string | prefix | The line prefix (typically used for indenting) |
Returns
| Type | Description |
|---|---|
| string | The carrier contents. |