CustomEvent Class
CustomEvent class
Events using the CustomEvent interface can be used to carry custom data.
public class CustomEvent : Event
Constructors
| Name | Description |
|---|
| CustomEvent(string) | Initializes a new instance of the CustomEvent class. |
| CustomEvent(string, IDictionary<string, object>) | Initializes a new instance of the CustomEvent class. |
Properties
| Name | Description |
|---|
| Bubbles { get; } | Used to indicate whether or not an event is a bubbling event. If the event can bubble the value is true, else the value is false. |
| Cancelable { get; } | Used to indicate whether or not an event can have its default action prevented. If the default action can be prevented the value is true, else the value is false. |
| CurrentTarget { get; } | Used to indicate the IEventTarget whose IEventListeners are currently being processed. This is particularly useful during capturing and bubbling. |
| DefaultPrevented { get; } | Returns true if preventDefault() was invoked while the cancelable attribute value is true, and false otherwise. |
| Detail { get; } | Gets the custom data. |
| EventPhase { get; } | Used to indicate which phase of event flow is currently being evaluated. |
| IsTrusted { get; } | The isTrusted attribute must return the value it was initialized to. When an event is created the attribute must be initialized to false. |
| Target { get; } | Used to indicate the IEventTarget to which the event was originally dispatched. |
| TimeStamp { get; } | Used to specify the time (in milliseconds relative to the epoch) at which the event was created. Due to the fact that some systems may not provide this information the value of timeStamp may be not available for all events. When not available, a value of 0 will be returned. Examples of epoch time are the time of the system start or 0:0:0 UTC 1st January 1970. |
| Type { get; } | The name of the event (case-insensitive). The name must be an XML name. |
Methods
| Name | Description |
|---|
| virtual GetPlatformType() | This method is used to retrieve ECMAScript object Type. |
| InitCustomEvent(string, bool, bool, object) | /// The InitEvent method is used to initialize the value of an Event created through the IDocumentEvent interface. |
| InitEvent(string, bool, bool) | The InitEvent method is used to initialize the value of an Event created through the IDocumentEvent interface. |
| PreventDefault() | If an event is cancelable, the PreventDefault method is used to signify that the event is to be canceled, meaning any default action normally taken by the implementation as a result of the event will not occur. |
| StopImmediatePropagation() | Invoking this method prevents event from reaching any event listeners registered after the current one and when dispatched in a tree also prevents event from reaching any other objects. |
| StopPropagation() | The StopPropagation method is used prevent further propagation of an event during event flow. |
See Also
