HostedControl Members
This control makes it easier to create WinForm applications by wrapping the most common operations into a base class.
The following tables list the members exposed by the HostedControl type.
Public Constructors
| Name | Description | |
|---|---|---|
| HostedControl | Overloaded. |
Top
Protected Fields
| Name | Description | |
|---|---|---|
.gif "protected field") |
actions | Dictionary of actions |
|
actionsByID | Dictionary of actions |
Top
Public Properties
(see also Protected Properties)
| Name | Description | |
|---|---|---|
.gif "public property") |
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 |
|
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) |
|
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 | Overridden. (inherited from Control) |
|
AutoSizeMode | (inherited from UserControl) |
|
AutoValidate | Overridden. (inherited from ContainerControl) |
|
BackColor | (inherited from Control) |
|
BackgroundImage | (inherited from Control) |
|
BackgroundImageLayout | (inherited from Control) |
|
BindingContext | Overridden. (inherited from Control) |
|
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. |
|
CanFocus | (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) |
|
CurrentAutoScaleDimensions | (inherited from ContainerControl) |
|
Cursor | (inherited from Control) |
|
DataBindings | (inherited from Control) |
|
DisplayGroup | The name of the UII panel this application is hosted within. This is taken from the database Application table initialization XML. |
|
DisplayRectangle | Overridden. (inherited from Control) |
|
Disposing | (inherited from Control) |
|
Dock | (inherited from Control) |
|
DockPadding | (inherited from ScrollableControl) |
|
EnableAutoSignOn | Get the value of private member variable enableAutoSignOn. |
|
Enabled | (inherited from Control) |
|
Focused | (inherited from Control) |
|
Font | (inherited from Control) |
|
ForeColor | (inherited from Control) |
|
Handle | (inherited from Control) |
|
HasChildren | (inherited from Control) |
|
Height | (inherited from Control) |
|
HorizontalScroll | (inherited from ScrollableControl) |
|
Icon | Used for hosted WinForm apps that want a simple way to set their icons. |
|
ImeMode | (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) |
|
Right | (inherited from Control) |
|
RightToLeft | (inherited from Control) |
|
SessionManager | Allows hosted apps to have access to sessions |
|
Site | Overridden. (inherited from Component) |
|
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) |
|
Width | (inherited from Control) |
|
WindowTarget | (inherited from Control) |
Top
Protected Properties
| Name | Description | |
|---|---|---|
.gif "protected property") |
AutoScaleFactor | (inherited from ContainerControl) |
|
CanEnableIme | Overridden. (inherited from Control) |
|
CanRaiseEvents | Overridden. (inherited from Component) |
|
CreateParams | Overridden. (inherited from ContainerControl) |
|
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 | Overridden. (inherited from Control) |
|
DesignMode | (inherited from Component) |
|
DoubleBuffered | (inherited from Control) |
|
Events | (inherited from Component) |
|
FontHeight | (inherited from Control) |
|
HScroll | (inherited from ScrollableControl) |
|
ImeModeBase | (inherited from Control) |
|
ResizeRedraw | (inherited from Control) |
|
ScaleChildren | (inherited from Control) |
|
VScroll | (inherited from ScrollableControl) |
Top
Public Methods
(see also Protected Methods)
| Name | Description | |
|---|---|---|
.gif "public method") |
AddAction | Adds an action for use from one application or the UII core to this application. An action with id of 1 is the default action and is called when initing the application. There is no requirement to have a default action though. |
|
BeginInvoke | (inherited from Control) |
|
BeginInvoke | (inherited from Control) |
|
BringToFront | (inherited from Control) |
|
Close | Called when the app is closed. |
|
Contains | (inherited from Control) |
|
CreateControl | (inherited from Control) |
|
CreateGraphics | (inherited from Control) |
|
CreateObjRef | (inherited from MarshalByRefObject) |
|
Dispose | (inherited from Component) |
|
DoAction | Overloaded. |
|
DoDefaultAction | Performs this hosted application's default action, if there is one. The default action is the one with an id of 1, but it is not required. |
|
DoDragDrop | (inherited from Control) |
|
DrawToBitmap | (inherited from Control) |
|
EndInvoke | (inherited from Control) |
|
Equals | (inherited from Object) |
|
ErrorMsg | So hosted winform applications can use this and have the same error message style as the rest of the desktop. |
|
FindForm | (inherited from Control) |
|
FireChangeContext | Informs all the other applications that the context has changed. |
|
FireRequestAction | Sends a request to perform some action to another application. If the RequestActionEventArgs has a target of *, then all apps get the action. |
|
Focus | (inherited from Control) |
|
GetChildAtPoint | (inherited from Control) |
|
GetChildAtPoint | (inherited from Control) |
|
GetContainerControl | (inherited from Control) |
|
GetHashCode | (inherited from Object) |
|
GetIconList | Gets the icon images |
|
GetLifetimeService | (inherited from MarshalByRefObject) |
|
GetNextControl | (inherited from Control) |
|
GetPreferredSize | (inherited from Control) |
|
GetStateData | Gets the application state data for the windows application For now we retrieve only the InputText value |
|
GetType | (inherited from Object) |
|
HandleRequestAction | This is for internal UII use only. Please do not use directly. Public visibility necessary for CAB integration. |
|
HandleRequestDefaultAction | This is for internal UII use only. Please do not use directly. Public visibility necessary for CAB integration. |
|
Hide | (inherited from Control) |
|
Initialize | Called when the application should initialize its internal state |
|
InitializeLifetimeService | (inherited from MarshalByRefObject) |
|
Invalidate | (inherited from Control) |
|
Invalidate | (inherited from Control) |
|
Invalidate | (inherited from Control) |
|
Invalidate | (inherited from Control) |
|
Invalidate | (inherited from Control) |
|
Invalidate | (inherited from Control) |
|
Invoke | (inherited from Control) |
|
Invoke | (inherited from Control) |
|
NotifyContextChange | Overloaded. |
|
PerformAutoScale | (inherited from ContainerControl) |
|
PerformLayout | (inherited from Control) |
|
PerformLayout | (inherited from Control) |
|
PointToClient | (inherited from Control) |
|
PointToScreen | (inherited from Control) |
|
PreProcessControlMessage | (inherited from Control) |
|
PreProcessMessage | (inherited from Control) |
|
RectangleToClient | (inherited from Control) |
|
RectangleToScreen | (inherited from Control) |
|
Refresh | (inherited from Control) |
|
ResetBackColor | (inherited from Control) |
|
ResetBindings | (inherited from Control) |
|
ResetCursor | (inherited from Control) |
|
ResetFont | (inherited from Control) |
|
ResetForeColor | (inherited from Control) |
|
ResetImeMode | (inherited from Control) |
|
ResetRightToLeft | (inherited from Control) |
|
ResetText | (inherited from Control) |
|
ResumeLayout | (inherited from Control) |
|
ResumeLayout | (inherited from Control) |
|
Scale | (inherited from Control) |
|
Scale | Obsolete. (inherited from Control) |
|
Scale | Obsolete. (inherited from Control) |
|
ScrollControlIntoView | (inherited from ScrollableControl) |
|
Select | (inherited from Control) |
|
SelectNextControl | (inherited from Control) |
|
SendToBack | (inherited from Control) |
|
SessionChange | Called for global applications when the session is activated or deactivated Not called for non-global applications. |
|
SetAutoScrollMargin | (inherited from ScrollableControl) |
|
SetBounds | (inherited from Control) |
|
SetBounds | (inherited from Control) |
|
SetContext | Overloaded. |
|
SetStateData | Sets the StateData to the controls |
|
Show | (inherited from Control) |
|
SuspendLayout | (inherited from Control) |
|
ToString | Overridden. (inherited from Object) |
|
Update | (inherited from Control) |
|
Validate | (inherited from ContainerControl) |
|
Validate | (inherited from ContainerControl) |
|
ValidateChildren | Overridden. (inherited from ContainerControl) |
|
ValidateChildren | Overridden. (inherited from ContainerControl) |
Top
Protected Methods
.gif "protected method")
Top
Public Events
| Name | Description | |
|---|---|---|
.gif "public event") |
ActionCompleted | For internal use Obsolete. |
|
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 | For internal use Obsolete. |
|
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 UserControl) |
|
Validated | (inherited from Control) |
|
Validating | (inherited from Control) |
|
VisibleChanged | (inherited from Control) |
Top
Explicit Interface Implementations
| Name | Description | |
|---|---|---|
| ActivateControl | (inherited from ContainerControl) | |
| OnDragDrop | (inherited from Control) | |
| OnDragEnter | (inherited from Control) | |
| OnDragLeave | (inherited from Control) | |
| OnDragOver | (inherited from Control) |
Top
See Also
Reference
HostedControl Class
Microsoft.Uii.Csr Namespace
Unified Service Desk
Send comments about this topic to Microsoft.
© 2015 Microsoft. All rights reserved.