The Application object is the top object in the Stonefield Query object model. A reference to this object is passed to every event and data object script so the script can interact with Stonefield Query as necessary. User-defined scripts can access the Application object through the built-in SQApplication object. Through the Application object, a script has access to every other object in the object model.

Properties

All properties except CanEditReports are read-only.

Name	Data Type	Description
ApplicationDataDirectory	String	The path for Stonefield Query's data files, such as the users and roles tables.
ApplicationDirectory	String	The path for the Stonefield Query program files.
ApplicationName	String	The name assigned to the Stonefield Query project. This is the value specified in the Application Name configuration setting.
BasicLicense	Boolean	True if the current user is using a Basic or Report Viewer license. This allows a script to turn on or off certain functionality in that case.
BatchReportRunning	Boolean	True if Stonefield Query is currently running a batch report. This allows a script such as DataEngine.BeforeResultSetRetrieved to do different things depending on whether a report is running from a batch report or not.
CalledFromProxy	Boolean	True if Stonefield Query is being run from the SQProxy object, False if not. This allows your scripts to use different behavior, such as not displaying dialogs, in that case.
CanEditReports	Boolean	True if the user can add or edit reports, False if not.
DashboardChart	Integer	The chart number being generated when a dashboard is previewed and 0 otherwise. This allows a script such as DataEngine.BeforeResultSetRetrieved to do different things for different charts such as prompting for values for the first one.
DataEngine	Object	A reference to the DataEngine object.
License	Integer	The license type for the current user: 1 = Basic, 2 = Ultimate, 3 = Viewer (for backward compatibility). It's better to use the BasicLicense or UltimateLicense properties instead.
Parameters	Object	A reference to the Parameters collection.
ProcessID	Integer	The process ID for the Stonefield Query process.
ProjectDirectory	String	The path for the open project's configuration files.
Quiet	Boolean	True for quiet mode (display no user interface, such as when running a scheduled report).
ReportsDirectory	String	The path for the reports files.
ReportEngine	Object	A reference to the ReportEngine object.
RibbonVisible	Boolean	True if the ribbon is displayed in the Reports Explorer, false if the toolbar and menu are displayed.
SerialNumber	String	The serial number for the current license.
ShortApplicationName	String	The abbreviated name assigned to the Stonefield Query project. This is the value specified in the Short Application Name configuration setting.
TargetApplicationDirectory	String	The target application's program directory. This value is blank if the Need Target Application Directory configuration setting is False.
TimeZoneDesc	String	Contains the descriptive name of the local time zone.
TimeZoneOffset	Integer	Contains the offset for the local time zone from GMT in seconds (it even accounts for daylight saving time). This can be used to display local time from fields containing GMT time.
UltimateLicense	Boolean	True if the current user is using an Ultimate or Report Viewer license. This allows a script to turn on or off certain functionality in that case.
Users	Object	A reference to the Users collection.
Version	String	The Stonefield Query version number.

Methods

Name	Description
AddProperty	Adds a property to the Application object.
CreateObject	Creates an instance of the specified class.
Decrypt	Decrypts a string.
Encrypt	Encrypts a string.
Execute	Executes an application.
GetDataSetFieldName	Returns the name of a field as it appears in the data set for a report.
GetINIValue	Reads a value from the specified INI file.
GetRegistryValue	Reads a value from the Windows Registry.
GetValuesCollection	Returns a values collection object.
Log	Logs a message to the diagnostic file.
OpenForm	Opens an instance of the specified form.
PromptUserForValue	Asks the user for a value.
RegisterCursorToCloseAfterRun	Registers a cursor to be closed at the end of a report run.
SaveEmailSettings	Saves the email settings for the current user.
SetINIValue	Writes a value to the specified INI file.
SetRegistryValue	Saves a value in the Windows Registry.
SetViewerLicenses	Sets the number of viewer licenses available.
ShowErrorMessage	Displays an error message, similar to the MESSAGEBOX() function.
ShowStatus	Displays a message in the Reports Explorer status bar.
Shutdown	Terminates the Stonefield Query session.
UpdateProgressBar	Updates the value of the progress bar in the Reports Explorer status bar.