Show / Hide Table of Contents

Class NSExtAppEntity

Contains information on an external application.

Syntax

Constructors

NSExtAppEntity()

Initializes a new instance of the NSExtAppEntity class.

Declaration
NSExtAppEntity

Methods

GetDeleted()

Contains information on an external application.

Declaration
Bool GetDeleted()
Returns
Type Description
Bool

True if the application is marked as deleted.

Examples
NSExtAppEntity thing;
Bool deleted = thing.GetDeleted();

GetExecuteOnEvent()

Contains information on an external application.

Declaration
NSExecuteOnEvent GetExecuteOnEvent()
Returns
Type Description
NSExecuteOnEvent

Events that cause automatic execution of this app. See ExecuteOnEvent

Examples
NSExtAppEntity thing;
NSExecuteOnEvent executeOnEvent = thing.GetExecuteOnEvent();

GetExtAppId()

Contains information on an external application.

Declaration
Integer GetExtAppId()
Returns
Type Description
Integer

The identity of the external app.

Examples
NSExtAppEntity thing;
Integer extAppId = thing.GetExtAppId();

GetFilename()

Contains information on an external application.

Declaration
String GetFilename()
Returns
Type Description
String

Filename of the programfile.

Examples
NSExtAppEntity thing;
String filename = thing.GetFilename();

GetIcon()

Contains information on an external application.

Declaration
Integer GetIcon()
Returns
Type Description
Integer

The ID of the icon of the external app.

Examples
NSExtAppEntity thing;
Integer icon = thing.GetIcon();

GetName()

Contains information on an external application.

Declaration
String GetName()
Returns
Type Description
String

The name of the web panel.

Examples
NSExtAppEntity thing;
String name = thing.GetName();

GetOnCentral()

Contains information on an external application.

Declaration
Bool GetOnCentral()
Returns
Type Description
Bool

Is the application visible when user is on central database.

Examples
NSExtAppEntity thing;
Bool onCentral = thing.GetOnCentral();

GetOnSalesMarketingPocket()

Contains information on an external application.

Declaration
Bool GetOnSalesMarketingPocket()
Returns
Type Description
Bool

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

Examples
NSExtAppEntity thing;
Bool onSalesMarketingPocket = thing.GetOnSalesMarketingPocket();

GetOnSatellite()

Contains information on an external application.

Declaration
Bool GetOnSatellite()
Returns
Type Description
Bool

Is the application visible when user is on a satellite.

Examples
NSExtAppEntity thing;
Bool onSatellite = thing.GetOnSatellite();

GetOnTravel()

Contains information on an external application.

Declaration
Bool GetOnTravel()
Returns
Type Description
Bool

Is the application visible when user is on travel.

Examples
NSExtAppEntity thing;
Bool onTravel = thing.GetOnTravel();

GetParameters()

Contains information on an external application.

Declaration
String GetParameters()
Returns
Type Description
String

Examples
NSExtAppEntity thing;
String parameters = thing.GetParameters();

GetPath()

Contains information on an external application.

Declaration
String GetPath()
Returns
Type Description
String

Path where the programfile is located; if empty, PATH is used.

Examples
NSExtAppEntity thing;
String path = thing.GetPath();

GetRank()

Contains information on an external application.

Declaration
Integer GetRank()
Returns
Type Description
Integer

The rank of the application.

Examples
NSExtAppEntity thing;
Integer rank = thing.GetRank();

GetShowInAddressBar()

Contains information on an external application.

Declaration
Bool GetShowInAddressBar()
Returns
Type Description
Bool

Does the web panel have an address bar.

Examples
NSExtAppEntity thing;
Bool showInAddressBar = thing.GetShowInAddressBar();

GetShowInMenuBar()

Contains information on an external application.

Declaration
Bool GetShowInMenuBar()
Returns
Type Description
Bool

Does the application have a menu bar.

Examples
NSExtAppEntity thing;
Bool showInMenuBar = thing.GetShowInMenuBar();

GetShowInStatusBar()

Contains information on an external application.

Declaration
Bool GetShowInStatusBar()
Returns
Type Description
Bool

Does the web panel have a status bar.

Examples
NSExtAppEntity thing;
Bool showInStatusBar = thing.GetShowInStatusBar();

GetShowInToolBar()

Contains information on an external application.

Declaration
Bool GetShowInToolBar()
Returns
Type Description
Bool

Does the web panel have a toolbar.

Examples
NSExtAppEntity thing;
Bool showInToolBar = thing.GetShowInToolBar();

GetShowState()

Contains information on an external application.

Declaration
Integer GetShowState()
Returns
Type Description
Integer

The application is shown in which state Minimized, Maximized or Restored. See ShowState

Examples
NSExtAppEntity thing;
Integer showState = thing.GetShowState();

GetTooltip()

Contains information on an external application.

Declaration
String GetTooltip()
Returns
Type Description
String

The tooltip of the web panel.

Examples
NSExtAppEntity thing;
String tooltip = thing.GetTooltip();

GetVisibleIn()

Contains information on an external application.

Declaration
Integer GetVisibleIn()
Returns
Type Description
Integer

The application is visible in. See Navigation

Examples
NSExtAppEntity thing;
Integer visibleIn = thing.GetVisibleIn();

GetWaitToFinish()

Contains information on an external application.

Declaration
Bool GetWaitToFinish()
Returns
Type Description
Bool

True if the application shall wait for finish event.

Examples
NSExtAppEntity thing;
Bool waitToFinish = thing.GetWaitToFinish();

GetWorkdir()

Contains information on an external application.

Declaration
String GetWorkdir()
Returns
Type Description
String

Directory set to current when loading the application, if different from application's own.

Examples
NSExtAppEntity thing;
String workdir = thing.GetWorkdir();

SetDeleted(Bool)

Contains information on an external application.

Declaration
Void SetDeleted(Bool deleted)
Parameters
Type Name Description
Bool deleted

True if the application is marked as deleted.

Returns
Type Description
Void
Examples
NSExtAppEntity thing;
Bool deleted;
thing.SetDeleted(deleted);

SetExecuteOnEvent(NSExecuteOnEvent)

Contains information on an external application.

Declaration
Void SetExecuteOnEvent(NSExecuteOnEvent executeOnEvent)
Parameters
Type Name Description
NSExecuteOnEvent executeOnEvent

Events that cause automatic execution of this app. See ExecuteOnEvent.

Returns
Type Description
Void
Examples
NSExtAppEntity thing;
NSExecuteOnEvent executeOnEvent;
thing.SetExecuteOnEvent(executeOnEvent);

SetExtAppId(Integer)

Contains information on an external application.

Declaration
Void SetExtAppId(Integer extAppId)
Parameters
Type Name Description
Integer extAppId

The identity of the external app.

Returns
Type Description
Void
Examples
NSExtAppEntity thing;
Integer extAppId;
thing.SetExtAppId(extAppId);

SetFilename(String)

Contains information on an external application.

Declaration
Void SetFilename(String filename)
Parameters
Type Name Description
String filename

Filename of the programfile.

Returns
Type Description
Void
Examples
NSExtAppEntity thing;
String filename;
thing.SetFilename(filename);

SetIcon(Integer)

Contains information on an external application.

Declaration
Void SetIcon(Integer icon)
Parameters
Type Name Description
Integer icon

The ID of the icon of the external app.

Returns
Type Description
Void
Examples
NSExtAppEntity thing;
Integer icon;
thing.SetIcon(icon);

SetName(String)

Contains information on an external application.

Declaration
Void SetName(String name)
Parameters
Type Name Description
String name

The name of the web panel.

Returns
Type Description
Void
Examples
NSExtAppEntity thing;
String name;
thing.SetName(name);

SetOnCentral(Bool)

Contains information on an external application.

Declaration
Void SetOnCentral(Bool onCentral)
Parameters
Type Name Description
Bool onCentral

Is the application visible when user is on central database.

Returns
Type Description
Void
Examples
NSExtAppEntity thing;
Bool onCentral;
thing.SetOnCentral(onCentral);

SetOnSalesMarketingPocket(Bool)

Contains information on an external application.

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
NSExtAppEntity thing;
Bool onSalesMarketingPocket;
thing.SetOnSalesMarketingPocket(onSalesMarketingPocket);

SetOnSatellite(Bool)

Contains information on an external application.

Declaration
Void SetOnSatellite(Bool onSatellite)
Parameters
Type Name Description
Bool onSatellite

Is the application visible when user is on a satellite.

Returns
Type Description
Void
Examples
NSExtAppEntity thing;
Bool onSatellite;
thing.SetOnSatellite(onSatellite);

SetOnTravel(Bool)

Contains information on an external application.

Declaration
Void SetOnTravel(Bool onTravel)
Parameters
Type Name Description
Bool onTravel

Is the application visible when user is on travel.

Returns
Type Description
Void
Examples
NSExtAppEntity thing;
Bool onTravel;
thing.SetOnTravel(onTravel);

SetParameters(String)

Contains information on an external application.

Declaration
Void SetParameters(String parameters)
Parameters
Type Name Description
String parameters

Returns
Type Description
Void
Examples
NSExtAppEntity thing;
String parameters;
thing.SetParameters(parameters);

SetPath(String)

Contains information on an external application.

Declaration
Void SetPath(String path)
Parameters
Type Name Description
String path

Path where the programfile is located; if empty, PATH is used.

Returns
Type Description
Void
Examples
NSExtAppEntity thing;
String path;
thing.SetPath(path);

SetRank(Integer)

Contains information on an external application.

Declaration
Void SetRank(Integer rank)
Parameters
Type Name Description
Integer rank

The rank of the application.

Returns
Type Description
Void
Examples
NSExtAppEntity thing;
Integer rank;
thing.SetRank(rank);

SetShowInAddressBar(Bool)

Contains information on an external application.

Declaration
Void SetShowInAddressBar(Bool showInAddressBar)
Parameters
Type Name Description
Bool showInAddressBar

Does the web panel have an address bar.

Returns
Type Description
Void
Examples
NSExtAppEntity thing;
Bool showInAddressBar;
thing.SetShowInAddressBar(showInAddressBar);

SetShowInMenuBar(Bool)

Contains information on an external application.

Declaration
Void SetShowInMenuBar(Bool showInMenuBar)
Parameters
Type Name Description
Bool showInMenuBar

Does the application have a menu bar.

Returns
Type Description
Void
Examples
NSExtAppEntity thing;
Bool showInMenuBar;
thing.SetShowInMenuBar(showInMenuBar);

SetShowInStatusBar(Bool)

Contains information on an external application.

Declaration
Void SetShowInStatusBar(Bool showInStatusBar)
Parameters
Type Name Description
Bool showInStatusBar

Does the web panel have a status bar.

Returns
Type Description
Void
Examples
NSExtAppEntity thing;
Bool showInStatusBar;
thing.SetShowInStatusBar(showInStatusBar);

SetShowInToolBar(Bool)

Contains information on an external application.

Declaration
Void SetShowInToolBar(Bool showInToolBar)
Parameters
Type Name Description
Bool showInToolBar

Does the web panel have a toolbar.

Returns
Type Description
Void
Examples
NSExtAppEntity thing;
Bool showInToolBar;
thing.SetShowInToolBar(showInToolBar);

SetShowState(Integer)

Contains information on an external application.

Declaration
Void SetShowState(Integer showState)
Parameters
Type Name Description
Integer showState

The application is shown in which state Minimized, Maximized or Restored. See ShowState.

Returns
Type Description
Void
Examples
NSExtAppEntity thing;
Integer showState;
thing.SetShowState(showState);

SetTooltip(String)

Contains information on an external application.

Declaration
Void SetTooltip(String tooltip)
Parameters
Type Name Description
String tooltip

The tooltip of the web panel.

Returns
Type Description
Void
Examples
NSExtAppEntity thing;
String tooltip;
thing.SetTooltip(tooltip);

SetVisibleIn(Integer)

Contains information on an external application.

Declaration
Void SetVisibleIn(Integer visibleIn)
Parameters
Type Name Description
Integer visibleIn

The application is visible in. See Navigation.

Returns
Type Description
Void
Examples
NSExtAppEntity thing;
Integer visibleIn;
thing.SetVisibleIn(visibleIn);

SetWaitToFinish(Bool)

Contains information on an external application.

Declaration
Void SetWaitToFinish(Bool waitToFinish)
Parameters
Type Name Description
Bool waitToFinish

True if the application shall wait for finish event.

Returns
Type Description
Void
Examples
NSExtAppEntity thing;
Bool waitToFinish;
thing.SetWaitToFinish(waitToFinish);

SetWorkdir(String)

Contains information on an external application.

Declaration
Void SetWorkdir(String workdir)
Parameters
Type Name Description
String workdir

Directory set to current when loading the application, if different from application's own.

Returns
Type Description
Void
Examples
NSExtAppEntity thing;
String workdir;
thing.SetWorkdir(workdir);
In This Article
  • Constructors
    • NSExtAppEntity()
  • Methods
    • GetDeleted()
    • GetExecuteOnEvent()
    • GetExtAppId()
    • GetFilename()
    • GetIcon()
    • GetName()
    • GetOnCentral()
    • GetOnSalesMarketingPocket()
    • GetOnSatellite()
    • GetOnTravel()
    • GetParameters()
    • GetPath()
    • GetRank()
    • GetShowInAddressBar()
    • GetShowInMenuBar()
    • GetShowInStatusBar()
    • GetShowInToolBar()
    • GetShowState()
    • GetTooltip()
    • GetVisibleIn()
    • GetWaitToFinish()
    • GetWorkdir()
    • SetDeleted(Bool)
    • SetExecuteOnEvent(NSExecuteOnEvent)
    • SetExtAppId(Integer)
    • SetFilename(String)
    • SetIcon(Integer)
    • SetName(String)
    • SetOnCentral(Bool)
    • SetOnSalesMarketingPocket(Bool)
    • SetOnSatellite(Bool)
    • SetOnTravel(Bool)
    • SetParameters(String)
    • SetPath(String)
    • SetRank(Integer)
    • SetShowInAddressBar(Bool)
    • SetShowInMenuBar(Bool)
    • SetShowInStatusBar(Bool)
    • SetShowInToolBar(Bool)
    • SetShowState(Integer)
    • SetTooltip(String)
    • SetVisibleIn(Integer)
    • SetWaitToFinish(Bool)
    • SetWorkdir(String)
© SuperOffice. All rights reserved.
SuperOffice |  Community |  Release Notes |  Privacy |  Site feedback |  Search Docs |  About Docs |  Contribute |  Back to top