Partilhar via


getEntityMainFormDescriptor (referência da API do cliente)

Retorna o descritor de formulário principal padrão para a tabela especificada.

Sintaxe

Xrm.Utility.getEntityMainFormDescriptor(entityName, formId);

Parâmetros

Nome Tipo Obrigatório Description
entityName String Yes O nome lógico da tabela.
formId String Não O ID do formulário da tabela.

Devoluções

Tipo: Promessa

Descrição: retorna uma promessa que contém o descritor de formulário principal padrão com os seguintes valores.

Nome do parâmetro Tipo Description
Attributes Matriz de cadeias de caracteres Lista de todas as colunas no formulário principal.
EntityLogicalName String O nome lógico da tabela especificada.
Id cadeia (de caracteres) A ID do formulário da tabela especificada.
Label String O rótulo da tabela especificada.
Name String O nome para exibição da tabela especificada.
Sections String O nome das seções da tabela especificada.
ShowLabel booleano Indica se o rótulo da tabela especificada deve ser mostrado ou não.
Visible booleano Indica se o formulário está visível ou não.

Example

O código de exemplo a seguir mostra como obter o descritor de formulário principal para uma tabela especificada.

  // Define the table and form ID
  var entityName = "account";
  var formId = "8448b78f-8f42-454e-8e2a-f8196b0419af";

  // Get the main form descriptor 
  Xrm.Utility.getEntityMainFormDescriptor(entityName, formId);

Xrm.Utility