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

# <a id="SuperOffice_WebApi_Data_Dash" /> Class Dash

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

Carrier object for Dash.
Dashboard configuration

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

#### Inheritance

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

## Constructors

### <a id="SuperOffice_WebApi_Data_Dash__ctor" /> Dash()

Default constructor - defaults any enum props to 0.

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

## Properties

### <a id="SuperOffice_WebApi_Data_Dash_AssociateId" /> AssociateId

Associate who owns this dashboard

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

#### Property Value

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

### <a id="SuperOffice_WebApi_Data_Dash_Columns" /> Columns

How many columns there will be in the dashboard.

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

#### Property Value

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

### <a id="SuperOffice_WebApi_Data_Dash_DashboardId" /> DashboardId

Primary key

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

#### Property Value

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

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

Detailed description

```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_Dash_Name" /> Name

The name of this dashboard

```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_Dash_PinForAll" /> PinForAll

True if pinned for all

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

#### Property Value

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

### <a id="SuperOffice_WebApi_Data_Dash_PinForAssociates" /> PinForAssociates

Array of references to the pinned associates

```csharp theme={null}
public virtual int[] PinForAssociates { get; set; }
```

#### Property Value

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

### <a id="SuperOffice_WebApi_Data_Dash_PinForGroups" /> PinForGroups

Array of references to the pinned groups

```csharp theme={null}
public virtual int[] PinForGroups { get; set; }
```

#### Property Value

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

### <a id="SuperOffice_WebApi_Data_Dash_Theme" /> Theme

The theme for this dashboard

```csharp theme={null}
public virtual DashTheme Theme { get; set; }
```

#### Property Value

[DashTheme](SuperOffice.WebApi.Data.DashTheme.md)

### <a id="SuperOffice_WebApi_Data_Dash_UniqueId" /> UniqueId

GUID identifying a default dashboard from SuperOffice

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

#### Property Value

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

### <a id="SuperOffice_WebApi_Data_Dash_VisibleForAll" /> VisibleForAll

True if visible for all

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

#### Property Value

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

### <a id="SuperOffice_WebApi_Data_Dash_VisibleForAssociates" /> VisibleForAssociates

Array of references to the visible for associates

```csharp theme={null}
public virtual int[] VisibleForAssociates { get; set; }
```

#### Property Value

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

### <a id="SuperOffice_WebApi_Data_Dash_VisibleForGroups" /> VisibleForGroups

Array of references to the visible for groups

```csharp theme={null}
public virtual int[] VisibleForGroups { get; set; }
```

#### Property Value

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

## See Also

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


## Related topics

- [SuperOffice.WebApi.Data.Dash GetDashCollectionRequest](/en/api/reference/webapi/SuperOffice.WebApi.Data.Dash_GetDashCollectionRequest.md)
- [SuperOffice.WebApi.Data.Dash GetDashListRequest](/en/api/reference/webapi/SuperOffice.WebApi.Data.Dash_GetDashListRequest.md)
- [SuperOffice.WebApi.Data.Dash GetDashTilesRequest](/en/api/reference/webapi/SuperOffice.WebApi.Data.Dash_GetDashTilesRequest.md)
- [SuperOffice.WebApi.Data.Dash GetPreviewDashRequest](/en/api/reference/webapi/SuperOffice.WebApi.Data.Dash_GetPreviewDashRequest.md)
- [SuperOffice.WebApi.Data.Dash SaveDashTilesRequest](/en/api/reference/webapi/SuperOffice.WebApi.Data.Dash_SaveDashTilesRequest.md)
- [SuperOffice.WebApi.Data.Dash GetDashQuickFiltersRequest](/en/api/reference/webapi/SuperOffice.WebApi.Data.Dash_GetDashQuickFiltersRequest.md)