Description

IAgUiApplication represents a root of the Application Model.

Public Methods

Activate	Activates the application's main window.
CreateApplication	Create a new instance of the application model root object.
CreateObject	Only works from local HTML pages and scripts.
DirectoryPickerDialog	Brings up the Directory Picker Dialog and returns a selected directory name.
FileOpenDialog	Brings up a common File Open dialog and returns the file name selected by the user. If the user canceled, returns an empty file name.
FileOpenDialogExt	Brings up a standard File Open Dialog and returns an object representing the selected file.
FileSaveAsDialog	Brings up a common File SaveAs dialog and returns the file name selected by the user. If the user canceled, returns an empty file name.
LoadPersonality	Loads a personality by its name.
LogMsg	Logs the Message specified.
OpenLogFile	Specifies the current log file to be written to.
Quit	Shuts down the application.

Public Properties

DisplayAlerts	Set to true to display certain alerts and messages. Otherwise false. The default value is True.
Height	Gets/sets a height of the main window.
HWND	Returns an HWND handle associated with the application main window.
Left	Gets/sets a vertical coordinate of the main window.
LogFile	Gets the current log files full path.
MessagePendingDelay	Gets/Sets message-pending delay for server busy dialog (in milliseconds).
MRUList	Returns a collection most recently used files.
Path	Returns the complete path to the application, excluding the final separator and name of the application. Read-only String.
Personality	Returns a reference to the currently loaded personality.
Personality2	Returns an new instance of the root object of the STK Object Model.
PrefFilesMode	Gets/sets whether to use saved user preference files.
ProcessID	Gets process id for the current instance.
Top	Gets/sets a horizontal coordinate of the main window.
UserControl	Gets/sets whether the application is user controlled.
Visible	Gets/sets whether the main window is visible.
Width	Gets/sets a width of the main window.
Windows	Returns a collection of windows.
WindowState	Gets/sets the state of the main window.

Interfaces

Implemented Interface
IAgUiApplicationEvents

CoClasses that Implement IAgUiApplication

Name
AgUiApplication

Example

Start STK and get a reference to IAgStkObjectRoot

[C#]

// Create an instance of STK
AgUiApplication uiApplication = new AgUiApplication();
uiApplication.LoadPersonality("STK");
uiApplication.Visible = true;

// Get our IAgStkObjectRoot interface
IAgStkObjectRoot stkRoot = uiApplication.Personality2 as IAgStkObjectRoot;

Get a reference to the AgStkObjectRoot using the running STK instance

[C#]

// Get reference to running STK instance
AgUiApplication uiApplication = System.Runtime.InteropServices.Marshal.GetActiveObject("STK.Application") as AgUiApplication;

// Get our IAgStkObjectRoot interface
IAgStkObjectRoot stkRoot = uiApplication.Personality2 as IAgStkObjectRoot;

Get a reference to the AgStkObjectRoot with display alerts turned off.

[C#]

// Get reference to running STK instance
AgUiApplication uiApplication = System.Runtime.InteropServices.Marshal.GetActiveObject("STK.Application") as AgUiApplication;

//Create a new instance of the application model root object. 
AgUiApplication uiApplication2 = uiApplication.CreateApplication() as AgUiApplication;
//Set DisplayAlerts to false to suppress certain alerts and messages.
//This is useful when automating tasks.
uiApplication2.DisplayAlerts = false;
// Get our IAgStkObjectRoot interface with display alerts turned off
IAgStkObjectRoot stkRoot = uiApplication2.Personality2 as IAgStkObjectRoot;

Start STK and get a reference to IAgStkObjectRoot

[Visual Basic .NET]

' Create an instance of STK
Dim uiApplication As New AgUiApplication()
uiApplication.LoadPersonality("STK")
uiApplication.Visible = True

' Get our IAgStkObjectRoot interface
Dim stkRoot As IAgStkObjectRoot = TryCast(uiApplication.Personality2, IAgStkObjectRoot)

Get a reference to the AgStkObjectRoot using the running STK instance

[Visual Basic .NET]

' Get reference to running STK instance
Dim uiApplication As AgUiApplication = TryCast(System.Runtime.InteropServices.Marshal.GetActiveObject("STK.Application"), AgUiApplication)

' Get our IAgStkObjectRoot interface
Dim stkRoot As IAgStkObjectRoot = TryCast(uiApplication.Personality2, IAgStkObjectRoot)

Get a reference to the AgStkObjectRoot with display alerts turned off.

[Visual Basic .NET]

' Get reference to running STK instance
Dim uiApplication As AgUiApplication = TryCast(System.Runtime.InteropServices.Marshal.GetActiveObject("STK.Application"), AgUiApplication)

'Create a new instance of the application model root object. 
Dim uiApplication2 As AgUiApplication = TryCast(uiApplication.CreateApplication(), AgUiApplication)

'Set DisplayAlerts to false to suppress certain alerts and messages.
'This is useful when automating tasks.
uiApplication2.DisplayAlerts = False

' Get our IAgStkObjectRoot interface with display alerts turned off
Dim stkRoot As IAgStkObjectRoot = TryCast(uiApplication2.Personality2, IAgStkObjectRoot)

Close STK

[Python - STK API]

# AgUiApplication uiApplication: STK Application
uiApplication.ShutDown()

STK UI Application	Send comments on this topic.
IAgUiApplication Interface