ExternalApplication Class
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Contains information that is used to integrate an external application with UII.
public ref class ExternalApplication : Microsoft::Uii::Csr::HostedApplication[Microsoft.Practices.CompositeUI.SmartParts.SmartPart]
public class ExternalApplication : Microsoft.Uii.Csr.HostedApplication[<Microsoft.Practices.CompositeUI.SmartParts.SmartPart>]
type ExternalApplication = class
inherit HostedApplicationPublic Class ExternalApplication
Inherits HostedApplication- Inheritance
- Attributes
Constructors
| ExternalApplication(Guid, String, String) |
Constructor when creating an external application hosted within or by UII. |
Fields
| actions |
Specifies the dictionary of associated actions. |
| actionsByID |
Specifies the dictionary of associated actions by action ID. |
| applicationType |
Specifies the hosted application type. |
| ScriptObjectName |
Hosted Application (Inherited from HostedApplication) |
Properties
| AgentID |
Get or set the agent ID. (Inherited from HostedApplication) |
| AmbientProperties |
Gets the set of ambient properties for an application. |
| AppHostWorkItem |
Sets the current work item |
| Application |
Gets or sets the application object for scripting. |
| ApplicationHost |
Gets or sets the application host. |
| ApplicationID |
Gets the unique ID for the application as given in the database. |
| ApplicationInitializationXml |
XML from the database that is used to configure the application in case this class is inherited and the init information is needed. |
| ApplicationName |
Name of this hosted application. |
| applicationObject |
Application Object. This is the main window handle |
| AssemblyUrl |
Extracted from //interopAssembly/URL of the application initstring. |
| CanEmbed |
Gets a Boolean value that specifies whether the application can be embedded. |
| ConfigurationReader |
Configuration reader used for reading app settings from application configuration or the server (Inherited from HostedApplication) |
| Context |
Gets and Sets the context for the hosted applications. |
| DisplayGroup |
Get the display group. |
| engine |
engine (Inherited from HostedApplication) |
| ExternalControl |
An instance of ExternalControl that is managing the execution of the hosted external application. |
| HostedApplicationAdapter |
Application adapter instance for the external application, when configured. For Internal Use. |
| HostInside |
Gets whether the hosted application window is managed by UII. |
| Icon |
Used to indicate the preferred icon to use |
| ImplementedAsCcf20 |
Allows system to run certain routines as CCF 2.0 or prior. |
| IsAdapterSessionController |
Gets a boolean indicating whether the adapter is a SessionController. (Inherited from HostedApplication) |
| IsDynamic |
Gets or sets a value indicating whether this instance is dynamic. |
| IsGlobal |
Tells whether the hosted application is global scoped. |
| IsListed |
Allows to be seen but not listed in SessionExplorer or CurrentSessionUI. |
| IsNavigating |
Could be used to indicate this hosted application is changing state. |
| IsTagged |
When true, application is dependent on workflow |
| LoadScriptActionData |
Action data capture prior to LoadScript() |
| MinimumSize |
Not used in CCF 1.02 |
| OptimumSize |
Initial size of the hosted application window if HostInside=false. |
| Parent |
The Windows Forms Control which is parenting this application. |
| Process |
Process object representing the process of the hosted external application. |
| SessionManager |
Allows hosted applications to have access to the session manager object. |
| TopLevelWindow |
The Windows Forms Control this hosted application resides in. |
Methods
| adapter_AdapterContextChangedEvent(Context) |
Event handler which is run when an adapter needs to notify UII of new context information. |
| adapter_AdapterFireRequestActionEvent(RequestActionEventArgs) |
Used when an adapter requests that an action be done on an application. |
| adapter_AdapterProcessChangedEvent(Process) |
Event handler which is run when an adapter needs to notify UII of a process change. |
| adapter_AdapterRequestActionEvent(String, String, String) |
Used when an adapter requests that an action be done on an application. |
| AddAction(Int32, String, String) |
Adds an action to the application's list. An action with id == 1 is the 'default' action and gets called on init. There does not need to be a default action though, just don't have an action with id 1 if you don't want a default. |
| Close() |
Called when the hosting framework wishes to close this application. |
| CreateInstance(String, String) |
Obsolete.
Method used to help create Instances of applications / objects (Inherited from HostedApplication) |
| CreateInstance(String, String, WorkItem) |
Method used to help create Instances of applications / objects (Inherited from HostedApplication) |
| DoAction(Int32, String) |
Performs an action where the action is specified by its ID. |
| DoAction(RequestActionEventArgs) |
Performs an action where the action is given by the RequestActionEventArgs. |
| DoAction(String, String) |
Obsolete.
Performs an action where the action is given by its unique name. |
| DoDefaultAction() |
Performs the default action on the application, if there is a default action. The default action is the one with an id of 1, but there may not be one. |
| FireRequestAction(RequestActionEventArgs) |
Additional public members to expose data and events to scripts |
| Focus() |
Gives the focus to the hosted Win32 application |
| GetCompiledState(Byte[], Byte[]) |
Obsolete.
Get the compiled State (Inherited from HostedApplication) |
| GetContextValue(String) |
Returns the value associated with the provided context key. If the key is not found, the empty string will be returned. If no reference to the Context object is held, null will be returned. |
| GetEventSourceInstance(String, String) |
Obsolete.
Get the event source instance. (Inherited from HostedApplication) |
| GetGlobalInstance(String) |
Obsolete.
Get global instances (Inherited from HostedApplication) |
| GetIconList() | |
| GetStateData() |
Gets the application state data for this application For now we retrieve only the ambient properties and context value |
| HandleRequestAction(Object, RequestActionEventArgs) |
This is for internal UII use only. Please do not use directly. Public visibility necessary for CAB integration. |
| HandleRequestDefaultAction(Object, DataEventArgs<ApplicationProperties>) |
This is for internal UII use only. Please do not use directly. Public visibility necessary for CAB integration. |
| Initialize() |
Called by the framework when it is ready for the application to initialize itself. |
| loadAdapter(XmlDocument) |
Loads an adapter (if any) to modify the application behavior. |
| Notify(String, Object) |
Obsolete.
Notify the script with information. (Inherited from HostedApplication) |
| NotifyContextChange(Context) |
Notify the application that the context changed |
| NotifyContextChange(String) |
Obsolete.
Called by application host to notify the app that the context has changed |
| OnCompilerError(IVsaError) |
Obsolete.
On Compiler error (Inherited from HostedApplication) |
| SessionChange(Boolean, Guid) |
Called for global applications when the session is activated or deactivated |
| SetContext(Context) |
Obsolete.
This is used to set the context from ApplicationHost without causing further notifications. It exists so that context can be updated quietly before doing the 'real' context notification because some applications fire actions onto other apps when the context changes and some actions are designed to depend upon context. In other words, a race condition. |
| SetContext(String) |
Obsolete.
This is used to set the context from ApplicationHost without causing further notifications. It exists so that context can be updated quietly before doing the 'real' context notification because some applications fire actions onto other apps when the context changes and some actions are designed to depend upon context. In otherwords, a race condition. |
| SetStateData(String) |
Set the application to the state provided in the xml string. |
| UpdateContextValue(Dictionary<String,String>) |
Accepts a Dictionary collection of keys and values and adds them (or updates it if it currently exists) to the current context. Then notify other apps the context has changed. |
| UpdateContextValue(String, String) |
Accepts a name and value pair and adds it (or updates it if it currently exists) to the current context. Then notify other apps the context has changed. The caller is NO LONGER responsible for notifying other apps of the context change via this.ChangeContext(). |
Events
| ActionCompleted |
Obsolete.
Event to notify AppHost that an action has completed |
| ActionCompletedEvent |
Event to notify ApplicationHost that an action has completed. Using CAB's EventBroker to publish the event topic. |
| ChangeContext |
Event to add a name-value pair to the context |
| RequestAction |
Obsolete.
Event to request an action of another application to be invoked |
| RequestActionEvent |
Event publication for event to request an action of another application to be invoked. Using CAB's EventBroker to publish the event topic |
| RequestActionStatusEvent |
Event to notify ApplicationHost of action status. |