> ## Documentation Index
> Fetch the complete documentation index at: https://docs.superoffice.com/llms.txt
> Use this file to discover all available pages before exploring further.

# SuperOffice.WebApi.Data.CustomObjectField

# <a id="SuperOffice_WebApi_Data_CustomObjectField" /> Class CustomObjectField

Namespace: [SuperOffice.WebApi.Data](SuperOffice.WebApi.Data.md)\
Assembly: SuperOffice.WebApi.dll

Carrier object for CustomObjectField.
Describes one field on a Custom Object Definition.

```csharp theme={null}
public class CustomObjectField
```

#### Inheritance

[object](https://learn.microsoft.com/dotnet/api/system.object) ←
[CustomObjectField](SuperOffice.WebApi.Data.CustomObjectField.md)

#### Inherited Members

[object.ToString()](https://learn.microsoft.com/dotnet/api/system.object.tostring),
[object.Equals(object)](https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals\(system-object\)),
[object.Equals(object, object)](https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals\(system-object-system-object\)),
[object.ReferenceEquals(object, object)](https://learn.microsoft.com/dotnet/api/system.object.referenceequals),
[object.GetHashCode()](https://learn.microsoft.com/dotnet/api/system.object.gethashcode),
[object.GetType()](https://learn.microsoft.com/dotnet/api/system.object.gettype),
[object.MemberwiseClone()](https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone)

## Constructors

### <a id="SuperOffice_WebApi_Data_CustomObjectField__ctor" /> CustomObjectField()

Default constructor - defaults any enum props to 0.

```csharp theme={null}
public CustomObjectField()
```

## Properties

### <a id="SuperOffice_WebApi_Data_CustomObjectField_DefaultValue" /> DefaultValue

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

```csharp theme={null}
public virtual string DefaultValue { get; set; }
```

#### Property Value

[string](https://learn.microsoft.com/dotnet/api/system.string)

### <a id="SuperOffice_WebApi_Data_CustomObjectField_Description" /> Description

Description of the field.

```csharp theme={null}
public virtual string Description { get; set; }
```

#### Property Value

[string](https://learn.microsoft.com/dotnet/api/system.string)

### <a id="SuperOffice_WebApi_Data_CustomObjectField_DisplayName" /> DisplayName

User-visible name of the field.

```csharp theme={null}
public virtual string DisplayName { get; set; }
```

#### Property Value

[string](https://learn.microsoft.com/dotnet/api/system.string)

### <a id="SuperOffice_WebApi_Data_CustomObjectField_FieldName" /> FieldName

Database column name of the field, e.g. 'x\_equipment\_type'.

```csharp theme={null}
public virtual string FieldName { get; set; }
```

#### Property Value

[string](https://learn.microsoft.com/dotnet/api/system.string)

### <a id="SuperOffice_WebApi_Data_CustomObjectField_FieldType" /> FieldType

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

```csharp theme={null}
public virtual string FieldType { get; set; }
```

#### Property Value

[string](https://learn.microsoft.com/dotnet/api/system.string)

### <a id="SuperOffice_WebApi_Data_CustomObjectField_IsDefault" /> IsDefault

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

```csharp theme={null}
public virtual bool IsDefault { get; set; }
```

#### Property Value

[bool](https://learn.microsoft.com/dotnet/api/system.boolean)

### <a id="SuperOffice_WebApi_Data_CustomObjectField_Rank" /> Rank

Display order of the field within the Custom Object Definition.

```csharp theme={null}
public virtual int Rank { get; set; }
```

#### Property Value

[int](https://learn.microsoft.com/dotnet/api/system.int32)

### <a id="SuperOffice_WebApi_Data_CustomObjectField_UseDefaultValue" /> UseDefaultValue

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

```csharp theme={null}
public virtual bool UseDefaultValue { get; set; }
```

#### Property Value

[bool](https://learn.microsoft.com/dotnet/api/system.boolean)

## See Also

[CustomObjectAgent](SuperOffice.WebApi.Agents.CustomObjectAgent.md)


## Related topics

- [SuperOffice.WebApi.Data.CustomObjectDefinition](/en/api/reference/webapi/SuperOffice.WebApi.Data.CustomObjectDefinition.md)
- [SuperOffice.WebApi.Data.CustomObject](/en/api/reference/webapi/SuperOffice.WebApi.Data.CustomObject.md)
- [SuperOffice.WebApi.Data.CustomObjectRelation](/en/api/reference/webapi/SuperOffice.WebApi.Data.CustomObjectRelation.md)
- [SuperOffice.WebApi.Data.CustomCommand](/en/api/reference/webapi/SuperOffice.WebApi.Data.CustomCommand.md)
- [SuperOffice.WebApi.Data.CustomObjectMetadata](/en/api/reference/webapi/SuperOffice.WebApi.Data.CustomObjectMetadata.md)
- [SuperOffice.WebApi.Data.CustomerLanguage](/en/api/reference/webapi/SuperOffice.WebApi.Data.CustomerLanguage.md)