Class NSWebPanelEntity

Contains information on a web panel.

Syntax

Constructors

NSWebPanelEntity()

Initializes a new instance of the NSWebPanelEntity class.

Declaration

NSWebPanelEntity

Methods

GetDeleted()

Contains information on a web panel.

Declaration

Bool GetDeleted()

Returns

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

Examples

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

GetIcon()

Contains information on a web panel.

Declaration

Integer GetIcon()

Returns

Type	Description
Integer	The icon of the web panel.

Examples

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

GetName()

Contains information on a web panel.

Declaration

String GetName()

Returns

Type	Description
String	The name of the web panel.

Examples

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

GetOnCentral()

Contains information on a web panel.

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()

Contains information on a web panel.

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()

Contains information on a web panel.

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()

Contains information on a web panel.

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()

Contains information on a web panel.

Declaration

Bool GetOnSattelite()

Returns

Type	Description
Bool

GetOnTravel()

Contains information on a web panel.

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()

Contains information on a web panel.

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()

Contains information on a web panel.

Declaration

Integer GetRank()

Returns

Type	Description
Integer	The rank of the web panel.

Examples

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

GetShowInAddressBar()

Contains information on a web panel.

Declaration

Bool GetShowInAddressBar()

Returns

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

Examples

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

GetShowInMenuBar()

Contains information on a web panel.

Declaration

Bool GetShowInMenuBar()

Returns

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

Examples

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

GetShowInStatusBar()

Contains information on a web panel.

Declaration

Bool GetShowInStatusBar()

Returns

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

Examples

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

GetShowInToolBar()

Contains information on a web panel.

Declaration

Bool GetShowInToolBar()

Returns

Type	Description
Bool	Does the web panel have a toolbar.

Examples

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

GetTooltip()

Contains information on a web panel.

Declaration

String GetTooltip()

Returns

Type	Description
String	The tooltip of the web panel.

Examples

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

GetUrl()

Contains information on a web panel.

Declaration

String GetUrl()

Returns

Type	Description
String	The URl.

Examples

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

GetUrlEncoding()

Contains information on a web panel.

Declaration

Integer GetUrlEncoding()

Returns

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

Examples

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

GetVisibleIn()

Contains information on a web panel.

Declaration

Integer GetVisibleIn()

Returns

Type	Description
Integer	The web panel is visible in.

Examples

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

GetWebPanelId()

Contains information on a web panel.

Declaration

Integer GetWebPanelId()

Returns

Type	Description
Integer	The identity of the web panel.

Examples

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

GetWindowName()

Contains information on a web panel.

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)

Contains information on a web panel.

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)

Contains information on a web panel.

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)

Contains information on a web panel.

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)

Contains information on a web panel.

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)

Contains information on a web panel.

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)

Contains information on a web panel.

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)

Contains information on a web panel.

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)

Contains information on a web panel.

Declaration

Void SetOnSattelite(Bool onSattelite)

Parameters

Type	Name	Description
Bool	onSattelite

Returns

Type	Description
Void

SetOnTravel(Bool)

Contains information on a web panel.

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)

Contains information on a web panel.

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)

Contains information on a web panel.

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)

Contains information on a web panel.

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)

Contains information on a web panel.

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)

Contains information on a web panel.

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)

Contains information on a web panel.

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)

Contains information on a web panel.

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)

Contains information on a web panel.

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)

Contains information on a web panel.

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)

Contains information on a web panel.

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)

Contains information on a web panel.

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)

Contains information on a web panel.

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);