GlideForm (g_form) - Cliente

. GlideForm A API fornece métodos para personalizar formulários.

Usar somente GlideForm métodos no cliente. Você pode usar esses métodos para fazer mudanças personalizadas na exibição de formulário de registros. Toda a validação de exemplos foi feita usando scripts de cliente.

Você também pode usar alguns desses métodos em outros scripts de cliente (como Scripts de cliente de catálogo ou Scripts de cliente de assistente), mas você deve primeiro testar isso para determinar se eles funcionarão conforme o esperado.

Nota:

Os métodos GetControl() , GetHelpTextControl() , GetElement() e GetFormElement() descontinuados para dispositivos móveis. Para obter informações sobre como usar GlideForm para dispositivos móveis, consulte Script e migração do GlideForm do cliente móvel (g_form) .

Não há construtor para GlideForm classe. Acesso GlideForm métodos que usam g_form objeto global.

GlideForm - addDecoration (cadeia de caracteres fieldName, ícone de cadeia de caracteres, título da cadeia de caracteres)

Adiciona um ícone no rótulo de um campo.

Adicionar o mesmo item duas vezes é impedido; no entanto, você pode adicionar o mesmo ícone com um título diferente.

Nota:

Este método não é compatível com Catálogo de serviços.

Tabela 1. Parâmetros

Nome	Tipo	Descrição
fieldName	Cadeia de caracteres	Nome do campo.
ícones	Cadeia de caracteres	Nome do ícone a ser mostrado ao lado do campo especificado. Valores válidos: icon-add ícone-alerta icon-book icon-book-open icon-calendar cartões de ícone ícone-cart-full icon-catalog icon-check-circle icon-cog icon-comment ícone-console ícone-painel icon-database ícone-excluir ícone-gaveta icon-edit icon-filter ícone-pasta ícone-formulário icon-help icon-home icon-image icon-info rótulo de ícone icon-lightbulb icon-list feed de atividades do ícone icon-locked icon-mail ícone-mobile ícone-novo-tíquete ícone-clipe de papel ícone-poder script de ícone icon-search classificação de ícone crescente ícone-estrela ícone-estrela-vazio tab-ícone ícone-lixeira icon-tree icon-tree-right ícone-usuário icon-user-group icon-view
título	Cadeia de caracteres	Título do ícone.

Tabela 2. Retornos

Tipo	Descrição
vazio

g_form.addDecoration('caller_id', 'icon-star', 'preferred member');

GlideForm - addDecoration (cadeia de caracteres fieldName, ícone de cadeia de caracteres, título da cadeia de caracteres, cor da cadeia de caracteres)

Adiciona um ícone no rótulo de um campo.

Adicionar o mesmo item duas vezes é impedido; no entanto, você pode adicionar o mesmo ícone com um título diferente.

Nota:

Este método não é compatível com o Catálogo de serviços.

Tabela 3. Parâmetros

Nome	Tipo	Descrição
fieldName	Cadeia de caracteres	Nome do campo.
ícones	Cadeia de caracteres	Nome do ícone a ser mostrado ao lado do campo especificado. Valores válidos: icon-add ícone-alerta icon-book icon-book-open icon-calendar cartões de ícone ícone-cart-full icon-catalog icon-check-circle icon-cog icon-comment ícone-console ícone-painel icon-database ícone-excluir ícone-gaveta icon-edit icon-filter ícone-pasta ícone-formulário icon-help icon-home icon-image icon-info rótulo de ícone icon-lightbulb icon-list feed de atividades do ícone icon-locked icon-mail ícone-mobile ícone-novo-tíquete ícone-clipe de papel ícone-poder script de ícone icon-search classificação de ícone crescente ícone-estrela ícone-estrela-vazio tab-ícone ícone-lixeira icon-tree icon-tree-right ícone-usuário icon-user-group icon-view
título	Cadeia de caracteres	Título do ícone.
cor	Cadeia de caracteres	Cor CSS.

Tabela 4. Retornos

Tipo	Descrição
vazio

g_form.addDecoration('caller_id', 'icon-star', 'Mark as Favorite', 'color-green');

GlideForm - addErrorMessage (mensagem de cadeia de caracteres)

Exibe a mensagem de erro especificada na parte superior do formulário.

Esta mensagem aparece durante aproximadamente quatro segundos e desaparece. Este tempo limite não é configurável no momento.

Tabela 5. Parâmetros

Nome	Tipo	Descrição
mensagem	Cadeia de caracteres	Mensagem a ser exibida.

Tabela 6. Retornos

Tipo	Descrição
vazio

g_form.addErrorMessage('This is an error');

GlideForm - addFormMessage(mensagem de cadeia de caracteres, tipo de cadeia de caracteres, opções de objeto)

Exibe uma mensagem de formulário flutuante na parte superior da seção de detalhes do formulário. A mensagem não cobre ações de IU.

Consulte também:

• Limpar AllFormMessages()
• ClearFormMessages()

Tabela 7. Parâmetros

Nome	Tipo	Descrição
mensagem	Cadeia de caracteres	Mensagem a ser exibida.
tipo	Cadeia de caracteres	Tipo de mensagem. Valores válidos: erro informações aviso
opções	Objeto	Opcional. Botões a serem adicionados à mensagem do formulário e todos os metadados necessários para lidar com um clique de botão. { buttons: [Array], meta: {Object} }
botões.opções	Matriz	Lista de botões a serem adicionados à mensagem do formulário. buttons: [ { actionName: "String", label: "String" } ]
Options.Buttons.ActionName	Cadeia de caracteres	Nome usado pelo FORM_MESSAGE_BUTTON_CLICKED manipuladores de eventos para determinar o botão que foi clicado. Por exemplo, se você adicionar um botão com actionName assign_to_me , você deve criar um manipulador de eventos em UIB em FORM_MESSAGE_BUTTON_CLICKED evento que só é executado quando actionName. assigned_to_me .
botão.opções.rótulo	Cadeia de caracteres	Texto a ser exibido no botão.
options.meta	Objeto	Mapa de todos os metadados necessários para lidar com o clique do botão formatado como pares de chave-valor. meta: { 'key': 'value' } Por exemplo, para um Atribuir a mim botão que o manipulador de eventos precisa do sys_id do usuário para atribuir o registro.

Tabela 8. Retornos

Tipo	Descrição
Nenhum(a)

O exemplo a seguir mostra como adicionar mensagens de formulário de cada tipo.

g_form.addFormMessage('info message','info');
g_form.addFormMessage('warning message','warning');
g_form.addFormMessage('error message','error');
g_form.addFormMessage('info2 message','info');
g_form.addFormMessage('warning2 message','warning');
g_form.addFormMessage('error2 message','error');
g_form.addFormMessage('Would you like to reassign this to yourself?', 'info', {buttons: [{label: "Assign to me", actionName: "assign_to_me"}], meta: {'userId': '46d44a23a9fe19810012d100cca80666'}});

GlideForm - addHighMessage(mensagem de cadeia de caracteres)

Exibe uma mensagem de alta prioridade na parte superior do formulário.

Esta mensagem aparece durante aproximadamente quatro segundos e desaparece. Este tempo limite não é configurável no momento.

Tabela 9. Parâmetros

Nome	Tipo	Descrição
mensagem	Cadeia de caracteres	Mensagem de alta prioridade a ser exibida no formulário.

Tabela 10. Retornos

Tipo	Descrição
Nenhum(a)

O exemplo a seguir mostra como exibir uma mensagem de alta prioridade na parte superior do formulário.

g_form.addHighMessage("This is a high priority message");

GlideForm - addInfoMessage(mensagem de cadeia de caracteres)

Adiciona a mensagem informativa especificada à parte superior do formulário.

Esta mensagem aparece durante aproximadamente quatro segundos e desaparece. Este tempo limite não é configurável no momento.

Tabela 11. Parâmetros

Nome	Tipo	Descrição
mensagem	Cadeia de caracteres	Mensagem a ser exibida.

Tabela 12. Retornos

Tipo	Descrição
vazio

g_form.addInfoMessage('The top five fields in this form are mandatory');

GlideForm - addLowMessage (mensagem de cadeia de caracteres)

Exibe uma mensagem de baixa prioridade na parte superior do formulário.

Esta mensagem aparece durante aproximadamente quatro segundos e desaparece. Este tempo limite não é configurável no momento.

Tabela 13. Parâmetros

Nome	Tipo	Descrição
mensagem	Cadeia de caracteres	Mensagem de baixa prioridade a ser exibida no formulário.

Tabela 14. Retornos

Tipo	Descrição
Nenhum(a)

O exemplo a seguir mostra como exibir uma mensagem de baixa prioridade na parte superior do formulário.

g_form.addLowMessage(“This is a low priority message"); 

GlideForm - addModerateMessage(mensagem de cadeia de caracteres)

Exibe uma mensagem de prioridade de nível moderado na parte superior do formulário.

Esta mensagem aparece durante aproximadamente quatro segundos e desaparece. Este tempo limite não é configurável no momento.

Tabela 15. Parâmetros

Nome	Tipo	Descrição
mensagem	Cadeia de caracteres	Mensagem de prioridade moderada a ser exibida no formulário.

Tabela 16. Retornos

Tipo	Descrição
Nenhum(a)

O exemplo a seguir mostra como exibir uma mensagem de prioridade moderada na parte superior do formulário.

g_form.addModerateMessage("This is a moderate priority message");

GlideForm - addOption(cadeia de caracteres fieldName, cadeia de caracteres choiceValue, cadeia de caracteres choiceLabel)

Adiciona uma opção ao final de um campo de lista de seleção especificado.

Tabela 17. Parâmetros

Nome	Tipo	Descrição
fieldName	Cadeia de caracteres	Nome do campo ao qual a opção de campo de seleção será adicionada.
choiceValue	Cadeia de caracteres	Valor a ser armazenado no banco de dados.
EscolheRótulo	Cadeia de caracteres	Valor a ser exibido.

Tabela 18. Retornos

Tipo	Descrição
vazio

g_form.addOption('priority', '6', '6 - Really Low');

GlideForm - addOption(cadeia de caracteres fieldName, cadeia de caracteres choiceValue, cadeia de caracteres choiceLabel, número choiceIndex)

Adiciona uma opção ao campo de lista na posição especificada.

Nota:

Rótulos de lista duplicados não são compatíveis com Portal de serviços. Por exemplo, itens com texto de rótulo correspondente a outro rótulo são ignorados e não adicionados à lista.

Tabela 19. Parâmetros

Nome	Tipo	Descrição
fieldName	Cadeia de caracteres	Nome do campo ao qual a opção de campo de seleção será adicionada.
choiceValue	Cadeia de caracteres	Valor a ser armazenado no banco de dados.
EscolheRótulo	Cadeia de caracteres	Valor a ser exibido.
ChoiceIndex	Número	Ordem da escolha na lista. O índice é uma matriz baseada em zero.

Tabela 20. Retornos

Tipo	Descrição
vazio

g_form.addOption('priority', '2.5', '2.5 - Moderately High', 3);

GlideForm - addSuccessMessage(mensagem de cadeia de caracteres)

Exibe uma mensagem de sucesso na parte superior do formulário.

Esta mensagem aparece durante aproximadamente quatro segundos e desaparece. Este tempo limite não é configurável no momento.

Tabela 21. Parâmetros

Nome	Tipo	Descrição
mensagem	Cadeia de caracteres	Mensagem de sucesso a ser exibida no formulário.

Tabela 22. Retornos

Tipo	Descrição
Nenhum(a)

O exemplo a seguir mostra como exibir uma mensagem confirmando uma mensagem de sucesso na parte superior do formulário.

g_form.addSuccessMessage("This is a success message");

GlideForm - clearAllFormMessages()

Remove todas as mensagens de formulário de qualquer tipo.

Consulte também:

• AddFormMessage()
• ClearFormMessages()

Tabela 23. Parâmetros

Nome	Tipo	Descrição
Nenhum

Tabela 24. Retorna

Tipo	Descrição
Nenhum(a)

O exemplo a seguir mostra como limpar todas as mensagens do formulário.

g_form.clearAllFormMessages();

GlideForm - clearFormMessages (tipo de cadeia de caracteres)

Remove todas as mensagens de formulário de um tipo especificado.

Consulte também:

• AddFormMessage()
• Limpar AllFormMessages()

Tabela 25. Parâmetros

Nome	Tipo	Descrição
tipo	Cadeia de caracteres	Tipo de mensagem. Valores válidos: erro informações aviso

Tabela 26. Retornos

Tipo	Descrição
Nenhum(a)

O exemplo a seguir mostra como limpar todas as mensagens de erro do formulário.

g_form.clearFormMessages('error');

GlideForm - clearMessages()

Remove todas as mensagens informativas e de erro da parte superior do formulário.

Remove mensagens informativas e de erro adicionadas com G_form.addInfoMessage() e. G_form.addErrorMessage() .

Tabela 27. Parâmetros

Nome	Tipo	Descrição
Nenhum

Tabela 28. Retorna

Tipo	Descrição
vazio

g_form.clearMessages();

GlideForm - clearOptions(cadeia de caracteres fieldName)

Remove todas as opções da lista de seleção especificada.

Tabela 29. Parâmetros

Nome	Tipo	Descrição
fieldName	Cadeia de caracteres	Nome do campo cujas opções de seleção serão desmarcadas.

Tabela 30. Retornos

Tipo	Descrição
vazio

GlideForm - clearValue(cadeia de caracteres fieldName)

Remove todos os valores do campo especificado.

Tabela 31. Parâmetros

Nome	Tipo	Descrição
fieldName	Cadeia de caracteres	Nome do campo a ser limpo.

Tabela 32. Retornos

Tipo	Descrição
vazio

GlideForm - disableAttachments()

Impede que anexos de arquivo sejam adicionados ao formulário.

Este método não está disponível na plataforma móvel. Se este método for executado em uma plataforma móvel, nenhuma ação ocorrerá.

Tabela 33. Parâmetros

Nome	Tipo	Descrição
Nenhum

Tabela 34. Retorna

Tipo	Descrição
vazio

GlideForm - disableChoice(cadeia de caracteres fieldName, cadeia de caracteres choiceValue)

Desabilita programaticamente uma opção específica no campo suspenso, se a opção existir. Nenhuma mudança será feita se a opção já estiver desabilitada.

Tabela 35. Parâmetros

Nome	Tipo	Descrição
fieldName	Cadeia de caracteres	Nome do campo da opção a ser desabilitado. Tipo de dados: Cadeia de caracteres
choiceValue	Cadeia de caracteres	Valor da opção a ser desabilitada. Tipo de dados: Cadeia de caracteres

Tabela 36. Retornos

Tipo	Descrição
Booliano	Sinalizador que indica se a opção fornecida está desabilitada ou ativa no formulário. Valores válidos: Verdadeiro: A opção está desabilitada. Falso: A opção já está desabilitada ou não foi encontrada. Tipo de dados: Booliano

Os exemplos a seguir chamam DisableChoice() para desabilitar a opção loading_dock no campo de formulário delivery_location.

if (g_form.getValue('address_type') == 'home') {
	g_form.disableChoice('delivery_location', 'loading_dock');
}

// Only itil_admin users can select the "Closed" option  

function onLoad() {
	if (g_user.hasRole('itil_admin')) return;

	if (g_form.getValue('incident_state') != '7')
		g_form.disableChoice('incident_state', 7);

	if (g_form.getValue('state') != '7') {
		g_form.disableChoice('state', 7);
	}

}

GlideForm - enableAttachments()

Permite que anexos de arquivo sejam adicionados ao formulário. Mostra o ícone de clipe de papel.

Este método não está disponível na plataforma móvel. Se este método for executado em uma plataforma móvel, nenhuma ação ocorrerá.

Tabela 37. Parâmetros

Nome	Tipo	Descrição
Nenhum

Tabela 38. Retorna

Tipo	Descrição
vazio

GlideForm - enableChoice(cadeia de caracteres fieldName, cadeia de caracteres choiceValue)

Habilita programaticamente uma opção específica no campo suspenso, se a opção existir. Nenhuma mudança será feita se a opção já estiver habilitada.

Tabela 39. Parâmetros

Nome	Tipo	Descrição
fieldName	Cadeia de caracteres	Nome do campo da opção a ser habilitada.
choiceValue	Cadeia de caracteres	Valor da opção a ser habilitada.

Tabela 40. Retornos

Tipo	Descrição
Booliano	Sinalizador que indica se a opção fornecida foi habilitada com sucesso. Valores válidos: Verdadeiro: A opção está habilitada. Falso: A opção já está habilitada ou não foi encontrada. Tipo de dados: Booliano

Os exemplos a seguir chamam habilitar() para habilitar uma nova opção suspensa, 1 . em prioridade campo de formulário.

var shortDescription = g_form.getValue('shortDescription');

// Allow priority 1 selection if short description mentions security 
if (shortDescription.includes('security')) {
	var p1Choice = g_form.getChoice('priority', '1');
	g_form.enableChoice('priority', '1');
}

GlideForm - flash (cadeia de caracteres fieldName, cor da cadeia de caracteres, contagem numérica)

Use para chamar a atenção para um campo. Pisca a cor especificada por uma duração especificada no campo especificado.

Este método não é compatível com Catálogo de serviços.

Este método não está disponível na plataforma móvel. Se este método for executado em uma plataforma móvel, nenhuma ação ocorrerá.

Tabela 41. Parâmetros

Nome	Tipo	Descrição
fieldName	Cadeia de caracteres	Campo a ser realçado no seguinte formato: "<table-name>.<field-name>" .
cor	Cadeia de caracteres	Cor RGB ou cor CSS aceitável.
contagem	Número	Por quanto tempo o rótulo piscará. Valores válidos: 2: Pisca por 1 segundo 0: Pisca durante 2 segundos -2: Pisca durante 3 segundos -4: Pisca durante 4 segundos

Tabela 42. Retornos

Tipo	Descrição
vazio

g_form.flash("incident.number", "#FFFACD", 0);

GlideForm - getActionName()

Retorna o nome da ação mais recente ou, para um client script, o sys_id da ação de IU clicada.

Nota:

Não disponível nos scripts de cliente do Assistente.

Tabela 43. Parâmetros

Nome	Tipo	Descrição
Nenhum

Tabela 44. Retorna

Tipo	Descrição
Cadeia de caracteres	Nome da ação atual ou sys_id da ação de IU clicada.

function onSubmit() {
   var action = g_form.getActionName();
   alert('You pressed ' + action);
}

GlideForm - getAnnotationByName(nome da cadeia de caracteres)

Retorna uma anotação de formulário de um determinado nome.

Anotações são separadores visuais entre elementos de formulário ou blocos de texto colorido usados para realçar elementos de formulário. Usar GlideForm - getAnnotationByName(nome da cadeia de caracteres) para retornar todas as anotações em um formulário.

Tabela 45. Parâmetros

Nome	Tipo	Descrição
nome	Cadeia de caracteres	O nome da anotação a ser retornada. Tabela: Anotações de formulário [sys_ui_annotation], Campo: Nome

Tabela 46. Retornos

Propriedade	Descrição
Matriz de objetivos	Conteúdo da anotação. Tipo de dados: Matriz de objetos [{content: "String", name: "String", visible: Boolean}]
array.content	Texto da anotação retornada. Tipo de dados: Cadeia de caracteres
array.name	Nome da anotação retornada. Tipo de dados: Cadeia de caracteres Local da tabela: Anotações de formulário [sys_ui_annotation], Campo: nome
matriz.visível	Sinalizador que indica se a anotação está visível no formulário. Valores válidos: Verdadeiro: A anotação está visível. Falso: A anotação não está visível. Tipo de dados: Booliano

O exemplo a seguir demonstra como usar o. ObAnotaçãoByName() método para recuperar uma anotação de formulário de acordo com seu nome fornecido, test-annotation-msg-1.

   var sampleAnnotation = g_form.getAnnotationByName("test-annotation-msg-1");

   /* returns:  
   { 
       "name": "test-annotation-msg-1", 
       "visible": true, 
       "content": "Test<input id=\"make_spacing_ok\" style=\"visibility:hidden; width:0px;\">" 
   }
   */

GlideForm - getAnotations()

Retorna uma lista de todas as anotações em um formulário.

Anotações são separadores visuais entre elementos de formulário ou blocos de texto colorido usados para realçar elementos de formulário. Usar GlideForm - getAnnotationByName(nome da cadeia de caracteres) para retornar uma anotação específica pelo nome.

Tabela 47. Parâmetros

Nome	Tipo	Descrição
Nenhum

Tabela 48. Retornos

Propriedade	Descrição
Matriz de objetivos	Conteúdo da anotação. Tipo de dados: Matriz de objetos [{content: "String", name: "String", visible: Boolean}]
array.content	Texto da anotação retornada. Tipo de dados: Cadeia de caracteres
array.name	Nome da anotação retornada. Tipo de dados: Cadeia de caracteres Local da tabela: Anotações de formulário [sys_ui_annotation], Campo: nome
matriz.visível	Sinalizador que indica se a anotação está visível no formulário. Valores válidos: Verdadeiro: A anotação está visível. Falso: A anotação não está visível. Tipo de dados: Booliano

O exemplo a seguir chama pela primeira vez GetAnotações() para retornar todas as anotações em um formulário e, em seguida, chamadas HideAnotação() para ocultar todas as anotações no formulário.

const annotations = getAnnotations();

/* returns:  
[ 
    { 
        "name": "test-annotation-msg-1", 
        "visible": true, 
        "content": "Test<input id=\"make_spacing_ok\" style=\"visibility:hidden; width:0px;\">" 
    }, 
    { 
        "name": "test-annotation-msg-2", 
        "visible": true, 
        "content": "Test 2<input id=\"make_spacing_ok\" style=\"visibility:hidden; width:0px;\">" 
    } 

]*/
annotations.forEach(function(annotation) {
	g_form.hideAnnotation(annotation.name);
});

// this script hides all annotations on the form.

GlideForm - getBooleanValue(cadeia de caracteres fieldName)

Retorna um valor booliano para o campo especificado.

Tabela 49. Parâmetros

Nome	Tipo	Descrição
fieldName	Cadeia de caracteres	Campo a ser realçado no seguinte formato: "<table-name>.<field-name>" .

Tabela 50. Retornos

Tipo	Descrição
Booliano	Retorna falso se o valor do campo for falso ou indefinido; caso contrário, retorna verdadeiro.

GlideForm - getChoice(cadeia de caracteres fieldName, cadeia de caracteres choiceValue)

Retorna um objeto com propriedades que representam um determinado campo e valor de escolha.

Tabela 51. Parâmetros

Nome	Tipo	Descrição
fieldName	Cadeia de caracteres	Nome do campo da opção a ser recuperado.
choiceValue	Cadeia de caracteres	Valor da opção a ser recuperada.

Tabela 52. Retornos

Propriedade	Descrição
Objeto GlideFormChoice ou nulo	Objeto GlideFormChoice para o campo especificado e o valor de opção. Retorna nulo se não houver opção correspondente. Tipo de dados: Objeto ("label", "value", "disabled", "index")
GlideFormChoice.label	Texto de exibição somente leitura da opção. Tipo de dados: Cadeia de caracteres
GlideFormChoice.Value	Valor somente leitura da opção. Tipo de dados: Cadeia de caracteres
GlideFormChoice.desabilitado	Sinalizador que indica se a opção está desabilitada no formulário. Valores válidos: Verdadeiro: A opção está desabilitada Falso: A opção está habilitada. Tipo de dados: Booliano
GlideFormChoice.index	Indica a posição da opção no menu suspenso. Tipo de dados: Número

Os exemplos a seguir chamam habilitar() para habilitar uma nova opção suspensa, 1 . em prioridade campo de formulário.

var shortDescription = g_form.getValue('shortDescription');

// Allow priority 1 selection if short description mentions security 
if (shortDescription.includes('security')) {
	var p1Choice = g_form.getChoice('priority', '1');
	g_form.enableChoice('priority', '1');
}

GlideForm - getControl(cadeia de caracteres fieldName)

Retorna o elemento HTML para o campo especificado.

Campos compostos podem conter vários elementos HTML. Este método geralmente não é necessário, pois existem métodos internos que usam os campos em um formulário.

Se o campo for um campo de referência e o controle for uma lista de seleção, GetControl() pode não retornar um controle conforme o esperado. Nesse caso, use sys_select. <table name>.<field name> .

Este método não está disponível em scripts para celular ou Portal de serviços scripts.

Tabela 53. Parâmetros

Nome	Tipo	Descrição
fieldName	Cadeia de caracteres	Nome do campo para o qual o elemento HTML será retornado.

Tabela 54. Retornos

Tipo	Descrição
HTMLElement	Elemento HTML do campo.

GlideForm - getDecimalValue(cadeia de caracteres fieldName)

Retorna o valor decimal do campo especificado.

Tabela 55. Parâmetros

Nome	Tipo	Descrição
fieldName	Cadeia de caracteres	Nome do campo para o qual retornar o valor decimal.

Tabela 56. Retornos

Tipo	Descrição
Cadeia de caracteres	Valor decimal do campo especificado.

function onChange(control, oldValue, newValue, isLoading) {
   alert(g_form.getDecimalValue('percent_complete'));
}

GlideForm - getDisplayBox(cadeia de caracteres fieldName)

Retorna o valor de exibição de um formulário na IU principal.

Nota:

Para obter um valor de exibição de um formulário em Portal de serviços, use ObtDisplayValue() método.

Consulte também:

• getValue()
• Obtenha o valor de exibição de uma variável de referência

Tabela 57. Parâmetros

Nome	Tipo	Descrição
fieldName	Cadeia de caracteres

Tabela 58. Retornos

Tipo	Descrição
Nenhum(a)	Nome do campo do qual recuperar o valor no formulário.

var caller = g_form.getDisplayBox('caller_id').value;

var assignee = g_form.getDisplayBox('assigned_to').value;

if (caller == assignee)
{
   alert('in');
}

GlideForm - getDisplayValue(cadeia de caracteres fieldName)

Retorna o valor de exibição de um formulário em Portal de serviços.

Consulte também:

• getValue()
• Obtenha o valor de exibição de uma variável de referência

Nota:

Na IU principal, chamando este método como G_form.getDisplayValue() sem um argumento, retorna o valor de exibição do registro em vez do valor de exibição de um campo individual.

Tabela 59. Parâmetros

Nome	Tipo	Descrição
fieldName	Cadeia de caracteres	Nome do campo do qual você deseja recuperar um valor no formulário.

Tabela 60. Retornos

Tipo	Descrição
Cadeia de caracteres	Valor de exibição do campo especificado.

O exemplo a seguir mostra como obter o valor de exibição de uma variável de referência na IU principal ou Portal de serviços. O caso de uso deste exemplo está no comunidade site.

function onChange(control, oldValue, newValue, isLoading) {
     if (isLoading || newValue == '') {
          return;
     }
     if(window == null){
          var valuePortal = g_form.getDisplayValue('requester');
          alert('Portal->' + valuePortal);
     }
     else{
          var valueNative = g_form.getDisplayBox('requester').value;     
          alert('CoreUI->' + valueCoreUI);
     }
     //Type appropriate comment here, and begin script below
}

GlideForm - getElement (ID de cadeia de caracteres)

Retorna o elemento HTML especificado pelo parâmetro.

Campos compostos podem conter vários elementos HTML. Este método geralmente não é necessário, pois existem métodos internos que usam os campos em um formulário.

Este método não está disponível em scripts para celular ou Portal de serviços scripts.

Tabela 61. Parâmetros

Nome	Tipo	Descrição
id	Cadeia de caracteres	ID do campo.

Tabela 62. Retornos

Tipo	Descrição
HTMLElement	Elemento HTML do campo.

GlideForm - getFormElement()

Retorna o elemento HTML do formulário.

Este método não está disponível em scripts para celular ou Portal de serviços scripts.

Tabela 63. Parâmetros

Nome	Tipo	Descrição
Nenhum

Tabela 64. Retorna

Tipo	Descrição
HTMLFormElement	Elemento HTML para o formulário.

GlideForm - getHelpTextControl(cadeia de caracteres fieldName)

Retorna o elemento HTML do texto de ajuda para o campo especificado.

Este método é aplicável somente a variáveis do catálogo de serviços.

Tabela 65. Parâmetros

Nome	Tipo	Descrição
fieldName	Cadeia de caracteres	Nome do campo.

Tabela 66. Retornos

Tipo	Descrição
HTMLElement	Elemento HTML do campo de texto de ajuda.

GlideForm - getIntValue(cadeia de caracteres fieldName)

Retorna o valor inteiro do campo especificado.

Tabela 67. Parâmetros

Nome	Tipo	Descrição
fieldName	Cadeia de caracteres	Nome do campo.

Tabela 68. Retornos

Tipo	Descrição
Número	Valor inteiro do campo.

GlideForm - getLabelOf(cadeia de caracteres fieldName)

Retorna o valor de texto sem formatação do rótulo do campo.

Tabela 69. Parâmetros

Nome	Tipo	Descrição
fieldName	Cadeia de caracteres	Nome do campo.

Tabela 70. Retornos

Tipo	Descrição
Cadeia de caracteres	Texto do rótulo.

if (g_user.hasRole('itil')) {
    var oldLabel = g_form.getLabelOf('comments');
    g_form.setLabelOf('comments', oldLabel + ' (Customer visible)');
}

GlideForm - getOption(cadeia de caracteres fieldName, cadeia de caracteres choiceValue)

Retorna o elemento de opção para uma caixa selecionada chamada fieldNameonde choiceValuecorresponde ao valor da opção.

Nota:

Este método não funciona em campos somente leitura.

Tabela 71. Parâmetros

Nome	Tipo	Descrição
fieldName	Cadeia de caracteres	Nome do campo.
choiceValue	Cadeia de caracteres	Valor da opção.

Tabela 72. Retornos

Tipo	Descrição
HTMLElement	HTMLElement da opção. Retorna nulo se o campo ou a opção não for encontrado.

O exemplo a seguir mostra como obter o rótulo para um valor de lista de seleção.

// Get the label for a choice list value
// fieldName is 'category'
 
function onChange(control, oldValue, newValue, isLoading) {
var choiceValue = g_form.getValue('category');
var choiceLabel = g_form.getOption('category', choiceValue).text; 
}

GlideForm - getOptions(cadeia de caracteres fieldName)

Retorna as opções disponíveis e selecionadas para um campo de escolha ou referência no formulário. Este método é útil para formulários dinâmicos, variáveis de catálogo e conjuntos de variáveis e integrações que precisam inspecionar ou filtrar opções de campo no tempo de execução.

Por exemplo, você pode usar G_form.getOptions() para:

• Obtenha e defina os pares nome-valor em um tipo de campo watch_list.
• PESQUISE ou filtre as opções disponíveis por um termo de pesquisa.
• Habilite o acesso aos mesmos resultados de preenchimento automático por meio de um retorno de chamada.
• Obtenha e defina opções em campos de escolha, campos de referência e tipos de campo avançados, como watch_list, glide_list, field_list e slushbucket.

Tabela 73. Parâmetros

Nome	Tipo	Descrição
fieldName	Cadeia de caracteres	O nome do campo de opção ou de referência a ser recuperado.

Tabela 74. Retornos

Propriedade	Descrição
Matriz de objetos ou nulo	Matriz somente leitura de objetos que contém o valor e o rótulo de cada opção selecionada. Retorna nulo se o campo não oferecer suporte a opções. Tipo de dados: Matriz de objetos [{value: "String", displayValue: "String"}]
Matriz.displayValue	O valor de exibição da opção. Tipo de dados: Cadeia de caracteres
matriz.valor	O valor da opção. Tipo de dados: Cadeia de caracteres
GetAvailable (termo)	Função para retornar todas as opções disponíveis. Um termo de pesquisa pode ser fornecido como um argumento para filtrar as opções por valor de exibição (uma correspondência de substring secundária que não diferencia maiúsculas de minúsculas). Retorna uma promessa de matriz de objetos com o valor de exibição e o valor da opção correspondente. Tipo de dados: Matriz de objetos [{value: "String", displayValue: "String"}]

Os exemplos a seguir chamam G_form.getOptions() para retornar todas as opções disponíveis para campos de formulário especificados, como state, work_notes_list e outros.

g_form.getOptions("state"); //table: incident, field: state, type: integer, choice: Dropdown without --None--
/*
returns [{"value":"1","displayValue":"New"},{"value":"2","displayValue":"In Progress"},{"value":"3","displayValue":"On Hold"},{"value":"6","displayValue":"Resolved"},{"value":"7","displayValue":"Closed"},{"value":"8","displayValue":"Canceled"}]
*/

g_form.getOptions("category"); //table: incident, field: category, type: string, choice: Dropdown with --None--
/*
returns [{"value":"","displayValue":"-- None --"},{"value":"inquiry","displayValue":"Inquiry / Help"},{"value":"software","displayValue":"Software"},{"value":"hardware","displayValue":"Hardware"},{"value":"network","displayValue":"Network"},{"value":"database","displayValue":"Database"}]
*/

g_form.getOptions("work_notes_list") //table: incident, field: work_notes_list, type: glide_list
/*
returns [{"value":"62826bf03710200044e0bfc8bcbe5df1","displayValue":"Abel Tuter"},{"value":"a8f98bb0eb32010045e1a5115206fe3a","displayValue":"Abraham Lincoln"},{"value":"5137153cc611227c000bbd1bd8cd2005","displayValue":"Fred Luddy"},{"value":"6a826bf03710200044e0bfc8bcbe5dec","displayValue":"Alissa Mountjoy"}]
*/

g_form.getOptions("restricted_fields") //table: std_change_properties, field: restricted_fields, type: field_list
/*
[{"value":"activity_due","displayValue":"Activity due"},{"value":"additional_assignee_list","displayValue":"Additional assignee list"},{"value":"comments","displayValue":"Additional comments"},{"value":"assignment_group","displayValue":"Assignment group"},{"value":"backout_plan","displayValue":"Backout plan"},{"value":"business_duration","displayValue":"Business duration"},{"value":"cab_delegate","displayValue":"CAB delegate"},...]
*/

g_form.getOptions('table') //table: sys_script_client, field: table, type: table_name
/*
[{"value":"","displayValue":"-- None --"},{"value":"cmdb_ci_appl_dot_net","displayValue":".NET Application [cmdb_ci_appl_dot_net]"},{"value":"evaluation","displayValue":"A/B Testing Evaluation [evaluation]"},{"value":"evaluation_execution","displayValue":"A/B Testing Evaluation Execution [evaluation_execution]"},{"value":"evaluation_parameter","displayValue":"A/B Testing Evaluation Parameter [evaluation_parameter]"},{"value":"sn_access_analyzer_request","displayValue":"Access Analyzer Query [sn_access_analyzer_request]"},{"value":"sn_access_analyzer_access_comparison_request","displayValue":"Access Comparison Request [sn_access_analyzer_access_comparison_request]"},{"value":"sys_security_acl","displayValue":"Access Control [sys_security_acl]"},...]
*/

g_form.getOptions('mandatory_fields'); //table: kb_knowledge_base, field: mandatory_fields, type: slushbucket
/*
[{"value":"active","displayValue":"Active"},{"value":"article_id","displayValue":"Article ID"},{"value":"displayValue","displayValue":"Article body"},{"value":"article_type","displayValue":"Article type"},{"value":"direct","displayValue":"Attachment link"},{"value":"author","displayValue":"Author"},{"value":"base_version","displayValue":"Base Version"},...]
*/

O script de exemplo a seguir demonstra como chamar G_form.getOptions() Com a função getAvailable().

const options = g_form.getOptions('priority');
if (options) {
  console.log('Selected:', options.selected);
  options.getAvailable('high').then(available => {
    console.log('Available matching "high":', available);
  });
}

GlideForm - getReference(cadeia de caracteres fieldName, retorno de chamada da função)

Retorna o GlideRecord para um campo especificado.

Se uma função de retorno de chamada estiver presente, esta rotina será executada de forma assíncrona. O processamento do navegador (e script) continua normalmente até que o servidor retorne o valor de referência, momento em que a função de retorno de chamada é invocada. Se uma função de retorno de chamada não estiver presente, essa rotina será executada de forma síncrona e o processamento será interrompido (fazendo com que o navegador pareça travar) enquanto aguarda uma resposta do servidor.

Importante:

É altamente recomendável que você use uma função de retorno de chamada.

O suporte à função de retorno de chamada para ServiceCatalogForm.getReference está disponível.

Nota:

Usar este método requer uma chamada para o servidor, o que requer tempo adicional e pode introduzir latência na sua página. Use este método com cuidado. Para obter informações adicionais, consulte Design e processamento de client script .

Tabela 75. Parâmetros

Nome	Tipo	Descrição
fieldName	Cadeia de caracteres	Nome do campo.
Retorno de chamada	Função	Nome da função de retorno de chamada.

Tabela 76. Retornos

Tipo	Descrição
GlideRecord	Objeto GlideRecord para o campo especificado. Se a referência especificada não puder ser encontrada, ela retornará um objeto GlideRecord inicializado em que CurrentRow: -1 e. comprimento: 0 .

function onChange(control, oldValue, newValue, isLoading) {
    g_form.getReference('caller_id', doAlert); // doAlert is our callback function
}
 
function doAlert(caller) { // reference is passed into callback as first arguments
   if (caller.getValue('vip') == 'true') {
      alert('Caller is a VIP!');
   }
}

GlideForm - getRelatedListNames()

Retorna uma matriz de nomes de lista relacionada do formulário atual.

Tabela 77. Parâmetros

Nome	Tipo	Descrição
Nenhum

Tabela 78. Retorna

Tipo	Descrição
Matriz de cadeia de caracteres	Lista de nomes de lista relacionada do formulário atual. Os nomes da lista relacionada são listados na ordem em que aparecem no formulário.

var listNames = g_form.getRelatedListNames();

for (var i = 0; i < listNames.length; i++) {  
  this.showRelatedList(listNames[i]);
 }

GlideForm - getSectionNames()

Retorna todos os nomes de seção, visíveis ou não.

Tabela 79. Parâmetros

Nome	Tipo	Descrição
Nenhum

Tabela 80. Retorna

Tipo	Descrição
Matriz de cadeia de caracteres	Nomes das seções.

GlideForm - getSections()

Retorna uma matriz das seções do formulário.

Este método não está disponível na plataforma móvel. Se este método for executado em uma plataforma móvel, nenhuma ação ocorrerá.

Tabela 81. Parâmetros

Nome	Tipo	Descrição
Nenhum

Tabela 82. Retorna

Tipo	Descrição
Matriz de elementos HTML	Seções do formulário.

function onChange(control, oldValue, newValue, isLoading) {
   //this example was run on a form divided into sections (Change form)
   // and hid a section when the "state" field was changed
   var sections = g_form.getSections();
   if (newValue == '2') {
      g_form.setSectionDisplay(sections[1], false);
   } else {
      g_form.setSectionDisplay(sections[1], true);
   }
}

GlideForm - getTableName()

Retorna o nome da tabela à qual este registro pertence.

Do lado do servidor, a tabela do registro atual pode ser recuperada com current.sys_class_name ou GetTableName() .

Tabela 83. Parâmetros

Nome	Tipo	Descrição
Nenhum

Tabela 84. Retorna

Tipo	Descrição
Cadeia de caracteres	Nome da tabela.

function onLoad() {
    if (g_form.isNewRecord()) {
        var tableName = g_form.getTableName(); //Get the table name
    }
}

GlideForm - getUniqueValue()

Retorna o sys_id do registro exibido no formulário.

Tabela 85. Parâmetros

Nome	Tipo	Descrição
Nenhum

Tabela 86. Retorna

Tipo	Descrição
Cadeia de caracteres	Sys_id do registro.

function onLoad() {
   var incSysid = g_form.getUniqueValue();
   alert(incSysid);
}

GlideForm - getValue(cadeia de caracteres fieldName)

Retorna o valor do campo de formulário especificado.

Este método também oferece suporte à obtenção de valores de um conjunto de variáveis de várias linhas (MRVS). Para obter dados de campos em um MRVS, você deve primeiro usar JSON.parse(getValue('<mrvs_field_name>') || '[]') Para obter a matriz MRVS e usar a indexação para acessar os campos nos objetos de linha. Para obter mais detalhes, consulte o exemplo de código abaixo.

Tabela 87. Parâmetros

Nome	Tipo	Descrição
fieldName	Cadeia de caracteres	Nome do campo cujo valor será retornado.

Tabela 88. Retornos

Tipo	Descrição
Cadeia de caracteres	Valor do campo especificado.

O exemplo a seguir mostra como obter a descrição resumida do formulário atual.

function onChange(control, oldValue, newValue, isLoading) {
   alert(g_form.getValue('short_description'));
}

O exemplo a seguir mostra como obter valores de um MRVS. Neste exemplo, os salários estão sendo gerenciados por meio do Catálogo de serviços. O script do cliente pesquisa todas as linhas no MRVS para o valor inserido em Cargo E atualiza as entradas correspondentes no MRVS com o que é inserido no Salário campo. O MRVS é chamado "variable_set_1" e contém os seguintes campos em cada objeto de linha: Nome do funcionário [employee_name], Cargo [employee_job_title] e Salário [employee_salary]. Além disso, o Item do catálogo contém: Cargo [job_title] e salário [salary].

function onChange(control, oldValue, newValue, isLoading) {
if (isLoading || newValue == '') {
return;
}
 
// Get the MRVS
var vs1 = g_form.getValue('variable_set_1') || '[]';
var multiRowVariableSet = JSON.parse(vs1);
 
for (var i = 0; i < multiRowVariableSet.length; i++) {
// Check if the entered job title matches the title in the current MRVS row
  if (multiRowVariableSet[i].employee_job_title == g_form.getValue("job_title")){
    // Update the value of a matching field with the new salary
    multiRowVariableSet[i].employee_salary = newValue;
  }
}
 
// Update the MRVS
g_form.setValue('variable_set_1', JSON.stringify(multiRowVariableSet));
}

GlideForm - hideAllFieldMsgs()

Oculta todas as mensagens de campo.

Tabela 89. Parâmetros

Nome	Tipo	Descrição
Nenhum

Tabela 90. Retorna

Tipo	Descrição
vazio

GlideForm - hideAllFieldMsgs(tipo de cadeia de caracteres)

Oculta todas as mensagens de campo do tipo especificado.

Tabela 91. Parâmetros

Nome	Tipo	Descrição
tipo	Cadeia de caracteres	Tipo de mensagem. Valores válidos: erro informações

Tabela 92. Retornos

Tipo	Descrição
vazio

GlideForm - hideAnnotation(nome da cadeia de caracteres)

Oculta uma anotação com um determinado nome na IU do formulário.

Anotações são separadores visuais entre elementos de formulário ou blocos de texto colorido usados para realçar elementos de formulário. Consulte também:

• GlideForm - showErrorBox (nome da cadeia de caracteres, mensagem da cadeia de caracteres, rolagem booliana) para exibir uma anotação específica no formulário.
• GlideForm - toggleAnnotations() para ativar e desativar anotações com maior flexibilidade.

Tabela 93. Parâmetros

Nome	Tipo	Descrição
nome	Cadeia de caracteres	Nome da anotação a ser ocultada no formulário. Tabela: Anotações de formulário [sys_ui_annotation], Campo: Nome

Tabela 94. Retornos

Tipo	Descrição
Nenhum(a)

O exemplo a seguir demonstra como ocultar programaticamente a anotação chamada test-annotation-msg-1 no campo de formulário usando HideAnotação() método.

g_form.hideAnnotation('test-annotation-msg-1');

GlideForm - hideErrorBox(cadeia de caracteres fieldName)

Oculta a mensagem de erro colocada por ShowErrorBox() .

Sempre que possível, use HideFieldMsg() em vez deste método sempre que possível.

Tabela 95. Parâmetros

Nome	Tipo	Descrição
fieldName	Cadeia de caracteres	Nome do campo ou controle cuja mensagem de erro será ocultada.

Tabela 96. Retornos

Tipo	Descrição
vazio

GlideForm - hideFieldMsg(cadeia de caracteres fieldName, booliano clearAll)

Oculta a primeira mensagem que aparece no campo especificado no formulário atual.

Use ShowFieldMsg (campo de cadeia de caracteres, mensagem de cadeia de caracteres, tipo de cadeia de caracteres) ou ShowFieldMsg (campo de cadeia de caracteres, mensagem de cadeia de caracteres, tipo de cadeia de caracteres, rolagem booliana) métodos para exibir mensagens em um formulário.

Por exemplo, o snippet de código a seguir mostra como exibir duas mensagens no work_notes campo de um formulário e oculte a primeira mensagem:

g_form.showFieldMsg('work_notes', 'First message', "error");
g_form.showFieldMsg('work_notes', 'Second message', "error");
g_form.hideFieldMsg('work_notes', false); // This call hides the 'First message'

Tabela 97. Parâmetros

Nome	Tipo	Descrição
fieldName	Cadeia de caracteres	Nome do campo no qual ocultar a mensagem.
Limpar Tudo	Booliano	Opcional. Sinalizador que indica se todas as mensagens do campo especificado devem ser ocultadas. Valores válidos: Verdadeiro: Oculta todas as mensagens. Falso: Oculta somente a primeira mensagem exibida. Padrão: falso

Tabela 98. Retornos

Tipo	Descrição
vazio

O exemplo a seguir mostra como limpar todas as mensagens de um campo de formulário especificado e exibir uma mensagem de erro de criptografia.

function submitEncryptedInputs() {
  return processEncryptedInputs(function(inputName, fieldName) {
    if (!checkEncryptedFieldValue(fieldName)) {
      g_form.hideFieldMsg(fieldName, true); // Hide all messages for the specified field
      g_form.showFieldMsg(fieldName, "Your activity requires an encrypted input.", "error");
      return false;
    }
    return true;
  });
}

GlideForm - hideRelatedLinks()

Oculta a seção Links relacionados de um formulário.

Consulte também:

• GlideForm - showRelatedLinks()
• GlideForm - setRelatedLinksDisplay (exibição booliana)

Tabela 99. Parâmetros

Nome	Tipo	Descrição
Nenhum

Tabela 100. Retorna

Tipo	Descrição
Nenhum(a)

O script de exemplo a seguir oculta links relacionados no formulário atual.

// Hide related links
g_form.hideRelatedLinks()

GlideForm - hideRelatedList(cadeia de caracteres listTableName)

Oculta a lista relacionada especificada no formulário.

Este método não está disponível na plataforma móvel. Se este método for executado em uma plataforma móvel, nenhuma ação ocorrerá.

Tabela 101. Parâmetros

Nome	Tipo	Descrição
ListTableName	Cadeia de caracteres	Nome da lista relacionada. Use o sys_id para ocultar uma lista por meio de um relacionamento.

Tabela 102. Retornos

Tipo	Descrição
vazio

GlideForm - hideRelatedLists()

Oculta todas as listas relacionadas no formulário.

Este método não está disponível na plataforma móvel. Se este método for executado em uma plataforma móvel, nenhuma ação ocorrerá.

Tabela 103. Parâmetros

Nome	Tipo	Descrição
Nenhum

Tabela 104. Retorna

Tipo	Descrição
vazio

GlideForm - hideTemplateBar()

Oculta a barra de modelo no formulário.

Tabela 105. Parâmetros

Nome	Tipo	Descrição
Nenhum

Tabela 106. Retorna

Tipo	Descrição
Nenhum(a)

O script de exemplo a seguir oculta a Barra de modelos no formulário atual.

g_form.hideTemplateBar()

GlideForm - isLiveUpdating()

Retorna verdadeiro enquanto uma atualização em tempo real está sendo feita no registro que o formulário está mostrando.

Isso pode ser usado em um Onchange() script de cliente para determinar se uma mudança no registro é devido a uma atualização em tempo real de outra sessão. O client script pode decidir qual ação executar ou não. Isso se aplica a sistemas que usam IU principal com formulários dinâmicos habilitados.

Tabela 107. Parâmetros

Nome	Tipo	Descrição
Nenhum

Tabela 108. Retorna

Tipo	Descrição
Booliano	Retorna verdadeiro se uma atualização em tempo real estiver acontecendo no registro exibido pelo formulário.

GlideForm - isObrigatório(cadeia de caracteres fieldName)

Retorna verdadeiro se o campo for obrigatório.

Tabela 109. Parâmetros

Nome	Tipo	Descrição
fieldName	Cadeia de caracteres	Nome do campo.

Tabela 110. Retornos

Tipo	Descrição
Booliano	Verdadeiro se o campo for obrigatório, caso contrário, falso.

GlideForm - isNewRecord()

Retorna verdadeiro se o registro nunca tiver sido salvo.

Tabela 111. Parâmetros

Nome	Tipo	Descrição
Nenhum

Tabela 112. Retorna

Tipo	Descrição
Booliano	Retorna verdadeiro se o registro não tiver sido salvo; caso contrário, falso.

function onLoad() {
   if(g_form.isNewRecord()){
      alert('New Record!');
   }
}

GlideForm - isSectionVisible(cadeia de caracteres SectionName)

Retorna verdadeiro se a seção estiver visível.

Importante:

A função isSectionVisible() não é compatível com o Espaço.

Tabela 113. Parâmetros

Nome	Tipo	Descrição
Nenhum

Tabela 114. Retorna

Tipo	Descrição
Booliano	Retorna verdadeiro quando a seção está visível; caso contrário, falso é retornado.

GlideForm - isVisible(cadeia de caracteres fieldName)

Determina se o campo associado ao nome do campo aprovado está visível no formulário atual.

Tabela 115. Parâmetros

Nome	Tipo	Descrição
fieldName	Cadeia de caracteres	Nome do campo para verificar se ele está visível no formulário atual.

Tabela 116. Retornos

Tipo	Descrição
Booliano	Sinalizador que indica se o campo especificado está visível no formulário atual. Valores possíveis: Verdadeiro: O campo está visível no formulário. Falso: O campo não está visível no formulário.

O exemplo de código a seguir mostra como verificar se user_address o campo está visível no formulário atual.

if(g_form.isVisible('user_address')) {
    alert('is visible');
}
else {
    alert('is hidden');
}

GlideForm - onUserChangeValue(function fn)

Registra um ouvinte de evento personalizado que detecta quando qualquer campo no formulário atual é modificado por um usuário.

Quando um campo de formulário é modificado, o ouvinte de evento chama a função que é passada quando o ouvinte é registrado inicialmente. Este ouvinte só é acionado quando um usuário faz uma mudança em um campo no formulário. Mudanças de scripts de cliente, políticas de IU ou quaisquer outras interações não relacionadas ao usuário não acionam o ouvinte.

Nota:

Este método não funciona para campos de registro ou Catálogo de serviços itens no ambiente clássico.

Tabela 117. Parâmetros

Nome	Tipo	Descrição
fn	Função	Função a ser chamada quando um usuário muda o valor de um campo no formulário atual. Na verdade, este é o código da função, não apenas o nome da função. Esta função deve aceitar os três seguintes argumentos: nome do campo valor do campo original valor do campo atualizado

Tabela 118. Retornos

Tipo	Descrição
Função	Função a ser chamada para cancelar o registro do ouvinte de evento onUserChangeValue.

var handler = function(fieldname, originalValue, newValue) {
  console.log('The field ('+ fieldname + ') has a new value of: ' + newValue); // function code
}
 
var unregister = g_form.onUserChangeValue(handler);
 
// To unregister the event listener
unregister();

GlideForm - refreshSlushbucket(cadeia de caracteres fieldName)

Você pode atualizar uma variável do coletor de lista.

Tabela 119. Parâmetros

Nome	Tipo	Descrição
fieldName	Cadeia de caracteres	Nome do bucket de slush.

Tabela 120. Retornos

Tipo	Descrição
vazio

g_form.refreshSlushbucket('bucket');

GlideForm - removeDecoration (cadeia de caracteres fieldname, ícone de cadeia de caracteres, título da cadeia de caracteres)

Remove o ícone do campo especificado que corresponde ao ícone e ao título especificados.

Nota:

Este método não é compatível com Catálogo de serviços.

Tabela 121. Parâmetros

Nome	Tipo	Descrição
fieldName	Cadeia de caracteres	Nome do campo do qual remover a decoração.
ícones	Cadeia de caracteres	Nome do ícone a ser removido.
título	Cadeia de caracteres	Título do texto do ícone (nome).

Tabela 122. Retornos

Tipo	Descrição
vazio

function onChange(control, oldValue, newValue, isLoading) {
	// if the caller_id field is not present, then we can't add an icon anywhere
	if (!g_form.hasField('caller_id'))
		return;
 
	if (!newValue)
		return;
 
	g_form.getReference('caller_id', function(ref) {
		g_form.removeDecoration('caller_id', 'icon-star', 'VIP');
 
		if (ref.getValue('vip') == 'true')
			g_form.addDecoration('caller_id', 'icon-star', 'VIP');			
	});
}

GlideForm - removeDecoration (cadeia de caracteres fieldname, ícone de cadeia de caracteres, título da cadeia de caracteres, cor da cadeia de caracteres)

Remove o ícone do campo especificado que corresponde ao ícone, título e cor especificados.

Nota:

Este método não é compatível com Catálogo de serviços.

Tabela 123. Parâmetros

Nome	Tipo	Descrição
fieldName	Cadeia de caracteres	Nome do campo do qual remover a decoração.
ícones	Cadeia de caracteres	Nome do ícone a ser removido.
título	Cadeia de caracteres	Título do texto do ícone (nome).
cor	Cadeia de caracteres	Cor CSS a ser correspondida.

Tabela 124. Retornos

Tipo	Descrição
vazio

g_form.removeDecoration('caller_id', 'icon-star', 'VIP', 'blue');

GlideForm - removeOption(cadeia de caracteres fieldName, cadeia de caracteres choiceValue)

Remove a opção especificada da lista de seleção especificada.

Tabela 125. Parâmetros

Nome	Tipo	Descrição
fieldName	Cadeia de caracteres	Nome do campo do qual remover a opção da lista de seleção.
choiceValue	Cadeia de caracteres	Valor armazenado no banco de dados. Este não é o rótulo.

Tabela 126. Retornos

Tipo	Descrição
vazio

g_form.removeOption('priority', '1');

GlideForm - save()

Salva o registro sem navegar (atualizar e permanecer).

Tabela 127. Parâmetros

Nome	Tipo	Descrição
Nenhum

Tabela 128. Retorna

Tipo	Descrição
vazio

GlideForm - setChoiceLabel(cadeia de caracteres fieldName, cadeia de caracteres choiceValue, cadeia de caracteres newLabel)

Atualiza o rótulo de uma opção específica no campo suspenso.

Ao chamar este método, a posição do índice da opção atualizada no menu suspenso permanece inalterada. O estado habilitado ou desabilitado da opção é preservado.

Tabela 129. Parâmetros

Nome	Tipo	Descrição
fieldName	Cadeia de caracteres	Nome do campo que contém a opção a ser atualizada. Tipo de dados: Cadeia de caracteres
choiceValue	Cadeia de caracteres	Valor do rótulo de opção a ser atualizado com um novo rótulo. Tipo de dados: Cadeia de caracteres
NoRótulo	Cadeia de caracteres	Nome do rótulo para atualizar o rótulo de opção existente. Tipo de dados: Cadeia de caracteres

Tabela 130. Retornos

Tipo	Descrição
Booliano	Sinalizador que indica se o rótulo da opção foi atualizado com sucesso. Valores válidos: Verdadeiro: O rótulo de opção foi atualizado. Falso: O rótulo de opção não foi atualizado porque a opção especificada para atualizar pode ter sido somente leitura ou não existe, ou o novo rótulo existe e já está associado a outra opção.

O exemplo a seguir chama setChoiceLabel() para atualizar as opções de campo "bônus" (10, 20 e 30) para novos valores.

// Show the calculated bonus next to the percentage label
var salary = parseInt(g_form.getValue('salary'), 10); 
g_form.setChoiceLabel('bonus', '10', '10% ($'+ (salary * .10) +')'); 
g_form.setChoiceLabel('bonus', '20', '20% ($'+ (salary * .20) +')'); 
g_form.setChoiceLabel('bonus', '30', '30% ($'+ (salary * .30) +')');

GlideForm - setDisabled (cadeia de caracteres fieldName, booliano desabilitado)

Torna o campo especificado disponível ou indisponível.

Tabela 131. Parâmetros

Nome	Tipo	Descrição
fieldName	Cadeia de caracteres	Nome do campo a ser habilitado ou desabilitado.
desativar	Booliano	Sinalizador que indica se o campo especificado deve ser desabilitado. Valores válidos: Verdadeiro: Desabilite o campo. Falso: Habilita o campo. Padrão: falso

Tabela 132. Retornos

Tipo	Descrição
vazio

GlideForm - setDisplay (cadeia de caracteres fieldName, exibição booliana)

Exibe ou oculta um campo especificado no formulário.

Este método não pode ocultar um campo obrigatório sem valor. Se o campo estiver oculto, o espaço será usado para exibir outros itens. Sempre que possível, use uma política de IU em vez deste método.

Tabela 133. Parâmetros

Nome	Tipo	Descrição
fieldName	Cadeia de caracteres	Nome do campo.
tela	Booliano	Sinalizador que indica se o campo especificado deve ser exibido. Valores válidos: Verdadeiro: Exiba o campo. Falso: Oculta o campo.

Tabela 134. Retornos

Tipo	Descrição
vazio

function onChange(control, oldValue, newValue, isLoading, isTemplate) {
   //If the page isn't loading
   if (!isLoading) {
      //If the new value isn't blank
      if (newValue != '') {
         g_form.setDisplay('priority', false);   
      }
      else 
         g_form.setDisplay('priority', true);
      }
   }

GlideForm - setLabelOf(cadeia de caracteres fieldName, rótulo da cadeia de caracteres)

Define o valor de texto sem formatação do rótulo de campo especificado.

Nota:

Este método não é compatível com Catálogo de serviços.

Tabela 135. Parâmetros

Nome	Tipo	Descrição
fieldName	Cadeia de caracteres	Nome do campo para o qual definir o rótulo.
rótulo	Cadeia de caracteres	Valor de texto sem formatação a ser definido no rótulo.

Tabela 136. Retornos

Tipo	Descrição
vazio

if (g_user.hasRole('itil')) {
    var oldLabel = g_form.getLabelOf('comments');
    g_form.setLabelOf('comments', oldLabel + ' (Customer visible)');
}

GlideForm - setObrigatório(Cadeia de caracteres fieldName, booliano obrigatório)

Torna o campo especificado obrigatório.

Sempre que possível, use uma política de IU em vez deste método.

Tabela 137. Parâmetros

Nome	Tipo	Descrição
fieldName	Cadeia de caracteres	Nome do campo a ser obrigatório.
obrigatória	Booliano	Sinalizador que indica se o campo é obrigatório. Valores válidos: Verdadeiro: O campo é obrigatório. Falso: O campo é opcional. Padrão: falso

Tabela 138. Retornos

Tipo	Descrição
vazio

GlideForm - setReadOnly(cadeia de caracteres fieldName, booliano ReadOnly)

Torna o campo especificado somente leitura ou editável.

Sempre que possível, use uma política de IU em vez deste método.

Para tornar um campo obrigatório somente leitura, você deve primeiro remover o requisito obrigatório desse campo usando SetObrigatório() método.

Depois de definir um campo como somente leitura, você não poderá usar SetValue() método para atualizar o valor desse campo. Se você precisar definir o valor dessa maneira, deverá definir readOnlyvalor para falso.

Tabela 139. Parâmetros

Nome	Tipo	Descrição
fieldName	Cadeia de caracteres	Nome do campo cujo valor de acesso será definido.
readOnly	Booliano	Sinalizador que determina se o campo associado é editável ou somente leitura. Valores válidos: Verdadeiro: Defina o campo como somente leitura. Falso: Define o campo como editável.

Tabela 140. Retornos

Tipo	Descrição
vazio

O exemplo a seguir mostra como definir o Editor de variáveis como somente leitura. Para fazer isso em Catálogo de serviços tabelas, usar SetVariablesReadOnly() .

// Create a Client Script on a table (e.g., incident) and paste this script
// Uncheck (set to false) the "isolate script" checkbox (not available by default)
// To add the isolate script checkbox to the form, configure form layout to add the checkbox
function onLoad() { 
  $("variable_map").querySelectorAll("item").forEach(function(item){
    var variable = item.getAttribute("qname"); 
    g_form.setReadOnly("variables."+ variable, true); 
  }); 
}

GlideForm - setRelatedLinksDisplay (exibição booliana)

Mostre ou oculte a seção Links relacionados na IU do formulário usando valores boolianos.

GlideForm - hideRelatedLinks() Oculta ações de IU de link relacionado no formulário, enquanto GlideForm - showRelatedLinks() mostra-os. . g_form.setRelatedLinksDisplay(boolean: visor) no entanto, o método pode ser usado para mostrar ou ocultar links relacionados com mais flexibilidade em seus scripts.

Tabela 141. Parâmetros

Nome	Tipo	Descrição
tela	Booliano	Sinalizador que indica se a seção Links relacionados deve ser mostrada ou ocultada de um formulário. Valores válidos: Verdadeiro: Exibe links relacionados no formulário. Falso: Oculta links relacionados no formulário. Padrão: verdadeiro

Tabela 142. Retornos

Tipo	Descrição
Nenhum(a)

O exemplo a seguir demonstra como mostrar ou ocultar a seção Links relacionados em um formulário.

// Displays the Related Links section in the UI
g_form.setRelatedLinksDisplay(true);
// Hides the Related Links section in the UI
g_form.setRelatedLinksDisplay(false);

GlideForm - setSectionDisplay(cadeia de caracteres SectionName, exibição booliana)

Mostra ou oculta uma seção especificada no formulário.

Tabela 143. Parâmetros

Nome	Tipo	Descrição
sectionName	Cadeia de caracteres	O nome da seção é minúscula com um sublinhado substituindo o primeiro espaço no nome e com os espaços restantes sendo removidos. Por exemplo, "A seção quatro está aqui" se torna "section_fourishere". Outros caracteres não alfanuméricos, como "E" (&), são removidos. Nomes de seção podem ser encontrados usando GetSectionNames() método.
tela	Booliano	Sinalizador que indica se a seção deve ser exibida. Valores válidos: Verdadeiro: Mostra a seção. Falso: Oculta a seção.

Tabela 144. Retornos

Tipo	Descrição
Booliano	Retorna verdadeiro quando bem-sucedido.

GlideForm - setValue(cadeia de caracteres fieldName, valor da cadeia de caracteres)

Define o valor de um campo de formulário especificado com o valor especificado.

Este método também oferece suporte à configuração de valores em um conjunto de variáveis de várias linhas (MRVS). Primeiro você deve usar JSON.parse(getValue('<mrvs_field_name>')) Para obter a matriz MRVS e usar a indexação para atualizar os campos nos objetos de linha. Depois que todos os valores forem atualizados no MRVS, use SetValue() Método para salvar a matriz MRVS atualizada. Para obter mais detalhes, consulte o exemplo de código abaixo.

Nota:

O método SetValue() Pode causar um estouro de pilha quando usado em um client script onchange. Sempre que o valor for definido, ele será registrado como uma mudança, o que pode acionar novamente o script do cliente onchange. Para evitar isso, execute uma verificação que validará se o novo valor será diferente do valor antigo. Por exemplo, antes de executar SetValue(shortDesc, newValue.toUpperCase()); valide se a descrição resumida ainda não está em maiúsculas. Isso impedirá que o client script aplique o. Para UpperCase() mais de uma vez.

Tabela 145. Parâmetros

Nome	Tipo	Descrição
fieldName	Cadeia de caracteres	Nome do campo do formulário a ser atualizado.
valor	Cadeia de caracteres	Valor a ser definido no campo especificado. Nota: Ao definir um valor em uma lista de seleção, certifique-se de usar o valor numérico em vez do rótulo.

Tabela 146. Retornos

Tipo	Descrição
vazio

O exemplo a seguir mostra como definir a descrição resumida no formulário atual.

g_form.setValue('short_description', 'replace this with appropriate text');

O exemplo a seguir mostra como definir valores em um MRVS. Neste exemplo, os salários estão sendo gerenciados por meio do Catálogo de serviços. O script do cliente pesquisa todas as linhas no MRVS para o valor inserido em Cargo E atualiza as entradas correspondentes no MRVS com o que é inserido no Salário campo. O MRVS é chamado "variable_set_1" e contém os seguintes campos em cada objeto de linha: Nome do funcionário [employee_name], Cargo [employee_job_title] e Salário [employee_salary]. Além disso, o Item do catálogo contém: Cargo [job_title] e salário [salary].

function onChange(control, oldValue, newValue, isLoading) {
if (isLoading || newValue == '') {
return;
}

// Get the MRVS
var multiRowVariableSet = JSON.parse(g_form.getValue('variable_set_1'));

for (var i = 0; i < multiRowVariableSet.length; i++) {
// Check if the entered job title matches the title in the current MRVS row
  if (multiRowVariableSet[i].employee_job_title == g_form.getValue("job_title")){
    // Update the value of a matching field with the new salary
    multiRowVariableSet[i].employee_salary = newValue;
  }
}

// Update the MRVS
g_form.setValue('variable_set_1', JSON.stringify(multiRowVariableSet));
}

GlideForm - setValue(cadeia de caracteres fieldName, valor da cadeia de caracteres, cadeia de caracteres displayValue)

Define o valor de um campo de formulário especificado como o valor de um valor de exibição especificado em um registro de referência.

Para melhorar o desempenho evitando uma viagem de ida e volta ao definir o valor de um campo de referência, use este método, não SetValue(fieldName, value) . Ao definir vários valores de referência para um campo do coletor de listas, passe matrizes no valuee. displayValueparâmetros.

Nota:

O método SetValue() pode causar um estouro de pilha quando usado em um onchange client script. Sempre que o valor for definido, ele será registrado como uma mudança, o que pode acionar novamente o script do cliente onchange. Para evitar isso, execute uma verificação que validará se o novo valor será diferente do valor antigo. Por exemplo, antes de executar SetValue(shortDesc, newValue.toUpperCase()); valide se a descrição resumida ainda não está em maiúsculas. Isso impedirá que o client script aplique o. Para UpperCase() mais de uma vez.

Tabela 147. Parâmetros

Nome	Tipo	Descrição
fieldName	Cadeia de caracteres	Nome do campo do formulário a ser atualizado.
valor	Cadeia de caracteres ou matriz	Sys_id do registro de referência a ser usado para atualizar o campo. Se o campo especificado for GlideList, este parâmetro poderá conter uma matriz de sys_ids. Nesse caso, o método executa uma pesquisa de todos os registros especificados na matriz e esses valores são usados para atualizar o conteúdo do campo especificado (lista relacionada). Nota: Ao definir um valor em uma lista de seleção, certifique-se de usar um valor numérico em vez do rótulo.
displayValue	Cadeia de caracteres ou matriz	Campo no registro de referência especificado a ser usado para atualizar o campo especificado. Por exemplo, na tabela Usuário [sys_user], pode ser nome de usuário. Se o campo especificado for uma GlideList, este parâmetro poderá conter uma matriz de nomes de valores de exibição. Para obter informações adicionais sobre valores de exibição, consulte Valor de exibição .

Tabela 148. Retornos

Tipo	Descrição
vazio

Este exemplo mostra passando o sys_id do registro de referência que contém o campo de nome de usuário a ser usado para atualizar o. assigned_to campo de formulário.

g_form.setValue('assigned_to', userSysID, userName);

Este exemplo mostra a aprovação de uma matriz de sys_ids de registro de referência e uma matriz de nomes de valor de exibição correspondentes a serem usados para atualizar os campos de formulário na GlideList glide-list_field_name .

g_form.setValue('glide-list_field_name', sysIDArray, displayNameArray);

GlideForm - setVariablesReadOnly(Booliano IsReadOnly)

Cria um Catálogo de serviços editor de variáveis somente leitura.

Nota:

Este método só se aplica a. Catálogo de serviços Editores de variáveis na IU principal. Este método não é compatível com Catálogo de serviços formulário.

O método deve ser colocado no script do cliente da tabela na qual o editor de variáveis é adicionado, como Item solicitado [sc_req_item], Incidente [incident] e assim por diante. Para definir variáveis como somente leitura em outras tabelas, use SetReadOnly() método.

Consulte também: Editores de variáveis do Catálogo de serviços

Tabela 149. Parâmetros

Nome	Tipo	Descrição
isReadOnly	Booliano	Sinalizador que determina se o editor de variáveis é somente leitura. Valores válidos: Verdadeiro: Define o editor de variáveis como somente leitura. Falso: Define o editor de variáveis como editável. Padrão: falso

Tabela 150. Retornos

Tipo	Descrição
vazio

Adicionar a linha a seguir a um client script define o editor de variáveis como somente leitura.

g_form.setVariablesReadOnly(true);

GlideForm - setVisible(cadeia de caracteres fieldName, exibição booliana)

Exibe ou oculta o campo especificado.

Na IU da área de trabalho, o espaço é deixado em branco quando oculto. Em dispositivos móveis ou Portal de serviços IU, o espaço é preenchido em meus outros campos quando oculto. Este método não pode ocultar campos obrigatórios sem valor.

Use Política de IU em vez deste método sempre que possível.

Tabela 151. Parâmetros

Nome	Tipo	Descrição
fieldName	Cadeia de caracteres	Nome do campo a ser exibido ou ocultado.
tela	Booliano	Sinalizador que indica se o campo especificado deve ser exibido. Valores válidos: Verdadeiro: Exiba o campo. Falso: Oculta o campo.

Tabela 152. Retornos

Tipo	Descrição
vazio

function onChange(control, oldValue, newValue, isLoading, isTemplate) {
   //If the page isn't loading
   if (!isLoading) {
      //If the new value isn't blank
      if(newValue != '') {
         g_form.setVisible('priority', false); 
      }
      else
         g_form.setVisible('priority', true); 
      }
   }

GlideForm - showAnnotation (nome da cadeia de caracteres)

Mostra uma anotação com um determinado nome na IU do formulário.

Anotações são separadores visuais entre elementos de formulário ou blocos de texto colorido usados para realçar elementos de formulário. Consulte também:

• GlideForm - hideAnnotation(nome da cadeia de caracteres) para ocultar uma anotação específica no formulário.
• GlideForm - toggleAnnotations() para ativar e desativar anotações com maior flexibilidade.

Tabela 153. Parâmetros

Nome	Tipo	Descrição
nome	Cadeia de caracteres	Nome da anotação a ser mostrada no formulário. Tabela: Anotações de formulário [sys_ui_annotation], Campo: Nome

Tabela 154. Retornos

Tipo	Descrição
Nenhum(a)

O exemplo a seguir demonstra como mostrar programaticamente a anotação chamada test-annotation-msg no campo de formulário usando ShowAnotação() método.

g_form.showAnnotation('test-annotation-msg');

GlideForm - showErrorBox (nome da cadeia de caracteres, mensagem da cadeia de caracteres, rolagem booliana)

Exibe uma mensagem de erro no campo de formulário especificado (um objeto de controle ou o nome do campo). Se o controle ou o campo estiver fora da tela e no momento scrollFormo parâmetro é verdadeiro, o formulário rola para o controle ou campo.

Uma propriedade global (glide.ui.scroll_to_message_field) está disponível que controla a rolagem automática da mensagem quando o campo do formulário está fora da tela (rola o formulário para o controle ou campo). . ShowFieldMsg() método é um método semelhante que requer um parâmetro de tipo.

Tabela 155. Parâmetros

Nome	Tipo	Descrição
nome	Cadeia de caracteres	Nome do campo ou controle sob o qual a mensagem de erro será exibida.
mensagem	Cadeia de caracteres	Mensagem de erro a ser exibida.
RolrollForm	Booliano	Sinalizador que indica se rolar automaticamente o formulário para o campo de mensagem de erro. Valores válidos: Verdadeiro: Role até o campo de mensagem de erro. Falso: Não role até o campo de mensagem de erro. Padrão: verdadeiro

Tabela 156. Retornos

Tipo	Descrição
vazio

GlideForm - showErrorBox (nome da cadeia de caracteres, mensagem da cadeia de caracteres)

Exibe uma mensagem de erro no campo de formulário especificado (um objeto de controle ou o nome do campo). Se o controle ou o campo estiver fora da tela no momento, o formulário rolará automaticamente para o controle ou campo.

Uma propriedade global (glide.ui.scroll_to_message_field) está disponível que controla a rolagem automática da mensagem quando o campo do formulário está fora da tela (rola o formulário para o controle ou campo). . ShowFieldMsg() método é um método semelhante que requer um parâmetro de tipo.

Tabela 157. Parâmetros

Nome	Tipo	Descrição
nome	Cadeia de caracteres	Nome do campo ou controle sob o qual a mensagem de erro será exibida.
mensagem	Cadeia de caracteres	Mensagem de erro a ser exibida.

Tabela 158. Retornos

Tipo	Descrição
vazio

ShowFieldMsg (campo de cadeia de caracteres, mensagem de cadeia de caracteres, tipo de cadeia de caracteres)

Exibe uma mensagem no campo de formulário especificado (um objeto de controle ou o nome do campo). Se o controle ou o campo estiver fora da tela, o método rolará automaticamente o formulário para esse campo.

Uma propriedade global (glide.ui.scroll_to_message_field) está disponível que controla a rolagem automática da mensagem quando o campo do formulário está fora da tela (rola o formulário para o controle ou campo).

. ShowErrorBox() método é um método resumido que não requer o parâmetro type.

Nota:

Este método não funciona com journal_fielddigite o campo em IU principal.

Tabela 159. Parâmetros

Nome	Tipo	Descrição
Assunto:	Cadeia de caracteres	Nome do campo ou controle sob o qual a mensagem será exibida.
mensagem	Cadeia de caracteres	Mensagem a ser exibida.
tipo	Cadeia de caracteres	Tipo de mensagem. Valores válidos: erro informações aviso

Tabela 160. Retornos

Tipo	Descrição
vazio

g_form.showFieldMsg('impact','Low impact response time can be one week','info');

ShowFieldMsg (campo de cadeia de caracteres, mensagem de cadeia de caracteres, tipo de cadeia de caracteres, rolagem booliana)

Exibe uma mensagem no campo de formulário especificado (um objeto de controle ou o nome do campo). Se o controle ou o campo estiver fora da tela e no momento scrollForm. verdadeiro , o método rola o formulário para esse campo.

Uma propriedade global (glide.ui.scroll_to_message_field) está disponível que controla a rolagem automática da mensagem quando o campo do formulário está fora da tela (rola o formulário para o controle ou campo).

. ShowErrorBox() método é um método resumido que não requer o parâmetro type.

Nota:

Este método não funciona com journal_fielddigite o campo em IU principal.

Tabela 161. Parâmetros

Nome	Tipo	Descrição
Assunto:	Cadeia de caracteres	Nome do campo ou controle sob o qual a mensagem será exibida.
mensagem	Cadeia de caracteres	Mensagem a ser exibida.
tipo	Cadeia de caracteres	Tipo de mensagem. Valores válidos: erro informações aviso
RolrollForm	Booliano	Sinalizador que indica se rolar automaticamente o formulário para o campo de mensagem. Valores válidos: Verdadeiro: Role até o campo de mensagem. Falso: Não role até o campo de mensagem. Padrão: verdadeiro

Tabela 162. Retornos

Tipo	Descrição
vazio

g_form.showFieldMsg('impact','Low impact not allowed with High priority','error',false);

GlideForm - showRelatedLinks()

Exibe a seção Links relacionados de um formulário.

Consulte também:

• GlideForm - hideRelatedLinks()
• GlideForm - setRelatedLinksDisplay (exibição booliana)

Tabela 163. Parâmetros

Nome	Tipo	Descrição
Nenhum

Tabela 164. Retorna

Tipo	Descrição
Nenhum(a)

O exemplo a seguir exibe links relacionados na IU do formulário.

// Show related links
g_form.showRelatedLinks()

GlideForm - showRelatedList(cadeia de caracteres listTableName)

Exibe a lista relacionada especificada no formulário.

Este método não está disponível na plataforma para celular. Se este método for executado em uma plataforma móvel, nenhuma ação ocorrerá.

Tabela 165. Parâmetros

Nome	Tipo	Descrição
ListTableName	Cadeia de caracteres	Nome da lista relacionada a ser exibida.

Tabela 166. Retornos

Tipo	Descrição
vazio

GlideForm - showRelatedLists()

Exibe todas as listas relacionadas do formulário.

Este método não está disponível na plataforma para celular. Se este método for executado em uma plataforma móvel, nenhuma ação ocorrerá.

Tabela 167. Parâmetros

Nome	Tipo	Descrição
Nenhum

Tabela 168. Retorna

Tipo	Descrição
vazio

GlideForm - showTemplateBar()

Se oculto, mostra a barra de modelo na parte inferior do formulário.

Tabela 169. Parâmetros

Nome	Tipo	Descrição
Nenhum

Tabela 170. Retorna

Tipo	Descrição
Nenhum(a)

O script de exemplo a seguir exibe a Barra de modelos na parte inferior do formulário atual.

g_form.showTemplateBar()

GlideForm - Enviar ()

Salva o registro.

O usuário é retirado do formulário, retornando-o para onde estava.

Tabela 171. Parâmetros

Nome	Tipo	Descrição
Nenhum

Tabela 172. Retorna

Tipo	Descrição
vazio

GlideForm - Enviar (Verbo de cadeia de caracteres)

Executa a ação de IU especificada.

Tabela 173. Parâmetros

Nome	Tipo	Descrição
verbo	Cadeia de caracteres	Um action_name de um registro sys_ui_action. O nome da ação deve ser para um botão de formulário visível.

Tabela 174. Retornos

Tipo	Descrição
vazio

GlideForm - toggleAnnotations()

Oculta ou mostra todas as anotações no formulário.

Anotações são separadores visuais entre elementos de formulário ou blocos de texto colorido usados para realçar elementos de formulário. Se as anotações estiverem visíveis no formulário, chamando ToggleAnotações() oculta-os. Da mesma forma, se as anotações estiverem ocultas no formulário, chamar este método as exibirá.

Consulte também:

• GlideForm - hideAnnotation(nome da cadeia de caracteres)
• GlideForm - showAnnotation (nome da cadeia de caracteres)

Tabela 175. Parâmetros

Nome	Tipo	Descrição
Nenhum

Tabela 176. Retorna

Tipo	Descrição
Nenhum(a)

O exemplo a seguir mostra como chamar ToggleAnotações() para mostrar ou ocultar anotações de formulário. Como resultado, as anotações são ocultas ou mostradas dependendo do estado anterior.

g_form.toggleAnnotations();