DynamicsBaseHostedControl Class
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.
Base class for creating native Unified Service Desk hosted controls.
public ref class DynamicsBaseHostedControl : Microsoft::Uii::Csr::Aif::HostedApplication::HostedWpfControl, Microsoft::Crm::UnifiedServiceDesk::Dynamics::ISessionInfoConsumer, Microsoft::Crm::UnifiedServiceDesk::Dynamics::IUsdControl, Microsoft::Uii::Desktop::Core::IDesktopUserActionsConsumerpublic class DynamicsBaseHostedControl : Microsoft.Uii.Csr.Aif.HostedApplication.HostedWpfControl, Microsoft.Crm.UnifiedServiceDesk.Dynamics.ISessionInfoConsumer, Microsoft.Crm.UnifiedServiceDesk.Dynamics.IUsdControl, Microsoft.Uii.Desktop.Core.IDesktopUserActionsConsumertype DynamicsBaseHostedControl = class
inherit HostedWpfControl
interface IDesktopUserActionsConsumer
interface IUsdControl
interface ISessionInfoConsumerPublic Class DynamicsBaseHostedControl
Inherits HostedWpfControl
Implements IDesktopUserActionsConsumer, ISessionInfoConsumer, IUsdControl- Inheritance
- Derived
- Implements
Remarks
A hosted control in Unified Service Desk is a .NET component or a CRM/external webpage that is hosted within the Unified Service Desk application. More information:Unified Service Desk Hosted Controls
Constructors
| DynamicsBaseHostedControl() |
Initializes a new instance of the DynamicsBaseHostedControl class. |
| DynamicsBaseHostedControl(Guid, String, String) |
Initializes a new instance of the DynamicsBaseHostedControl class setting the vales specified in the parameters list. |
Fields
| _applicationInitString | (Inherited from HostedWpfControl) |
| _client | |
| _crmWebResource | |
| actions |
Specifies a dictionary of associated actions (Inherited from HostedWpfControl) |
| actionsByID |
Specifies a dictionary of associated actions. (Inherited from HostedWpfControl) |
| CRMWindowRouter | |
| CurrentContext |
Stores the current UII context values |
| desktopAccess |
A reference to the IDesktopUserActions interface that provides access to some basic session management functions. |
| InitString |
Initialization string that contains information about the control. |
| thisApplication | |
| thisSessionId | |
| UIThread | |
Properties
| 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) |
| 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. |
| 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. |
| EnableAutoSignOn |
Gets the Boolean value that specifies whether auto sign on is enabled. (Inherited from HostedWpfControl) |
| HostedApplicationAdapter | (Inherited from HostedWpfControl) |
| 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) |
| 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) |
| 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. |
| localSessionManager |
Gets or sets a reference to the session manager. localSession is one of the sessions contained in the session manager. |
| 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) |
| RegisteredKeyShortcuts | |
| SafeDispatcher | |
| SessionManager |
Sets the session manager reference. |
| 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) |
| UserCanClose |
Gets or sets whether a user can close the control. |
Methods
| 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) |
| AddShortcut(KeyGesture, Object, Boolean) | |
| AddShortcut(String, Object, Boolean) | |
| BlockPopupErrors(IWebBrowser2) |
Blocks the pop up errors. |
| CheckButtonStates() | |
| 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. |
| Close() |
Cleans up this control before removing it from the UI. |
| CreateInstance(String, String, WorkItem) | (Inherited from HostedWpfControl) |
| 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. |
| DeparentIE() |
Obsolete.
Used by an obselete workaround for SetParent use in User Interface Integration (UII). |
| DesktopLoadingComplete() |
Allows a global hosted control to get notification about the desktop loading being completed. |
| DesktopReady() |
Occurs on startup when all the desktop initialization in Unified Service Desk has completed and the connections to Microsoft Dynamics 365 have been established. |
| 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) |
Action handler for the hosted control. |
| DoAction(String, String) |
Obsolete.
Called to perform the action configured in the database. (Inherited from HostedWpfControl) |
| DoActionCanExecute(Object, CanExecuteRoutedEventArgs) | |
| DoActionExecuted(Object, ExecutedRoutedEventArgs) | |
| DoActionExecutedInternal(String) | |
| DoDefaultAction() |
Performs this hosted application's default action, if there is one. (Inherited from HostedWpfControl) |
| ErrorMsg(String, String) |
Displays the error message. (Inherited from HostedWpfControl) |
| ExecuteActions(List<ActionDefinition>, String) | |
| ExecuteActions(List<ActionDefinition>, String, Dictionary<String,String>) | |
| FindElement<T>(DependencyObject, String) | |
| FireChangeContext(ContextEventArgs) |
Informs all the other applications that the context has changed. (Inherited from HostedWpfControl) |
| FireEvent(String) |
Fires and event to the event configuration for the control. It is executed on the same session that the control lives in. |
| 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. |
| FireRequestAction(RequestActionEventArgs) |
Sends a request to perform some action to another application. (Inherited from HostedWpfControl) |
| GetApp(String) |
Obtains a reference to the specified hosted control by name, on the same session as this hosted control. |
| GetConfigurationValue(String) | |
| GetCurrentContext() | |
| GetDesktopRecord() |
Retrieves the DynamicsCustomerRecord which contains all the data about the current customer. |
| GetIconList() |
Gets the list of icons. (Inherited from HostedWpfControl) |
| GetImageSourceList() |
Gets the list of image source. (Inherited from HostedWpfControl) |
| GetResourceDictionary(String, String) | |
| GetStateData() |
Gets the application state data. (Inherited from HostedWpfControl) |
| 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) | |
| Initialize() |
Initialize function called by UII when a hosted control is loaded |
| loadAdapter(XmlDocument, Object) | (Inherited from HostedWpfControl) |
| LogException(Exception, TraceEventType) |
Logs an exception with information about the trace event type that caused the exception. |
| LogException(String, TraceEventType, Exception) |
Logs an exception with user-provided error message and information about the trace event type that caused the exception. |
| NavigateBeforeUnLoad() | |
| NotifyContextChange(Context) |
UII function that provides notification whenever Replacement parameters or the context have changed. This function is called frequently so no long running code should be placed into this override. It is recommended that you avoid using this override except when it is absolutely necessary. |
| NotifyContextChange(String) |
Obsolete.
Notifies the application of a context change. (Inherited from HostedWpfControl) |
| OnCreateAutomationPeer() | |
| OnShortcutKeysInvoked(Object, ShortcutKeyInvokedArgs) | |
| OnVisualParentChanged(DependencyObject) | |
| 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. |
| 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. |
| RemoveAllShortcuts() | |
| RemoveShortcut(KeyGesture) | |
| RemoveShortcut(String) | |
| ReparentIE() | |
| SafeDispatcherUnhandledExceptionHandler(Object, SafeDispatcherUnhandledExceptionEventArgs) |
Represents the method that will handle the SafeDispatcherUnhandledException event. |
| SessionChange(Boolean, Guid) |
Activates or deactivates the session. Not called for non-global applications. (Inherited from HostedWpfControl) |
| SessionCloseEvent(Session) |
Override that is called when a session is closing. |
| SessionCreatedEvent(Session) |
Called by the system to indicate a session was created |
| SessionHideEvent(Session) |
Called by the system to indicate that a session is being hidden |
| SessionShowEvent(Session) |
Called by the system to indicate that a session is being shown |
| 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. |
| 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. |
| SystemParameters_StaticPropertyChanged(Object, PropertyChangedEventArgs) | |
| UIIEventCanExecute(Object, CanExecuteRoutedEventArgs) | |
| UIIEventExecuted(Object, ExecutedRoutedEventArgs) | |
| USDDynamicInitialize() |
Special initialization method that is invoked every time an instance of this control is created. |
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) |
| ChangeContext |
Notifies the hosted application that the context has changed. (Inherited from HostedWpfControl) |
| 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
| ISessionInfoConsumer.LocalSession |
Sets the local session. |