Mudanças entre as edições de "Desenvolvedor:APIs/JavaScript/latromi.formManager/getFormInstance(string)"

De LATROMI Manuais
Desenvolvedor:APIs/JavaScript/latromi.formManager/getFormInstance(string)
Ir para: navegação, pesquisa
(Criou página com '{{DISPLAYTITLE:Método getFormInstance()}}__NOTOC__ Função que retorna uma instância de formInstance. '''Memebro de:''' DEV:...')
 
 
(10 revisões intermediárias pelo mesmo usuário não estão sendo mostradas)
Linha 1: Linha 1:
{{DISPLAYTITLE:Método getFormInstance()}}__NOTOC__
+
{{DISPLAYTITLE:Método getFormInstance(string | null)}}__NOTOC__
 
Função que retorna uma instância de [[Dev:APIs/JavaScript/latromi.formInstance|formInstance]].
 
Função que retorna uma instância de [[Dev:APIs/JavaScript/latromi.formInstance|formInstance]].
  
'''Memebro de:''' [[DEV:APIs/JavaScript/latromi.formInstance|latromi.formInstance]]
+
'''Memebro de:''' [[DEV:APIs/JavaScript/latromi.formManager|latromi.formManager]]
  
 
== Sintaxe ==
 
== Sintaxe ==
 
<syntaxhighlight lang="JavaScript">
 
<syntaxhighlight lang="JavaScript">
function getFieldValue(fieldName) { }
+
function getFormInstance(upgradeCode) { }
 
</syntaxhighlight>
 
</syntaxhighlight>
  
 
=== Parâmetros ===
 
=== Parâmetros ===
: ''fieldName''
+
: ''upgradeCode''
 
:: Tipo: String
 
:: Tipo: String
:: Nome do campo a obter o valor.
+
:: Código de atualização do Formulário Dinâmico. Este parâmetro é '''opcional'''. Se for especificado, o formManager vai procurar um formulário que contenha esse código. Caso contrário, vai retornar o primeiro Formulário encontrado.
  
 
=== Valor de Retorno ===
 
=== Valor de Retorno ===
O tipo de dados do retorno varia conforme o tipo de campo.
+
Retorna um objeto do tipo [[DEV:APIs/JavaScript/latromi.formInstance|latromi.formInstance]], referente a um Formulário Dinâmico carregado na tela.
  
 
== Exemplos ==
 
== Exemplos ==
  
O Exemplo abaixo exibe no console do navegador o nome completo de uma pessoa, obtido através das ''TextBoxes'' '''txtFirstName''' e '''txtLastName'''. Se o ''CheckBox'' '''chkIsInternational''' estiver marcada, a mensagem será exibida em inglês, se não em português.
+
=== Obtendo o objeto formInstace ===
 
+
O exemplo abaixo mostra como obter uma instância do objeto '''formInstance'''. O código executa as seguintes ações:
Exemplo:
+
* Obtém um objeto do tipo '''formInstance''', referente ao primeiro Formulário encontrado na página.
 +
* Se o objeto foi encontrado, exibe no console do navegador o ''Código de Ataulização''.
  
 
<syntaxhighlight lang="JavaScript">
 
<syntaxhighlight lang="JavaScript">
Linha 32: Linha 33:
 
}
 
}
 
</syntaxhighlight>
 
</syntaxhighlight>
 +
 +
== Ver Também ==
 +
* [[DEV:APIs/JavaScript/latromi.formManager|Objeto latromi.formManager]]
 +
* [[DEV:APIs/JavaScript|APIs JavaScript]]

Edição atual tal como às 16h17min de 9 de julho de 2018

Função que retorna uma instância de formInstance.

Memebro de: latromi.formManager

Sintaxe

function getFormInstance(upgradeCode) { }

Parâmetros

upgradeCode
Tipo: String
Código de atualização do Formulário Dinâmico. Este parâmetro é opcional. Se for especificado, o formManager vai procurar um formulário que contenha esse código. Caso contrário, vai retornar o primeiro Formulário encontrado.

Valor de Retorno

Retorna um objeto do tipo latromi.formInstance, referente a um Formulário Dinâmico carregado na tela.

Exemplos

Obtendo o objeto formInstace

O exemplo abaixo mostra como obter uma instância do objeto formInstance. O código executa as seguintes ações:

  • Obtém um objeto do tipo formInstance, referente ao primeiro Formulário encontrado na página.
  • Se o objeto foi encontrado, exibe no console do navegador o Código de Ataulização.
function getFormInstance() {
   // Obtém a instância do formulário
   var form = latromi.formManager.getFormInstance();
   if (form) {
      console.log('Form com UpgradeCode ' + form.upgradeCode + ' encontrado!');
   }
}

Ver Também