Riferimento rapido dello scripting dei moduli

Accedere a un attributo per nome

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

Assegna l'attributo per il campo Nome account alla variabile nameAttribute

Accedere a tutti gli attributi

var allAttributes = Xrm.Page.getAttribute();

Assegna una matrice di tutti gli attributi nella raccolta Xrm.Page.data.entity.attributes alla variabile allAttributes.

Ottenere il valore di un attributo

getValue

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

Assegna il valore del campo Nome account alla variabile nameValue.

Ottenere il valore testuale dell'opzione selezionata di un attributo del set di opzioni

getText

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

Assegna il testo dell'opzione selezionata nel campo Tipo di indirizzo alla variabile addressType.

Ottenere il tipo di attributo

getAttributeType

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

Assegna il valore stringa che indica il tipo di attributo per il primo attributo alla variabile attributeType.

Ottenere il valore iniziale di un attributo Boolean o optionset

getInitialValue

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

Assegna il valore del numero iniziale del campo Tipo di indirizzo alla variabile attributeInitialValue.

Determina se un attributo di ricerca indica una ricerca di partylist.

getIsPartyList

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

Assegna un valore Boolean che indica se il campo Invia per e-mail entità a indica una ricerca di party list.

Questo metodo è disponibile solo per Entità aggiornate.

Ottenere la lunghezza massima consentita per un attributo che contiene una stringa

getMaxLength

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

Assegna un valore Boolean che indica se il valore della variabile newAccountName supera la lunghezza massima consentita per il campo Nome account alla variabile nameTooLong.

Ottiene il nome logico di un attributo

getName

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

Assegna il valore del nome logico del primo attributo sulla pagina alla variabile attributeName.

Ottenere un valore del numero che indica il livello di precisione per l'attributo di numero

getPrecision

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

Assegna il valore di precisione del campo Limite di credito alla variabile creditLimitPrecision.

Modificare se i dati sono necessari in un campo per salvare un record

setRequiredLevel

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

Rende il campo Limite di credito obbligatorio.

Controllare se i dati in un attributo verranno salvati quando viene salvato il record

setSubmitMode

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

L'esempio forzerà il valore del campo Nome account per essere sempre salvato anche quando non è stato modificato.

Evitare che un record venga salvato.

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

Utilizzare il parametro eContext per acquisire il contesto di esecuzione e utilizzare il metodo preventDefault incluso negli argomenti dell'evento.

Visualizzare un messaggio accanto al controllo per indicare che i dati non sono validi.

setNotification

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

Imposta un messaggio di errore di convalida su ogni controllo nel modulo dell'attributo Nome account.

Quando viene visualizzato questo messaggio il record non può essere salvato.

Questo metodo è disponibile solo per Entità aggiornate.

Visualizzare notifiche relative a livello di modulo.

setFormNotification

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

Visualizza il messaggio "Ciao" nella parte superiore del modulo con un'icona di informazioni di sistema.

Questo metodo è disponibile solo per Entità aggiornate.

Visualizzare un dialogo di avviso non bloccante con una funzione di richiamata.

alertDialog

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

Visualizzare un avviso e impostare il valore della variabile alertDisplayed alla chiusura.

Questo metodo è disponibile solo per Entità aggiornate.

Accedere a tutti i controlli per un attributo specifico

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

Assegna una matrice di tutti i controlli per l'attributo name alla variabile nameControls.

Accedere a un controllo per indice

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

Assegna il primo controllo nella raccolta Xrm.Page.ui.controls alla variabile firstControl.

Accedere a tutti i controlli che soddisfano un criterio specifico

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

Assegna una matrice di tutti gli attributi nella raccolta Xrm.Page.ui.controls che soddisfano i criteri della funzione anonima, che restituisce true quando il tipo di controllo è "set di opzioni" alla variabile optionsetControls.

Determinare se un controllo è visibile

getVisible

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

Assegna un valore Boolean alla variabile isNameVisible che indica se il campo Nome account è visibile.

Ottenere un riferimento all'attributo per il controllo

getAttribute

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

Assegna l'attributo per il controllo per il campo Nome account alla variabile nameAttribute.

Determinare se un controllo è abilitato

getDisabled

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

Assegna una matrice di controlli disabilitati alla variabile disabledControls.

Ottenere l'etichetta per un controllo

getLabel

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

Assegna il valore del controllo per il campo Nome account alla variabile nameControlLabel.

Ottenere il nome di un controllo

getName

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

Assegna il nome del primo controllo nella raccolta Xrm.Page.ui.controls alla variabile firstControlName.

Impostare lo stato attivo su un controllo

setFocus

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

Imposta lo stato attivo sul campo Nome account.

Aggiungere un'opzione a un controllo di set di opzioni

addOption

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

Utilizzando un riferimento al controllo per il campo Tipo di indirizzo, accedere all'attributo per il controllo e utilizzare il metodo di getOption per impostare la variabile billToAddressOption sull'opzione che indica l'opzione Fatturazione.

Utilizzare clearOptions per rimuovere tutte le opzioni esistenti e utilizzare addOption per impostare billToAddressOption come l'unica opzione disponibile per il controllo.

Rimuovere una singola opzione da un controllo di set di opzioni.

removeOption

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

Rimuovere l'opzione Fatturazione dal controllo per il campo Tipo di indirizzo.

Ottenere il valore del parametro stringa di query dei dati passato a una risorsa Web Silverlight.

getData

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

Assegna il valore passato attraverso il parametro stringa di query dei dati alla variabile dataValue.

Impostare l'URL per il contenuto da visualizzare in IFRAME.

setSrc

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

Impostare un URL per essere IFRAME.src per il controllo.

Ottiene l'oggetto nel modulo che indica la risorsa Web o IFRAME.

getObject

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

Assegna un riferimento di oggetto alla variabile obj. Per IFRAME questo sarà IFRAME l'elemento di Document Object Model (DOM). Per una risorsa Web Silverlight sarà l'elemento Oggetto che indica il plug-in Silverlight incorporato.

Aggiungere una visualizzazione personalizzata per una ricerca.

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

Imposta le variabili viewId, viewDisplayName, fetchXml e layoutXml da passare come argomenti in modo da aggiungere una visualizzazione personalizzata come visualizzazione predefinita al controllo per il campo di ricerca Account padre.

Impostare la visualizzazione predefinita per una ricerca.

setDefaultView

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

Imposta la visualizzazione predefinita per il controllo per il campo Account padre sul valore id alla variabile viewId.

Aggiornare i dati visualizzati nella griglia secondaria

refresh

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

Aggiornare i Contattisubgrid.

Specificare se il controllo della data deve visualizzare la porzione di tempo della data.

setShowTime

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

Impostare il campo Data creazione in modo che il tempo non venga visualizzato.

Questo metodo è disponibile solo per Entità aggiornate.

Ottenere il nome di un elemento di navigazione

getId

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

Creare una matrice navItemIds contenente i valori id di ogni elemento di navigazione nella raccolta Xrm.Page.ui.navigation.items.

Impostare l'etichetta di un elemento di navigazione

setLabel

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

Modificare l'etichetta dell'elemento di navigazione Altri indirizzi in Altri indirizzi.

Determinare se un elemento di navigazione è visibile

getVisible

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

Assegnare un valore Boolean alla variabile moreAddressesVisible per rappresentare se l'elemento di navigazione Altri indirizzi è visibile.

Determinare se una scheda è espansa o compressa

getDisplayState

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

Assegnare un valore Boolean alla variabile isGeneralTabExpanded che indica se la scheda Generale è espansa.

Determinare se una scheda è visibile

getVisible

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

Assegnare un valore Boolean alla variabile isGeneralTabVisible che indica se la scheda Generale è visibile.

Ottenere l'etichetta per una scheda

getLabel

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

Assegnare l'etichetta della scheda Generale alla variabile generalTabLabel.

Impostare lo stato attivo su una scheda

setFocus

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

Impostare lo stato attivo sulla scheda Generale.

Ottenere la scheda padre di una sezione

getParent

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

Impostare lo stato attivo sulla scheda che contiene il campo Settore.

Mostrare o nascondere una sezione

setVisible

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

Nascondere la sezione che contiene il campo Settore.

Modificare l'etichetta per una sezione

setLabel

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

Modificare l'etichetta della sezione che contiene il campo Settore in Informazioni dettagliate.

Aggiungere una funzione all'evento OnSave

addOnSave

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

Aggiungere la funzione myFunction all'evento OnSave.

Aggiungere una funzione all'evento OnChange di un attributo.

addOnChange

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

Aggiungere la funzione myFunction all'evento OnChange del campo Nome account.

Aggiungere una funzione all'evento PreSearch di un controllo di ricerca.

addPreSearch

Il seguente esempio di codice riguarda la ricerca Account del modulo Opportunità (parentaccountid). Quando la funzione Sdk.setParentAccountIdFilter è impostata nel gestore eventi Onload del modulo, la funzione Sdk.filterCustomAccounts viene aggiunta all'evento PreSearch per tale ricerca. Ne risulta che solo gli account con il valore Categoria (accountcategorycode) di Cliente preferito (1) verranno restituiti.

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

Ottenere l'URL per connettersi all'organizzazione.

getClientUrl

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

Assegnare una stringa che indica l'URL alla variabile serverUrl.

Ottenere il nome dell'utente corrente.

getUserName

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

Assegnare una stringa che indica il nome dell'utente alla variabile userName.

Questo metodo è disponibile solo per Entità aggiornate.

Ottenere una matrice di stringhe che indica i valori GUID per ogni ruolo di sicurezza assegnato all'utente corrente e a tutti i team cui l'utente è associato.

getUserRoles

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

Assegna una matrice di stringhe che indicano i ruoli di sicurezza dell'utente alla variabile userRoles.

Determinare se l'utente sta lavorando offline con il client Microsoft Dynamics CRM per Microsoft Office Outlook con accesso offline.

client.getClientState

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

Assegnare un valore Boolean che indica se l'utente sta lavorando attualmente offline alla variabile IsOffline.

Ottenere il nome logico dell'entità corrente

getEntityName

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

Assegnare il nome di entità logico alla variabile entityName.

Ottenere l'Id del record corrente

getId

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

Assegnare l'id del record alla variabile recordId.

Salvare il record corrente

Xrm.Page.data.entity.Salva

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

Salva il record. Esistono argomenti facoltativi. Utilizzare saveandclose o saveandnew per eseguire azioni equivalenti.

Determinare se i dati del record corrente sono stati modificati.

getIsDirty

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

Assegnare un valore Boolean che indica che i dati nel record sono stati modificati alla variabile isDirty.