HostedControl Class
Applies To: Dynamics 365 (online), Dynamics 365 (on-premises), Dynamics CRM 2013, Dynamics CRM 2015, Dynamics CRM 2016
This control makes it easier to create WinForm applications by wrapping the most common operations into a base class.
Namespace: Microsoft.Uii.Csr
Assembly: Microsoft.Uii.Csr.Core (in Microsoft.Uii.Csr.Core.dll)
Inheritance Hierarchy
System.Object
System.MarshalByRefObject
System.ComponentModel.Component
System.Windows.Forms.Control
System.Windows.Forms.ScrollableControl
System.Windows.Forms.ContainerControl
System.Windows.Forms.UserControl
Microsoft.Uii.Csr.HostedControl
Microsoft.Uii.Csr.HostedControlEx
Microsoft.Uii.Desktop.Cti.Controls.CtiDesktopManager
Microsoft.Uii.Desktop.Cti.Controls.CtiHostedControl
Syntax
[SmartPartAttribute]
public class HostedControl : UserControl, IHostedApplication4,
IHostedApplication3, IHostedApplication2, IHostedApplication
<SmartPartAttribute>
Public Class HostedControl
Inherits UserControl
Implements IHostedApplication4, IHostedApplication3, IHostedApplication2,
IHostedApplication
Constructors
| Name | Description | |
|---|---|---|
.jpeg "System_CAPS_pubmethod") |
HostedControl() | Hosted Control constructor |
|
HostedControl(Guid, String, String) | Hosted Control constructor |
Properties
| Name | Description | |
|---|---|---|
.jpeg "System_CAPS_pubproperty") |
AccessibilityObject | (Inherited from Control.) |
|
AccessibleDefaultActionDescription | (Inherited from Control.) |
|
AccessibleDescription | (Inherited from Control.) |
|
AccessibleName | (Inherited from Control.) |
|
AccessibleRole | (Inherited from Control.) |
|
ActiveControl | (Inherited from ContainerControl.) |
|
AgentID | Useful for management apps that need to know who is logged into them. This is used for apps supporting the IHostedApplication2 interface. |
|
AllowDrop | (Inherited from Control.) |
|
Anchor | (Inherited from Control.) |
|
AppHostWorkItem | For CAB integration purposes only; allows injection of current WorkItem |
.jpeg "System_CAPS_protproperty") |
ApplicationHost | Intended to provide access to the containing ApplicationHost instance to support advanced hosting senarios. Usage may increase coupling between AIF hosted applications, running counter to the architectural intent of AIF. Setter is for internal use only, it will have no effect. |
|
ApplicationID | Returns the unique id for this hosted application. |
|
ApplicationName | Returns the name of the hosted application as given in the database. |
|
AutoScaleDimensions | (Inherited from ContainerControl.) |
|
AutoScaleFactor | (Inherited from ContainerControl.) |
|
AutoScaleMode | (Inherited from ContainerControl.) |
|
AutoScroll | (Inherited from ScrollableControl.) |
|
AutoScrollMargin | (Inherited from ScrollableControl.) |
|
AutoScrollMinSize | (Inherited from ScrollableControl.) |
|
AutoScrollOffset | (Inherited from Control.) |
|
AutoScrollPosition | (Inherited from ScrollableControl.) |
|
AutoSize | (Inherited from UserControl.) |
|
AutoSizeMode | (Inherited from UserControl.) |
|
AutoValidate | (Inherited from UserControl.) |
|
BackColor | (Inherited from Control.) |
|
BackgroundImage | (Inherited from Control.) |
|
BackgroundImageLayout | (Inherited from Control.) |
|
BindingContext | (Inherited from ContainerControl.) |
|
BorderStyle | (Inherited from UserControl.) |
|
Bottom | (Inherited from Control.) |
|
Bounds | (Inherited from Control.) |
|
CanEmbed | Returns true if the application can be hosted within the UII panels. False if the application can only be integrated with UII via scripts. |
|
CanEnableIme | (Inherited from ContainerControl.) |
|
CanFocus | (Inherited from Control.) |
|
CanRaiseEvents | (Inherited from Control.) |
|
CanSelect | (Inherited from Control.) |
|
Capture | (Inherited from Control.) |
|
CausesValidation | (Inherited from Control.) |
|
ClientRectangle | (Inherited from Control.) |
|
ClientSize | (Inherited from Control.) |
|
CompanyName | (Inherited from Control.) |
|
ConfigurationReader | Gets or set the hosted controls Configuration Value reader object. |
|
Container | (Inherited from Component.) |
|
ContainsFocus | (Inherited from Control.) |
|
Context | Contains session-wide context. Modifying this also notifies other applications of the context change. |
|
ContextMenu | (Inherited from Control.) |
|
ContextMenuStrip | (Inherited from Control.) |
|
Controls | (Inherited from Control.) |
|
Created | (Inherited from Control.) |
|
CreateParams | (Inherited from UserControl.) |
|
CurrentAutoScaleDimensions | (Inherited from ContainerControl.) |
|
Cursor | (Inherited from Control.) |
|
DataBindings | (Inherited from Control.) |
|
DefaultCursor | (Inherited from Control.) |
|
DefaultImeMode | (Inherited from Control.) |
|
DefaultMargin | (Inherited from Control.) |
|
DefaultMaximumSize | (Inherited from Control.) |
|
DefaultMinimumSize | (Inherited from Control.) |
|
DefaultPadding | (Inherited from Control.) |
|
DefaultSize | (Inherited from UserControl.) |
|
DesignMode | (Inherited from Component.) |
|
DisplayGroup | The name of the UII panel this application is hosted within. This is taken from the database Application table initialization XML. |
|
DisplayRectangle | (Inherited from ScrollableControl.) |
|
Disposing | (Inherited from Control.) |
|
Dock | (Inherited from Control.) |
|
DoubleBuffered | (Inherited from Control.) |
|
EnableAutoSignOn | Get the value of private member variable enableAutoSignOn. |
|
Enabled | (Inherited from Control.) |
|
Events | (Inherited from Component.) |
|
Focused | (Inherited from Control.) |
|
Font | (Inherited from Control.) |
|
FontHeight | (Inherited from Control.) |
|
ForeColor | (Inherited from Control.) |
|
Handle | (Inherited from Control.) |
|
HasChildren | (Inherited from Control.) |
|
Height | (Inherited from Control.) |
|
HorizontalScroll | (Inherited from ScrollableControl.) |
|
HScroll | (Inherited from ScrollableControl.) |
|
Icon | Used for hosted WinForm apps that want a simple way to set their icons. |
|
ImeMode | (Inherited from Control.) |
|
ImeModeBase | (Inherited from Control.) |
|
ImplementedAsCcf20 | Allows system to run certain routines as CCF 2.0 or prior |
|
InvokeRequired | (Inherited from Control.) |
|
IsAccessible | (Inherited from Control.) |
|
IsAdapterSessionController | Gets a boolean indicating whether the adapter is a SessionController. |
|
IsDisposed | (Inherited from Control.) |
|
IsDynamic | Gets or sets a value indicating whether this instance is dynamic. |
|
IsGlobal | Tells whether the hosted application is global |
|
IsHandleCreated | (Inherited from Control.) |
|
IsListed | Allows to be seen but not listed in SessionExplorer or CurrentSessionUI |
|
IsMirrored | (Inherited from Control.) |
|
IsNavigating | Could be used to indicate an application is changing its state. |
|
IsTagged | When true, application is dependent on workflow |
|
LayoutEngine | (Inherited from Control.) |
|
Left | (Inherited from Control.) |
|
Location | (Inherited from Control.) |
|
Margin | (Inherited from Control.) |
|
MaximumSize | (Inherited from Control.) |
|
MinimumSize | (Inherited from Control.) |
|
Name | (Inherited from Control.) |
|
OptimumSize | The size that the applications's window will initially be if it is a floating window. |
|
Padding | (Inherited from Control.) |
|
Parent | (Inherited from Control.) |
|
ParentForm | (Inherited from ContainerControl.) |
|
PreferredSize | (Inherited from Control.) |
|
ProductName | (Inherited from Control.) |
|
ProductVersion | (Inherited from Control.) |
|
RecreatingHandle | (Inherited from Control.) |
|
Region | (Inherited from Control.) |
|
RenderRightToLeft | (Inherited from Control.) |
|
ResizeRedraw | (Inherited from Control.) |
|
Right | (Inherited from Control.) |
|
RightToLeft | (Inherited from Control.) |
|
ScaleChildren | (Inherited from Control.) |
|
SessionManager | Allows hosted apps to have access to sessions |
|
ShowFocusCues | (Inherited from Control.) |
|
ShowKeyboardCues | (Inherited from Control.) |
|
Site | (Inherited from Control.) |
|
Size | (Inherited from Control.) |
|
TabIndex | (Inherited from Control.) |
|
TabStop | (Inherited from Control.) |
|
Tag | (Inherited from Control.) |
|
Text | Sets/Gets the text for the window or tab control containing this application. |
|
Top | (Inherited from Control.) |
|
TopLevelControl | (Inherited from Control.) |
|
TopLevelWindow | Returns a control for the owning window of this hosted app. If this is an external application, then null is returned. |
|
UseWaitCursor | (Inherited from Control.) |
|
VerticalScroll | (Inherited from ScrollableControl.) |
|
Visible | (Inherited from Control.) |
|
VScroll | (Inherited from ScrollableControl.) |
|
Width | (Inherited from Control.) |
Methods
Fields
| Name | Description | |
|---|---|---|
.jpeg "System_CAPS_protfield") |
actions | Dictionary of actions |
|
actionsByID | Dictionary of actions |
Events
| Name | Description | |
|---|---|---|
.jpeg "System_CAPS_pubevent") |
ActionCompleted | Obsolete. For internal use |
|
ActionCompletedEvent | Event to notify ApplicationHost that an action has completed. Using CAB's EventBroker to publish the event topic. |
|
AutoSizeChanged | (Inherited from UserControl.) |
|
AutoValidateChanged | (Inherited from UserControl.) |
|
BackColorChanged | (Inherited from Control.) |
|
BackgroundImageChanged | (Inherited from Control.) |
|
BackgroundImageLayoutChanged | (Inherited from Control.) |
|
BindingContextChanged | (Inherited from Control.) |
|
CausesValidationChanged | (Inherited from Control.) |
|
ChangeContext | This event is for internal UII use only and should not be used directly. If your hosted control wants to recieve context change notification, you should be overriding NotifyContextChange method in your implementation. |
|
ChangeUICues | (Inherited from Control.) |
|
Click | (Inherited from Control.) |
|
ClientSizeChanged | (Inherited from Control.) |
|
ContextMenuChanged | (Inherited from Control.) |
|
ContextMenuStripChanged | (Inherited from Control.) |
|
ControlAdded | (Inherited from Control.) |
|
ControlRemoved | (Inherited from Control.) |
|
CursorChanged | (Inherited from Control.) |
|
Disposed | (Inherited from Component.) |
|
DockChanged | (Inherited from Control.) |
|
DoubleClick | (Inherited from Control.) |
|
DragDrop | (Inherited from Control.) |
|
DragEnter | (Inherited from Control.) |
|
DragLeave | (Inherited from Control.) |
|
DragOver | (Inherited from Control.) |
|
EnabledChanged | (Inherited from Control.) |
|
Enter | (Inherited from Control.) |
|
FontChanged | (Inherited from Control.) |
|
ForeColorChanged | (Inherited from Control.) |
|
GiveFeedback | (Inherited from Control.) |
|
GotFocus | (Inherited from Control.) |
|
HandleCreated | (Inherited from Control.) |
|
HandleDestroyed | (Inherited from Control.) |
|
HelpRequested | (Inherited from Control.) |
|
ImeModeChanged | (Inherited from Control.) |
|
Invalidated | (Inherited from Control.) |
|
KeyDown | (Inherited from Control.) |
|
KeyPress | (Inherited from Control.) |
|
KeyUp | (Inherited from Control.) |
|
Layout | (Inherited from Control.) |
|
Leave | (Inherited from Control.) |
|
Load | (Inherited from UserControl.) |
|
LocationChanged | (Inherited from Control.) |
|
LostFocus | (Inherited from Control.) |
|
MarginChanged | (Inherited from Control.) |
|
MouseCaptureChanged | (Inherited from Control.) |
|
MouseClick | (Inherited from Control.) |
|
MouseDoubleClick | (Inherited from Control.) |
|
MouseDown | (Inherited from Control.) |
|
MouseEnter | (Inherited from Control.) |
|
MouseHover | (Inherited from Control.) |
|
MouseLeave | (Inherited from Control.) |
|
MouseMove | (Inherited from Control.) |
|
MouseUp | (Inherited from Control.) |
|
MouseWheel | (Inherited from Control.) |
|
Move | (Inherited from Control.) |
|
PaddingChanged | (Inherited from Control.) |
|
Paint | (Inherited from Control.) |
|
ParentChanged | (Inherited from Control.) |
|
PreviewKeyDown | (Inherited from Control.) |
|
QueryAccessibilityHelp | (Inherited from Control.) |
|
QueryContinueDrag | (Inherited from Control.) |
|
RegionChanged | (Inherited from Control.) |
|
RequestAction | Obsolete. For internal use |
|
RequestActionEvent | Event to request an action of another application to be invoked. Using CAB's EventBroker to publish the event topic. |
|
RequestActionStatusEvent | Event to notify ApplicationHost of action status. |
|
Resize | (Inherited from Control.) |
|
RightToLeftChanged | (Inherited from Control.) |
|
Scroll | (Inherited from ScrollableControl.) |
|
SizeChanged | (Inherited from Control.) |
|
StyleChanged | (Inherited from Control.) |
|
SystemColorsChanged | (Inherited from Control.) |
|
TabIndexChanged | (Inherited from Control.) |
|
TabStopChanged | (Inherited from Control.) |
|
TextChanged | (Inherited from Control.) |
|
Validated | (Inherited from Control.) |
|
Validating | (Inherited from Control.) |
|
VisibleChanged | (Inherited from Control.) |
Explicit Interface Implementations
| Name | Description | |
|---|---|---|
.jpeg "System_CAPS_pubinterface") .jpeg "System_CAPS_protmethod") |
Object.Finalize() | (Inherited from Component.) |
.jpeg "System_CAPS_privmethod") |
IContainerControl.ActivateControl(Control) | (Inherited from ContainerControl.) |
|
IDropTarget.OnDragDrop(DragEventArgs) | (Inherited from Control.) |
|
IDropTarget.OnDragEnter(DragEventArgs) | (Inherited from Control.) |
|
IDropTarget.OnDragLeave(EventArgs) | (Inherited from Control.) |
|
IDropTarget.OnDragOver(DragEventArgs) | (Inherited from Control.) |
Remarks
It would be better to make this an abstract class and have the DoAction( Action ) method also be abstract. However doing so causes the VS 2003 UI designer to not allow drag-n-drop layout which most people will want. Thus, the obvious abstract-ness of this class is not being coded.
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