Class CustomObjectDefinition
Schema definition for a Custom Object: the underlying table and its fields.
Carrier object for CustomObjectDefinition. Services for the CustomObjectDefinition Carrier is available from the CustomObject Agent.Namespace: SuperOffice.CRM.Services
Assembly: SuperOffice.Services.dll
Syntax
[DataContract(Namespace = "http://www.superoffice.net/ws/crm/NetServer/12.2.0.0")]
public class CustomObjectDefinition : CarrierConstructors
CustomObjectDefinition()
Default constructor
Declaration
public CustomObjectDefinition()See Also
Properties
Description
Description of the Custom Object.
Declaration
[DataMember]
public virtual string Description { get; set; }Property Value
| Type | Description |
|---|---|
| string |
See Also
DisplayField
Name of the field used to represent a row in lists and previews.
Declaration
[DataMember]
public virtual string DisplayField { get; set; }Property Value
| Type | Description |
|---|---|
| string |
See Also
Fields
Field definitions for this Custom Object.
Declaration
[DataMember]
public virtual CustomObjectField[] Fields { get; set; }Property Value
| Type | Description |
|---|---|
| CustomObjectField[] |
See Also
Flags
Bitmask of ExtraTableFlag values.
Declaration
[DataMember]
public virtual int Flags { get; set; }Property Value
| Type | Description |
|---|---|
| int |
See Also
IconId
Icon binary-object id used in the UI.
Declaration
[DataMember]
public virtual int IconId { get; set; }Property Value
| Type | Description |
|---|---|
| int |
See Also
Id
Primary key in the extra-tables table.
Declaration
[DataMember]
public virtual int Id { get; set; }Property Value
| Type | Description |
|---|---|
| int |
See Also
Name
Database table name of the Custom Object, e.g. 'y_equipment'.
Declaration
[DataMember]
public virtual string Name { get; set; }Property Value
| Type | Description |
|---|---|
| string |
See Also
Title
User-visible title of the Custom Object.
Declaration
[DataMember]
public virtual string Title { 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. |
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. |