RMLEvent

Summary

Remarks

Danger

All calls made within this class MUST be performed on the Master Thread. See Threads.RunLater on how to safely call this from an asynchronous thread. Failure to comply with this can cause catastrophical failures as the engine is not designed for this.

Definition

Namespace: SDT4.Managed.UI.RML
Assembly: SDT4.Managed.UI.dll

sealed class RMLEvent
Inheritance:

Object ➔ RMLEvent

Implements:


Fields

Name Type Description

Properties

Name Type Description
public get; Type String Get the event type.
public get; set; CurrentTarget RMLElement Get/Set the current element in the propagation.
public get; Target RMLElement The original target of the event
public get; EventPhase RMLEventPhase Indicates which phase of the event flow is being processed.
public get; Interruptible Boolean Returns true if the event can be interrupted, that is, stopped from propagating.
public get; Propagating Boolean Returns true if the event is still propagating.
public get; ImmediatePropagating Boolean Returns true if the event is still immediate propagating.
public get; Parameters RMLEventParameters The list of parameters provided by the event. This map is only valid during the execution of the event listener callback

Methods

public Void StopPropagation()

Summary: Stops propagation of the event if it is interruptible, but finish all listeners on the current element.


public Void StopImmediatePropagation()

Summary: Stops propagation of the event if it is interruptible, including to any other listeners on the current element.