SPEvent class
Representa un evento de marco al que los componentes pueden suscribirse.
Comentarios
Algunos ejemplos de eventos de una aplicación web pueden ser: el usuario que hace clic en un botón, el sistema que navega a otra página o un elemento que se agrega o quita de una colección abstracta. El SharePoint Framework representa eventos mediante instancias del objeto SPEvent, uno para cada tipo de evento. El objeto SPEvent normalmente se expone como una propiedad de una clase asociada (por ejemplo, el botón en el que se puede hacer clic). Cuando un componente está interesado en un evento, llama a add() para registrar una devolución de llamada del controlador de eventos que se invocará cada vez que se produzca el evento. El controlador recibe un parámetro SPEventArgs que puede proporcionar detalles adicionales sobre lo que ha ocurrido. Esto es análogo a los eventos del modelo de objetos de documento (DOM) del explorador. La principal diferencia es la característica ISPEventObserver, que realiza un seguimiento de qué componente está suscrito a cada evento y cancela automáticamente la suscripción del controlador cuando se elimina el componente.
Cuando se genera un evento, todos los controladores se invocan de forma sincrónica. El orden en el que se llama a los controladores de eventos no está especificado. La devolución de llamada del controlador de eventos debe detectar las excepciones que se produzcan durante el procesamiento; Una excepción no detectada no impedirá la ejecución de otros controladores, pero se notificará como un problema con el componente asociado.
El constructor de esta clase está marcado como interno. El código de terceros no debe llamar directamente al constructor ni crear subclases que extiendan la clase SPEvent.
Métodos
| add(observer, event |
Registra una devolución de llamada que se invocará cada vez que se produzca el evento. |
| remove(observer, event |
Anula el registro de una devolución de llamada registrada mediante add(). |
Detalles del método
add(observer, eventHandler)
Registra una devolución de llamada que se invocará cada vez que se produzca el evento.
add(observer: ISPEventObserver, eventHandler: (eventArgs: TEventArgs) => void): void;Parámetros
- observer
- ISPEventObserver
Indica el objeto que se suscribe al evento: cuando se elimina el objeto, el controlador de eventos se quitará automáticamente. Este objeto también se usa con fines de diagnóstico, por ejemplo, detectar si el controlador de eventos no pudo detectar una excepción.
- eventHandler
-
(eventArgs: TEventArgs) => void
Una función de devolución de llamada que se invocará cada vez que se produzca el evento
Devoluciones
void
Comentarios
El mismo objeto puede agregar varios controladores de eventos al mismo evento. Puesto que BaseComponent implementa la interfaz ISPEventObserver, un elemento web o extensión puede pasarse como observador. Esto hará que el controlador de eventos se cancele automáticamente la suscripción cuando se elimine el elemento web o la extensión.
remove(observer, eventHandler)
Anula el registro de una devolución de llamada registrada mediante add().
remove(observer: ISPEventObserver, eventHandler: (eventArgs: TEventArgs) => void): void;Parámetros
- observer
- ISPEventObserver
Debe ser el mismo observador que se pasó a la función add().
- eventHandler
-
(eventArgs: TEventArgs) => void
Controlador de eventos que se va a quitar; debe ser la misma instancia de objeto que se pasó a la función add().
Devoluciones
void
Comentarios
Si el controlador de eventos ya se ha quitado o si nunca se agregó, este método no tiene ningún efecto.