SessionTabsControl 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.
Represents the interaction logic for WpfSessionTabsControl.xaml
public ref class SessionTabsControl : Microsoft::Crm::UnifiedServiceDesk::Dynamics::DynamicsBaseHostedControl, Microsoft::Uii::Desktop::Core::ISessionExplorer, Microsoft::Uii::Desktop::Core::ISessionExplorer2, System::Windows::Markup::IComponentConnectorpublic class SessionTabsControl : Microsoft.Crm.UnifiedServiceDesk.Dynamics.DynamicsBaseHostedControl, Microsoft.Uii.Desktop.Core.ISessionExplorer, Microsoft.Uii.Desktop.Core.ISessionExplorer2, System.Windows.Markup.IComponentConnectortype SessionTabsControl = class
inherit DynamicsBaseHostedControl
interface ISessionExplorer2
interface ISessionExplorer
interface IHostedApplication3
interface IHostedApplication2
interface IHostedApplication
interface IComponentConnectorPublic Class SessionTabsControl
Inherits DynamicsBaseHostedControl
Implements IComponentConnector, ISessionExplorer, ISessionExplorer2- Inheritance
- Implements
-
IHostedApplication IHostedApplication2 IHostedApplication3 ISessionExplorer Microsoft.Uii.Desktop.Core.ISessionExplorer2 IComponentConnector
Constructors
| SessionTabsControl() |
Initializes a new instance of the SessionTabControl class. |
| SessionTabsControl(Guid, String, String) |
Initializes a new instance of the SessionTabControl class. |
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) |
| appsUI |
Specifies the desktop application UI. |
| 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) |
| isolatedAppWithPendingUIOperation | |
| thisApplication | (Inherited from DynamicsBaseHostedControl) |
| thisSessionId | (Inherited from DynamicsBaseHostedControl) |
| UIThread | (Inherited from DynamicsBaseHostedControl) |
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) |
| AppsUI |
Gets or sets the application UI. |
| CanEmbed |
Gets a Boolean value that specifies whether the application can be hosted within the UII panels. (Inherited from HostedWpfControl) |
| CloseButtonVisibility |
Gets a value that specifies whether the close button on the session tabs control is visible or not. |
| 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) |
| ControlHeight |
Gets or sets the height of the control |
| 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) |
| 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) |
| IsControlVisible |
Gets or sets the Boolean value that specifies whether the control is displayed. |
| 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 or sets the Boolean value that specifies whether the control is listed. |
| 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. (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) |
| RegisteredKeyShortcuts | (Inherited from DynamicsBaseHostedControl) |
| SafeDispatcher | (Inherited from DynamicsBaseHostedControl) |
| 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) |
| UserCanClose |
Gets or sets whether a user can close the control. (Inherited from DynamicsBaseHostedControl) |
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) |
| AddApplicationNode(Session, IHostedApplication) |
Adds a single application node. |
| AddImplicitAction(String) |
Adds an implicit action. (Inherited from HostedWpfControl) |
| AddSession(Session, Boolean) |
Adds the session to the ComboBox control if it’s not already there. |
| AddShortcut(KeyGesture, Object, Boolean) | (Inherited from DynamicsBaseHostedControl) |
| AddShortcut(String, Object, Boolean) | (Inherited from DynamicsBaseHostedControl) |
| AddWorkflowApplicationNodes(Session, Boolean) |
Adds tagged global and non-global application nodes to the Application Explorer. |
| BlockPopupErrors(IWebBrowser2) |
Blocks the pop up errors. (Inherited from DynamicsBaseHostedControl) |
| 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) |
| Close() |
Cleans up this control before removing it from the UI. (Inherited from DynamicsBaseHostedControl) |
| CloseSessionTabCanExecute(Object, CanExecuteRoutedEventArgs) |
Determines whether to execute close session command or not, when the user clicks on ‘X’ on the session tabs control. |
| CloseSessionTabExecuted(Object, ExecutedRoutedEventArgs) | |
| ControlRefresh() |
Forces the control to invalidate its client area and immediately redraw itself and any child controls. |
| 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. (Inherited from DynamicsBaseHostedControl) |
| DeparentIE() |
Obsolete.
Used by an obselete workaround for SetParent use in User Interface Integration (UII). (Inherited from DynamicsBaseHostedControl) |
| DesktopLoadingComplete() |
Allows a global hosted control to get notification about the desktop loading being completed. (Inherited from DynamicsBaseHostedControl) |
| DesktopReady() | |
| 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) |
Called by UII whenever an action is about to be performed on the application. |
| 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) |
| ErrorMsg(String, String) |
Displays the error message. (Inherited from HostedWpfControl) |
| ExecuteActions(List<ActionDefinition>, String, Dictionary<String,String>) | (Inherited from DynamicsBaseHostedControl) |
| ExecuteActions(List<ActionDefinition>, String) | (Inherited from DynamicsBaseHostedControl) |
| FireChangeContext(ContextEventArgs) |
Informs all the other applications that the context has changed. (Inherited from HostedWpfControl) |
| 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) |
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) |
| FireRequestAction(RequestActionEventArgs) |
Sends a request to perform some action to another application. (Inherited from HostedWpfControl) |
| FocusOnApplication(IHostedApplication) |
Selects the given application's node in the treeview. |
| 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) |
| GetCurrentContext() | (Inherited from DynamicsBaseHostedControl) |
| GetDesktopRecord() |
Retrieves the DynamicsCustomerRecord which contains all the data about the current customer. (Inherited from DynamicsBaseHostedControl) |
| GetIconList() |
Gets the list of icons. (Inherited from HostedWpfControl) |
| GetImageSourceList() |
Gets the list of image source. (Inherited from HostedWpfControl) |
| GetResourceDictionary(String, String) | (Inherited from DynamicsBaseHostedControl) |
| 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) | (Inherited from DynamicsBaseHostedControl) |
| HideChatIndicator(Object, ChatSessionEventArgs) | |
| Initialize() |
Initialize function called by UII when a hosted control is loaded (Inherited from DynamicsBaseHostedControl) |
| InitializeComponent() |
Initializes the components. |
| loadAdapter(XmlDocument, Object) | (Inherited from HostedWpfControl) |
| 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) |
Notifies the application of a context change. |
| 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) |
| RefreshView() |
Refreshes the session explorer UI. |
| RemoveAllShortcuts() | (Inherited from DynamicsBaseHostedControl) |
| RemoveApplicationNode(Session, IHostedApplication) |
Removes a single application node from the session explorer. |
| RemoveSession(Session) |
Removes a session from the session explorer tree. |
| RemoveShortcut(KeyGesture) | (Inherited from DynamicsBaseHostedControl) |
| RemoveShortcut(String) | (Inherited from DynamicsBaseHostedControl) |
| RemoveWorkflowApplicationNodes(Session) |
Remove the applications for a session from the DefaultSessionExplorerControl |
| ReparentIE() |
Obsolete.
(Inherited from DynamicsBaseHostedControl)
|
| SafeDispatcherUnhandledExceptionHandler(Object, SafeDispatcherUnhandledExceptionEventArgs) |
Represents the method that will handle the SafeDispatcherUnhandledException event. (Inherited from DynamicsBaseHostedControl) |
| 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. (Inherited from DynamicsBaseHostedControl) |
| SessionCreatedEvent(Session) |
Called by the system to indicate a session was created (Inherited from DynamicsBaseHostedControl) |
| SessionHideEvent(Session) |
Called by the system to indicate that a session is being hidden (Inherited from DynamicsBaseHostedControl) |
| SessionShowEvent(Session) |
Called by the system to indicate that a session is being shown (Inherited from DynamicsBaseHostedControl) |
| 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) |
| SetSessionName(String, Session) | |
| 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) |
| ShowChatIndicator(Object, ChatSessionEventArgs) | |
| SwitchSessionHandler(Object, SwitchSessionEventArgs) | |
| SystemParameters_StaticPropertyChanged(Object, PropertyChangedEventArgs) | (Inherited from DynamicsBaseHostedControl) |
| UIIEventCanExecute(Object, CanExecuteRoutedEventArgs) | (Inherited from DynamicsBaseHostedControl) |
| UIIEventExecuted(Object, ExecutedRoutedEventArgs) | (Inherited from DynamicsBaseHostedControl) |
| 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) |
| 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) |
| SEHostedAppSelected |
Raised when a hosted application is selected. |
| SessionClosed |
Raised when a session is closed. |
Explicit Interface Implementations
| IComponentConnector.Connect(Int32, Object) | |
| ISessionInfoConsumer.LocalSession |
Sets the local session. (Inherited from DynamicsBaseHostedControl) |