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

# NSWebPanelEntity

> Contains information on a web panel.

Contains information on a web panel.

## Constructors

### NSWebPanelEntity()

```crmscript theme={null}
NSWebPanelEntity
```

Initializes a new instance of the NSWebPanelEntity class.

## Methods

## GetDeleted()

```crmscript theme={null}
Bool GetDeleted()
```

**Returns:** [CRMScript.Global.Bool](CRMScript.Global.Bool) - True if the web panel is marked as deleted.

**Example:**

```crmscript theme={null}
NSWebPanelEntity thing;
Bool deleted = thing.GetDeleted();
```

## GetIcon()

```crmscript theme={null}
Integer GetIcon()
```

**Returns:** [CRMScript.Global.Integer](CRMScript.Global.Integer) - The icon of the web panel.

**Example:**

```crmscript theme={null}
NSWebPanelEntity thing;
Integer icon = thing.GetIcon();
```

## GetName()

```crmscript theme={null}
String GetName()
```

**Returns:** [CRMScript.Global.String](CRMScript.Global.String) - The name of the web panel.

**Example:**

```crmscript theme={null}
NSWebPanelEntity thing;
String name = thing.GetName();
```

## GetOnCentral()

```crmscript theme={null}
Bool GetOnCentral()
```

**Returns:** [CRMScript.Global.Bool](CRMScript.Global.Bool) - Is the web panel visible when user is on central database.

**Example:**

```crmscript theme={null}
NSWebPanelEntity thing;
Bool onCentral = thing.GetOnCentral();
```

## GetOnSalesMarketingPocket()

```crmscript theme={null}
Bool GetOnSalesMarketingPocket()
```

**Returns:** [CRMScript.Global.Bool](CRMScript.Global.Bool) - Is the web panel visible when user is on pocket client.

**Example:**

```crmscript theme={null}
NSWebPanelEntity thing;
Bool onSalesMarketingPocket = thing.GetOnSalesMarketingPocket();
```

## GetOnSalesMarketingWeb()

```crmscript theme={null}
Bool GetOnSalesMarketingWeb()
```

**Returns:** [CRMScript.Global.Bool](CRMScript.Global.Bool) - Is the web panel visible when user is on web client.

**Example:**

```crmscript theme={null}
NSWebPanelEntity thing;
Bool onSalesMarketingWeb = thing.GetOnSalesMarketingWeb();
```

## GetOnSatellite()

```crmscript theme={null}
Bool GetOnSatellite()
```

**Returns:** [CRMScript.Global.Bool](CRMScript.Global.Bool) - Is the web panel visible when user is on a satellite.

**Example:**

```crmscript theme={null}
NSWebPanelEntity thing;
Bool onSatellite = thing.GetOnSatellite();
```

## GetOnSattelite()

```crmscript theme={null}
Bool GetOnSattelite()
```

**Returns:** [CRMScript.Global.Bool](CRMScript.Global.Bool)

## GetOnTravel()

```crmscript theme={null}
Bool GetOnTravel()
```

**Returns:** [CRMScript.Global.Bool](CRMScript.Global.Bool) - Is the web panel visible when user is on travel.

**Example:**

```crmscript theme={null}
NSWebPanelEntity thing;
Bool onTravel = thing.GetOnTravel();
```

## GetProgId()

```crmscript theme={null}
String GetProgId()
```

**Returns:** [CRMScript.Global.String](CRMScript.Global.String) - String key that can be used to uniquely retrieve the panel; particularly useful for partners and others who do not wish to store database IDs.

**Example:**

```crmscript theme={null}
NSWebPanelEntity thing;
String progId = thing.GetProgId();
```

## GetRank()

```crmscript theme={null}
Integer GetRank()
```

**Returns:** [CRMScript.Global.Integer](CRMScript.Global.Integer) - The rank of the web panel.

**Example:**

```crmscript theme={null}
NSWebPanelEntity thing;
Integer rank = thing.GetRank();
```

## GetShowInAddressBar()

```crmscript theme={null}
Bool GetShowInAddressBar()
```

**Returns:** [CRMScript.Global.Bool](CRMScript.Global.Bool) - Does the web panel have an address bar.

**Example:**

```crmscript theme={null}
NSWebPanelEntity thing;
Bool showInAddressBar = thing.GetShowInAddressBar();
```

## GetShowInMenuBar()

```crmscript theme={null}
Bool GetShowInMenuBar()
```

**Returns:** [CRMScript.Global.Bool](CRMScript.Global.Bool) - Does the web panel have a menu bar.

**Example:**

```crmscript theme={null}
NSWebPanelEntity thing;
Bool showInMenuBar = thing.GetShowInMenuBar();
```

## GetShowInStatusBar()

```crmscript theme={null}
Bool GetShowInStatusBar()
```

**Returns:** [CRMScript.Global.Bool](CRMScript.Global.Bool) - Does the web panel have a status bar.

**Example:**

```crmscript theme={null}
NSWebPanelEntity thing;
Bool showInStatusBar = thing.GetShowInStatusBar();
```

## GetShowInToolBar()

```crmscript theme={null}
Bool GetShowInToolBar()
```

**Returns:** [CRMScript.Global.Bool](CRMScript.Global.Bool) - Does the web panel have a toolbar.

**Example:**

```crmscript theme={null}
NSWebPanelEntity thing;
Bool showInToolBar = thing.GetShowInToolBar();
```

## GetTooltip()

```crmscript theme={null}
String GetTooltip()
```

**Returns:** [CRMScript.Global.String](CRMScript.Global.String) - The tooltip of the web panel.

**Example:**

```crmscript theme={null}
NSWebPanelEntity thing;
String tooltip = thing.GetTooltip();
```

## GetUrl()

```crmscript theme={null}
String GetUrl()
```

**Returns:** [CRMScript.Global.String](CRMScript.Global.String) - The URl.

**Example:**

```crmscript theme={null}
NSWebPanelEntity thing;
String url = thing.GetUrl();
```

## GetUrlEncoding()

```crmscript theme={null}
Integer GetUrlEncoding()
```

**Returns:** [CRMScript.Global.Integer](CRMScript.Global.Integer) - The encoding of the URL. See \<xref href="CRMScript.NetServer.UrlEncoding" data-throw-if-not-resolved="false">\</xref>.

**Example:**

```crmscript theme={null}
NSWebPanelEntity thing;
Integer urlEncoding = thing.GetUrlEncoding();
```

## GetVisibleIn()

```crmscript theme={null}
Integer GetVisibleIn()
```

**Returns:** [CRMScript.Global.Integer](CRMScript.Global.Integer) - The web panel is visible in.

**Example:**

```crmscript theme={null}
NSWebPanelEntity thing;
Integer visibleIn = thing.GetVisibleIn();
```

## GetWebPanelId()

```crmscript theme={null}
Integer GetWebPanelId()
```

**Returns:** [CRMScript.Global.Integer](CRMScript.Global.Integer) - The identity of the web panel.

**Example:**

```crmscript theme={null}
NSWebPanelEntity thing;
Integer webPanelId = thing.GetWebPanelId();
```

## GetWindowName()

```crmscript theme={null}
String GetWindowName()
```

**Returns:** [CRMScript.Global.String](CRMScript.Global.String) - The window which the URL address is to open in (web panel only).

**Example:**

```crmscript theme={null}
NSWebPanelEntity thing;
String windowName = thing.GetWindowName();
```

## SetDeleted(Bool)

```crmscript theme={null}
Void SetDeleted(Bool deleted)
```

**Returns:** [CRMScript.Global.Void](CRMScript.Global.Void)

**Example:**

```crmscript theme={null}
NSWebPanelEntity thing;
Bool deleted;
thing.SetDeleted(deleted);
```

## SetIcon(Integer)

```crmscript theme={null}
Void SetIcon(Integer icon)
```

**Returns:** [CRMScript.Global.Void](CRMScript.Global.Void)

**Example:**

```crmscript theme={null}
NSWebPanelEntity thing;
Integer icon;
thing.SetIcon(icon);
```

## SetName(String)

```crmscript theme={null}
Void SetName(String name)
```

**Returns:** [CRMScript.Global.Void](CRMScript.Global.Void)

**Example:**

```crmscript theme={null}
NSWebPanelEntity thing;
String name;
thing.SetName(name);
```

## SetOnCentral(Bool)

```crmscript theme={null}
Void SetOnCentral(Bool onCentral)
```

**Returns:** [CRMScript.Global.Void](CRMScript.Global.Void)

**Example:**

```crmscript theme={null}
NSWebPanelEntity thing;
Bool onCentral;
thing.SetOnCentral(onCentral);
```

## SetOnSalesMarketingPocket(Bool)

```crmscript theme={null}
Void SetOnSalesMarketingPocket(Bool onSalesMarketingPocket)
```

**Returns:** [CRMScript.Global.Void](CRMScript.Global.Void)

**Example:**

```crmscript theme={null}
NSWebPanelEntity thing;
Bool onSalesMarketingPocket;
thing.SetOnSalesMarketingPocket(onSalesMarketingPocket);
```

## SetOnSalesMarketingWeb(Bool)

```crmscript theme={null}
Void SetOnSalesMarketingWeb(Bool onSalesMarketingWeb)
```

**Returns:** [CRMScript.Global.Void](CRMScript.Global.Void)

**Example:**

```crmscript theme={null}
NSWebPanelEntity thing;
Bool onSalesMarketingWeb;
thing.SetOnSalesMarketingWeb(onSalesMarketingWeb);
```

## SetOnSatellite(Bool)

```crmscript theme={null}
Void SetOnSatellite(Bool onSatellite)
```

**Returns:** [CRMScript.Global.Void](CRMScript.Global.Void)

**Example:**

```crmscript theme={null}
NSWebPanelEntity thing;
Bool onSatellite;
thing.SetOnSatellite(onSatellite);
```

## SetOnSattelite(Bool)

```crmscript theme={null}
Void SetOnSattelite(Bool onSattelite)
```

**Returns:** [CRMScript.Global.Void](CRMScript.Global.Void)

## SetOnTravel(Bool)

```crmscript theme={null}
Void SetOnTravel(Bool onTravel)
```

**Returns:** [CRMScript.Global.Void](CRMScript.Global.Void)

**Example:**

```crmscript theme={null}
NSWebPanelEntity thing;
Bool onTravel;
thing.SetOnTravel(onTravel);
```

## SetProgId(String)

```crmscript theme={null}
Void SetProgId(String progId)
```

**Returns:** [CRMScript.Global.Void](CRMScript.Global.Void)

**Example:**

```crmscript theme={null}
NSWebPanelEntity thing;
String progId;
thing.SetProgId(progId);
```

## SetRank(Integer)

```crmscript theme={null}
Void SetRank(Integer rank)
```

**Returns:** [CRMScript.Global.Void](CRMScript.Global.Void)

**Example:**

```crmscript theme={null}
NSWebPanelEntity thing;
Integer rank;
thing.SetRank(rank);
```

## SetShowInAddressBar(Bool)

```crmscript theme={null}
Void SetShowInAddressBar(Bool showInAddressBar)
```

**Returns:** [CRMScript.Global.Void](CRMScript.Global.Void)

**Example:**

```crmscript theme={null}
NSWebPanelEntity thing;
Bool showInAddressBar;
thing.SetShowInAddressBar(showInAddressBar);
```

## SetShowInMenuBar(Bool)

```crmscript theme={null}
Void SetShowInMenuBar(Bool showInMenuBar)
```

**Returns:** [CRMScript.Global.Void](CRMScript.Global.Void)

**Example:**

```crmscript theme={null}
NSWebPanelEntity thing;
Bool showInMenuBar;
thing.SetShowInMenuBar(showInMenuBar);
```

## SetShowInStatusBar(Bool)

```crmscript theme={null}
Void SetShowInStatusBar(Bool showInStatusBar)
```

**Returns:** [CRMScript.Global.Void](CRMScript.Global.Void)

**Example:**

```crmscript theme={null}
NSWebPanelEntity thing;
Bool showInStatusBar;
thing.SetShowInStatusBar(showInStatusBar);
```

## SetShowInToolBar(Bool)

```crmscript theme={null}
Void SetShowInToolBar(Bool showInToolBar)
```

**Returns:** [CRMScript.Global.Void](CRMScript.Global.Void)

**Example:**

```crmscript theme={null}
NSWebPanelEntity thing;
Bool showInToolBar;
thing.SetShowInToolBar(showInToolBar);
```

## SetTooltip(String)

```crmscript theme={null}
Void SetTooltip(String tooltip)
```

**Returns:** [CRMScript.Global.Void](CRMScript.Global.Void)

**Example:**

```crmscript theme={null}
NSWebPanelEntity thing;
String tooltip;
thing.SetTooltip(tooltip);
```

## SetUrl(String)

```crmscript theme={null}
Void SetUrl(String url)
```

**Returns:** [CRMScript.Global.Void](CRMScript.Global.Void)

**Example:**

```crmscript theme={null}
NSWebPanelEntity thing;
String url;
thing.SetUrl(url);
```

## SetUrlEncoding(Integer)

```crmscript theme={null}
Void SetUrlEncoding(Integer urlEncoding)
```

**Returns:** [CRMScript.Global.Void](CRMScript.Global.Void)

**Example:**

```crmscript theme={null}
NSWebPanelEntity thing;
Integer urlEncoding;
thing.SetUrlEncoding(urlEncoding);
```

## SetVisibleIn(Integer)

```crmscript theme={null}
Void SetVisibleIn(Integer visibleIn)
```

**Returns:** [CRMScript.Global.Void](CRMScript.Global.Void)

**Example:**

```crmscript theme={null}
NSWebPanelEntity thing;
Integer visibleIn;
thing.SetVisibleIn(visibleIn);
```

## SetWebPanelId(Integer)

```crmscript theme={null}
Void SetWebPanelId(Integer webPanelId)
```

**Returns:** [CRMScript.Global.Void](CRMScript.Global.Void)

**Example:**

```crmscript theme={null}
NSWebPanelEntity thing;
Integer webPanelId;
thing.SetWebPanelId(webPanelId);
```

## SetWindowName(String)

```crmscript theme={null}
Void SetWindowName(String windowName)
```

**Returns:** [CRMScript.Global.Void](CRMScript.Global.Void)

**Example:**

```crmscript theme={null}
NSWebPanelEntity thing;
String windowName;
thing.SetWindowName(windowName);
```


## Related topics

- [NSListAgent](/en/automation/crmscript/reference/CRMScript.NetServer.NSListAgent.md)
- [NSPocketStartupData](/en/automation/crmscript/reference/CRMScript.NetServer.NSPocketStartupData.md)
- [Put Web Panel Entity](/en/api/reference/restful/rest/list_webpanel/put-web-panel-entity.md)
- [Get Web Panel Entity](/en/api/reference/restful/rest/list_webpanel/get-web-panel-entity.md)
- [Delete Web Panel Entity](/en/api/reference/restful/rest/list_webpanel/delete-web-panel-entity.md)
- [Post Web Panel Entity](/en/api/reference/restful/rest/list_webpanel/post-web-panel-entity.md)