SalApplication

PPJ.Runtime.Windows.SalApplication

Namespace: PPJ.Runtime.Windows

Assembly: PPJ.Web.49 (4.9.0.0)

Base class for SAL applications.

C#

public class SalApplication

VB.NET

Constructors

SalApplication()

Properties

ApplicationType

Type: Returns the type of the application.

CompanyName

String: Returns the company of the application loaded from the AssemblyCompany attribute;

DefaultPrinterSettings

PrinterSettings: Returns the default printer settings. This is set by SalPrt

Instance

SalApplication: Singleton instance of the SalApplication object. When this is the main SalApplication object, the instance is created as the startup form. References assemblies, instead, create their session instance of the SalApplication object upon accessing the Instance singleton property.

Applications can have multiple instances of the SalApplication object, one for each ported assembly. Each SalApplication class belongs necessarily to a different namespace.

Title

String: Returns the title of the application loaded from the AssemblyTitle attribute;

TopLevelForms

Form[]: Returns a list of all top-level forms that belong to this application.

Version

Int32: Returns the version of the framework.

Methods

AddForm(form)

Increase the reference count for the application object. It is called every time a new SalForm is created.

Parameter	Type	Description
form	Form

Returns: Int32. Updated reference count

Disable()

Disables input to all open forms. Use SalAppDisable and SalAppEnable when there are multiple applications running simultaneously and you want to control which application receives user input.

Returns: Boolean. bOk

Enable()

Enables input to all open forms that were disabled by SalAppDisable. Use SalAppDisable and SalAppEnable when there are multiple applications running simultaneously and you want to control which application receives user input.

Returns: Boolean. bOk

EndTrace()

Stops all tracing. Any calls to SalTrace() occurring after SalEndTrace() will be ignored.

Returns: Boolean.

GetProfileInt(section, entry, defaultValue, fileName)

Retrieves the integer value of an entry in the specified section of an initialization file or registry.

Parameter	Type	Description
section	String
entry	String
defaultValue	UInt32
fileName	String

Returns: UInt32.

GetProfileString(section, entry, defaultValue, value, fileName)

Parameter	Type	Description
section	String
entry	String
defaultValue	String
value	SalString&
fileName	String

Returns: Int32.

InvokeScript(script)

Executes javascript on the client.

Parameter	Type	Description
script	String

LoadApp(name, args)

Starts an application.

Parameter	Type	Description
name	String
args	String

Returns: Boolean.

LoadAppAndWait(name, mode, retCode)

Parameter	Type	Description
name	String
mode	Int32
retCode	SalNumber&

Returns: Boolean.

Quit()

Forces the termination of the application.

Refresh()

Forces the browser to reload the document. It's necessary when changing the Mdi tabbed layout and may come handy for other live changes.

RemoveForm(form)

Decreases the reference count for the application object. When the count drops to zero (or below if there is a bug), the application exits. It is called every time a Sal form is destroyed. This should emulate SAL application's behavior with respect to top level windows. When the last form is destroyed the app exits.

Parameter	Type	Description
form	Form

Returns: Int32.

Run(args)

Main method to startup a SAL application.

Parameter	Type	Description
args	NameValueCollection

Returns: Int32.

The SAL application class that extends SalApplication should call this method in the application's Main form OnLoad() method.

public class MainForm : Form
{
  protected override void OnLoad(EventArgs e)
  {
    new App().Run();
  }
}

SetProfileString(section, entry, value, fileName)

Set the value of an entry in the specified section of an initialization file or registry. All profile information is stored as string, so if you want to store an integer it must be converted to a string first. Then it can be retrieved as an integer using the SalGetProfileInt- Function .

Parameter	Type	Description
section	String	The section heading.
entry	String	The entry whose associated value is being set.
value	String	The value of sEntry.
fileName	String	The name of the initialization file or company name depending on the settings made using the SalUseRegistry function. If you are searching for an INI file and do not specify the full path, searches for the file in the Windows subdirectory.

Returns: Boolean. bOk

StartTrace(outputType, traceFile, clear)

Allows tracing to begin.

Parameter	Type	Description
outputType	Int32
traceFile	String
clear	Boolean

Returns: Boolean.

Trace(severity, text)

Outputs a string to the trace output target selected earlier in the SalStartTrace function. Note that if tracing is not already activated, this function will return TRUE even though no trace action is taken. When writing to the event log, the severity level is kept in numeric form. When writing to any other output target, it is translated into a text string such as "Warning".

Parameter	Type	Description
severity	Int32
text	String

Returns: Boolean.

UseEventLog(useLog, logAndcontinue)

Enables logging of unhandled exceptions in the event log.

Parameter	Type	Description
useLog	Boolean
logAndcontinue	Boolean

Returns: Boolean.

UseRegistry(useRegistry, companyName)

This function is used to re-direct all SalProfile* functions to use the Registry. All values for the SalProfile* functions are saved as strings. The INI file name used as the last parameter of the SalProfile* functions will be used as the application name. The resulting path will be: \HKEY_CURRENT_USER\Software[company name][application name][section][setting]\

Parameter	Type	Description
useRegistry	Boolean
companyName	String

Returns: Boolean. bOk