DataDrivenAdapterBase Class

  • Article

 

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

Represents the base adapter abstract class to manage access between the application, user interface, and automated entities within UII.

Namespace:   Microsoft.Uii.HostedApplicationToolkit.DataDrivenAdapter
Assembly:  Microsoft.Uii.HostedApplicationToolkit.DataDrivenAdapter (in Microsoft.Uii.HostedApplicationToolkit.DataDrivenAdapter.dll)

Inheritance Hierarchy

System.Object
  Microsoft.Uii.HostedApplicationToolkit.DataDrivenAdapter.DataDrivenAdapterBase
    Microsoft.Uii.HostedApplicationToolkit.DataDrivenAdapter.JavaDataDrivenAdapter
    Microsoft.Uii.HostedApplicationToolkit.DataDrivenAdapter.UIADataDrivenAdapter
    Microsoft.Uii.HostedApplicationToolkit.DataDrivenAdapter.WebDataDrivenAdapter
    Microsoft.Uii.HostedApplicationToolkit.DataDrivenAdapter.WinDataDrivenAdapter

Syntax

public abstract class DataDrivenAdapterBase : IDisposable

Public MustInherit Class DataDrivenAdapterBase
    Implements IDisposable

Constructors

Name Description
System_CAPS_protmethod DataDrivenAdapterBase(XmlDocument)

Initializes a new instance of the DataDrivenAdapterBase class.

Methods

Name Description
System_CAPS_pubmethodSystem_CAPS_static CreateInstance(String, Object)

Instantiates specific derivations of the DataDrivenAdapterBase class.
System_CAPS_pubmethod Dispose()

Clears up any resources being used.
System_CAPS_protmethod Dispose(Boolean)

Overridden. Unregisters the event listeners.
System_CAPS_pubmethod Equals(Object)

(Inherited from Object.)
System_CAPS_pubmethod ExecuteControlAction(String, Boolean, String)

Executes the designated action of the named control.
System_CAPS_protmethod Finalize()

Destructor for the DataDrivenAdapterBase class.(Overrides Object.Finalize().)
System_CAPS_pubmethod FindControl(String)

Reports whether the named control is available for use.
System_CAPS_protmethodSystem_CAPS_static GetAttributeValue(XmlNode, String, Int32)

Retrieves an integer valued attribute from an XML node.
System_CAPS_protmethodSystem_CAPS_static GetAttributeValue(XmlNode, String, String)

Retrieves a string valued attribute from an XML node.
System_CAPS_pubmethod GetAvailableApplicationEvents()

Gets the list of application events propagated. Intended for design-time use. Custom implementation not required for run-time operation.
System_CAPS_pubmethod GetAvailableControlEvents()

Gets the list of control events propagated. Intended for design-time use. Custom implementation isn’t required for run-time operation.
System_CAPS_protmethod GetControlConfig(String)

Gets the subordinate nodes from a top-level XML node of a data-driven adapter control binding.
System_CAPS_pubmethod GetControlNames()

Gets the control names.
System_CAPS_pubmethod GetControlValue(String, String)

Gets the current value of the control.
System_CAPS_protmethod GetFirstDescendentUnderControlConfig(String, String)

Retrieves the first descendent node from a top-level XML node of a data-driven adapter control binding.
System_CAPS_pubmethod GetHashCode()

(Inherited from Object.)
System_CAPS_pubmethod GetType()

(Inherited from Object.)
System_CAPS_protmethod MemberwiseClone()

(Inherited from Object.)
System_CAPS_protmethod OperationHandler(OperationType, String, String)

Calls to the DataDrivenAdapterBase API to manipulate the UI are dispatched to this handler. Override to implement custom behavior.
System_CAPS_protmethod OperationHandler(OperationType, String, String, String)

Calls to the DataDrivenAdapterBaseAPI to manipulate the user interface (UI) are dispatched to this handler. Override to implement custom behavior.
System_CAPS_protmethod RaiseEvent(Object, String, String, String)

Raises events where necessary. There is no synchronization context marshalling. Events go out on the thread that raised them. It is the listeners responsibility to perform an application-specific thread marshalling as required.
System_CAPS_pubmethod RegisterEventListener(String, String, EventHandler<ControlChangedEventArgs>)

Facilitates explicit data-driven adapter event listener registration.
System_CAPS_pubmethod RegisterEventListener(String, String, EventHandler<ControlChangedEventArgs>, String)

Facilitates explicit data-driven adapter event listener registration.
System_CAPS_protmethod RegisterEventListenerBase(String, String, EventHandler<ControlChangedEventArgs>)

Adds the specified listenerCallback to the internal list of registered listeners. Once registered, RaiseEvent can then be used to raise the event to the registered listeners.
System_CAPS_pubmethod SetControlValue(String, String, String)

Assigns a new value to the named control.
System_CAPS_pubmethod ToString()

(Inherited from Object.)
System_CAPS_pubmethod UnregisterEventListener(String, String, EventHandler<ControlChangedEventArgs>)

Facilitates explicit data-driven adapter event listener unregistration. Called for every registered event on Dispose.
System_CAPS_protmethod UnregisterEventListenerBase(String, String, EventHandler<ControlChangedEventArgs>)

Removes the specified listenerCallback from the internal list of registered listeners. Once unregistered, RaiseEvent no longer can be used to raise the event.

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.HostedApplicationToolkit.DataDrivenAdapter Namespace
UII data driven adapters
Use data driven adapters (DDAs)

Return to top

Unified Service Desk 2.0

© 2017 Microsoft. All rights reserved. Copyright