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

# <a id="SuperOffice_WebApi_Data_WebPanelEntity" /> Class WebPanelEntity

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

Carrier object for WebPanelEntity.
The web panel entity contains information on a web panel

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

#### Inheritance

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

## Constructors

### <a id="SuperOffice_WebApi_Data_WebPanelEntity__ctor" /> WebPanelEntity()

Default constructor - defaults any enum props to 0.

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

## Properties

### <a id="SuperOffice_WebApi_Data_WebPanelEntity_AlwaysReloadOnShow" /> AlwaysReloadOnShow

If set to true, the content will reload every time the panel is shown

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

#### Property Value

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

### <a id="SuperOffice_WebApi_Data_WebPanelEntity_CustomObjectEntity" /> CustomObjectEntity

The name of the custom object when VisibleIn is set to custom object

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

#### Property Value

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

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

True if the web panel 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_WebPanelEntity_Icon" /> Icon

The icon of the webpanel

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

#### Property Value

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

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

The name of the web panel

```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_WebPanelEntity_NeverReloadOnCurrentChange" /> NeverReloadOnCurrentChange

If set to true, the content will not reload on current changes, only applies to sidepanels

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

#### Property Value

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

### <a id="SuperOffice_WebApi_Data_WebPanelEntity_OnCentral" /> OnCentral

Is the webpanel visible when user is on central database

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

#### Property Value

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

### <a id="SuperOffice_WebApi_Data_WebPanelEntity_OnSalesMarketingPocket" /> OnSalesMarketingPocket

Is the webpanel visible when user is on pocket client

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

#### Property Value

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

### <a id="SuperOffice_WebApi_Data_WebPanelEntity_OnSalesMarketingWeb" /> OnSalesMarketingWeb

Is the webpanel visible when user is on web client

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

#### Property Value

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

### <a id="SuperOffice_WebApi_Data_WebPanelEntity_OnSatellite" /> OnSatellite

Is the webpanel visible when user is on a satellite

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

#### Property Value

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

### <a id="SuperOffice_WebApi_Data_WebPanelEntity_OnTravel" /> OnTravel

Is the webpanel visible when user is on travel

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

#### Property Value

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

### <a id="SuperOffice_WebApi_Data_WebPanelEntity_ProgId" /> ProgId

String key that can be used to uniquely retrieve the panel; particularly useful for partners and others who do not wish to store database ID's

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

#### Property Value

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

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

The rank of the web panel

```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_WebPanelEntity_ShowInAddressBar" /> ShowInAddressBar

Does the webpanel have an address bar

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

#### Property Value

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

### <a id="SuperOffice_WebApi_Data_WebPanelEntity_ShowInMenuBar" /> ShowInMenuBar

Does the webpanel have a menu bar

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

#### Property Value

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

### <a id="SuperOffice_WebApi_Data_WebPanelEntity_ShowInStatusBar" /> ShowInStatusBar

Does the webpanel have a status bar

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

#### Property Value

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

### <a id="SuperOffice_WebApi_Data_WebPanelEntity_ShowInToolBar" /> ShowInToolBar

Does the webpanel have a toolbar

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

#### Property Value

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

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

The tooltip of the web panel

```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_WebPanelEntity_Url" /> Url

The url

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

#### Property Value

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

### <a id="SuperOffice_WebApi_Data_WebPanelEntity_UrlEncoding" /> UrlEncoding

The encoding of the URL
NULL if unknown enum value.

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

#### Property Value

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

#### See Also

[WebPanelEntity](SuperOffice.WebApi.Data.WebPanelEntity.md).[UrlEncoding\_String](SuperOffice.WebApi.Data.WebPanelEntity.md#SuperOffice_WebApi_Data_WebPanelEntity_UrlEncoding_String)

### <a id="SuperOffice_WebApi_Data_WebPanelEntity_UrlEncoding_String" /> UrlEncoding\_String

The encoding of the URL
Raw string enum value.

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

#### Property Value

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

#### See Also

[WebPanelEntity](SuperOffice.WebApi.Data.WebPanelEntity.md).[UrlEncoding](SuperOffice.WebApi.Data.WebPanelEntity.md#SuperOffice_WebApi_Data_WebPanelEntity_UrlEncoding)

### <a id="SuperOffice_WebApi_Data_WebPanelEntity_VisibleIn" /> VisibleIn

The webpanel is visible in
NULL if unknown enum value.

```csharp theme={null}
[JsonIgnore]
public Navigation? VisibleIn { get; set; }
```

#### Property Value

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

#### See Also

[WebPanelEntity](SuperOffice.WebApi.Data.WebPanelEntity.md).[VisibleIn\_String](SuperOffice.WebApi.Data.WebPanelEntity.md#SuperOffice_WebApi_Data_WebPanelEntity_VisibleIn_String)

### <a id="SuperOffice_WebApi_Data_WebPanelEntity_VisibleIn_String" /> VisibleIn\_String

The webpanel is visible in
Raw string enum value.

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

#### Property Value

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

#### See Also

[WebPanelEntity](SuperOffice.WebApi.Data.WebPanelEntity.md).[VisibleIn](SuperOffice.WebApi.Data.WebPanelEntity.md#SuperOffice_WebApi_Data_WebPanelEntity_VisibleIn)

### <a id="SuperOffice_WebApi_Data_WebPanelEntity_WebPanelId" /> WebPanelId

The identity of the web panel

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

#### Property Value

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

### <a id="SuperOffice_WebApi_Data_WebPanelEntity_WindowName" /> WindowName

The window which the URL address is to open in (webpanel only)

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

#### Property Value

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

## 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.PocketStartupData](/en/api/reference/webapi/SuperOffice.WebApi.Data.PocketStartupData.md)
- [SuperOffice.WebApi.Data.ExtAppEntity](/en/api/reference/webapi/SuperOffice.WebApi.Data.ExtAppEntity.md)
- [SuperOffice.WebApi.Data.DashboardTileEntityType](/en/api/reference/webapi/SuperOffice.WebApi.Data.DashboardTileEntityType.md)
- [SuperOffice.WebApi.Data.List DeleteWebPanelRequest](/en/api/reference/webapi/SuperOffice.WebApi.Data.List_DeleteWebPanelRequest.md)