Skip to main content

​
Class CustomObjectField

Namespace: SuperOffice.WebApi.Data
Assembly: SuperOffice.WebApi.dll Carrier object for CustomObjectField. Describes one field on a Custom Object Definition.

​
Inheritance

object ← CustomObjectField

​
Inherited Members

object.ToString(), object.Equals(object), object.Equals(object, object), object.ReferenceEquals(object, object), object.GetHashCode(), object.GetType(), object.MemberwiseClone()

​
Constructors

​
CustomObjectField()

Default constructor - defaults any enum props to 0.

​
Properties

​
DefaultValue

Default value, formatted with CultureDataFormatter (e.g. ‘[I:1]’ for an integer).

​
Property Value

string

​
Description

Description of the field.

​
Property Value

string

​
DisplayName

User-visible name of the field.

​
Property Value

string

​
FieldName

Database column name of the field, e.g. ‘x_equipment_type’.

​
Property Value

string

​
FieldType

Field type, formatted as the string value of ExtraFieldType (e.g. ‘string’, ‘int’, ‘datetime’).

​
Property Value

string

​
IsDefault

True if the field is shown by default in list views (mirrors the ViewInList extra-field flag).

​
Property Value

bool

​
Rank

Display order of the field within the Custom Object Definition.

​
Property Value

int

​
UseDefaultValue

True if the field has a default value that should be used when creating new rows.

​
Property Value

bool

​
See Also

CustomObjectAgent

Related topics

WebAPI changes in SuperOffice 12.1How to create a user-defined field using the web services APIWebAPI changes in SuperOffice 12.2How to update a user-defined field using the web services APISuperOffice WebApiWebAPI changes in SuperOffice 12.0How to get all user-defined fields using the web services API