ApplicationHost Class
Applies To: Dynamics 365 (online), Dynamics 365 (on-premises), Dynamics CRM 2013, Dynamics CRM 2015, Dynamics CRM 2016
Hosts the applications, regardless of type, held by a session.
Namespace: Microsoft.Uii.Csr
Assembly: Microsoft.Uii.Csr.Core (in Microsoft.Uii.Csr.Core.dll)
Inheritance Hierarchy
System.Object
Microsoft.Uii.Csr.ApplicationHost
Syntax
[SerializableAttribute]
public class ApplicationHost : ICollection, IEnumerable
<SerializableAttribute>
Public Class ApplicationHost
Implements ICollection, IEnumerable
Constructors
| Name | Description | |
|---|---|---|
.jpeg "System_CAPS_pubmethod") |
ApplicationHost() | Obsolete. Initializes a new instance of the ApplicationHost class. |
|
ApplicationHost(Guid, Boolean) | Initializes a new instance of the ApplicationHost class. |
|
ApplicationHost(Guid, Boolean, Boolean) | Initializes a new instance of the ApplicationHost class. |
Properties
| Name | Description | |
|---|---|---|
.jpeg "System_CAPS_pubproperty") |
ApplicationHostID | Gets the application host's unique ID. |
.jpeg "System_CAPS_protproperty") |
AppRecords | Gets or sets the application definitions as returned from the web service. |
|
ContextID | Gets or sets the ID of the context |
|
contextObject | Gets or sets the context object. |
|
contextObjectCache | Gets or sets the context object cache. |
|
contextObjectFilled | Gets a Boolean value that specifies whether the context is filled or not. |
|
Count | Gets the count of the hosted applcations. |
|
globalAppHost | Gets or sets a Boolean value that specifies whether application is a global application host. |
|
IsSynchronized | Gets or sets a Boolean value that specifies whether the application is synchronized. |
|
Item[Int32] | Gets the application at the specified index. |
|
SyncRoot | Gets the sync root object. |
Methods
| Name | Description | |
|---|---|---|
|
AddDynamicApplication(ApplicationRecord) | Adds an a dynamic application to the application host |
|
CanCloseDynamicApplication(IHostedApplication) | Determines whether the dynamic application can be closed dynamically (either via code or UI). |
|
ClearContext() | Clears the local copy of the context. Does not send the context to the backend systems. This is originally for closing context on application sessions which have ended. |
|
Close() | Closes the non-global applications. |
|
CopyTo(Array, Int32) | Copies all the elements of the current one dimensional System.Array to specified one dimensional System.Array starting at the specified destination System.Array Index |
|
CreateContext() | Creates a default context. |
|
CreateContext(Context) | Creates a new copy of the context |
|
Equals(Object) | (Inherited from Object.) |
|
ExecuteDefaultActions() | Executes the default actions on all the hosted applications. |
|
ExecuteDefaultActions(Boolean) | Runs the default action for every application in this session. |
|
ExecuteDefaultActions(IHostedApplication) | Executes the default action on a single application. |
.jpeg "System_CAPS_protmethod") |
Finalize() | (Inherited from Object.) |
|
GetApplication(Guid) | Retrieves the application instance for a given application ID.. |
|
GetApplication(String) | Retrieves the application instance for a given application name |
|
GetApplicationInitializationXml(Guid) | Retrieves the XML initialization string used for a given application. |
|
GetApplicationName(Guid) | Gets the name of the application for the given application ID. |
|
GetApplications() | Retrieves the contained set of hosted applications. |
|
GetContext() | Retrieves the context string. |
|
GetDynamicApplicationNames(Boolean) | Retrieves the names of all the global or non-global applications that are configured via the CRM admin page to show in UI menu. |
|
GetEnumerator() | Retrieves an enumerator that can iterate through a collection. |
|
GetExtendedApplicationbyID(Guid) | Gets an extended application by its application id |
|
GetHashCode() | (Inherited from Object.) |
|
GetIsolatedApplicationbyID(Guid) | Gets an isolated application by its application ID. |
|
GetType() | (Inherited from Object.) |
|
HandleActionCompleted(IHostedApplication, ActionEventArgs) | Obsolete. Event handlers for hosted apps |
|
HandleActionCompletedEvent(Object, ActionEventArgs) | This is for internal UII use only. Please do not use directly. Public visibility necessary for CAB integration. |
|
HandleChangeContext(IHostedApplication, ContextEventArgs) | Obsolete. All applications, as well as ApplicationHost, share the same instance of context so we don't have to overwrite it b/c everyone is updating the same instance. |
|
HandleIsolatedFormSelected(IHostedAppUICommand, EventArgs) | Handler for form selected event |
|
HandleRequestAction(IHostedApplication, RequestActionEventArgs) | Obsolete. Event handler for the RequestAction event raised by a HostedApplication. |
|
HandleRequestActionStatusEvent(Object, RequestActionEventArgs) | Event handler for status of the requested action |
|
HandleStateChanged(Object, StateChangedEventArgs) | Event handler for when the workItem state (context) has changed. |
|
InitializeApplications() | Initializes the applications. |
|
InitializeApplications(IHostedApplication) | Initialize a single hosted application. |
|
InitializeProxies() | Creates the web service proxies. |
|
invalidateContextObjectCache() | Invalidates the context object cache. |
|
IsDynamicApplication(IHostedApplication) | Determines whether the hosted application is dynamic. |
|
IsExtendedApplication(IHostedApplication) | Determines whether the hosted application is an extended application or not |
|
IsGlobalApplication(Guid) | Determine whether the application is a global application. |
|
IsGlobalApplication(IHostedApplication) | Determine whether the application is a global application. |
|
IsGlobalDynamicApplication(IHostedApplication) | Determines whether the dynamic application is global. |
|
IsHiddenGlobalDynamicApp(IHostedApplication) | Determines whether the dynamic global application is hidden. |
|
IsImplicitAifAction(String) | Determines whether the action is an implicit action. |
|
IsIsolatedApplication(IHostedApplication) | Determines whether the passed in hosted application is an isolated application. |
|
IsNavigationComplete() | Determined whether the navigation is complete. |
|
IsNonGlobalDynamicApplication(IHostedApplication) | Determines whether the dynamic application is non-global. |
|
IsTaggedApplication(IHostedApplication) | Determines whether application is a tagged (global or non-global) application |
|
IsTaggedGlobalApplication(Guid) | Determines whether application is a tagged global application. |
|
IsTaggedGlobalApplication(IHostedApplication) | Determines whether application is a tagged global application. |
|
IsTaggedNonGlobalApplication(Guid) | Determines whether application is a tagged non-global application. |
|
IsTaggedNonGlobalApplication(IHostedApplication) | Determines whether application is a tagged non-global application. |
|
LoadApplications(ArrayList, Boolean, Boolean) | Dynamically loads/unloads hosted applications depending on the status of workflows. |
|
LoadDynamicApplication(ApplicationRecord, Boolean) | Loads the dynamic application from the record |
|
LoadDynamicApplication(String) | Loads the dynamic hosted application. |
|
LoadDynamicApplication(String, Boolean) | Loads the dynamic hosted application |
|
MemberwiseClone() | (Inherited from Object.) |
|
NotifyContextChange() | Notify all the applications of the current context. |
|
NotifyContextChange(Boolean) | Obsolete. Notifies all the applications of the current context. |
|
NotifyContextChange(IHostedApplication) | Notifies a single hosted application of the context change. |
|
QueryInterface(AifInterfaces, IHostedApplication) | Checks whether a particular application implements a specified interface. |
|
RequiresApplicationsReload(ArrayList) | Checks whether all the apps required by the workflow are already loaded and visible. |
|
RequiresContextChangeNotification(IHostedApplication, Boolean) | Determines whether a given application is need to be notified with the change in the context. |
|
SessionChange(Boolean, Guid) | Handles changing sessions |
.jpeg "System_CAPS_static") |
SessionClose(Guid) | Called when a session is closed to tell ISessionController implementing applications a session has been closed. |
|
SessionOpen(Guid, Guid) | Called when a session is opened to tell ISessionController implementing applications that a session has been opened. |
|
SetApplicationEventHandlers(IHostedApplication, Boolean) | Sets the event handlers for the application. |
|
SetContext(Context) | Sets the context. |
|
setContextNoNotify(Context) | Sets the context but does not notify each application |
|
ToString() | (Inherited from Object.) |
|
UnloadDynamicApplication(IHostedApplication) | Unloads the dynamic hosted application. |
Fields
| Name | Description | |
|---|---|---|
.jpeg "System_CAPS_protfield") |
allGlobalApps | Specifies all the global applications (both tagged and untagged) |
|
allGlobalAppsLoaded | Specifies whether all the global applications are loaded or not. |
|
configurationReader | Retrieves the application settings from the configuration/server. |
|
globalHostedApps | Specifies the global applications. |
|
hostedApps | Specifies the array of hosted applications. |
|
initializedApps | Specifies the initialized global applications. |
|
initializedNonGlobalApps | Specifies the initialized non-global applications. |
|
taggedGlobalApps | Specifies the tagged global applications |
|
untaggedNonGlobalApps | Specifies the untagged non-global applications |
Events
| Name | Description | |
|---|---|---|
.jpeg "System_CAPS_pubevent") |
ActionCompleted | Raised when an action is completed. |
|
CurrentContextChange | Raised when context information is changed by some application. |
|
IsolatedFormSelected | Event handler for the FormSelected event from IHostedAppUICommand interface of the isolated applications. |
|
RequestActionStatus | Eventhandler for the status of the request action specifically used for Winform application. |
|
RequestApplicationAdditionFromAutomation | Event handler for the request application addition from automation. |
|
RequestApplicationClose | Handler to notify others that an application is closing. |
|
RequestApplicationCloseFromAutomation | Raised when requesting hosted within the UI to be closed by an automation. |
|
RequestApplicationCreation | Raised when requesting a new application to be created and hosted within UII. |
|
RequestApplicationCreationFromAutomation | Raised when requesting a new application to be created by an automation and hosted within UII. |
|
RequestBeforeApplicationCreation | Raised when requesting a new application to be created and hosted within UII. |
|
RequestDefaultAction | Raised on default action |
|
RequestFocus | Raised to request the focus to a specific application. |
|
SessionChanged | Raised when a session is changed. |
|
SessionClosed | Raised when a session is closed. |
|
SessionOpened | Raised when a session is opened. |
Remarks
One ApplicationHost exists for each session.
Thread Safety
Any public static ( Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
See Also
Return to top
Unified Service Desk 2.0
© 2017 Microsoft. All rights reserved. Copyright