Referência rápida do script de formulário

Acessar um atributo por nome

var nameAttribute = Xrm.Page.getAttribute("name");

Atribui o atributo para o campo Nome da Conta à variável nameAttribute

Acessar todos os atributos

var allAttributes = Xrm.Page.getAttribute();

Atribui uma matriz de todos os atributos no conjunto Xrm.Page.data.entity.attributes à variável allAttributes.

Obter o valor de um atributo

getValue

var nameValue = Xrm.Page.getAttribute("name").getValue();

Atribui o valor do campo Nome da Conta à variável nameValue.

Obter o valor de texto da opção selecionada atualmente de um atributo optionset

getText

var addressType = Xrm.Page.getAttribute("address1_addresstypecode").getText();

Atribui o texto da opção selecionada no campo Tipo de Endereço à variável addressType.

Obter o tipo de um atributo

getAttributeType

var attributeType = Xrm.Page.getAttribute(0).getAttributeType();

Atribui o valor de cadeia de caracteres que representa o tipo de atributo para o primeiro atributo da variável attributeType.

Obter o valor inicial de um atributo Boolean ou optionset

getInitialValue

var attributeInitialValue = Xrm.Page.getAttribute("address1_addresstypecode").getInitialValue();

Atribui o valor do número inicial do campo Tipo de Endereço à variável attributeInitialValue.

Determina se um atributo de pesquisa representa uma pesquisa de partylist.

getIsPartyList

var isPartyList = Xrm.Page.getAttribute("to").getIsPartyList();

Atribui um valor Boolean indicando se a entidade Email para o campo para representa uma pesquisa da lista parcial.

Este método está disponível somente para o Entidades atualizadas.

Obter o comprimento máximo permitido para um atributo que contém uma cadeia de caracteres

getMaxLength

var newAccountName = "A Store";
var nameTooLong = (newAccountName.length > Xrm.Page.getAttribute("name").getMaxLength())

Atribui um valor Boolean que indica se o valor da variável newAccountName excede o comprimento máximo permitido para o campo Nome da Conta à variável nameTooLong.

Obtém o nome lógico de um atributo

getName

var attributeName = Xrm.Page.getAttribute(0).getName();

Atribui o valor do nome lógico do primeiro atributo na página para a variável attributeName

Obter um valor numérico que representa o nível de precisão para o número de atributo

getPrecision

var creditLimitPrecision = Xrm.Page.getAttribute("creditlimit").getPrecision();

Atribui o valor de precisão do campo Limite de Crédito à variável creditLimitPrecision.

Alterar se os dados são obrigatórios em um campo para salvar um registro

setRequiredLevel

Xrm.Page.getAttribute("creditlimit").setRequiredLevel("required");

Torna o campo Limite de Crédito necessário.

Controla se os dados em um atributo serão salvos quando o registro for salvo

setSubmitMode

Xrm.Page.getAttribute("name").setSubmitMode("always");

O exemplo forçará o valor do campo Nome da Conta para sempre ser salvo, mesmo quando não for alterado.

Evita que um registro seja salvo.

function My_PreventSaveFunction(eContext) {
 eContext.getEventArgs().preventDefault();
}

Use o parâmetro eContext para capturar o contexto de execução e use o método preventDefault incluído com argumentos de evento.

Exibe uma mensagem próxima ao controle para indicar que os dados não são válidos.

setNotification

Xrm.Page.getAttribute("name").controls.forEach(
function (control, i) {
control.setNotification("'Test' is not a valid name.");
})

Define uma mensagem de erro de validação em cada controle no formulário para o atributo Nome da Conta.

Enquanto essa mensagem for exibida, o registro não pode ser salvo.

Este método está disponível somente para o Entidades atualizadas.

Exibir notificações do nível do formulário.

setFormNotification

Xrm.Page.ui.setFormNotification(
"Hello",
"INFO",
"helloMsg"
);

Exibe a mensagem “Olá” na parte superior do formulário com um ícone de informações do sistema.

Este método está disponível somente para o Entidades atualizadas.

Exibe um diálogo de alerta de não bloqueio com uma função de retorno de chamada.

alertDialog

var alertDisplayed = false;
Xrm.Utility.alertDialog(
"Showing Alert",
function () { alertDisplayed = true; }
)

Exibe um alerta e define o valor da variável alertDisplayed quando foi fechada.

Este método está disponível somente para o Entidades atualizadas.

Acessa todos os controles para um atributo específico

var nameControls = Xrm.Page.getAttribute("name").controls.get();

Atribui uma matriz de todos os controles para o atributo name à variável nameControls.

Acessar um controle pelo índice

var firstControl = Xrm.Page.getControl(0);

Atribui o primeiro controle no conjunto Xrm.Page.ui.controls à variável firstControl.

Acessa todos os controles que atendam a critérios específicos

var optionsetControls = Xrm.Page.getControl(function (control, index) {
return control.getControlType() == "optionset";
});

Atribui uma matriz de todos os atributos no conjunto Xrm.Page.ui.controls que atende aos critérios definidos na função anônima, que retorna true quando o tipo de controle é "optionsetControls" à variável.

Determine se um controle está visível

getVisible

var isNameVisible = Xrm.Page.getControl("name").getVisible();

Atribui um valor Boolean para a variável isNameVisible que representa se o campo Nome da Conta está visível.

Obter uma referência ao atributo para o controle

getAttribute

var nameAttribute = Xrm.Page.getControl("name").getAttribute();

Atribui o atributo para o controle do campo Nome da Conta à variável nameAttribute.

Determine se um controle está habilitado

getDisabled

var disabledControls = Xrm.Page.getControl(function(control, index) { return control.getDisabled(); });

Atribui uma matriz de controles desabilitados à variável disabledControls.

Obter a etiqueta para um controle

getLabel

var nameControlLabel = Xrm.Page.getControl("name").getLabel();

Atribui o valor do controle do campo Nome da Conta à variável nameControlLabel.

Obter o nome de um controle

getName

var firstControlName = Xrm.Page.getControl(0).getName();

Atribui o nome do primeiro controle no conjunto Xrm.Page.ui.controls à variável firstControlName.

Definir foco em um controle

setFocus

Xrm.Page.getControl("name").setFocus();

Define o foco no campo Nome da Conta.

Adicionar uma opção para um controle optionset

addOption

var addressTypeCodeControl = Xrm.Page.getControl("address1_addresstypecode");
var billToAddressOption = addressTypeCodeControl.getAttribute().getOption(1);
addressTypeCodeControl.clearOptions();
addressTypeCodeControl.addOption(billToAddressOption);

Usando uma referência para o controle do campo Tipo de Endereço, acesse o atributo para o controle e use o método getOption para definir a variável billToAddressOption para a opção que representa a opção Cobrar Para.

Use clearOptions para remover as opções existentes e use addOption para definir billToAddressOption como a única opção disponível para este controle.

Remover uma única opção de um controle optionset.

removeOption

Xrm.Page.getControl("address1_addresstypecode").removeOption(1);

Remover a opção Cobrar Para do controle para o campo Tipo de Endereço.

Obter o valor do parâmetro de cadeia de caracteres de consulta de dados passado para um recurso da Web Silverlight.

getData

var dataValue = Xrm.Page.getControl("WebResource_SilverLightControl").getData();

Atribui o valor passado pelo parâmetro da cadeia de caracteres de consulta de dados para a variável dataValue.

Define o URL para o conteúdo a ser exibido em um IFRAME.

setSrc

Xrm.Page.getControl("IFRAME_targetPage").setSrc("http://www.bing.com");

Define um URL para ser o IFRAME.src do controle.

Obtém o objeto no formulário que representa o recurso da Web ou o IFRAME.

getObject

var obj = Xrm.Page.getControl("IFRAME_bing").getObject();

Atribui uma referência de objeto à variável obj. Para um IFRAME este será o elemento do Modelo de Objeto do Documento (DOM) do IFRAME. Para um recurso da Web Silverlight será o elemento Object do Objeto que representa o plug-in Silverlight integrado.

Adiciona uma exibição personalizada para uma pesquisa.

addCustomView

var viewId = "{C7034F4F-6F92-4DD7-BD9D-9B9C1E996380}";
var viewDisplayName = "SDK Sample View";
var fetchXml = "<fetch version='1.0' " +
"output-format='xml-platform' " +
"mapping='logical'>" +
"<entity name='account'>" +
"<attribute name='name' />" +
"<attribute name='address1_city' />" +
"<order attribute='name' " +
"descending='false' />" +
"<filter type='and'>" +
"<condition attribute='ownerid' " +
"operator='eq-userid' />" +
"<condition attribute='statecode' " +
"operator='eq' " +
"value='0' />" +
"</filter>" +
"<attribute name='primarycontactid' />" +
"<attribute name='telephone1' />" +
"<attribute name='accountid' />" +
"<link-entity "+
"alias='accountprimarycontactidcontactcontactid' " +
"name='contact' " +
"from='contactid' " +
"to='primarycontactid' " +
"link-type='outer' " +
"visible='false'>" +
"<attribute name='emailaddress1' />" +
"</link-entity>" +
"</entity>" +
"</fetch>";
var layoutXml = "<grid name='resultset' " +
"object='1' " +
"jump='name' " +
"select='1' " +
"icon='1' " +
"preview='1'>" +
"<row name='result' " +
"id='accountid'>" +
"<cell name='name' " +
"width='300' />" +
"<cell name='telephone1' " +
"width='100' />" +
"<cell name='address1_city' " +
"width='100' />" +
"<cell name='primarycontactid' " +
"width='150' />" +
"<cell name='accountprimarycontactidcontactcontactid.emailaddress1' " +
"width='150' " +
"disableSorting='1' />" +
"</row>" +
"</grid>";
Xrm.Page.getControl("parentaccountid").addCustomView(viewId, "account", viewDisplayName, fetchXml, layoutXml, true);

Define as variáveis viewId, viewDisplayName, fetchXml e layoutXml para passar como argumentos para que uma exibição personalizada seja adicionada como a exibição padrão para o controle no campo de pesquisa Conta Primária.

Definir a exibição padrão para uma pesquisa.

setDefaultView

var viewId = "{C7034F4F-6F92-4DD7-BD9D-9B9C1E996380}";
Xrm.Page.getControl("parentaccountid").setDefaultView(viewId);

Definir a exibição padrão do controle para o campo Conta Primária para o valor id na variável viewId.

Atualizar os dados exibidos na subgrade

refresh

Xrm.Page.getControl("accountcontactsgrid").refresh();

Atualize os Contatossubgrid.

Especificar se um controle de data deve mostrar a parte de hora da data.

setShowTime

Xrm.Page.getControl("createdon").setShowTime(false);

Definir o campo Data de Criação para que a hora não seja exibida.

Este método está disponível somente para o Entidades atualizadas.

Obter o nome de um item de navegação

getId

var navItemIds = [];
Xrm.Page.ui.navigation.items.forEach(
function (item, index)
{ navItemIds.push(item.getId()) }
);

Criar uma matriz navItemIds que contém os valores id de cada item de navegação no conjunto Xrm.Page.ui.navigation.items.

Definir a etiqueta de um item de navegação

setLabel

Xrm.Page.ui.navigation.items.get("navAddresses").setLabel("Other Addresses");

Alterar a etiqueta do item de navegação Mais Endereços para Outro Endereços.

Determine se um item de navegação está visível

getVisible

var moreAddressesVisible = Xrm.Page.ui.navigation.items.get("navAddresses").getVisible()

Atribuir um valor Boolean à variável moreAddressesVisible para representar se o item de navegação Mais Endereços está visível.

Determinar se uma guia está expandida ou recolhida

getDisplayState

var isGeneralTabExpanded = (Xrm.Page.ui.tabs.get("general").getDisplayState() == "expanded")

Atribuir um valor Boolean à variável isGeneralTabExpanded que indica quando a guia Geral é expandida.

Determinar se uma guia está visível

getVisible

var isGeneralTabVisible = Xrm.Page.ui.tabs.get("general").getVisible();

Atribuir um valor Boolean à variável isGeneralTabVisible indicando quando a guia Geral está visível.

Obter a etiqueta para uma guia

getLabel

var generalTabLabel = Xrm.Page.ui.tabs.get("general").getLabel();

Atribuir a etiqueta da guia Geral à variável generalTabLabel.

Definir foco em uma guia

setFocus

Xrm.Page.ui.tabs.get("general").setFocus();

Definir foco na guia Geral.

Obter a guia principal de uma seção

getParent

Xrm.Page.getControl("industrycode").getParent().getParent().setFocus();

Definir o foco na guia que contém o campo Setor.

Ocultar ou mostrar uma seção

setVisible

Xrm.Page.getControl("industrycode").getParent().setVisible(false);

Ocultar a seção que contém o campo Setor.

Alterar uma etiqueta para uma seção

setLabel

Xrm.Page.getControl("industrycode").getParent().setLabel("Detailed Information");

Alterar a etiqueta da seção que contém o campo Setor para Informações Detalhadas.

Adicionar uma função ao evento OnSave

addOnSave

Xrm.Page.data.entity.addOnSave(myFunction);

Adicionar a função myFunction ao evento OnSave.

Adicionar uma função a um evento OnChange de um atributo.

addOnChange

Xrm.Page.getAttribute("name").addOnChange(myFunction);

Adiciona a função myFunction para o evento OnChange do campo Nome da Conta.

Adicionar uma função a um evento PreSearch de um controle de pesquisa.

addPreSearch

A seguinte amostra de código é para a pesquisa do formulário de oportunidade Conta (parentaccountid). Quando a função Sdk.setParentAccountIdFilter é definida no manipulador de eventos do formulário Onload, a função Sdk.filterCustomAccounts é adicionada ao evento PreSearch para essa pesquisa. O resultado é que apenas contas com o valor de Categoria (accountcategorycode) de Cliente Preferencial (1) serão retornadas.

var Sdk = window.Sdk || {};

Sdk.filterCustomerAccounts = function () {
    //Only show accounts with the type 'Preferred Customer'
    var customerAccountFilter = "<filter type='and'><condition attribute='accountcategorycode' operator='eq' value='1'/></filter>";
    Xrm.Page.getControl("parentaccountid").addCustomFilter(customerAccountFilter, "account");
}
//set 'Sdk.setParentAccountIdFilter' in the Opportunity form Onload event handler
Sdk.setParentAccountIdFilter = function () {
    Xrm.Page.getControl("parentaccountid").addPreSearch(Sdk.filterCustomerAccounts);
}

Obter a URL para se conectar à organização.

getClientUrl

var serverUrl = Xrm.Page.context.getClientUrl();

Atribuir uma cadeia de caracteres que representa o URL à variável serverUrl.

Obter o nome do usuário atual.

getUserName

var userName = Xrm.Page.context.getUserName();

Atribuir uma cadeia de caracteres que representa o nome do usuário à variável userName.

Este método está disponível somente para o Entidades atualizadas.

Obter uma matriz das cadeias de caracteres que representa os valores GUID para cada direito de acesso atribuído ao usuário atual e em todos as equipes que o usuário está associado.

getUserRoles

var userRoles = Xrm.Page.context.getUserRoles();

Atribuir uma matriz das cadeias de caracteres que representa os direitos de acesso do usuário à variável userRoles.

Determinar se o usuário está trabalhando offine com o cliente Microsoft Dynamics CRM para Microsoft Office Outlook com Acesso Offline.

cliente.getClientState

var IsOffline = (Xrm.Page.context.client.getClientState() == "Offline");

Atribuir um valor Boolean que representa se o usuário está trabalhando offline atualmente na variável IsOffline.

Obter o nome lógico da entidade atual

getEntityName

var entityName = Xrm.Page.data.entity.getEntityName();

Atribuir o nome da entidade lógica à variável entityName.

Obter o Id do registro atual

getId

var recordId = Xrm.Page.data.entity.getId();

Atribuir o valor id do registro à variável recordId.

Salve o registro atual.

Xrm.Page.data.entity.Salvar

Xrm.Page.data.entity.save();

Salva o registro. Há argumentos opcionais. Use saveandclose ou saveandnew para executar as ações equivalentes.

Determina se algum dado no registro atual está alterado.

getIsDirty

var isDirty = Xrm.Page.data.entity.getIsDirty();

Atribuir um valor Boolean que representa se os dados no registro foram alterados para a variável isDirty.