SPEvent class
Representa um evento de arquitetura ao qual os componentes podem subscrever.
Comentários
Exemplos de eventos numa aplicação Web podem incluir: o utilizador a clicar num botão, o sistema a navegar para outra página ou um item a ser adicionado/removido de uma coleção abstrata. O Estrutura do SharePoint representa eventos com instâncias do objeto SPEvent, uma para cada tipo de evento. O objeto SPEvent é normalmente exposto como uma propriedade de uma classe associada (por exemplo, o botão que pode ser clicado). Quando um componente está interessado num evento, chama add() para registar uma chamada de retorno do processador de eventos que será invocada sempre que o evento ocorrer. O processador recebe um parâmetro SPEventArgs que pode fornecer detalhes adicionais sobre o que aconteceu. Isto é análogo aos eventos do Modelo de Objeto de Documento (DOM) do browser. A diferença main é a funcionalidade ISPEventObserver, que controla o componente subscrito a cada evento e anula automaticamente a subscrição do processador quando o componente é eliminado.
Quando um evento é gerado, todos os processadores são invocados de forma síncrona. A ordem pela qual os processadores de eventos são chamados não é especificada. A chamada de retorno do processador de eventos tem de detetar quaisquer exceções que ocorram durante o processamento; uma exceção não identificada não impedirá a execução de outros processadores, mas será comunicada como um problema com o componente associado.
O construtor desta classe é marcado como interno. O código de terceiros não deve chamar diretamente o construtor ou criar subclasses que ampliem a classe SPEvent.
Métodos
| add(observer, event |
Regista uma chamada de retorno que será invocada sempre que o evento ocorrer. |
| remove(observer, event |
Anula o registo de uma chamada de retorno registada com add(). |
Detalhes do método
add(observer, eventHandler)
Regista uma chamada de retorno que será invocada sempre que o evento ocorrer.
add(observer: ISPEventObserver, eventHandler: (eventArgs: TEventArgs) => void): void;Parâmetros
- observer
- ISPEventObserver
Indica o objeto que está a subscrever o evento: quando o objeto é eliminado, o processador de eventos será removido automaticamente. Este objeto também é utilizado para fins de diagnóstico, por exemplo, detetar se o processador de eventos não conseguiu detetar uma exceção.
- eventHandler
-
(eventArgs: TEventArgs) => void
Uma função de chamada de retorno que será invocada sempre que o evento ocorrer
Retornos
void
Comentários
O mesmo objeto pode adicionar vários processadores de eventos ao mesmo evento. Uma vez que a BaseComponent implementa a interface ISPEventObserver, uma peça Web ou extensão pode passar-se como observador. Isto fará com que o processador de eventos seja automaticamente anular a subscrição quando a peça Web ou extensão for eliminada.
remove(observer, eventHandler)
Anula o registo de uma chamada de retorno registada com add().
remove(observer: ISPEventObserver, eventHandler: (eventArgs: TEventArgs) => void): void;Parâmetros
- observer
- ISPEventObserver
Tem de ser o mesmo observador que foi transmitido à função add().
- eventHandler
-
(eventArgs: TEventArgs) => void
O processador de eventos a remover; tem de ser a mesma instância de objeto que foi transmitida para a função add().
Retornos
void
Comentários
Se o processador de eventos já tiver sido removido ou se nunca tiver sido adicionado, este método não tem qualquer efeito.