ExternalApplication Members

Contains information that is used to integrate an external application with UII.

The following tables list the members exposed by the ExternalApplication type.

Public Constructors

  Name Description
  ExternalApplication Constructor when creating an external application hosted within or by UII.

Top

Protected Fields

  Name Description
protected field actions Specifies the dictionary of associated actions.
protected field actionsByID Specifies the dictionary of associated actions by action ID.
protected field applicationType Specifies the hosted application type.

Top

Public Properties

(see also Protected Properties)

  Name Description
public property AgentID  Get or set the agent ID. (inherited from HostedApplication)
public property AmbientProperties Gets the set of ambient properties for an application.
public property AppHostWorkItem Sets the current work item
public property Application Gets or sets the application object for scripting.
public property ApplicationID Overridden. Gets the unique ID for the application as given in the database.
public property ApplicationInitializationXml XML from the database that is used to configure the application in case this class is inherited and the init information is needed.
public property ApplicationName Overridden. Name of this hosted application.
public property CanEmbed Overridden. Gets a Boolean value that specifies whether the application can be embedded.
public property ConfigurationReader  Configuration reader used for reading app settings from application configuration or the server (inherited from HostedApplication)
public property Context Gets and Sets the context for the hosted applications.
public property DisplayGroup Overridden. Get the display group.
public property HostedApplicationAdapter Application adapter instance for the external application, when configured. For Internal Use.
public property HostInside Gets whether the hosted application window is managed by UII.
public property Icon Overridden. Used to indicate the preferred icon to use
public property ImplementedAsCcf20 Overridden. Allows system to run certain routines as CCF 2.0 or prior.
public property IsAdapterSessionController  Gets a boolean indicating whether the adapter is a SessionController. (inherited from HostedApplication)
public property IsDynamic Gets or sets a value indicating whether this instance is dynamic.
public property IsGlobal Overridden. Tells whether the hosted application is global scoped.
public property IsListed Overridden. Allows to be seen but not listed in SessionExplorer or CurrentSessionUI.
public property IsNavigating Overridden. Could be used to indicate this hosted application is changing state.
public property IsTagged When true, application is dependent on workflow
public property MinimumSize Overridden. Not used in CCF 1.02
public property OptimumSize Overridden. Initial size of the hosted application window if HostInside=false.
public property Parent The Windows Forms Control which is parenting this application.
public property SessionManager Overridden. Allows hosted applications to have access to the session manager object.
public property TopLevelWindow Overridden. The Windows Forms Control this hosted application resides in.

Top

Protected Properties

  Name Description
protected property applicationObject Application Object. This is the main window handle
protected property AssemblyUrl Extracted from //interopAssembly/URL of the application initstring.
protected property engine  engine (inherited from HostedApplication)
protected property ExternalControl An instance of ExternalControl that is managing the execution of the hosted external application.
protected property LoadScriptActionData Action data capture prior to LoadScript()
protected property Process Process object representing the process of the hosted external application.

Top

Public Methods

(see also Protected Methods)

  Name Description
public method AddAction Overridden. 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.
public method Close Overridden. Called when the hosting framework wishes to close this application.
public method DoAction Overloaded. Overridden.  
public method DoDefaultAction Overridden. 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.
public method Equals  (inherited from Object)
public method FireRequestAction Overridden. Additional public members to expose data and events to scripts
public method Focus Gives the focus to the hosted Win32 application
public method GetCompiledState  Get the compiled State Obsolete.  (inherited from HostedApplication)
public method GetContextValue 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.
public method GetEventSourceInstance  Get the event source instance. Obsolete.  (inherited from HostedApplication)
public method GetGlobalInstance  Get global instances Obsolete.  (inherited from HostedApplication)
public method GetHashCode  (inherited from Object)
public method GetIconList Overridden.  
public method GetStateData Overridden. Gets the application state data for this application For now we retrieve only the ambient properties and context value
public method GetType  (inherited from Object)
public method HandleRequestAction This is for internal UII use only. Please do not use directly. Public visibility necessary for CAB integration.
public method HandleRequestDefaultAction This is for internal UII use only. Please do not use directly. Public visibility necessary for CAB integration.
public method Initialize Overridden. Called by the framework when it is ready for the application to initialize itself.
public method Notify  Notify the script with information. Obsolete.  (inherited from HostedApplication)
public method NotifyContextChange Overloaded. Overridden.  
public method OnCompilerError  On Compiler error Obsolete.  (inherited from HostedApplication)
public method SessionChange Overridden. Called for global applications when the session is activated or deactivated
public method SetContext Overloaded. Overridden.  
public method SetStateData Overridden. Set the application to the state provided in the xml string.
public method ToString  (inherited from Object)
public method UpdateContextValue Overloaded.  

Top

Protected Methods

  Name Description
protected method adapter_AdapterContextChangedEvent Event handler which is run when an adapter needs to notify UII of new context information.
protected method adapter_AdapterFireRequestActionEvent Used when an adapter requests that an action be done on an application.
protected method adapter_AdapterProcessChangedEvent Event handler which is run when an adapter needs to notify UII of a process change.
protected method adapter_AdapterRequestActionEvent Used when an adapter requests that an action be done on an application.
protected method CreateInstance  Overloaded. (inherited from HostedApplication)
protected method DoAction Overloaded. Overridden.  
protected method Finalize  (inherited from Object)
protected method loadAdapter Loads an adapter (if any) to modify the application behavior.
protected method MemberwiseClone  (inherited from Object)

Top

Public Events

  Name Description
public event ActionCompleted Overridden. Event to notify AppHost that an action has completed Obsolete.
public event ActionCompletedEvent Overridden. Event to notify ApplicationHost that an action has completed. Using CAB's EventBroker to publish the event topic.
public event ChangeContext Overridden. Event to add a name-value pair to the context
public event RequestAction Overridden. Event to request an action of another application to be invoked Obsolete.
public event RequestActionEvent Overridden. Event publication for event to request an action of another application to be invoked. Using CAB's EventBroker to publish the event topic
public event RequestActionStatusEvent Overridden. Event to notify ApplicationHost of action status.

Top

See Also

Reference

ExternalApplication Class
Microsoft.Uii.Csr Namespace

Unified Service Desk
Send comments about this topic to Microsoft.
© 2015 Microsoft. All rights reserved.