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
(→‎Propriedades)
 
(42 revisões intermediárias pelo mesmo usuário não estão sendo mostradas)
Linha 1: Linha 1:
−
{{DISPLAYTITLE:latromi.formInstance}}
+
{{DISPLAYTITLE:latromi.formInstance}}__NOTOC__
−
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 [[Dev:APIs/JavaScript/latromi.formManager|formManager]]. Essa API fornece os seguintes objetos no lado do cliente:
+
Fornece propriedades e métodos para manipulação do Formulário Dinâmico. A instância desse objeto deve ser obtida através da API estática [[Dev:APIs/JavaScript/latromi.formManager|formManager]].  
  
−
{|class="wikitable apidoctable"
+
== Propriedades ==
−
!Funções / Propriedades
+
{|class="wikitable apidoctable2"
−
! Tipo
+
! Nome
 
! Descrição
 
! Descrição
 
|----------------------------------
 
|----------------------------------
−
|id
+
|[[DEV:APIs/JavaScript/latromi.formInstance/id|id]]
−
|Number
+
|Obtém o ID do Formulário Dinâmico.
−
|Obtém o ID do Formulário Dinâmico (não é o ID do Elemento HTML).
 
 
|-
 
|-
−
|upgradeCode
+
|[[DEV:APIs/JavaScript/latromi.formInstance/upgradeCode|upgradeCode]]
−
|String
+
|Obtém o Código de Atualização Formulário Dinâmico.
−
|Obtém o Código de Atualização (Chave Única) do Formulário Dinâmico.
 
 
|-
 
|-
−
|[[#getElement|getElement()]]
+
|[[DEV:APIs/JavaScript/latromi.formInstance/fields|fields]]
−
|Element
+
|Obtém um array de [[Dev:APIs/JavaScript/latromi.fieldInstance|latromi.fieldInstance]].
 +
|}
 +
 
 +
== Métodos ==
 +
{|class="wikitable apidoctable2"
 +
!Nome
 +
! Descrição
 +
|----------------------------------
 +
|[[DEV:APIs/JavaScript/latromi.formInstance/getElement()|getElement()]]
 
|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()]]
+
|[[DEV:APIs/JavaScript/latromi.formInstance/getFieldValue(string)|getFieldValue(string)]]
−
|Any
 
 
|Obtém o valor atual de um campo.
 
|Obtém o valor atual de um campo.
 
|-
 
|-
−
|setFieldValue()
+
|[[DEV:APIs/JavaScript/latromi.formInstance/setFieldValue(string,any)|setFieldValue(string, any)]]
−
|Any
 
 
|Atribui valor a um campo.
 
|Atribui valor a um campo.
 +
|-
 +
|[[DEV:APIs/JavaScript/latromi.formInstance/getVariableValue(string)|getVariableValue(string)]]
 +
|Obtém o valor atual de uma variável.
 +
|-
 +
|[[DEV:APIs/JavaScript/latromi.formInstance/setVariableValue(string,any)|setVariableValue(string, any)]]
 +
|Atribui valor a uma variável.
 
|}
 
|}
  
−
== <span id="getElement"></span>getElement() ==
+
== Ver Também ==
−
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''.
+
: [[DEV:APIs/JavaScript/latromi.formManager|Objeto latromi.formManager]]
−
 
 
−
Exemplo:
 
−
 
 
−
<syntaxhighlight lang="JavaScript">
 
−
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!');
 
−
  }
 
−
}
 
−
</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 logFullName() {
 
−
  // Obtém a instância do formulário
 
−
  var form = latromi.formManager.getFormInstance();
 
−
 
 
−
  // 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>
 
−
 
 
−
== setFieldValue() ==
 
−
Função que atribui valor a um campo. O valor especificado deve variar conforme o tipo de campo. Por exemplo, se form uma ''TextBox'' deve ser passado um valor do tipo ''String'', mas se for uma ''CheckBox'', deve ser um valor do tipo ''Booelan''.
 

Edição atual tal como às 11h26min de 17 de janeiro de 2019

Fornece propriedades e métodos para manipulação do Formulário Dinâmico. A instância desse objeto deve ser obtida através da API estática formManager.

Propriedades

Nome Descrição
id Obtém o ID do Formulário Dinâmico.
upgradeCode Obtém o Código de Atualização Formulário Dinâmico.
fields Obtém um array de latromi.fieldInstance.

Métodos

Nome Descrição
getElement() Obtém o Elemento HTML que envolve o Formulário Dinâmico.
getFieldValue(string) Obtém o valor atual de um campo.
setFieldValue(string, any) Atribui valor a um campo.
getVariableValue(string) Obtém o valor atual de uma variável.
setVariableValue(string, any) Atribui valor a uma variável.

Ver Também

Objeto latromi.formManager
Disponível em "http://docs.latromi.com.br/index.php?title=Desenvolvedor:APIs/JavaScript/latromi.formInstance&oldid=2254"