Share via


DataDrivenAdapterBase.RegisterEventListener Method (String, String, EventHandler, String)

Facilitates explicit data-driven adapter event listener registration.

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

Usage

'Usage
Dim instance As DataDrivenAdapterBase
Dim eventName As String
Dim controlName As String
Dim listenerCallback As EventHandler(Of ControlChangedEventArgs)
Dim Data As String
Dim returnValue As Boolean

returnValue = instance.RegisterEventListener(eventName, controlName, listenerCallback, Data)

Syntax

'Declaration
Public MustOverride Function RegisterEventListener ( _
    eventName As String, _
    controlName As String, _
    listenerCallback As EventHandler(Of ControlChangedEventArgs), _
    Data As String _
) As Boolean
public abstract bool RegisterEventListener (
    string eventName,
    string controlName,
    EventHandler<ControlChangedEventArgs> listenerCallback,
    string Data
)
public:
virtual bool RegisterEventListener (
    String^ eventName, 
    String^ controlName, 
    EventHandler<ControlChangedEventArgs^>^ listenerCallback, 
    String^ Data
) abstract
public abstract boolean RegisterEventListener (
    String eventName, 
    String controlName, 
    EventHandler<ControlChangedEventArgs> listenerCallback, 
    String Data
)
public abstract function RegisterEventListener (
    eventName : String, 
    controlName : String, 
    listenerCallback : EventHandler<ControlChangedEventArgs>, 
    Data : String
) : boolean

Parameters

  • eventName
    Specifies the name of the event.
  • controlName
    Specifies the name of the control (specify blank or null to omit).
  • listenerCallback
    Specifies the callback associated with the listener.
  • Data
    Specifies additional data that is to be passed for customizing the operation.

Return Value

Returns true if the registration is successful (duplicate registration attempts should return false).

Exceptions

Exception type Condition
ArgumentNullException

eventName and listenerCallback must not be null.

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.

Platforms

See Also

Reference

DataDrivenAdapterBase Class
DataDrivenAdapterBase Members
Microsoft.Uii.HostedApplicationToolkit.DataDrivenAdapter Namespace

Unified Service Desk
Send comments about this topic to Microsoft.
© 2015 Microsoft. All rights reserved.