IHostedApplication3 Interface
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.
An extension on IHostedApplication2.
public interface class IHostedApplication3 : Microsoft::Uii::Csr::IHostedApplication2
public interface IHostedApplication3 : Microsoft.Uii.Csr.IHostedApplication2
type IHostedApplication3 = interface
interface IHostedApplication2
interface IHostedApplication
Public Interface IHostedApplication3
Implements IHostedApplication2
- Derived
- Implements
Remarks
Implements IHostedApplication2. Use IHostedApplication4 for new implementations.
Properties
AgentID |
Gets or sets the agent who is logged in. |
ApplicationID |
Gets the application ID. (Inherited from IHostedApplication) |
ApplicationName |
Gets the application name. (Inherited from IHostedApplication) |
CanEmbed |
Gets a Boolean value that specifies whether the application is an external application. (Inherited from IHostedApplication) |
DisplayGroup |
Gets the display group extracted from the initialization string. (Inherited from IHostedApplication) |
Icon |
Gets or sets the icon used to represent the application in the UII UI. (Inherited from IHostedApplication2) |
ImplementedAsCcf20 |
Gets a Boolean value that specifies whether the application is allowed to run certain routines as CCF 2.0 or prior. |
IsGlobal |
Gets or sets a Boolean value that specifies whether the hosted application is global. |
IsListed |
Gets a Boolean value that specifies whether the application is allowed to be seen but not listed. |
IsNavigating |
Get a Boolean value that specifies whether the application is currently navigating. (Inherited from IHostedApplication) |
MinimumSize |
Gets a hint for minimum window size. (Inherited from IHostedApplication) |
OptimumSize |
Gets a hint for optimal window size. (Inherited from IHostedApplication) |
SessionManager |
Sets the session manager object. |
TopLevelWindow |
Gets the top level window for the application. (Inherited from IHostedApplication) |
Methods
AddAction(Int32, String, String) |
Adds an action to the application. (Inherited from IHostedApplication) |
Close() |
Closes the application. (Inherited from IHostedApplication) |
DoAction(Int32, String) |
Invokes an action on the application (Inherited from IHostedApplication) |
DoAction(String, String) |
Obsolete.
Invokes an action on the application (Inherited from IHostedApplication) |
DoDefaultAction() |
Invokes the default action for the application (Inherited from IHostedApplication) |
FireRequestAction(RequestActionEventArgs) |
Sends a request to perform some action to another application. If the RequestActionEventArgs has a target of *, then all applications get the action. |
GetIconList() |
Gets the image list for the application. (Inherited from IHostedApplication) |
GetStateData() |
Requests the hosted application to return its current state. (Inherited from IHostedApplication) |
Initialize() |
Initializes the hosted application. (Inherited from IHostedApplication) |
NotifyContextChange(Context) |
Notifies the application that the context has changed. |
NotifyContextChange(String) |
Obsolete.
Notifies the application that context has changed. (Inherited from IHostedApplication) |
SessionChange(Boolean, Guid) |
Called whenever the session is changed. Only global applications receive this since 'local' applications don't need to know if their session is shown or not. (Inherited from IHostedApplication) |
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.
Sets 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. (Inherited from IHostedApplication2) |
SetStateData(String) |
Passes the saved state to the hosted application. (Inherited from IHostedApplication) |
Events
ActionCompleted |
Event to notify the hosted application that the action has completed. (Inherited from IHostedApplication) |
ChangeContext |
Event to add a name-value pair to the context. (Inherited from IHostedApplication) |
RequestAction |
Event to request an action of another application to be invoked. (Inherited from IHostedApplication) |