ExternalApplication Members

Article
04/27/2015

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
	actions	Specifies the dictionary of associated actions.
	actionsByID	Specifies the dictionary of associated actions by action ID.
	applicationType	Specifies the hosted application type.

Top

Public Properties

(see also Protected Properties)

	Name	Description
	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.
	ApplicationID	Overridden. 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	Overridden. Name of this hosted application.
	CanEmbed	Overridden. 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	Overridden. Get the display group.
	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	Overridden. Used to indicate the preferred icon to use
	ImplementedAsCcf20	Overridden. 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	Overridden. Tells whether the hosted application is global scoped.
	IsListed	Overridden. Allows to be seen but not listed in SessionExplorer or CurrentSessionUI.
	IsNavigating	Overridden. Could be used to indicate this hosted application is changing state.
	IsTagged	When true, application is dependent on workflow
	MinimumSize	Overridden. Not used in CCF 1.02
	OptimumSize	Overridden. Initial size of the hosted application window if HostInside=false.
	Parent	The Windows Forms Control which is parenting this application.
	SessionManager	Overridden. Allows hosted applications to have access to the session manager object.
	TopLevelWindow	Overridden. The Windows Forms Control this hosted application resides in.

Top

Protected Properties

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

Top

Public Methods

(see also Protected Methods)

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

Top

Protected Methods

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

Top

Public Events

	Name	Description
	ActionCompleted	Overridden. Event to notify AppHost that an action has completed Obsolete.
	ActionCompletedEvent	Overridden. Event to notify ApplicationHost that an action has completed. Using CAB's EventBroker to publish the event topic.
	ChangeContext	Overridden. Event to add a name-value pair to the context
	RequestAction	Overridden. Event to request an action of another application to be invoked Obsolete.
	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
	RequestActionStatusEvent	Overridden. Event to notify ApplicationHost of action status.

Top

Share via