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

De LATROMI Manuais
Desenvolvedor:APIs/JavaScript/latromi.formInstance
Ir para: navegação, pesquisa
(getElement())
Linha 19: Linha 19:
 
|Obtém o Elemento HTML que envolve o Formulário Dinâmico.
 
|Obtém o Elemento HTML que envolve o Formulário Dinâmico.
 
|-
 
|-
|getFieldValue()
+
|[[#getFieldValue|getFieldValue()]]
 
|Any
 
|Any
 
|Obtém o valor atual de um campo.
 
|Obtém o valor atual de um campo.
Linha 28: Linha 28:
 
|}
 
|}
  
= <span id="getElement"></span>getElement() =
+
== <span id="getElement"></span>getElement() ==
 
Função que retorna o Elemento HTML que envolve o Formulário Dinâmico. O comum é que seja retornado uma DIV, com a classe CSS ''DynamicForm''.
 
Função que retorna o Elemento HTML que envolve o Formulário Dinâmico. O comum é que seja retornado uma DIV, com a classe CSS ''DynamicForm''.
  
Linha 41: Linha 41:
 
   if (element) {
 
   if (element) {
 
       console.log('Elemento do tipo  ' + element.tagName + ' encontrado!');
 
       console.log('Elemento do tipo  ' + element.tagName + ' encontrado!');
 +
  }
 +
}
 +
</syntaxhighlight>
 +
 +
== <span id="getFieldValue"></span>getFieldValue() ==
 +
Função que retorna o valor de um campo. O tipo de dados retornado vai variar conforme o tipo de campo. Por exemplo, se for uma ''TextBox'', o resultado será uma ''String'', mas se for uma ''CheckBox'' o resultado será ''Boolean''.
 +
 +
{|class="wikitable apidoctable"
 +
! Parâmetro
 +
! Tipo
 +
! Descrição
 +
|----------------------------------
 +
| fieldName
 +
| String
 +
| Nome do campo a obter o valor.
 +
|}
 +
 +
Exemplo:
 +
 +
<syntaxhighlight lang="JavaScript">
 +
function getElement() {
 +
  // Obtém a instância do formulário
 +
  var form = latromi.formManager.getFormInstance();
 +
  // Obtém o Element HTML
 +
 
 +
  // Obtém o valor dos campos
 +
  var firstName = form.getFieldValue('txtFirstName'),
 +
      lastName = form.getFieldValue('txtFirstName'),
 +
      isInternational = form.getFieldValue('chkIsInternational');
 +
 
 +
  // Mostra uma mensagem em inglês no log se se a
 +
  // CheckBox "chkIsInternational" estiver marcada
 +
  if (isInternational  === true) {
 +
      console.log('The full name is ' + lastName + ', ' + firstName);
 +
  }
 +
  else {
 +
      console.log('O nome completo é ' + firstName + ' ' + lastName);
 
   }
 
   }
 
}
 
}
 
</syntaxhighlight>
 
</syntaxhighlight>

Edição das 03h15min de 7 de julho de 2018

Conjunto de funções e propriedades para interação com o Formulário Dinâmico. A instância desse objeto deve ser obtido através da API formManager. Essa API fornece os seguintes objetos no lado do cliente:

Funções / Propriedades Tipo Descrição
id Number Obtém o ID do Formulário Dinâmico (não é o ID do Elemento HTML).
upgradeCode String Obtém o Código de Atualização (Chave Única) do Formulário Dinâmico.
getElement() Element Obtém o Elemento HTML que envolve o Formulário Dinâmico.
getFieldValue() Any Obtém o valor atual de um campo.
setFieldValue() Any Atribui valor a um campo.

getElement()

Função que retorna o Elemento HTML que envolve o Formulário Dinâmico. O comum é que seja retornado uma DIV, com a classe CSS DynamicForm.

Exemplo:

function getElement() {
   // Obtém a instância do formulário
   var form = latromi.formManager.getFormInstance();
   // Obtém o Element HTML
   var element = form.getElement();
   if (element) {
      console.log('Elemento do tipo  ' + element.tagName + ' encontrado!');
   }
}

getFieldValue()

Função que retorna o valor de um campo. O tipo de dados retornado vai variar conforme o tipo de campo. Por exemplo, se for uma TextBox, o resultado será uma String, mas se for uma CheckBox o resultado será Boolean.

Parâmetro Tipo Descrição
fieldName String Nome do campo a obter o valor.

Exemplo:

function getElement() {
   // Obtém a instância do formulário
   var form = latromi.formManager.getFormInstance();
   // Obtém o Element HTML
   
   // Obtém o valor dos campos
   var firstName = form.getFieldValue('txtFirstName'),
       lastName = form.getFieldValue('txtFirstName'),
       isInternational = form.getFieldValue('chkIsInternational');
   
   // Mostra uma mensagem em inglês no log se se a 
   // CheckBox "chkIsInternational" estiver marcada
   if (isInternational  === true) {
      console.log('The full name is ' + lastName + ', ' + firstName);
   }
   else {
      console.log('O nome completo é ' + firstName + ' ' + lastName);
   }
}