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

# <a id="SuperOffice_WebApi_Data_ListEntity" /> Class ListEntity

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

Carrier object for ListEntity.
The list entity contains information about a specific list

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

#### Inheritance

[object](https://learn.microsoft.com/dotnet/api/system.object) ←
[Carrier](SuperOffice.WebApi.Data.Carrier.md) ←
[ListEntity](SuperOffice.WebApi.Data.ListEntity.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 ListEntity 123 using the WebApi client:
<pre><code class="lang-csharp">var configuration = new WebApiConfiguration(url);
var agent = new ListAgent(configuration);
var listEntity = agent.GetListEntity( 123 );</code></pre>

## Constructors

### <a id="SuperOffice_WebApi_Data_ListEntity__ctor" /> ListEntity()

Default constructor - defaults any enum props to 0.

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

## Properties

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

True if the list item 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_ListEntity_Id" /> Id

The identity of the list

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

#### Property Value

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

### <a id="SuperOffice_WebApi_Data_ListEntity_InUseByUserDefinedFields" /> InUseByUserDefinedFields

True if this in use by one or more udfields

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

#### Property Value

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

### <a id="SuperOffice_WebApi_Data_ListEntity_IsCustomList" /> IsCustomList

Indicates if this is a custom list or a standard list

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

#### Property Value

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

### <a id="SuperOffice_WebApi_Data_ListEntity_IsMDOList" /> IsMDOList

Indicates if this is a MDO list

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

#### Property Value

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

### <a id="SuperOffice_WebApi_Data_ListEntity_ListType" /> ListType

The type of this list, often indicated by the database name, but not necessarily

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

#### Property Value

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

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

The name of the list

```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_ListEntity_Rank" /> Rank

The rank of the list

```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_ListEntity_Tooltip" /> Tooltip

The tooltip of the list

```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_ListEntity_UseGroupsAndHeadings" /> UseGroupsAndHeadings

Indicates if this list should use groups and headings

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

#### Property Value

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

## See Also

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


## Related topics

- [SuperOffice.WebApi.Agents.ListAgent](/en/api/reference/webapi/SuperOffice.WebApi.Agents.ListAgent.md)
- [SuperOffice.WebApi.Agents.IListAgent](/en/api/reference/webapi/SuperOffice.WebApi.Agents.IListAgent.md)
- [SuperOffice.WebApi.Data.List SaveListEntityByNameRequest](/en/api/reference/webapi/SuperOffice.WebApi.Data.List_SaveListEntityByNameRequest.md)
- [SuperOffice.WebApi.Data.Carrier](/en/api/reference/webapi/SuperOffice.WebApi.Data.Carrier.md)
- [SuperOffice.WebApi.Data.ListItemEntity](/en/api/reference/webapi/SuperOffice.WebApi.Data.ListItemEntity.md)
- [SuperOffice.WebApi.Data.List GetListEntityByNameRequest](/en/api/reference/webapi/SuperOffice.WebApi.Data.List_GetListEntityByNameRequest.md)