Share via


HostedWpfControl Class

Definition

Represents the hosted control for creating WPF applications by wrapping the most common operations into a base class.

public ref class HostedWpfControl : System::Windows::Controls::UserControl, Microsoft::Uii::Csr::IHostedApplication5
[Microsoft.Practices.CompositeUI.SmartParts.SmartPart]
public class HostedWpfControl : System.Windows.Controls.UserControl, Microsoft.Uii.Csr.IHostedApplication5
[<Microsoft.Practices.CompositeUI.SmartParts.SmartPart>]
type HostedWpfControl = class
    inherit UserControl
    interface IHostedApplication5
    interface IHostedApplication4
    interface IHostedApplication3
    interface IHostedApplication2
    interface IHostedApplication
Public Class HostedWpfControl
Inherits UserControl
Implements IHostedApplication5
Inheritance
HostedWpfControl
Derived
Attributes
Implements

Constructors

HostedWpfControl()

Initializes a new instance of the HostedWpfControl class.

HostedWpfControl(Guid, String, String)

Initializes a new instance of the HostedWpfControl class.

Fields

_applicationInitString
actions

Specifies a dictionary of associated actions

actionsByID

Specifies a dictionary of associated actions.

Properties

AgentID

Gets or sets the agent ID.

AppHostWorkItem

Gets or sets the application host work item.

ApplicationHost

Gets or sets the host application.

ApplicationID

Gets the unique id for this hosted application.

ApplicationName

Gets the name of the hosted application.

CanEmbed

Gets a Boolean value that specifies whether the application can be hosted within the UII panels.

ConfigurationReader

Gets or set the hosted controls configuration value reader object.

Context

Gets or sets the session-wide context. Modifying this also notifies other applications of the context change.

DisplayGroup

Gets the name of the UII panel this application is hosted within.

EnableAutoSignOn

Gets the Boolean value that specifies whether auto sign on is enabled.

HostedApplicationAdapter
Icon
Obsolete.

Gets or sets the icone.

ImageSource

Gets or sets the image source.

ImplementedAsCcf20

Gets a Boolean value that specifies whether the system runs certain routines as CCF 2.0 or prior.

IsAdapterSessionController

Gets a boolean value that specifies whether the adapter is a session controller.

IsDynamic

Gets or sets a Boolean value that specifies whether this instance is dynamic.

IsGlobal

Gets or sets a Boolean value that specifies whether the hosted application is global.

IsListed

Gets a Boolean value that specifies whether the application is listed in SessionExplorer or CurrentSessionUI

IsNavigating

Gets a Boolean value that specifies whether the application is changing its state.

IsTagged

Gets or sets a Boolean value that specifies whether the application is dependent on workflow.

MinimumSize

Gets or sets the minimum size up to which the control can be resized.

OptimumSize

Gets the size the optimum size of the application’s window.

SessionManager

Sets the session manager.

Text

Gets or sets the text for the window or tab control containing this application.

TopLevelWindow
Obsolete.

Gets the top level window of this hosted app.

TopLevelWpfWindow

Gets the top level wpf window of the hosted application.

Methods

adapter_AdapterContextChangedEvent(Context)
adapter_AdapterFireRequestActionEvent(RequestActionEventArgs)
adapter_AdapterRequestActionEvent(String, String, String)
AddAction(Int32, String, String)

Adds an action for use from one application or the UII core to this application.

AddImplicitAction(String)

Adds an implicit action.

Close()

Closes the application.

CreateInstance(String, String, WorkItem)
DoAction(Action, String)
Obsolete.

Method to override in the implemention to handle the action.

DoAction(Int32, String)
Obsolete.

Called to perform the action configured in the database.

DoAction(RequestActionEventArgs)

Method to override in the implementation to handle the action.

DoAction(String, String)
Obsolete.

Called to perform the action configured in the database.

DoDefaultAction()

Performs this hosted application's default action, if there is one.

ErrorMsg(String, String)

Displays the error message.

FireChangeContext(ContextEventArgs)

Informs all the other applications that the context has changed.

FireRequestAction(RequestActionEventArgs)

Sends a request to perform some action to another application.

GetIconList()

Gets the list of icons.

GetImageSourceList()

Gets the list of image source.

GetStateData()

Gets the application state data.

HandleRequestAction(Object, RequestActionEventArgs)

This is for internal UII use only. Please do not use directly. Public visibility necessary for CAB integration.

HandleRequestDefaultAction(Object, DataEventArgs<ApplicationProperties>)

This is for internal UII use only. Please do not use directly. Public visibility necessary for CAB integration.

Initialize()

Called when the application should initialize its internal state

IsImplicitAction(String)
loadAdapter(XmlDocument, Object)
NotifyContextChange(Context)

Notifies the application of a context change.

NotifyContextChange(String)
Obsolete.

Notifies the application of a context change.

SessionChange(Boolean, Guid)

Activates or deactivates the session. Not called for non-global applications.

SetContext(Context)
Obsolete.

This is used to set the context from applicationhost without causing further notifications.

SetContext(String)
Obsolete.

This is used to set the context from applicationhost without causing further notifications.

SetStateData(String)

Sets the StateData ofthe controls

Events

ActionCompleted
Obsolete.

For internal use only

ActionCompletedEvent

Event to notify the hosted application that an action has completed.

ChangeContext

Notifies the hosted application that the context has changed.

RequestAction
Obsolete.

For internal use only

RequestActionEvent

Requests the action of another application to be invoked.

RequestActionStatusEvent

Notifies the hosted application of action status.

Applies to