CustomEvent: initCustomEvent() method

فهرست فصل‌ها دانلود آرشیوناشر

MDN Web Docs · نسخهٔ df622a2a1c1e · CC BY-SA 2.5 و مجوز جداگانهٔ ناشر برای نمونه‌کد

{{APIRef("DOM")}}{{AvailableInWorkers}}

The **CustomEvent.initCustomEvent()** method initializes a {{domxref("CustomEvent")}} object. If the event has already been dispatched, this method does nothing.

Events initialized in this way must have been created with the {{domxref("Document.createEvent()")}} method. This method must be called to set the event before it is dispatched using {{ domxref("EventTarget.dispatchEvent()") }}. Once dispatched, it doesn't do anything anymore.

توجه: Do not use this method anymore, as it is deprecated. Rather than using the feature, instead use specific event constructors, like {{domxref("CustomEvent.CustomEvent", "CustomEvent()")}}. The section on Creating and dispatching events gives more information about the way to use those.

Syntax

js-nolint
initCustomEvent(type, canBubble, cancelable, detail)

Parameters

  • type
  • : A string containing the name of the event.
  • canBubble
  • : A boolean value indicating whether the event bubbles up through the DOM

or not.

  • cancelable
  • : A boolean value indicating whether the event is cancelable.
  • detail
  • : Any data that will be available to the handler through the {{domxref("CustomEvent.detail")}} property.

Return value

None (undefined).

Specifications

{{Specifications}}

Browser compatibility

{{Compat}}

See also

  • {{domxref("CustomEvent")}}
  • The constructor to use instead of this deprecated method: {{domxref("CustomEvent.CustomEvent", "CustomEvent()")}}.