> ## 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.CustomObjectRelation

# <a id="SuperOffice_WebApi_Data_CustomObjectRelation" /> Class CustomObjectRelation

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

Carrier object for CustomObjectRelation.
Describes a relation from a Custom Object to another entity.

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

#### Inheritance

[object](https://learn.microsoft.com/dotnet/api/system.object) ←
[CustomObjectRelation](SuperOffice.WebApi.Data.CustomObjectRelation.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_CustomObjectRelation__ctor" /> CustomObjectRelation()

Default constructor - defaults any enum props to 0.

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

## Properties

### <a id="SuperOffice_WebApi_Data_CustomObjectRelation_DisplayField" /> DisplayField

Database column name of the display field for the related entity.

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

#### Property Value

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

### <a id="SuperOffice_WebApi_Data_CustomObjectRelation_EntityName" /> EntityName

Database table name of the related entity.

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

#### Property Value

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

### <a id="SuperOffice_WebApi_Data_CustomObjectRelation_EntityTitle" /> EntityTitle

User-visible title of the related entity.

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

#### Property Value

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

### <a id="SuperOffice_WebApi_Data_CustomObjectRelation_EntityType" /> EntityType

Type of the related entity, e.g. 'contact', 'CustomObject'.

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

#### Property Value

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

### <a id="SuperOffice_WebApi_Data_CustomObjectRelation_HideFunctions" /> HideFunctions

True if the functions (add/edit/delete) should be hidden for this relation.

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

#### Property Value

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

### <a id="SuperOffice_WebApi_Data_CustomObjectRelation_ProviderName" /> ProviderName

Archive provider name for listing related rows.

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

#### Property Value

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

### <a id="SuperOffice_WebApi_Data_CustomObjectRelation_RelationField" /> RelationField

Database column name of the foreign key field.

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

#### Property Value

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

## See Also

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


## Related topics

- [SuperOffice.WebApi.Data.CustomObjectMetadata](/en/api/reference/webapi/SuperOffice.WebApi.Data.CustomObjectMetadata.md)
- [SuperOffice.WebApi.Data.RoleRelationToOwner](/en/api/reference/webapi/SuperOffice.WebApi.Data.RoleRelationToOwner.md)
- [SuperOffice.WebApi.Data.CustomObject](/en/api/reference/webapi/SuperOffice.WebApi.Data.CustomObject.md)
- [SuperOffice.WebApi.Data.CustomObject SaveCustomObjectRequest](/en/api/reference/webapi/SuperOffice.WebApi.Data.CustomObject_SaveCustomObjectRequest.md)
- [SuperOffice.WebApi.Data.CustomObject DeleteCustomObjectRequest](/en/api/reference/webapi/SuperOffice.WebApi.Data.CustomObject_DeleteCustomObjectRequest.md)
- [SuperOffice.WebApi.Data.CustomObject GetCustomObjectRequest](/en/api/reference/webapi/SuperOffice.WebApi.Data.CustomObject_GetCustomObjectRequest.md)