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

# <a id="SuperOffice_WebApi_Data_FieldInfoBase" /> Class FieldInfoBase

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

Carrier object for FieldInfoBase.
Abstract basic information about database fields. May be custom or user-defined fields. The information can be used to build a user interface.

```csharp theme={null}
[KnownType(typeof(FieldInfoAttachment))]
[KnownType(typeof(FieldInfoBlob))]
[KnownType(typeof(FieldInfoBool))]
[KnownType(typeof(FieldInfoDate))]
[KnownType(typeof(FieldInfoDateTime))]
[KnownType(typeof(FieldInfoDecimal))]
[KnownType(typeof(FieldInfoDynamicLink))]
[KnownType(typeof(FieldInfoInt))]
[KnownType(typeof(FieldInfoMdoList))]
[KnownType(typeof(FieldInfoListText))]
[KnownType(typeof(FieldInfoLongText))]
[KnownType(typeof(FieldInfoRelation))]
[KnownType(typeof(FieldInfoShortText))]
[KnownType(typeof(FieldInfoTime))]
[KnownType(typeof(FieldInfoTimeSpan))]
public class FieldInfoBase
```

#### Inheritance

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

#### Derived

[FieldInfoAttachment](SuperOffice.WebApi.Data.FieldInfoAttachment.md),
[FieldInfoBlob](SuperOffice.WebApi.Data.FieldInfoBlob.md),
[FieldInfoBool](SuperOffice.WebApi.Data.FieldInfoBool.md),
[FieldInfoDate](SuperOffice.WebApi.Data.FieldInfoDate.md),
[FieldInfoDateTime](SuperOffice.WebApi.Data.FieldInfoDateTime.md),
[FieldInfoDecimal](SuperOffice.WebApi.Data.FieldInfoDecimal.md),
[FieldInfoDynamicLink](SuperOffice.WebApi.Data.FieldInfoDynamicLink.md),
[FieldInfoInt](SuperOffice.WebApi.Data.FieldInfoInt.md),
[FieldInfoListText](SuperOffice.WebApi.Data.FieldInfoListText.md),
[FieldInfoLongText](SuperOffice.WebApi.Data.FieldInfoLongText.md),
[FieldInfoMdoList](SuperOffice.WebApi.Data.FieldInfoMdoList.md),
[FieldInfoRelation](SuperOffice.WebApi.Data.FieldInfoRelation.md),
[FieldInfoShortText](SuperOffice.WebApi.Data.FieldInfoShortText.md),
[FieldInfoTime](SuperOffice.WebApi.Data.FieldInfoTime.md),
[FieldInfoTimeSpan](SuperOffice.WebApi.Data.FieldInfoTimeSpan.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_FieldInfoBase__ctor" /> FieldInfoBase()

Default constructor - defaults any enum props to 0.

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

## Properties

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

Optional tooltip text for this 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_FieldInfoBase_DisplayName" /> DisplayName

Label for field. May be multi-lang string encoded.

```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_FieldInfoBase_FieldName" /> FieldName

Database name or prog-id: 'x\_foobar' or 'SuperOffice:2'.

```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_FieldInfoBase_FieldType" /> FieldType

What sort of data does this field contain. 1 = int, 2 = short text, ...
NULL if unknown enum value.

```csharp theme={null}
[JsonIgnore]
public CustomFieldType? FieldType { get; set; }
```

#### Property Value

[CustomFieldType](SuperOffice.WebApi.Data.CustomFieldType.md)?

#### See Also

[FieldInfoBase](SuperOffice.WebApi.Data.FieldInfoBase.md).[FieldType\_String](SuperOffice.WebApi.Data.FieldInfoBase.md#SuperOffice_WebApi_Data_FieldInfoBase_FieldType_String)

### <a id="SuperOffice_WebApi_Data_FieldInfoBase_FieldType_String" /> FieldType\_String

What sort of data does this field contain. 1 = int, 2 = short text, ...
Raw string enum value.

```csharp theme={null}
[JsonProperty("FieldType")]
public string FieldType_String { get; set; }
```

#### Property Value

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

#### See Also

[FieldInfoBase](SuperOffice.WebApi.Data.FieldInfoBase.md).[FieldType](SuperOffice.WebApi.Data.FieldInfoBase.md#SuperOffice_WebApi_Data_FieldInfoBase_FieldType)

### <a id="SuperOffice_WebApi_Data_FieldInfoBase_HideField" /> HideField

Hide the field from the UI. Only allow API access.

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

#### Property Value

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

### <a id="SuperOffice_WebApi_Data_FieldInfoBase_HideLabel" /> HideLabel

Hide the label if 1

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

#### Property Value

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

### <a id="SuperOffice_WebApi_Data_FieldInfoBase_IsDisplayField" /> IsDisplayField

Flag indicating that this field is chosen as DisplayField for a table it belongs

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

#### Property Value

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

### <a id="SuperOffice_WebApi_Data_FieldInfoBase_IsExternal" /> IsExternal

Should this field be shown to external users via customer center?

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

#### Property Value

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

### <a id="SuperOffice_WebApi_Data_FieldInfoBase_IsIndexed" /> IsIndexed

Is this field indexed? 0 if no, index no. if yes

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

#### Property Value

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

### <a id="SuperOffice_WebApi_Data_FieldInfoBase_IsMandatory" /> IsMandatory

0 = no, 1 = yes (field must be filled out)

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

#### Property Value

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

### <a id="SuperOffice_WebApi_Data_FieldInfoBase_IsReadOnly" /> IsReadOnly

0 = read/write, 1 = readonly (don't combine with mandatory  8-) )

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

#### Property Value

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

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

Tab order, ranking within the custom fields.

```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_FieldInfoBase_ShortLabel" /> ShortLabel

Short name to be used in Archive headings and on page 1. If blank, the fieldLabel will be used everywhere.

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

#### Property Value

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

### <a id="SuperOffice_WebApi_Data_FieldInfoBase_TemplateVariableName" /> TemplateVariableName

Template variable name: 'cs01', 'cl02' etc. Null for extra fields.

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

#### Property Value

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

## See Also

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


## Related topics

- [SuperOffice.WebApi.Data.FieldInfoAttachment](/en/api/reference/webapi/SuperOffice.WebApi.Data.FieldInfoAttachment.md)
- [SuperOffice.WebApi.Data.FieldInfoBlob](/en/api/reference/webapi/SuperOffice.WebApi.Data.FieldInfoBlob.md)
- [SuperOffice.WebApi.Data.FieldInfoBool](/en/api/reference/webapi/SuperOffice.WebApi.Data.FieldInfoBool.md)
- [SuperOffice.WebApi.Data.FieldInfoDate](/en/api/reference/webapi/SuperOffice.WebApi.Data.FieldInfoDate.md)
- [SuperOffice.WebApi.Data.FieldInfoTime](/en/api/reference/webapi/SuperOffice.WebApi.Data.FieldInfoTime.md)
- [SuperOffice.WebApi.Data.FieldInfoDecimal](/en/api/reference/webapi/SuperOffice.WebApi.Data.FieldInfoDecimal.md)