Mudanças entre as edições de "Desenvolvedor:APIs/JavaScript/latromi.formEventFiringContext"

De LATROMI Manuais
Desenvolvedor:APIs/JavaScript/latromi.formEventFiringContext
Ir para: navegação, pesquisa
(Criou página com '== Propriedades == {|class="wikitable apidoctable2" ! Nome ! Descrição |---------------------------------- | eventKind | |} == Métodos == {|class="wikitable apidoctable2"...')
 
(→‎Propriedades)
 
(14 revisões intermediárias pelo mesmo usuário não estão sendo mostradas)
Linha 1: Linha 1:
 +
{{DISPLAYTITLE:latromi.formEventFiringContext}}__NOTOC__
 +
Objeto de contexto, passado como argumento para funções de callback chamadas antes do processamento de eventos.
 +
 +
== Sintaxe ==
 +
<syntaxhighlight lang="JavaScript">
 +
var formEventFiringContext = {
 +
    eventKind: undefined,     
 +
    eventName: undefined,
 +
    form: undefined,
 +
    field: undefined,
 +
    cancel: false,
 +
    completeCallback: undefined
 +
};
 +
</syntaxhighlight>
 +
 
== Propriedades ==
 
== Propriedades ==
 
{|class="wikitable apidoctable2"
 
{|class="wikitable apidoctable2"
Linha 5: Linha 20:
 
|----------------------------------
 
|----------------------------------
 
| eventKind
 
| eventKind
−
|
+
| Tipo de evento, do tipo ''String''. O valor dessa propriedade pode ser:
 +
* '''Form''': Se for um evento de Formulário.
 +
* '''Field''': Se for um evento de campo do Formulário.
 +
* '''Windows''': Se for um evento de Janela de Formulário.
 +
|-
 +
| eventName
 +
| Nome do Evento, do tipo ''String''. Exemplo: ''Load'', ''LostFocus'', ''Click'' e ''WindowClosed''.
 +
|-
 +
| field
 +
| Obtém uma instância de [[DEV:APIs/JavaScript/latromi.fieldInstance|fieldInstance]], referente ao campo que disparou o evento. Se não for um evento de campo, esta propriedade terá valor ''null''.
 +
|-
 +
| form
 +
| Obtém uma instância de [[DEV:APIs/JavaScript/latromi.formInstance|formInstance]]. Esta propriedade terá valor quando for um evento de Formulário ou de membros de Formulário (Campos e Janelas).
 +
|-
 +
| cancel
 +
| Cancelamento do Evento, do tipo ''Boolean''. Se for especificado '''true''' nesta propriedade, o evento não será processado no servidor.
 
|}
 
|}
−
 
  
 
== Métodos ==
 
== Métodos ==
Linha 14: Linha 43:
 
! Descrição
 
! Descrição
 
|----------------------------------
 
|----------------------------------
−
|completeCallback(function)
+
| completeCallback(function)
−
|
+
| Função para passar um callback que será chamado quando o processamento do evento no servidor for concluído. A função deve esperar um parâmetro do tipo [[DEV:APIs/JavaScript/latromi.formEventCompleteContext|formEventCompleteContext]].
 
|}
 
|}
 +
 +
== Ver Também ==
 +
* [[DEV:APIs/JavaScript/latromi.formManager|Objeto latromi.formManager]]
 +
* [[DEV:APIs/JavaScript/latromi.formManager/setOnEventFiringCallback(function)|Método setOnEventFiringCallback(function)]]

Edição atual tal como às 15h25min de 9 de julho de 2018

Objeto de contexto, passado como argumento para funções de callback chamadas antes do processamento de eventos.

Sintaxe

var formEventFiringContext = {
    eventKind: undefined,      
    eventName: undefined,
    form: undefined,
    field: undefined,
    cancel: false,
    completeCallback: undefined
};

Propriedades

Nome Descrição
eventKind Tipo de evento, do tipo String. O valor dessa propriedade pode ser:
  • Form: Se for um evento de Formulário.
  • Field: Se for um evento de campo do Formulário.
  • Windows: Se for um evento de Janela de Formulário.
eventName Nome do Evento, do tipo String. Exemplo: Load, LostFocus, Click e WindowClosed.
field Obtém uma instância de fieldInstance, referente ao campo que disparou o evento. Se não for um evento de campo, esta propriedade terá valor null.
form Obtém uma instância de formInstance. Esta propriedade terá valor quando for um evento de Formulário ou de membros de Formulário (Campos e Janelas).
cancel Cancelamento do Evento, do tipo Boolean. Se for especificado true nesta propriedade, o evento não será processado no servidor.

Métodos

Nome Descrição
completeCallback(function) Função para passar um callback que será chamado quando o processamento do evento no servidor for concluído. A função deve esperar um parâmetro do tipo formEventCompleteContext.

Ver Também

Disponível em "http://docs.latromi.com.br/index.php?title=Desenvolvedor:APIs/JavaScript/latromi.formEventFiringContext&oldid=1778"