CRMGlobalManager Class

Definition

Namespace:

Microsoft.Crm.UnifiedServiceDesk.Dynamics

Assembly:

Microsoft.Crm.UnifiedServiceDesk.Dynamics.dll

This hosted control is the core to the CRM window management and is the primary control mechanism for the Unified Service Desk for CRM It must be configured as a global application for all implementations

public ref class CRMGlobalManager : Microsoft::Crm::UnifiedServiceDesk::Dynamics::DynamicsBaseHostedControl, Microsoft::Crm::UnifiedServiceDesk::Dynamics::ICRMCustomerSearch2, Microsoft::Crm::UnifiedServiceDesk::Dynamics::ICRMWindowRouter, Microsoft::Uii::Desktop::Core::IContextManager, Microsoft::Uii::Desktop::Cti::Core::ICtiEnabledControlConsumer

public class CRMGlobalManager : Microsoft.Crm.UnifiedServiceDesk.Dynamics.DynamicsBaseHostedControl, Microsoft.Crm.UnifiedServiceDesk.Dynamics.ICRMCustomerSearch2, Microsoft.Crm.UnifiedServiceDesk.Dynamics.ICRMWindowRouter, Microsoft.Uii.Desktop.Core.IContextManager, Microsoft.Uii.Desktop.Cti.Core.ICtiEnabledControlConsumer

type CRMGlobalManager = class
    inherit DynamicsBaseHostedControl
    interface ICRMWindowRouter
    interface ICtiEnabledControlConsumer
    interface ICRMCustomerSearch2
    interface ICRMCustomerSearch
    interface IContextManager

Public Class CRMGlobalManager
Inherits DynamicsBaseHostedControl
Implements IContextManager, ICRMCustomerSearch2, ICRMWindowRouter, ICtiEnabledControlConsumer

Inheritance

UserControl

HostedWpfControl

DynamicsBaseHostedControl

CRMGlobalManager

Implements

ICRMCustomerSearch ICRMCustomerSearch2 ICRMWindowRouter IContextManager ICtiEnabledControlConsumer

Constructors

CRMGlobalManager(Guid, String, String)

Fields

_applicationInitString	(Inherited from HostedWpfControl)
_client	(Inherited from DynamicsBaseHostedControl)
_crmWebResource	(Inherited from DynamicsBaseHostedControl)
actions	Specifies a dictionary of associated actions (Inherited from HostedWpfControl)
actionsByID	Specifies a dictionary of associated actions. (Inherited from HostedWpfControl)
CRMWindowRouter	(Inherited from DynamicsBaseHostedControl)
CurrentContext	Stores the current UII context values (Inherited from DynamicsBaseHostedControl)
desktopAccess	A reference to the IDesktopUserActions interface that provides access to some basic session management functions. (Inherited from DynamicsBaseHostedControl)
InitString	Initialization string that contains information about the control. (Inherited from DynamicsBaseHostedControl)
isSingleSignOnComplete
isSingleSignOnCompleteSignaled
sessionActionSinglton
thisApplication	(Inherited from DynamicsBaseHostedControl)
thisSessionId	(Inherited from DynamicsBaseHostedControl)
UIThread	(Inherited from DynamicsBaseHostedControl)

Properties

actionHistory
AgentID	Gets or sets the agent ID. (Inherited from HostedWpfControl)
AppHostWorkItem	Gets or sets the application host work item. (Inherited from HostedWpfControl)
ApplicationHost	Gets or sets the host application. (Inherited from HostedWpfControl)
ApplicationID	Gets the unique id for this hosted application. (Inherited from HostedWpfControl)
ApplicationName	Gets the name of the hosted application. (Inherited from HostedWpfControl)
AppWithFocus
CanEmbed	Gets a Boolean value that specifies whether the application can be hosted within the UII panels. (Inherited from HostedWpfControl)
ConfigurationReader	Gets or set the hosted controls configuration value reader object. (Inherited from HostedWpfControl)
Context	Gets or sets the session-wide context. Modifying this also notifies other applications of the context change. (Inherited from HostedWpfControl)
controlHeader	Gets or sets the control header. (Inherited from DynamicsBaseHostedControl)
crmManagementSvc	CRM Access management service
ctiSearchDefinitions
DisplayGroup	Gets the name of the UII panel this application is hosted within. (Inherited from HostedWpfControl)
DisplayName	Gets or sets the name of the control. (Inherited from DynamicsBaseHostedControl)
EnableAutoSignOn	Gets the Boolean value that specifies whether auto sign on is enabled. (Inherited from HostedWpfControl)
GlobalApplications
GlobalSettings
HostedApplicationAdapter	(Inherited from HostedWpfControl)
HostedApplications
Icon	Obsolete. Gets or sets the icone. (Inherited from HostedWpfControl)
ImageSource	Gets or sets the image source. (Inherited from HostedWpfControl)
ImplementedAsCcf20	Gets a Boolean value that specifies whether the system runs certain routines as CCF 2.0 or prior. (Inherited from HostedWpfControl)
IsAdapterSessionController	Gets a boolean value that specifies whether the adapter is a session controller. (Inherited from HostedWpfControl)
IsDynamic	Gets or sets a Boolean value that specifies whether this instance is dynamic. (Inherited from HostedWpfControl)
IsGlobal	Gets or sets a Boolean value that specifies whether the hosted application is global. (Inherited from HostedWpfControl)
IsListed	Gets a Boolean value that specifies whether the application is listed in SessionExplorer or CurrentSessionUI (Inherited from HostedWpfControl)
IsManagersSet
IsNavigating	Gets a Boolean value that specifies whether the application is changing its state. (Inherited from HostedWpfControl)
IsTagged	Gets or sets a Boolean value that specifies whether the application is dependent on workflow. (Inherited from HostedWpfControl)
languageTranslation
localSession	Gets or sets a reference to the session where this control exists. The session reference is used as input to many Global Manager functions. (Inherited from DynamicsBaseHostedControl)
localSessionManager	Gets or sets a reference to the session manager. localSession is one of the sessions contained in the session manager. (Inherited from DynamicsBaseHostedControl)
MinimumSize	Gets or sets the minimum size up to which the control can be resized. (Inherited from HostedWpfControl)
OptimumSize	Gets the size the optimum size of the application’s window. (Inherited from HostedWpfControl)
PanelWithFocus
RegisteredKeyShortcuts	(Inherited from DynamicsBaseHostedControl)
SafeDispatcher	(Inherited from DynamicsBaseHostedControl)
scriptDefinitions
searchDefinitions
SessionCount
SessionManager	Sets the session manager reference. (Inherited from DynamicsBaseHostedControl)
Text	Gets or sets the text for the window or tab control containing this application. (Inherited from HostedWpfControl)
TopLevelWindow	Obsolete. Gets the top level window of this hosted app. (Inherited from HostedWpfControl)
TopLevelWpfWindow	Gets the top level wpf window of the hosted application. (Inherited from HostedWpfControl)
usdActions
usdAgentScriptAction
usdAgentScriptActionMap
usdAgentScriptAnswerActionMap
usdAnswer
usdForms
usdScriptTaskTrigger
usdSessionInfo
usdSubActionsMap
usdSubjects
usdTask
usdTaskAnswer
usdToolbarActionMap
usdToolbarButton
usdToolbarStrip
usdToolbarStripMap
UserCanClose	Gets or sets whether a user can close the control. (Inherited from DynamicsBaseHostedControl)
WindowRules

Methods

ActionByName(String)
adapter_AdapterContextChangedEvent(Context)	(Inherited from HostedWpfControl)
adapter_AdapterFireRequestActionEvent(RequestActionEventArgs)	(Inherited from HostedWpfControl)
adapter_AdapterRequestActionEvent(String, String, String)	(Inherited from HostedWpfControl)
AddAction(Int32, String, String)	Adds an action for use from one application or the UII core to this application. (Inherited from HostedWpfControl)
AddImplicitAction(String)	Adds an implicit action. (Inherited from HostedWpfControl)
AddServerSetting(String, String)
AddShortcut(KeyGesture, Object, Boolean)	(Inherited from DynamicsBaseHostedControl)
AddShortcut(String, Object, Boolean)	(Inherited from DynamicsBaseHostedControl)
AsyncDoRoute(String, String, String, String, String, Boolean, Boolean, Boolean, CRMGlobalManager+RouteType, List<String>, Boolean, Session)
BlockPopupErrors(IWebBrowser2)	Blocks the pop up errors. (Inherited from DynamicsBaseHostedControl)
BuildCustomerResponse(String, DynamicsCustomerRecord, Boolean, Guid)	Build and send a response to the Customer Search Result.
CheckButtonStates()	(Inherited from DynamicsBaseHostedControl)
CheckControlHeaderVisibility()	Checks whether it is an appropriate time to show the control header. Derived classes may call this to update the visibility based on actions taken in the derived class. (Inherited from DynamicsBaseHostedControl)
CheckUpdateContact()
Close()	Cleans up this control before removing it from the UI. (Inherited from DynamicsBaseHostedControl)
CopyLogicalEntityToContext(String)
CreateActionDefinitionFromEntity(String, Entity)
CreateBackgroundSession(CustomerEntity, Guid)
CreateBackgroundSessionForCustomer(DynamicsCustomerRecord)
CreateEntityUrl(String, String)
CreateEntityUrl(String, String, Boolean)
CreateEntityUrl(String, String, String, Boolean)
CreateInstance(String, String, WorkItem)	(Inherited from HostedWpfControl)
CreateSession(CustomerEntity, Guid)
CreateSessionForCustomer(DynamicsCustomerRecord)
CRMWindowRouter_DesktopReady(Object, EventArgs)	Occurs on startup when all the desktop initialization in Unified Service Desk has completed and the connections to Microsoft Dynamics 365 have been established. (Inherited from DynamicsBaseHostedControl)
DeparentIE()	Obsolete. Used by an obselete workaround for SetParent use in User Interface Integration (UII). (Inherited from DynamicsBaseHostedControl)
DesktopLoadingComplete()
DetectLanguage(String, String, String)
DoAction(Action, String)	Obsolete. Method to override in the implemention to handle the action. (Inherited from HostedWpfControl)
DoAction(Int32, String)	Obsolete. Called to perform the action configured in the database. (Inherited from HostedWpfControl)
DoAction(RequestActionEventArgs)
DoAction(String, String)	Obsolete. Called to perform the action configured in the database. (Inherited from HostedWpfControl)
DoActionCanExecute(Object, CanExecuteRoutedEventArgs)	(Inherited from DynamicsBaseHostedControl)
DoActionExecuted(Object, ExecutedRoutedEventArgs)	(Inherited from DynamicsBaseHostedControl)
DoActionExecutedInternal(String)	(Inherited from DynamicsBaseHostedControl)
DoDefaultAction()	Performs this hosted application's default action, if there is one. (Inherited from HostedWpfControl)
DoRoute(Session, String, String, String, String, Boolean, Boolean, Boolean, CRMGlobalManager+RouteType, List<String>)
DoRoute(Session, String, String, String, String, String, CRMGlobalManager+RouteType, List<String>)
DoRouteDetermineRule(Session, String, String, String, String, String, CRMGlobalManager+RouteType, List<String>)	This function is meant to determine which routing rule would be used if DoRoute was called. No action is taken with this function.
DoRouteFromSearch(Session, String, String, Guid, List<String>)
DoRouteOnLoad(Session, String, String, Guid, List<String>)	used for OnLoad routes only This method only handles OnLoad routes that are default A default onLoad route is one that occurs once after all the other OnLoad routes are determined and executed and after a page is loaded.
DoRouteOnLoad(Session, String, String, String, String, String, Boolean, Boolean, CRMGlobalManager+RouteType, List<String>)
DoRoutePopup(Session, String, String, String, Boolean, Boolean)	This method is only used by popup handlers and is intended to return a bool to signal that the popup should be cancelled or not
DoRoutePopup(Session, String, String, String, String)
DoSearchFromCtiRequest(String)	Executes the Search command per the requested action.
EntityNameFromType(Int32)
EntityTypeFromName(String)
ErrorMsg(String, String)	Displays the error message. (Inherited from HostedWpfControl)
ExecuteActions(List<ActionDefinition>, String)	(Inherited from DynamicsBaseHostedControl)
ExecuteActions(List<ActionDefinition>, String, Dictionary<String,String>)
ExecuteActions(Session, List<ActionDefinition>, String, Dictionary<String,String>)
ExecuteOnDataAvailable(ActionSave)
FireChangeContext(ContextEventArgs)	Informs all the other applications that the context has changed. (Inherited from HostedWpfControl)
FireEvent(Session, String, String)
FireEvent(Session, String, String, Dictionary<String,String>)
FireEvent(String)	Fires and event to the event configuration for the control. It is executed on the same session that the control lives in. (Inherited from DynamicsBaseHostedControl)
FireEvent(String, Dictionary<String,String>)	Fires and event to the event configuration for the control. It is executed on the same session that the control lives in. (Inherited from DynamicsBaseHostedControl)
FireEvent(String, String)
FireEvent(String, String, Dictionary<String,String>)
FireRequestAction(RequestActionEventArgs)	Sends a request to perform some action to another application. (Inherited from HostedWpfControl)
GetApp(Session, String)
GetApp(String)	Obtains a reference to the specified hosted control by name, on the same session as this hosted control. (Inherited from DynamicsBaseHostedControl)
GetConfigurationValue(String)	(Inherited from DynamicsBaseHostedControl)
GetCRMWebResource(String)
GetCurrentContext()	(Inherited from DynamicsBaseHostedControl)
GetCurrentlyVisableHostedApplicationInAPanel(String, String)	Utility function to get the currently visable app in anygiven UII window
GetDesktopRecord()	Retrieves the DynamicsCustomerRecord which contains all the data about the current customer. (Inherited from DynamicsBaseHostedControl)
GetEntity(EntityReference, String, String, String, Entity)	This version captures the Entity that is found from the Entity Searches configuration. It also returns the actual search definition entry that would contain the fetchXml that was executed
GetEntity(String, String, String)
GetEntity(String, String, String, Entity)	This version captures the Entity that is found from the Entity Searches configuration. It also returns the actual search definition entry that would contain the fetchXml that was executed
GetIconList()	Gets the list of icons. (Inherited from HostedWpfControl)
GetImageSourceList()	Gets the list of image source. (Inherited from HostedWpfControl)
GetMetadata(String)
GetResourceDictionary(String, String)	(Inherited from DynamicsBaseHostedControl)
GetScriptlet(String)
GetSearchControlAppName()
GetServerSetting(String)
GetSessionManager()
GetStateData()	Gets the application state data. (Inherited from HostedWpfControl)
GetStringResource(String)
GetStringResource(String, String)
GetUserDisplayName()
HandleRequestAction(Object, RequestActionEventArgs)	This is for internal UII use only. Please do not use directly. Public visibility necessary for CAB integration. (Inherited from HostedWpfControl)
HandleRequestDefaultAction(Object, DataEventArgs<ApplicationProperties>)	This is for internal UII use only. Please do not use directly. Public visibility necessary for CAB integration. (Inherited from HostedWpfControl)
HandleShowTab(CRMToolbarButton)	(Inherited from DynamicsBaseHostedControl)
IdFromUrl(String)
Initialize()
InitializeFocusSelection()
InitializeUsd()	Begins the initialization of the Usd Process
IsActivity(String)
IsAppLoaded(String)
IsDesktopReady()
loadAdapter(XmlDocument, Object)	(Inherited from HostedWpfControl)
LoadApplicationEntity(String)
LoadCachedData(String, String)	Loads cached entity. If it's not already in the cache, it loads it into the cache and then returns the data
LoadEvents(String)
LoadTranslation()	loads the translation tables for this user.
LoadUsdConfig()	Starts the loading of USD's configuration
LogException(Exception, TraceEventType)	Logs an exception with information about the trace event type that caused the exception. (Inherited from DynamicsBaseHostedControl)
LogException(String, TraceEventType, Exception)	Logs an exception with user-provided error message and information about the trace event type that caused the exception. (Inherited from DynamicsBaseHostedControl)
NavigateBeforeUnLoad()	(Inherited from DynamicsBaseHostedControl)
NotifyContextChange(Context)
NotifyContextChange(String)	Obsolete. Notifies the application of a context change. (Inherited from HostedWpfControl)
OnCreateAutomationPeer()	(Inherited from DynamicsBaseHostedControl)
OnShortcutKeysInvoked(Object, ShortcutKeyInvokedArgs)	(Inherited from DynamicsBaseHostedControl)
OnVisualParentChanged(DependencyObject)	(Inherited from DynamicsBaseHostedControl)
PopulateToolbars(ToolBarTray)	The control writer should call PopulateToolbars passing a reference to their ToolbarTray. This function will read the configuration and populate the buttons based on the toolbar configuration assigned to this hosted control on the server. (Inherited from DynamicsBaseHostedControl)
PostWindowRoute(String)	An overridable function that DynamicsBaseHostedControl calls after it has routed a window in response to it's action handlers (new, open, etc). The base class version of this fires an event called "PopupRouted" so it can be handled in configuration. (Inherited from DynamicsBaseHostedControl)
PreCreateSession(DynamicsCustomerRecord, Boolean)
ReadCachableEntity(String, String, String, String, Boolean)
RefreshCachedEntry(List<Entity>, String, String)
RefreshHostedApplications()
RegisterAsyncDollarReturnUpdate(String, String)
RemoveAllShortcuts()	(Inherited from DynamicsBaseHostedControl)
RemoveShortcut(KeyGesture)	(Inherited from DynamicsBaseHostedControl)
RemoveShortcut(String)	(Inherited from DynamicsBaseHostedControl)
ReparentIE()	Obsolete. (Inherited from DynamicsBaseHostedControl)
ReplaceParametersInCurrentSession(String)	Replaces USD parameters in a string
ReplaceParametersInCurrentSession(String, Dictionary<String,String>)
RetrieveView(Int32, String)
SafeDispatcherUnhandledExceptionHandler(Object, SafeDispatcherUnhandledExceptionEventArgs)	Represents the method that will handle the SafeDispatcherUnhandledException event. (Inherited from DynamicsBaseHostedControl)
SessionChange(Boolean, Guid)
SessionCloseEvent(Session)
SessionCloseEvent(SessionControllerEventArgs)
SessionCreatedEvent(Session)
SessionHideEvent(Session)
SessionShowEvent(Session)
SetAppWithFocus(IHostedApplication, IPanel, String)
SetContext(Context)	Obsolete. This is used to set the context from applicationhost without causing further notifications. (Inherited from HostedWpfControl)
SetContext(String)	Obsolete. This is used to set the context from applicationhost without causing further notifications. (Inherited from HostedWpfControl)
SetDesktopUserActionsAccess(IDesktopUserActions)	System calls this function to set the IDesktopUserActions interface. (Inherited from DynamicsBaseHostedControl)
SetManagers(Object, Object)
SetStateData(String)	Sets the StateData ofthe controls (Inherited from HostedWpfControl)
SetVisualProperty(String, String, String)	Set the visual properties such as height, width, and visibility of a hosted control. (Inherited from DynamicsBaseHostedControl)
SystemParameters_StaticPropertyChanged(Object, PropertyChangedEventArgs)
TraceWindowRoute(String, CRMGlobalManager+WindowRoute, Dictionary<String,String>, ConditionResult)
Translate(String)
Translate(String, String, String, String, String)
UIIEventCanExecute(Object, CanExecuteRoutedEventArgs)	(Inherited from DynamicsBaseHostedControl)
UIIEventExecuted(Object, ExecutedRoutedEventArgs)	(Inherited from DynamicsBaseHostedControl)
UpdateReplaceableParameters(Session, Entity, Entity)
UpdateReplaceableParameters(Session, Entity, String)	This updates the session store of replacement fields that can be used as replacement parameters
USDDynamicInitialize()	Special initialization method that is invoked every time an instance of this control is created. (Inherited from DynamicsBaseHostedControl)

Events

ActionCompleted	Obsolete. For internal use only (Inherited from HostedWpfControl)
ActionCompletedEvent	Event to notify the hosted application that an action has completed. (Inherited from HostedWpfControl)
ActionHistoryAdded
AppWithFocusChanged
ChangeContext	Notifies the hosted application that the context has changed. (Inherited from HostedWpfControl)
DesktopLoadFailure	Raised to notify a caller of a critical failure
DesktopLoadingMessageUpdate	Raised to notify a caller that the UI splash Screen should be updated.
DesktopReady
RequestAction	Obsolete. For internal use only (Inherited from HostedWpfControl)
RequestActionEvent	Requests the action of another application to be invoked. (Inherited from HostedWpfControl)
RequestActionStatusEvent	Notifies the hosted application of action status. (Inherited from HostedWpfControl)

Explicit Interface Implementations

IContextManager.DesktopContextChange(Context)
IContextManager.GenerateSessionName(CustomerEntity)
IContextManager.RenewSession(Context)
IContextManager.SetContext(CustomerEntity)
ISessionInfoConsumer.LocalSession	Sets the local session. (Inherited from DynamicsBaseHostedControl)