Desenvolvedor:APIs/JavaScript/latromi.formInstance

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	Retorno	Descrição
id	Number	Obtém o ID do Formulário Dinâmico.
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.

id

Propriedade que retorna o ID do cadastro do Formulário Dinâmico. Este ID é numérico, e não deve ser confundido com o ID do Elemento HTML.

upgradeCode

Propriedade que retorna o Código de Atualização do Formulário Dinâmico.

Exemplo:

function logProperties() {
   // Obtém a instância do formulário
   var form = latromi.formManager.getFormInstance();
   
   // Mostra no log o valor das propriedades
   console.log('Formulário com ID ' + form.id + 
               ' e Código de Atualização ' + form.upgradeCode);
}

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 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);
   }
}

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.

Parâmetro	Tipo	Descrição
fieldName	String	Nome do campo que reberá o valor.
value	Any	Valor a ser atribuído ao campo. O tipo de dados varia conforme o tipo de campo.

Exemplo:

function populateFields() {
   // Obtém a instância do formulário
   var form = latromi.formManager.getFormInstance();
   
   // Preenche os campos
   form.setFieldValue('txtFirstName', 'Bob').
   form.setFieldValue('txtLastName', 'Dylan').
   form.setFieldValue('chkIsInternational', true);
}