add_event_listener method

add_event_listener

This method allows the registration of event listeners on the event target.

def add_event_listener(self, type, listener):
    ...
ParameterTypeDescription
typestrThe event type for which the user is registering
listeneraspose.html.dom.events.IEventListenerTakes an interface implemented by the user which contains the methods to be called when the event occurs.

Remarks

If an IEventListener is added to an EventTarget while it is processing an event, it will not be triggered by the current actions but may be triggered during a later stage of event flow, such as the bubbling phase.

If multiple identical Event Listeners are registered on the same EventTarget with the same parameters the duplicate instances are discarded. They do not cause the IEventListener to be called twice and since they are discarded they do not need to be removed with the EventTarget.remove_event_listener method.

add_event_listener

This method allows the registration of event listeners on the event target.

def add_event_listener(self, type, listener, use_capture):
    ...
ParameterTypeDescription
typestrThe event type for which the user is registering
listeneraspose.html.dom.events.IEventListenerTakes an interface implemented by the user which contains the methods to be called when the event occurs.
use_captureboolIf true, useCapture indicates that the user wishes to initiate capture.
After initiating capture, all events of the specified type will be dispatched to the registered
IEventListener
before being dispatched to any Event Targets beneath them in the tree.
Events which are bubbling upward through the tree will not trigger an IEventListener designated to use capture.

Remarks

If an IEventListener is added to an EventTarget while it is processing an event, it will not be triggered by the current actions but may be triggered during a later stage of event flow, such as the bubbling phase.

If multiple identical Event Listeners are registered on the same EventTarget with the same parameters the duplicate instances are discarded. They do not cause the IEventListener to be called twice and since they are discarded they do not need to be removed with the EventTarget.remove_event_listener method.

See Also