Skip to main content

​
Class CustomObjectDefinition

Namespace: SuperOffice.WebApi.Data
Assembly: SuperOffice.WebApi.dll Carrier object for CustomObjectDefinition. Schema definition for a Custom Object: the underlying table and its fields.

​
Inheritance

object ← Carrier ← CustomObjectDefinition

​
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()

​
Constructors

​
CustomObjectDefinition()

Default constructor - defaults any enum props to 0.

​
Properties

​
Description

Description of the Custom Object.

​
Property Value

string

​
DisplayField

Name of the field used to represent a row in lists and previews.

​
Property Value

string

​
Fields

Field definitions for this Custom Object.

​
Property Value

CustomObjectField[]

​
Flags

Bitmask of ExtraTableFlag values.

​
Property Value

int

​
IconId

Icon binary-object id used in the UI.

​
Property Value

int

​
Id

Primary key in the extra-tables table.

​
Property Value

int

​
Name

Database table name of the Custom Object, e.g. ‘y_equipment’.

​
Property Value

string

​
Title

User-visible title of the Custom Object.

​
Property Value

string

​
See Also

CustomObjectAgent

Related topics

SuperOffice.WebApi.Agents.CustomObjectAgentSuperOffice.WebApi.Agents.ICustomObjectAgentSuperOffice.WebApi.Data.CustomObject GetCustomObjectDefinitionRequestSuperOffice.WebApi.Data.CustomObjectSuperOffice.WebApi.Data.CustomObjectFieldSuperOffice.WebApi.Data.CustomObject SaveCustomObjectRequest