Class NSWebPanelEntity

Contains information on a web panel.

Syntax

Constructors

NSWebPanelEntity()

Initializes a new instance of the NSWebPanelEntity class.

Introduced or updated in version: 7.5

Declaration

NSWebPanelEntity

Methods

GetDeleted()

Introduced or updated in version: 7.5

Declaration

Bool GetDeleted()

Returns

Type	Description
Bool	True if the web panel is marked as deleted.

Examples

NSWebPanelEntity thing;
Bool deleted = thing.GetDeleted();

GetIcon()

Introduced or updated in version: 8.0sr3

Declaration

Integer GetIcon()

Returns

Type	Description
Integer	The icon of the web panel.

Examples

NSWebPanelEntity thing;
Integer icon = thing.GetIcon();

GetName()

Introduced or updated in version: 7.5

Declaration

String GetName()

Returns

Type	Description
String	The name of the web panel.

Examples

NSWebPanelEntity thing;
String name = thing.GetName();

GetOnCentral()

Introduced or updated in version: 7.5

Declaration

Bool GetOnCentral()

Returns

Type	Description
Bool	Is the web panel visible when user is on central database.

Examples

NSWebPanelEntity thing;
Bool onCentral = thing.GetOnCentral();

GetOnSalesMarketingPocket()

Introduced or updated in version: 8.0sr3

Declaration

Bool GetOnSalesMarketingPocket()

Returns

Type	Description
Bool	Is the web panel visible when user is on pocket client.

Examples

NSWebPanelEntity thing;
Bool onSalesMarketingPocket = thing.GetOnSalesMarketingPocket();

GetOnSalesMarketingWeb()

Introduced or updated in version: 7.5

Declaration

Bool GetOnSalesMarketingWeb()

Returns

Type	Description
Bool	Is the web panel visible when user is on web client.

Examples

NSWebPanelEntity thing;
Bool onSalesMarketingWeb = thing.GetOnSalesMarketingWeb();

GetOnSatellite()

Introduced or updated in version: 8.0sr3

Declaration

Bool GetOnSatellite()

Returns

Type	Description
Bool	Is the web panel visible when user is on a satellite.

Examples

NSWebPanelEntity thing;
Bool onSatellite = thing.GetOnSatellite();

GetOnSattelite()

Introduced or updated in version: 7.5

Declaration

Bool GetOnSattelite()

Returns

Type	Description
Bool

GetOnTravel()

Introduced or updated in version: 7.5

Declaration

Bool GetOnTravel()

Returns

Type	Description
Bool	Is the web panel visible when user is on travel.

Examples

NSWebPanelEntity thing;
Bool onTravel = thing.GetOnTravel();

GetProgId()

Introduced or updated in version: 8.0sr3

Declaration

String GetProgId()

Returns

Type	Description
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.

Examples

NSWebPanelEntity thing;
String progId = thing.GetProgId();

GetRank()

Introduced or updated in version: 7.5

Declaration

Integer GetRank()

Returns

Type	Description
Integer	The rank of the web panel.

Examples

NSWebPanelEntity thing;
Integer rank = thing.GetRank();

GetShowInAddressBar()

Introduced or updated in version: 7.5

Declaration

Bool GetShowInAddressBar()

Returns

Type	Description
Bool	Does the web panel have an address bar.

Examples

NSWebPanelEntity thing;
Bool showInAddressBar = thing.GetShowInAddressBar();

GetShowInMenuBar()

Introduced or updated in version: 7.5

Declaration

Bool GetShowInMenuBar()

Returns

Type	Description
Bool	Does the web panel have a menu bar.

Examples

NSWebPanelEntity thing;
Bool showInMenuBar = thing.GetShowInMenuBar();

GetShowInStatusBar()

Introduced or updated in version: 7.5

Declaration

Bool GetShowInStatusBar()

Returns

Type	Description
Bool	Does the web panel have a status bar.

Examples

NSWebPanelEntity thing;
Bool showInStatusBar = thing.GetShowInStatusBar();

GetShowInToolBar()

Introduced or updated in version: 7.5

Declaration

Bool GetShowInToolBar()

Returns

Type	Description
Bool	Does the web panel have a toolbar.

Examples

NSWebPanelEntity thing;
Bool showInToolBar = thing.GetShowInToolBar();

GetTooltip()

Introduced or updated in version: 7.5

Declaration

String GetTooltip()

Returns

Type	Description
String	The tooltip of the web panel.

Examples

NSWebPanelEntity thing;
String tooltip = thing.GetTooltip();

GetUrl()

Introduced or updated in version: 7.5

Declaration

String GetUrl()

Returns

Type	Description
String	The URl.

Examples

NSWebPanelEntity thing;
String url = thing.GetUrl();

GetUrlEncoding()

Introduced or updated in version: 7.5

Declaration

Integer GetUrlEncoding()

Returns

Type	Description
Integer	The encoding of the URL. See UrlEncoding.

Examples

NSWebPanelEntity thing;
Integer urlEncoding = thing.GetUrlEncoding();

GetVisibleIn()

Introduced or updated in version: 7.5

Declaration

Integer GetVisibleIn()

Returns

Type	Description
Integer	The web panel is visible in.

Examples

NSWebPanelEntity thing;
Integer visibleIn = thing.GetVisibleIn();

GetWebPanelId()

Introduced or updated in version: 7.5

Declaration

Integer GetWebPanelId()

Returns

Type	Description
Integer	The identity of the web panel.

Examples

NSWebPanelEntity thing;
Integer webPanelId = thing.GetWebPanelId();

GetWindowName()

Introduced or updated in version: 7.5

Declaration

String GetWindowName()

Returns

Type	Description
String	The window which the URL address is to open in (web panel only).

Examples

NSWebPanelEntity thing;
String windowName = thing.GetWindowName();

SetDeleted(Bool)

Introduced or updated in version: 7.5

Declaration

Void SetDeleted(Bool deleted)

Parameters

Type	Name	Description
Bool	deleted	True if the web panel is marked as deleted.

Returns

Type	Description
Void

Examples

NSWebPanelEntity thing;
Bool deleted;
thing.SetDeleted(deleted);

SetIcon(Integer)

Introduced or updated in version: 8.0sr3

Declaration

Void SetIcon(Integer icon)

Parameters

Type	Name	Description
Integer	icon	The icon of the web panel.

Returns

Type	Description
Void

Examples

NSWebPanelEntity thing;
Integer icon;
thing.SetIcon(icon);

SetName(String)

Introduced or updated in version: 7.5

Declaration

Void SetName(String name)

Parameters

Type	Name	Description
String	name	The name of the web panel.

Returns

Type	Description
Void

Examples

NSWebPanelEntity thing;
String name;
thing.SetName(name);

SetOnCentral(Bool)

Introduced or updated in version: 7.5

Declaration

Void SetOnCentral(Bool onCentral)

Parameters

Type	Name	Description
Bool	onCentral	Is the web panel visible when user is on central database.

Returns

Type	Description
Void

Examples

NSWebPanelEntity thing;
Bool onCentral;
thing.SetOnCentral(onCentral);

SetOnSalesMarketingPocket(Bool)

Introduced or updated in version: 8.0sr3

Declaration

Void SetOnSalesMarketingPocket(Bool onSalesMarketingPocket)

Parameters

Type	Name	Description
Bool	onSalesMarketingPocket	Is the web panel visible when user is on pocket client.

Returns

Type	Description
Void

Examples

NSWebPanelEntity thing;
Bool onSalesMarketingPocket;
thing.SetOnSalesMarketingPocket(onSalesMarketingPocket);

SetOnSalesMarketingWeb(Bool)

Introduced or updated in version: 7.5

Declaration

Void SetOnSalesMarketingWeb(Bool onSalesMarketingWeb)

Parameters

Type	Name	Description
Bool	onSalesMarketingWeb	Is the web panel visible when user is on web client.

Returns

Type	Description
Void

Examples

NSWebPanelEntity thing;
Bool onSalesMarketingWeb;
thing.SetOnSalesMarketingWeb(onSalesMarketingWeb);

SetOnSatellite(Bool)

Introduced or updated in version: 8.0sr3

Declaration

Void SetOnSatellite(Bool onSatellite)

Parameters

Type	Name	Description
Bool	onSatellite	Is the web panel visible when user is on a satellite.

Returns

Type	Description
Void

Examples

NSWebPanelEntity thing;
Bool onSatellite;
thing.SetOnSatellite(onSatellite);

SetOnSattelite(Bool)

Introduced or updated in version: 7.5

Declaration

Void SetOnSattelite(Bool onSattelite)

Parameters

Type	Name	Description
Bool	onSattelite

Returns

Type	Description
Void

SetOnTravel(Bool)

Introduced or updated in version: 7.5

Declaration

Void SetOnTravel(Bool onTravel)

Parameters

Type	Name	Description
Bool	onTravel	Is the web panel visible when user is on travel.

Returns

Type	Description
Void

Examples

NSWebPanelEntity thing;
Bool onTravel;
thing.SetOnTravel(onTravel);

SetProgId(String)

Introduced or updated in version: 8.0sr3

Declaration

Void SetProgId(String progId)

Parameters

Type	Name	Description
String	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 IDs.

Returns

Type	Description
Void

Examples

NSWebPanelEntity thing;
String progId;
thing.SetProgId(progId);

SetRank(Integer)

Introduced or updated in version: 7.5

Declaration

Void SetRank(Integer rank)

Parameters

Type	Name	Description
Integer	rank	The rank of the web panel.

Returns

Type	Description
Void

Examples

NSWebPanelEntity thing;
Integer rank;
thing.SetRank(rank);

SetShowInAddressBar(Bool)

Introduced or updated in version: 7.5

Declaration

Void SetShowInAddressBar(Bool showInAddressBar)

Parameters

Type	Name	Description
Bool	showInAddressBar	Does the web panel have an address bar.

Returns

Type	Description
Void

Examples

NSWebPanelEntity thing;
Bool showInAddressBar;
thing.SetShowInAddressBar(showInAddressBar);

SetShowInMenuBar(Bool)

Introduced or updated in version: 7.5

Declaration

Void SetShowInMenuBar(Bool showInMenuBar)

Parameters

Type	Name	Description
Bool	showInMenuBar	Does the web panel have a menu bar.

Returns

Type	Description
Void

Examples

NSWebPanelEntity thing;
Bool showInMenuBar;
thing.SetShowInMenuBar(showInMenuBar);

SetShowInStatusBar(Bool)

Introduced or updated in version: 7.5

Declaration

Void SetShowInStatusBar(Bool showInStatusBar)

Parameters

Type	Name	Description
Bool	showInStatusBar	Does the web panel have a status bar.

Returns

Type	Description
Void

Examples

NSWebPanelEntity thing;
Bool showInStatusBar;
thing.SetShowInStatusBar(showInStatusBar);

SetShowInToolBar(Bool)

Introduced or updated in version: 7.5

Declaration

Void SetShowInToolBar(Bool showInToolBar)

Parameters

Type	Name	Description
Bool	showInToolBar	Does the web panel have a toolbar.

Returns

Type	Description
Void

Examples

NSWebPanelEntity thing;
Bool showInToolBar;
thing.SetShowInToolBar(showInToolBar);

SetTooltip(String)

Introduced or updated in version: 7.5

Declaration

Void SetTooltip(String tooltip)

Parameters

Type	Name	Description
String	tooltip	The tooltip of the web panel.

Returns

Type	Description
Void

Examples

NSWebPanelEntity thing;
String tooltip;
thing.SetTooltip(tooltip);

SetUrl(String)

Introduced or updated in version: 7.5

Declaration

Void SetUrl(String url)

Parameters

Type	Name	Description
String	url	The URl.

Returns

Type	Description
Void

Examples

NSWebPanelEntity thing;
String url;
thing.SetUrl(url);

SetUrlEncoding(Integer)

Introduced or updated in version: 7.5

Declaration

Void SetUrlEncoding(Integer urlEncoding)

Parameters

Type	Name	Description
Integer	urlEncoding	The encoding of the URL. See UrlEncoding.

Returns

Type	Description
Void

Examples

NSWebPanelEntity thing;
Integer urlEncoding;
thing.SetUrlEncoding(urlEncoding);

SetVisibleIn(Integer)

Introduced or updated in version: 7.5

Declaration

Void SetVisibleIn(Integer visibleIn)

Parameters

Type	Name	Description
Integer	visibleIn	The web panel is visible in. See Navigation

Returns

Type	Description
Void

Examples

NSWebPanelEntity thing;
Integer visibleIn;
thing.SetVisibleIn(visibleIn);

SetWebPanelId(Integer)

Introduced or updated in version: 7.5

Declaration

Void SetWebPanelId(Integer webPanelId)

Parameters

Type	Name	Description
Integer	webPanelId	The identity of the web panel.

Returns

Type	Description
Void

Examples

NSWebPanelEntity thing;
Integer webPanelId;
thing.SetWebPanelId(webPanelId);

SetWindowName(String)

Introduced or updated in version: 7.5

Declaration

Void SetWindowName(String windowName)

Parameters

Type	Name	Description
String	windowName	The window which the URL address is to open in (web panel only).

Returns

Type	Description
Void

Examples

NSWebPanelEntity thing;
String windowName;
thing.SetWindowName(windowName);