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

# <a id="SuperOffice_WebApi_Data_HeadingEntity" /> Class HeadingEntity

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

Carrier object for HeadingEntity.
The heading entity contains generic list item information

```csharp theme={null}
public class HeadingEntity : Carrier
```

#### Inheritance

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

#### Inherited Members

[Carrier.TableRight](SuperOffice.WebApi.Data.Carrier.md#SuperOffice_WebApi_Data_Carrier_TableRight),
[Carrier.FieldProperties](SuperOffice.WebApi.Data.Carrier.md#SuperOffice_WebApi_Data_Carrier_FieldProperties),
[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)

## Examples

Get HeadingEntity 123 using the WebApi client:
<pre><code class="lang-csharp">var configuration = new WebApiConfiguration(url);
var agent = new ListAgent(configuration);
var headingEntity = agent.GetHeadingEntity( 123 );</code></pre>

## Constructors

### <a id="SuperOffice_WebApi_Data_HeadingEntity__ctor" /> HeadingEntity()

Default constructor - defaults any enum props to 0.

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

## Properties

### <a id="SuperOffice_WebApi_Data_HeadingEntity_Deleted" /> Deleted

True if the heading is marked as deleted

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

#### Property Value

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

### <a id="SuperOffice_WebApi_Data_HeadingEntity_HeadingId" /> HeadingId

Primary key

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

#### Property Value

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

### <a id="SuperOffice_WebApi_Data_HeadingEntity_Name" /> Name

The visible heading

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

#### Property Value

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

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

Rank order

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

#### Property Value

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

### <a id="SuperOffice_WebApi_Data_HeadingEntity_Tooltip" /> Tooltip

Tooltip or other description

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

#### Property Value

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

### <a id="SuperOffice_WebApi_Data_HeadingEntity_UdListDefinitionId" /> UdListDefinitionId

The id of the list which this heading belongs to

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

#### Property Value

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

## See Also

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


## Related topics

- [SuperOffice.WebApi.Agents.IListAgent](/en/api/reference/webapi/SuperOffice.WebApi.Agents.IListAgent.md)
- [SuperOffice.WebApi.Agents.ListAgent](/en/api/reference/webapi/SuperOffice.WebApi.Agents.ListAgent.md)
- [SuperOffice.WebApi.Data.List SaveHeadingFromNameRequest](/en/api/reference/webapi/SuperOffice.WebApi.Data.List_SaveHeadingFromNameRequest.md)
- [SuperOffice.WebApi.Data.List SaveHeadingsFromNameRequest](/en/api/reference/webapi/SuperOffice.WebApi.Data.List_SaveHeadingsFromNameRequest.md)
- [SuperOffice.WebApi.Data.List SaveHeadingFromListDefinitionRequest](/en/api/reference/webapi/SuperOffice.WebApi.Data.List_SaveHeadingFromListDefinitionRequest.md)
- [SuperOffice.WebApi.Data.List SaveHeadingsFromListDefinitionRequest](/en/api/reference/webapi/SuperOffice.WebApi.Data.List_SaveHeadingsFromListDefinitionRequest.md)