HostedWebApplication Class

Reference

Definition

Namespace:: Microsoft.Uii.Csr

Assembly:: Microsoft.Uii.Csr.Core.dll

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.

Classes to handle web applications (HTML, ASP, etc) within UII.

public ref class HostedWebApplication : Microsoft::Uii::Csr::HostedApplication

[Microsoft.Practices.CompositeUI.SmartParts.SmartPart]
public class HostedWebApplication : Microsoft.Uii.Csr.HostedApplication

[<Microsoft.Practices.CompositeUI.SmartParts.SmartPart>]
type HostedWebApplication = class
    inherit HostedApplication

Public Class HostedWebApplication
Inherits HostedApplication

Inheritance: Object

HostedApplication
HostedWebApplication

Attributes: SmartPartAttribute

Constructors

HostedWebApplication(Guid, String, String)

Constructor for HostedWebApplication

Fields

ScriptObjectName	Hosted Application (Inherited from HostedApplication)
webActions	Dictionary of actions
webActionsByID	Dictionary of actions
webBrowser	An instance of the WebBrowserExtended object

Properties

AgentCreds	Get the agent credentials for this application Changed the return type to System.ComponentModel.BindingList in the process of Migrating Web Service to WCF service.
AgentID	Get or set the agent ID. (Inherited from HostedApplication)
AppHostWorkItem	For CAB integration purposes only; allows injection of current WorkItem
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	The unique ID for the application as given in the database definitions.
ApplicationName	Returns the name of the hosted application as given in the database.
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.
ConfigurationReader	Configuration reader used for reading app settings from application configuration or the server (Inherited from HostedApplication)
Context	Gets and Sets the context for the web application. This can be used by scripts.
DisplayGroup	Get the display group.
engine	engine (Inherited from HostedApplication)
HostedApplicationAdapter	Application adapter instance for the external application, if so configured.
HostInside
Icon	Used to indicate the preferred icon to use
ImplementedAsCcf20	Allows system to run certain routines as CCF 2.0 or prior
IsAdapterSessionController	Gets a boolean indicating whether the adapter is a SessionController. (Inherited from HostedApplication)
IsDynamic	Gets or sets a value indicating whether this instance is dynamic.
IsGlobal	Tells whether the hosted application is global
IsListed	Allows to be seen but not listed in SessionExplorer or CurrentSessionUI
IsNavigating	Returns a `true` if the application is still navigating to a page.
IsTagged	When true, application is dependent on workflow
MinimumSize	The minimum size for an application's window
OptimumSize	The size that the applications's window will initially be if it is a floating window.
SessionManager	Allows hosted apps to have access to the session manager object
TopLevelWindow	Returns the control which represents the browser
WebAppAdapter	Web Application adater instance for the web applications. For Internal Use.

Methods

ActionCompletedFromScript(ActionEventArgs)	Action is completed from script
adapter_AdapterContextChangedEvent(Context)	Event handler which is run when an adapter needs to notify UII of new context information.
adapter_AdapterFireRequestActionEvent(RequestActionEventArgs)	Used when an adapter requests that an action be done on an application.
adapter_AdapterRequestActionEvent(String, String, String)	Used when an adapter requests that an action be done on an application.
AddAction(Int32, String, String)	Used at initialization time to create the list of actions that may be performed.
ChangeContextFromScript()
Close()	Closes the web application and any adapter it may be using.
CreateInstance(String, String)	Obsolete. Method used to help create Instances of applications / objects (Inherited from HostedApplication)
CreateInstance(String, String, WorkItem)	Method used to help create Instances of applications / objects (Inherited from HostedApplication)
DoAction(Int32, String)	Performs the indicated action on a web app using the passed data.
DoAction(RequestActionEventArgs)	Perform an action on a web app using the passed arguments.
DoAction(String, String)	Obsolete. Perform the given action on the application.
DoDefaultAction()	DoDefaultAction : navigates to the saved page or homepage specified
FireRequestAction(RequestActionEventArgs)	Sends a request to perform some action to another application. If the RequestActionEventArgs has a target of *, then all apps get the action.
Focus()	Gives the focus to the hosted Web application
GetCompiledState(Byte[], Byte[])	Obsolete. Get the compiled State (Inherited from HostedApplication)
GetContextValue(String)	Returns the value associated with the name-value pair in the context.
GetEventSourceInstance(String, String)	Obsolete. Get the event source instance. (Inherited from HostedApplication)
GetGlobalInstance(String)	Obsolete. Get global instances (Inherited from HostedApplication)
GetIconList()	Gets the icon images
GetStateData()	Gets the application state data for the Web application For now we retrieve only the URL value
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>)	Event handler for default action This is for internal UII use only. Please do not use directly. Public visibility necessary for CAB integration.
Initialize()	This must be called before any actions are done on the hosted web application.
InitializeClosing()	This Method is called before closing a hosted web application to perform required actions on web browser to close.
loadAdapter(XmlDocument)	Loads an adapter (if any) to modify the web application behavior.
Notify(String, Object)	Obsolete. Notify the script with information. (Inherited from HostedApplication)
NotifyContextChange(Context)	Notify the application that the context changed
NotifyContextChange(String)	Obsolete. Handle the change in the context.
OnCompilerError(IVsaError)	Obsolete. On Compiler error (Inherited from HostedApplication)
RequestActionFromScript(RequestActionEventArgs)	Request Action
SessionChange(Boolean, Guid)	Called for global applications when the session is activated or deactivated
SetContext(Context)	Obsolete. This is used to set the context from ApplicationHost without causing further notifications. It exists so that context can be updated quietly before doing the 'real' context notification because some applications fire actions onto other apps when the context changes and some actions are designed to depend upon context. In other words, a race condition.
SetContext(String)	Obsolete. This is used to set the context from applicationhost without causing further notifications. It exists so that context can be updated quietly before doing the 'real' context notification because some applications fire actions onto other apps when the context changes and some actions are designed to depend upon context. In otherwords, a race condition.
SetStateData(String)	Set the application to the state provided in the xml string.
SubstituteQueryString(String)	Inserts a value from the context into a query string where the query string specifies it by using the syntax %valuename.
SubstituteQueryString(String, Boolean)	Inserts a value from the context into a query string where the query string specifies it by using the syntax %valuename.
UpdateContextValue(Dictionary<String,String>)	Accepts a Dictionary collection of keys and values and adds them (or updates it if it currently exists) to the current context. Then notify other apps the context has changed.
UpdateContextValue(String, String)	Accepts a name and value pair and adds or updates it if it currently exists to the current context. This is public so it can be called via scripts as well.

Events

ActionCompleted	Obsolete. Action Completed event handler.
ActionCompletedEvent	Event to notify ApplicationHost that an action has completed. Using CAB's EventBroker to publish the event topic.
ChangeContext	Change context event handler.
RequestAction	Obsolete. Request Action event handler.
RequestActionEvent	Event to request an action of another application to be invoked. Using CAB's EventBroker to publish the DoAction event topic.
RequestActionStatusEvent	Event to notify ApplicationHost of action status.

Applies to