DataDrivenAdapterBase.RegisterEventListener Method

Definition

Namespace:

Microsoft.Uii.HostedApplicationToolkit.DataDrivenAdapter

Assembly:

Microsoft.Uii.HostedApplicationToolkit.DataDrivenAdapter.dll

Overloads

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

RegisterEventListener(String, String, EventHandler<ControlChangedEventArgs>)

Facilitates explicit data-driven adapter event listener registration.

public:
 virtual bool RegisterEventListener(System::String ^ eventName, System::String ^ controlName, EventHandler<Microsoft::Uii::HostedApplicationToolkit::DataDrivenAdapter::ControlChangedEventArgs ^> ^ listenerCallback);

public virtual bool RegisterEventListener (string eventName, string controlName, EventHandler<Microsoft.Uii.HostedApplicationToolkit.DataDrivenAdapter.ControlChangedEventArgs> listenerCallback);

abstract member RegisterEventListener : string * string * EventHandler<Microsoft.Uii.HostedApplicationToolkit.DataDrivenAdapter.ControlChangedEventArgs> -> bool
override this.RegisterEventListener : string * string * EventHandler<Microsoft.Uii.HostedApplicationToolkit.DataDrivenAdapter.ControlChangedEventArgs> -> bool

Public Overridable Function RegisterEventListener (eventName As String, controlName As String, listenerCallback As EventHandler(Of ControlChangedEventArgs)) As Boolean

Parameters

eventName

String

Specifies the name of the event.

controlName

String

Specifies the name of the control. Event listener registration can be scoped at the data-driven adapter control level (specify blank or null to omit).

listenerCallback

EventHandler<ControlChangedEventArgs>

Specifies the callback associated with the listener.

Returns

Boolean

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

Exceptions

ArgumentNullException

eventName and listenerCallback must not be null.

RegisterEventListener(String, String, EventHandler<ControlChangedEventArgs>, String)

Facilitates explicit data-driven adapter event listener registration.

public:
 abstract bool RegisterEventListener(System::String ^ eventName, System::String ^ controlName, EventHandler<Microsoft::Uii::HostedApplicationToolkit::DataDrivenAdapter::ControlChangedEventArgs ^> ^ listenerCallback, System::String ^ Data);

public abstract bool RegisterEventListener (string eventName, string controlName, EventHandler<Microsoft.Uii.HostedApplicationToolkit.DataDrivenAdapter.ControlChangedEventArgs> listenerCallback, string Data);

abstract member RegisterEventListener : string * string * EventHandler<Microsoft.Uii.HostedApplicationToolkit.DataDrivenAdapter.ControlChangedEventArgs> * string -> bool

Public MustOverride Function RegisterEventListener (eventName As String, controlName As String, listenerCallback As EventHandler(Of ControlChangedEventArgs), Data As String) As Boolean

Parameters

eventName

String

Specifies the name of the event.

controlName

String

Specifies the name of the control (specify blank or null to omit).

listenerCallback

EventHandler<ControlChangedEventArgs>

Specifies the callback associated with the listener.

Data

String

Specifies additional data that is to be passed for customizing the operation.

Returns

Boolean

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

Exceptions

ArgumentNullException

eventName and listenerCallback must not be null.