WebApplicationAdapter Class

Article
02/21/2017

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

Represents an abstract class used by UII developers to create web based adapters.

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

Inheritance Hierarchy

System.Object
Microsoft.Uii.Csr.HostedApplicationAdapter
Microsoft.Uii.Csr.WebApplicationAdapter

Syntax

public abstract class WebApplicationAdapter : HostedApplicationAdapter

Public MustInherit Class WebApplicationAdapter
    Inherits HostedApplicationAdapter

Constructors

	Name	Description
	WebApplicationAdapter()	Initializes a new instance of the WebApplicationAdapter class.

Properties

	Name	Description
	ApplicationInitString	Gets or sets the XML string used to initialize the application.(Inherited from HostedApplicationAdapter.)
	Browser	Gets or sets a reference to the Internet Explorer browser that hosts the web application.
	DdaApplicationObject	Gets or sets the application object data-driven adapters used to manipulate the application.(Inherited from HostedApplicationAdapter.)
	EmptyQueryStringData	Gets or sets a Boolean value that represents the visibility of data specified by System Integrator.
	EncodeQueryStringData	Gets or sets the flag to turn on encoding of data.
	Name	Gets or sets the name of the application that the adapter is working with.(Inherited from HostedApplicationAdapter.)
	SessionID	Gets or sets the ID of the current session. The SessionID is used with global applications to track which session is active.(Inherited from HostedApplicationAdapter.)
	SessionWorkItem	Gets or sets the work item that identifies the session.(Inherited from HostedApplicationAdapter.)

Methods

	Name	Description
	AdapterContextChange(Context)	Used by inherited classes to send context change event to UII.(Inherited from HostedApplicationAdapter.)
	AdapterFireAction(String, String, String)	Obsolete. Used by inherited classes to request an action through UII to other applications.(Inherited from HostedApplicationAdapter.)
	AdapterFireRequestAction(RequestActionEventArgs)	Used by inherited classes to request an action through UII to other applications.(Inherited from HostedApplicationAdapter.)
	BeforeNavigate(String, String, String, Int32, String, String, Object)	Called by UII whenever the hosted web application navigates to a new page. The application, action, and data arguments can all be modified.
	Close()	Called when the application this is working with is being closed by the UII application host. This may not run if the application closes itself.(Inherited from HostedApplicationAdapter.)
	DoAction(Action, RequestActionEventArgs)	Called by UII whenever an action is about to be performed on the application.(Inherited from HostedApplicationAdapter.)
	DoAction(Action, String)	Obsolete. Called by UII whenever an action is about to be performed on the application.(Inherited from HostedApplicationAdapter.)
	DoAction(HostedWebApplication.WebAction, String)	Called by UII whenever an action is about to be performed on the web application.
	DocumentComplete(String)	Called when the document loading is completed.
	Equals(Object)	(Inherited from Object.)
	Finalize()	(Inherited from Object.)
	GetHashCode()	(Inherited from Object.)
	GetStateData(String)	Gets the UII agent's state.(Inherited from HostedApplicationAdapter.)
	GetType()	(Inherited from Object.)
	Initialize()	Initializes the hosted application.(Inherited from HostedApplicationAdapter.)
	MemberwiseClone()	(Inherited from Object.)
	NavigateComplete(String)	Called when navigation for this browser is completed.
	NotifyContextChange(Context)	Called when the context is changed.(Inherited from HostedApplicationAdapter.)
	NotifyContextChange(String)	Obsolete. Obsolete. Called when the context is changed.(Inherited from HostedApplicationAdapter.)
	OnNewWindow(String, String, Int64)	Creates a new browser window. It permits the application to cancel or allow the NewWindow operation.
	SessionChange(Boolean, String)	Called by UII whenever the session changes. Only happens for global applications.(Inherited from HostedApplicationAdapter.)
	SetStateData(String)	Sets the UII agent's state.(Inherited from HostedApplicationAdapter.)
	ToString()	(Inherited from Object.)

Events

	Name	Description
	AdapterContextChangedEvent	Notifies the UII when the adapter changes the context.(Inherited from HostedApplicationAdapter.)
	AdapterFireRequestActionEvent	Lets the adapter request that an action be started. This can be used within custom adapters to send UII actions.(Inherited from HostedApplicationAdapter.)
	AdapterRequestActionEvent	Obsolete. Lets the adapter request that an action be fired. This can be used within custom adapters to send UII actions. Obsolete.(Inherited from HostedApplicationAdapter.)

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.