Zum Hauptinhalt springen

attachEvent

Description

Verbindet einen Handler mit einem internen Event des dhtmlxScheduler

attachEvent: (name: SchedulerEventName, handler: SchedulerCallback, settings?: any) => string

Parameters

  • name - (required) SchedulerEventName - der Name des Events, case-insensitive
  • handler - (required) function - die Funktion, die das Event behandelt
  • settings - (optional) object - optionale Einstellungen für den Event-Handler

Returns

  • event - (string) - id die Kennung des verbundenen Event-Handlers

Example

scheduler.attachEvent("onEventSave",function(id,ev){  
if (!ev.text) {
alert("Text darf nicht leer sein");
return false;
}
return true;
})

Details

Mehrere Handler können an dasselbe Event angehängt werden und werden alle ausgeführt.
Wenn ein Handler false zurückgibt, wird die zugehörige Aktion verhindert.
Die Handler werden in der Reihenfolge aufgerufen, in der sie angehängt wurden.

Alle Event-Listener, die über event hinzugefügt wurden, werden automatisch entfernt, wenn der destructor aufgerufen wird.

Properties of settings object

Das settings-Objekt kann zwei Eigenschaften enthalten:

1. id - (string) eine eindeutige Kennung für den Event-Handler

Dies ermöglicht das einfache Entfernen eines bestimmten Handlers von einem Event:

scheduler.attachEvent("onClick", function(){  
console.log("event click");
}, {id: "my-click"}); /*!*/
... //später:
gantt.detachEvent("my-click");

2. once - (boolean) gibt an, ob das Event nur einmal ausgeführt werden soll

Setze dies auf true, um nur das erste Auftreten des Events zu behandeln, so:

scheduler.attachEvent("onClick", function(){  
console.log("capture next event click");
return true;
}, {once: true}); /*!*/
Need help?
Got a question about the documentation? Reach out to our technical support team for help and guidance. For custom component solutions, visit the Services page.