HostedControlEx Class

Constructor

Constructor

Dictionary of actions

Dictionary of actions

Useful for management apps that need to know who is logged into them. This is used for apps supporting the IHostedApplication2 interface.

This is the agent's phone when using CTI

For CAB integration purposes only; allows injection of current WorkItem

Intended to provide access to the containing ApplicationHost instance to support advanced hosting senarios. Usage may increase coupling between AIF hosted applications, running counter to the architectural intent of AIF. Setter is for internal use only, it will have no effect.

Returns the unique id for this hosted application.

Returns the name of the hosted application as given in the database.

Returns true if the application can be hosted within the UII panels. False if the application can only be integrated with UII via scripts.

Gets or set the hosted controls Configuration Value reader object.

Contains session-wide context. Modifying this also notifies other applications of the context change.

Telephony member for controlling phones and calls

The name of the UII panel this application is hosted within. This is taken from the database Application table initialization XML.

Get the value of private member variable enableAutoSignOn.

Used for hosted WinForm apps that want a simple way to set their icons.

Allows system to run certain routines as CCF 2.0 or prior

Gets a boolean indicating whether the adapter is a SessionController.

Gets or sets a value indicating whether this instance is dynamic.

Tells whether the hosted application is global

Allows to be seen but not listed in SessionExplorer or CurrentSessionUI

Could be used to indicate an application is changing its state.

When true, application is dependent on workflow

The size that the applications's window will initially be if it is a floating window.

Allows hosted apps to have access to sessions

Sets/Gets the text for the window or tab control containing this application.

Returns a control for the owning window of this hosted app. If this is an external application, then null is returned.

Adds an action for use from one application or the UII core to this application. An action with id of 1 is the default action and is called when initing the application. There is no requirement to have a default action though.

Adds implicit action . Action Id will use the maximum available int .

Called when the app is closed.

Method to override in the implemention to handle the action.

Called to perform the action configured in the database. Do not override this method! To handle DoAction in your implementation override DoAction(RequestActionEventArgs) instead.

Method to override in the implementation to handle the action.

Called to perform the action configured in the database.

Performs this hosted application's default action, if there is one. The default action is the one with an id of 1, but it is not required.

So hosted winform applications can use this and have the same error message style as the rest of the desktop.

Informs all the other applications that the context has changed.

Sends a request to perform some action to another application. If the RequestActionEventArgs has a target of *, then all apps get the action.

Gets the icon images

Gets the application state data for the windows application For now we retrieve only the InputText value

This is for internal UII use only. Please do not use directly. Public visibility necessary for CAB integration.

This is for internal UII use only. Please do not use directly. Public visibility necessary for CAB integration.

Called when the application should initialize its internal state

Event which happens whenever the context is changed.

Event which happens whenever the context is changed. This is called by the applicationHost

Called for global applications when the session is activated or deactivated Not called for non-global applications.

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.

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.

Sets the StateData to the controls

For internal use

Event to notify ApplicationHost that an action has completed. Using CAB's EventBroker to publish the event topic.

This event is for internal UII use only and should not be used directly. If your hosted control wants to recieve context change notification, you should be overriding NotifyContextChange method in your implementation.

For internal use

Event to request an action of another application to be invoked. Using CAB's EventBroker to publish the event topic.

Event to notify ApplicationHost of action status.