Share via

HostedWebApplication Class

  • Article

 

Applies To: Dynamics 365 (online), Dynamics 365 (on-premises), Dynamics CRM 2013, Dynamics CRM 2015, Dynamics CRM 2016

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

Namespace:   Microsoft.Uii.Csr
Assembly:  Microsoft.Uii.Csr.Core (in Microsoft.Uii.Csr.Core.dll)

Inheritance Hierarchy

System.Object
  Microsoft.Uii.Csr.HostedApplication
    Microsoft.Uii.Csr.HostedWebApplication

Syntax

[SmartPartAttribute]
public class HostedWebApplication : HostedApplication

<SmartPartAttribute>
Public Class HostedWebApplication
    Inherits HostedApplication

Constructors

Name Description
System_CAPS_pubmethod HostedWebApplication(Guid, String, String)

Constructor for HostedWebApplication

Properties

Name Description
System_CAPS_pubproperty 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.
System_CAPS_pubproperty AgentID

Get or set the agent ID.(Inherited from HostedApplication.)
System_CAPS_pubproperty AppHostWorkItem

For CAB integration purposes only; allows injection of current WorkItem
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.
System_CAPS_pubproperty ApplicationID

The unique ID for the application as given in the database definitions.(Overrides HostedApplication.ApplicationID.)
System_CAPS_pubproperty ApplicationName

Returns the name of the hosted application as given in the database.(Overrides HostedApplication.ApplicationName.)
System_CAPS_pubproperty 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.(Overrides HostedApplication.CanEmbed.)
System_CAPS_pubproperty ConfigurationReader

Configuration reader used for reading app settings from application configuration or the server(Inherited from HostedApplication.)
System_CAPS_pubproperty Context

Gets and Sets the context for the web application. This can be used by scripts.
System_CAPS_pubproperty DisplayGroup

Get the display group.(Overrides HostedApplication.DisplayGroup.)
System_CAPS_protproperty engine

engine(Inherited from HostedApplication.)
System_CAPS_protproperty HostedApplicationAdapter

Application adapter instance for the external application, if so configured.
System_CAPS_pubproperty HostInside

System_CAPS_pubproperty Icon

Used to indicate the preferred icon to use(Overrides HostedApplication.Icon.)
System_CAPS_pubproperty ImplementedAsCcf20

Allows system to run certain routines as CCF 2.0 or prior(Overrides HostedApplication.ImplementedAsCcf20.)
System_CAPS_pubproperty IsAdapterSessionController

Gets a boolean indicating whether the adapter is a SessionController.(Inherited from HostedApplication.)
System_CAPS_pubproperty IsDynamic

Gets or sets a value indicating whether this instance is dynamic.
System_CAPS_pubproperty IsGlobal

Tells whether the hosted application is global(Overrides HostedApplication.IsGlobal.)
System_CAPS_pubproperty IsListed

Allows to be seen but not listed in SessionExplorer or CurrentSessionUI(Overrides HostedApplication.IsListed.)
System_CAPS_pubproperty IsNavigating

Returns a true if the application is still navigating to a page.(Overrides HostedApplication.IsNavigating.)
System_CAPS_pubproperty IsTagged

When true, application is dependent on workflow
System_CAPS_pubproperty MinimumSize

The minimum size for an application's window(Overrides HostedApplication.MinimumSize.)
System_CAPS_pubproperty OptimumSize

The size that the applications's window will initially be if it is a floating window.(Overrides HostedApplication.OptimumSize.)
System_CAPS_pubproperty SessionManager

Allows hosted apps to have access to the session manager object(Overrides HostedApplication.SessionManager.)
System_CAPS_pubproperty TopLevelWindow

Returns the control which represents the browser(Overrides HostedApplication.TopLevelWindow.)
System_CAPS_pubproperty WebAppAdapter

Web Application adater instance for the web applications. For Internal Use.

Methods

Name Description
System_CAPS_pubmethod ActionCompletedFromScript(ActionEventArgs)

Action is completed from script
System_CAPS_protmethod adapter_AdapterContextChangedEvent(Context)

Event handler which is run when an adapter needs to notify UII of new context information.
System_CAPS_protmethod adapter_AdapterFireRequestActionEvent(RequestActionEventArgs)

Used when an adapter requests that an action be done on an application.
System_CAPS_protmethod adapter_AdapterRequestActionEvent(String, String, String)

Used when an adapter requests that an action be done on an application.
System_CAPS_pubmethod AddAction(Int32, String, String)

Used at initialization time to create the list of actions that may be performed.(Overrides HostedApplication.AddAction(Int32, String, String).)
System_CAPS_pubmethod ChangeContextFromScript()

System_CAPS_pubmethod Close()

Closes the web application and any adapter it may be using.(Overrides HostedApplication.Close().)
System_CAPS_protmethod CreateInstance(String, String)

Obsolete. Method used to help create Instances of applications / objects(Inherited from HostedApplication.)
System_CAPS_protmethod CreateInstance(String, String, WorkItem)

Method used to help create Instances of applications / objects(Inherited from HostedApplication.)
System_CAPS_pubmethod DoAction(Int32, String)

Performs the indicated action on a web app using the passed data.(Overrides HostedApplication.DoAction(Int32, String).)
System_CAPS_protmethod DoAction(RequestActionEventArgs)

Perform an action on a web app using the passed arguments.(Overrides HostedApplication.DoAction(RequestActionEventArgs).)
System_CAPS_pubmethod DoAction(String, String)

Obsolete. Perform the given action on the application.(Overrides HostedApplication.DoAction(String, String).)
System_CAPS_pubmethod DoDefaultAction()

DoDefaultAction : navigates to the saved page or homepage specified(Overrides HostedApplication.DoDefaultAction().)
System_CAPS_pubmethod Equals(Object)

(Inherited from Object.)
System_CAPS_protmethod Finalize()

(Inherited from Object.)
System_CAPS_pubmethod 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.(Overrides HostedApplication.FireRequestAction(RequestActionEventArgs).)
System_CAPS_pubmethod Focus()

Gives the focus to the hosted Web application
System_CAPS_pubmethod GetCompiledState(Byte[], Byte[])

Obsolete. Get the compiled State(Inherited from HostedApplication.)
System_CAPS_pubmethod GetContextValue(String)

Returns the value associated with the name-value pair in the context.
System_CAPS_pubmethod GetEventSourceInstance(String, String)

Obsolete. Get the event source instance.(Inherited from HostedApplication.)
System_CAPS_pubmethod GetGlobalInstance(String)

Obsolete. Get global instances(Inherited from HostedApplication.)
System_CAPS_pubmethod GetHashCode()

(Inherited from Object.)
System_CAPS_pubmethod GetIconList()

Gets the icon images(Overrides HostedApplication.GetIconList().)
System_CAPS_pubmethod GetStateData()

Gets the application state data for the Web application For now we retrieve only the URL value(Overrides HostedApplication.GetStateData().)
System_CAPS_pubmethod GetType()

(Inherited from Object.)
System_CAPS_pubmethod HandleRequestAction(Object, RequestActionEventArgs)

This is for internal UII use only. Please do not use directly. Public visibility necessary for CAB integration.
System_CAPS_pubmethod 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.
System_CAPS_pubmethod Initialize()

This must be called before any actions are done on the hosted web application.(Overrides HostedApplication.Initialize().)
System_CAPS_pubmethod InitializeClosing()

This Method is called before closing a hosted web application to perform required actions on web browser to close.
System_CAPS_protmethod loadAdapter(XmlDocument)

Loads an adapter (if any) to modify the web application behavior.
System_CAPS_protmethod MemberwiseClone()

(Inherited from Object.)
System_CAPS_pubmethod Notify(String, Object)

Obsolete. Notify the script with information.(Inherited from HostedApplication.)
System_CAPS_pubmethod NotifyContextChange(Context)

Notify the application that the context changed(Overrides HostedApplication.NotifyContextChange(Context).)
System_CAPS_pubmethod NotifyContextChange(String)

Obsolete. Handle the change in the context.(Overrides HostedApplication.NotifyContextChange(String).)
System_CAPS_pubmethod OnCompilerError(IVsaError)

Obsolete. On Compiler error(Inherited from HostedApplication.)
System_CAPS_pubmethod RequestActionFromScript(RequestActionEventArgs)

Request Action
System_CAPS_pubmethod SessionChange(Boolean, Guid)

Called for global applications when the session is activated or deactivated(Overrides HostedApplication.SessionChange(Boolean, Guid).)
System_CAPS_pubmethod 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.(Overrides HostedApplication.SetContext(Context).)
System_CAPS_pubmethod 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.(Overrides HostedApplication.SetContext(String).)
System_CAPS_pubmethod SetStateData(String)

Set the application to the state provided in the xml string.(Overrides HostedApplication.SetStateData(String).)
System_CAPS_protmethod SubstituteQueryString(String)

Inserts a value from the context into a query string where the query string specifies it by using the syntax %valuename.
System_CAPS_protmethod SubstituteQueryString(String, Boolean)

Inserts a value from the context into a query string where the query string specifies it by using the syntax %valuename.
System_CAPS_pubmethod ToString()

(Inherited from Object.)
System_CAPS_pubmethod 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.
System_CAPS_pubmethod 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.

Fields

Name Description
System_CAPS_protfield webActions

Dictionary of actions
System_CAPS_protfield webActionsByID

Dictionary of actions
System_CAPS_protfield webBrowser

An instance of the WebBrowserExtended object

Events

Name Description
System_CAPS_pubevent ActionCompleted

Obsolete. Action Completed event handler.(Overrides HostedApplication.ActionCompleted.)
System_CAPS_pubevent ActionCompletedEvent

Event to notify ApplicationHost that an action has completed. Using CAB's EventBroker to publish the event topic.(Overrides HostedApplication.ActionCompletedEvent.)
System_CAPS_pubevent ChangeContext

Change context event handler.(Overrides HostedApplication.ChangeContext.)
System_CAPS_pubevent RequestAction

Obsolete. Request Action event handler.(Overrides HostedApplication.RequestAction.)
System_CAPS_pubevent RequestActionEvent

Event to request an action of another application to be invoked. Using CAB's EventBroker to publish the DoAction event topic.(Overrides HostedApplication.RequestActionEvent.)
System_CAPS_pubevent RequestActionStatusEvent

Event to notify ApplicationHost of action status.(Overrides HostedApplication.RequestActionStatusEvent.)

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

Microsoft.Uii.Csr Namespace

Return to top

Unified Service Desk 2.0

© 2017 Microsoft. All rights reserved. Copyright