Controllo Xrm.Page.ui (riferimento lato client)

  • Articolo

 

Data di pubblicazione: gennaio 2017

Si applica a: Dynamics 365 (online), Dynamics 365 (on-premises), Dynamics CRM 2016, Dynamics CRM Online

L'oggetto control offre metodi per modificare la presentazione o il comportamento di un controllo e individuare l'attributo corrispondente.

Per accedere ai controlli si utilizzano le raccolte seguenti: Xrm.Page.ui.controls, Xrm.Page.ui Section.controls o Xrm.Page.data.entity Attribute.controls. Il metodo Xrm.Page.getControl è un metodo veloce per accedere a Xrm.Page.ui.controls.get.

Gli esempi di sintassi di questo argomento illustrano l'utilizzo del metodo Xrm.Page.getControl per accedere a un controllo. Il controllo dipende dagli argomenti passati al metodo. Il parametro args per accedere a un singolo controllo deve essere il nome del controllo o l'indice.

Se un modulo visualizza un controllo di processo aziendale nell'intestazione, verranno aggiunti controlli aggiuntivi per ogni attributo visualizzato nel processo aziendale. Tali controlli hanno un nome univoco simile al seguente esempio: header_process_<attribute name>.

Nota

È possibile eseguire l'accesso per nome solo ai controlli nella fase attiva del flusso aziendale in questo modo.

I controlli visualizzati nell'intestazione del modulo sono accessibili e hanno un nome univoco come il seguente: header_<attribute name>.

Per i controlli associati agli attributi è comune accedere ai controlli tramite la raccolta Xrm.Page.data.entity Attribute.controls.

I controlli personalizzati per i clienti mobili Dynamics 365 (telefoni e tablet) supportano tutte le proprietà e i metodi di controllo eccetto i seguenti: Metodi di completamento automatico, getValue, Metodi Keypress e Metodi di controlli di ricerca ed eventi.

Nelle versioni di Aggiornamento 1 di Microsoft Dynamics CRM Online 2016 e Microsoft Dynamics CRM 2016 Service Pack 1 (locale), sono ora supportati i seguenti metodi per il controllo timer nel nuovo motore di rendering moduli (detto anche "turbo modulo"): getControlType, getName, getParent, Etichetta, refresh e Visibile.

Proprietà dei controlli e metodi

  • Metodi di completamento automatico
    Configura il completamento automatico nei controlli di testo nei moduli Dynamics 365. Questi metodi sono stati introdotti in Dynamics 365.

  • Disabilitata
    Rilevare lo stato e abilitare o disabilitare i controlli utilizzando i metodi setDisabled e getDisabled.

  • getAttribute
    Ottenere l'attributo a cui è associato il controllo.

  • getControlType
    Ottenere informazioni sul tipo di controllo.

  • getName
    Ottenere il nome del controllo

  • getParent
    Ottenere l'oggetto della sezione in cui si trova il controllo.

  • getValue
    Ottiene l'ultimo valore per un controllo mentre gli utenti digitano un carattere in uno specifico campo di testo o numerico. Questo metodo è stato introdotto in Dynamics 365.

  • Metodi Keypress
    Aggiungono, rimuovono o eseguono una funzione quando l'utente preme un pulsante in un controllo. Questi metodi sono stati introdotti in Dynamics 365.

  • Metodi di controllo nella Knowledge Base
    Questi metodi sono disponibili solo per il controllo Ricerca nella Knowledge Base in un'istanza di Dynamics 365 nella quale è abilitata la funzionalità di gestione delle informazioni.

    Per informazioni su questo controllo, vedi Controllo di ricerca nella Knowledge Base (riferimento lato client).

  • Etichetta
    Ottenere o modificare l'etichetta per un controllo utilizzando i metodi setLabel e getLabel.

  • Metodi di controlli di ricerca ed eventi
    Controllare i risultati visualizzati per un utente per scegliere da quale momento impostano il valore di un controllo di ricerca tramite i metodi addCustomFilter, addCustomView, getDefaultView, setDefaultView.

    È possibile aggiungere o rimuovere i gestori eventi per Evento PreSearch utilizzando i metodi removePreSearch e addPreSearch.

  • Notifica
    Visualizzare e rimuovere le notifiche per gli utenti su un controllo utilizzando i metodi setNotification, addNotification e clearNotification.

  • Metodi del controllo OptionSet
    Modificare le opzioni visualizzate nei controlli OptionSet utilizzando i metodi addOption, clearOptions e removeOption.

  • ShowTime
    Utilizza setShowTime per specificare se un controllo di data deve mostrare la parte dell'ora della data e getShowTime per determinare se la parte dell'ora della data è attualmente visualizzata.

  • Metodi di controllo della griglia secondaria
    Per le organizzazioni che utilizzano Aggiornamento 1 di CRM Online 2015, sono disponibili nuove funzionalità per utilizzare i controlli della griglia secondaria.Ulteriori informazioni:Oggetti e metodi (sola lettura) della griglia (riferimento lato client)

    In altre organizzazioni, il metodo refresh è l'unico metodo disponibile per i controlli della griglia secondaria. Questo metodo aggiorna i dati visualizzati nella griglia secondaria.

  • Visibile
    Determinare quali comandi sono visibili e mostrarli o nasconderli utilizzando i metodi setVisible e getVisible.

  • Metodi dei controlli di risorsa Web e IFRAME
    Interagire con controlli di risorsa Web e IFRAME tramite i metodi getData, setData, getInitialUrl, getObject, setSrc e getSrc.

Metodi di completamento automatico

Utilizza i metodi showAutoComplete e hideAutoComplete per configurare il completamento automatico nel controlli di testo dei moduli.

Per un esempio di codice JavaScript che dimostra la funzionalità di completamento automatico, vedi Esempio: Completamento automatico nel controlli Dynamics 365

Nota

Questi metodi non sono supportati per i client mobili Dynamics 365 (telefoni o tablet) e l'hub di servizio interattivo. Questi metodi sono disponibili solo per Entità aggiornate.

showAutoComplete

Questo metodo consente di mostrare fino a 10 stringhe corrispondenti in un elenco a discesa mentre gli utenti premono i tasti per digitare i caratteri in un campo di testo specifico. Puoi anche aggiungere un comando personalizzato con icona nella parte inferiore dell'elenco a discesa. Quando si seleziona una voce nell'elenco a discesa, il valore nel campo di testo cambia nella voce selezionata, l'elenco a discesa scompare e viene richiamato l'Evento OnChange per il campo di testo.

Xrm.Page.getControl(arg).showAutoComplete(object)

  • Parametro
    Type: oggetto che definisce il set di risultati, che include results e commands, che viene visualizzato nell'elenco a discesa a completamento automatico.

    Remarks: chiama questo metodo in una funzione che è stata aggiunta utilizzando il metodo addOnKeyPress da eseguire su un evento keypress.

    Esempio: nell'esempio seguente viene mostrata la definizione dell'oggetto da passare al metodo showAutoComplete.

    var resultset = { 
   results: [{ 
         id: <value1>, 
         icon: <url>, 
         fields: [<fieldValue1>]}, 

         {...}, 

         { 
         id: <valueN>, 
         icon: <url>, 
         fields: [<fieldValue1, fieldValue2,..., fieldValueN>]}],
   commands:{ 
         id: <value>, 
         icon: <url>, 
         label: <value>, 
         action: <function reference> 
   } 
}

hideAutoComplete

Questa funzione consente di nascondere l'elenco a discesa a completamento automatico che hai configurato per uno specifico campo di testo.

Xrm.Page.getControl(arg).hideAutoComplete()

Nota

Non è necessario utilizzare esplicitamente il metodo hideAutoComplete in quanto, per impostazione predefinita, l'elenco a discesa viene nascosto automaticamente se l'utente fa clic in un qualsiasi altro punto o se viene visualizzato un nuovo elenco a discesa. Questa funzione è disponibile nel caso in cui gli sviluppatori debbano nascondere in modo esplicito l'elenco a discesa a completamento automatico per gestire uno scenario personalizzato.

Disabilitata

Utilizzare getDisabled e setDisabled per rilevare se un controllo è disabilitato o per abilitarlo o disabilitarlo.

**Tipi di controllo: standard, lookup, optionset.

getDisabled

Restituisce un valore che indica se il controllo è disabilitato.

Xrm.Page.getControl(arg).getDisabled()
  • Valore restituito
    Tipo: booleano. True se il controllo è disabilitato; in caso contrario false.

setDisabled

Imposta un valore che indica se il controllo è disabilitato.

Xrm.Page.getControl(arg).setDisabled(bool)
  • Argomenti
    Tipo: booleano. True se il controllo deve essere disabilitato; in caso contrario false.

getAttribute

Restituisce l'attributo a cui è associato il controllo.

**Tipi di controllo: standard, lookup, optionset.

Xrm.Page.getControl(arg).getAttribute()

Nota

I controlli non associati a un attributo (griglia secondaria, risorsa Web e IFRAME) non hanno questo metodo. Se si tenta di utilizzare questo metodo su uno di tali controlli, viene generato un errore.

  • Valore restituito
    Tipo: Oggetto: un attributo.

Note

I controlli costituenti in un controllo di visualizzazione rapida sono inclusi nella raccolta dei controlli e dispongono del metodo getAttribute. Tuttavia, l'attributo non fa parte della raccolta di attributi per l'entità. Benché sia possibile recuperare il valore di tale attributo tramite getValue e anche modificare il valore tramite setValue, le modifiche apportate non verranno salvate con l'entità.

Il codice seguente illustra l'utilizzo del valore dell'attributo mobilephone del contatto quando viene visualizzato in un modulo dell'entità dell'account utilizzando un controllo di visualizzazione rapida denominato contactQuickForm. Questo codice nasconde il controllo quando il valore dell'attributo è null.

var quickViewMobilePhoneControl = Xrm.Page.getControl("contactQuickForm_contactQuickForm_contact_mobilephone");
 if (quickViewMobilePhoneControl.getAttribute().getValue() == null)
 {
  quickViewMobilePhoneControl.setVisible(false);
 }

getControlType

Restituisce un valore che suddivide i controlli in categorie.

**Tipi di controllo: tutti.

Xrm.Page.getControl(arg).getControlType()

  • Valore restituito
    Tipo: stringa.

    Valori restituiti possibili di getControlType**:

    Valore restituito

    Descrizione

    standard

    Controllo standard.

    iframe

    Controllo IFRAME

    lookup

    Controllo di ricerca.

    optionset

    Controllo del set di opzioni.

    subgrid

    Controllo della griglia secondaria.

    webresource

    Controllo di risorsa Web.

    notes

    Controllo di note.

    timercontrol

    Controllo Timer.

    kbsearch

    Controllo di ricerca nella Knowledge Base.

    customcontrol: <spazio dei nomi>.<nome>

    Un controllo personalizzato per i client mobili Dynamics 365 (telefoni e tablet).

    customsubgrid:<spazio dei nomi>.<nome>

    Un controllo set di dati personalizzato per i client mobili Dynamics 365 (telefoni e tablet).

getName

Restituisce il nome assegnato al controllo.

Nota

Il nome assegnato a un controllo non è determinato fino al caricamento del modulo. Le modifiche apportate al modulo possono modificare il nome assegnato a un controllo specificato.

**Tipi di controllo: tutti.

Xrm.Page.getControl(arg).getName()
  • Valore restituito
    Tipo: stringa. Nome del controllo.

getParent

Restituisce un riferimento all'oggetto sezione che contiene il controllo.

**Tipi di controllo: tutti.

Xrm.Page.getControl(arg).getParent()

getValue

Ottiene l'ultimo valore in un controllo mentre l'utente digita i caratteri in uno specifico campo di testo o numerico. Questo metodo ti aiuta a creare esperienze interattive convalidando i dati e avvertendo gli utenti mentre digitano i caratteri in un controllo.

Il metodo getValue è diverso dal metodo getValue dell'attributo perché il metodo del controllo recupera il valore dal controllo mentre l'utente digita nel controllo, a differenza del metodo getValue dell'attributo che recupera il valore dopo che l'utente esegue il commit (salva) del campo.

Nota

Questo metodo non è supportato per i client mobili Dynamics 365 (telefoni o tablet) ed è disponibile solo per Entità aggiornate.

Per un esempio di codice JavaScript che utilizza il metodo getValue per configurare il completamento automatico, vedi Esempio: Completamento automatico nel controlli Dynamics 365.

Xrm.Page.getControl(arg).getValue()
  • Valore restituito
    Tipo: stringa. L'ultimo valore dati di un controllo.

Metodi Keypress

Utilizza i metodi addOnKeyPress, removeOnKeyPress e fireOnKeyPress per fornire un feedback immediato o intraprendere un'azione mentre l'utente digita in un controllo. Questi metodi consentono di eseguire le convalide dei dati in un controllo anche prima che l'utente esegua il commit (salvi) del valore in un modulo.

Nota

Questi metodi non sono supportati per i client mobili Dynamics 365 (telefoni e tablet) e sono disponibili solo per Entità aggiornate.

addOnKeyPress

Questo metodo consente di aggiungere una funzione come un gestore eventi per un evento pressione di tasto in modo che la funzione venga chiamata quando digiti un carattere in uno specifico campo di testo o numerico.

Per un esempio di codice JavaScript che utilizza il metodo addOnKeyPress per configurare il completamento automatico, vedi Esempio: Completamento automatico nel controlli Dynamics 365.

Xrm.Page.getControl(arg).addOnKeyPress([function reference])

  • Parametro
    Tipo: riferimento a funzione.

    Note: la funzione sarà aggiunta al fondo della pipeline del gestore eventi. Il contesto di esecuzione viene impostato automaticamente per essere passato come primo parametro passato al gestore eventi impostato utilizzando questo metodo.Ulteriori informazioni:Contesto di esecuzione (riferimento sul lato client)

    Si consiglia di utilizzare un riferimento a una funzione denominata anziché a una funzione anonima se successivamente si desidera rimuovere il gestore eventi per il campo.

removeOnKeyPress

Utilizza questo metodo per rimuovere un gestore eventi per un campo di testo o numerico che hai aggiunto utilizzando addOnKeyPress.

Xrm.Page.getControl(arg).removeOnKeyPress([function reference])

  • Parametro
    Tipo: riferimento a funzione.

    Remarks: se una funzione anonima viene impostata utilizzando addOnKeyPress, non può essere rimossa utilizzando questo metodo.

fireOnKeyPress

Utilizza questo metodo per attivare manualmente un gestore eventi creato per un campo numerico o di testo specifico da eseguire all'evento keypress.

Xrm.Page.getControl(arg).fireOnKeyPress()

Metodi di controllo nella Knowledge Base

Questi metodi sono disponibili solo per il controllo Ricerca nella Knowledge Base, che è disponibile quando l'organizzazione Dynamics 365 è abilitata all'utilizzo della funzionalità di gestione delle informazioni. Per informazioni su questi controlli, vedi Controllo di ricerca nella Knowledge Base (riferimento lato client).

Etichetta

Ottenere o modificare l'etichetta per un controllo utilizzando i metodi setLabel e getLabel.

**Tipi di controllo: tutti.

getLabel

Restituisce l'etichetta per il controllo.

Xrm.Page.getControl(arg).getLabel()
  • Valore restituito
    Tipo: stringa. Etichetta del controllo.

setLabel

Imposta l'etichetta per il controllo.

Xrm.Page.getControl(arg).setLabel(label)
  • Argomenti
    Tipo: stringa. Nuova etichetta per il controllo.

Metodi di controlli di ricerca ed eventi

Controllare i risultati visualizzati per un utente per scegliere da quale momento impostano il valore di un controllo di ricerca tramite i metodi addCustomFilter, addCustomView, getDefaultView e setDefaultView. Il controllo di Lookup espone anche Evento PreSearch in modo da poter aggiungere gestori eventi a livello di programmazione utilizzando i metodi addPreSearch e removePreSearch.

**Tipi di controllo: ricerca.

addCustomFilter

Utilizzare per aggiungere filtri aggiuntivi ai risultati visualizzati nella ricerca. Ogni filtro verrà combinato con tutti i filtri aggiunti in precedenza come condizione "AND".

Xrm.Page.getControl(arg).addCustomFilter(filter, entityLogicaName)

  • Argomenti**

    • filterXml
      Tipo: stringa: elemento filtro fetchXml da applicare. Ad esempio:

      <filter type="and">
 <condition attribute="address1_city" operator="eq" value="Redmond" />
</filter>

    • entityLogicalName
      Tipo: stringa: (facoltativo) se è impostato il filtro viene applicato solo a tale tipo di entità. In caso contrario viene applicato a tutti i tipi di entità restituite.

  • Note
    Ulteriori informazioni:FetchXML schema.

    Questo metodo è disponibile solo per Entità aggiornate.

    Questo metodo può essere utilizzato solo in una funzione in un gestore eventi per Evento PreSearch di controllo di ricerca.

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

addCustomView

Aggiunge una nuova visualizzazione per la finestra di dialogo di ricerca.

Xrm.Page.getControl(arg).addCustomView(viewId, entityName, viewDisplayName, fetchXml, layoutXml, isDefault)

  • Argomenti**

    • viewId
      Tipo: stringa; rappresentazione di stringa di un GUID per una visualizzazione.

      Nota

      Questo valore non viene mai salvato e deve essere univoco tra le altre visualizzazioni disponibili per la ricerca. Funziona una stringa per un GUID non valido, ad esempio "{00000000-0000-0000-0000-000000000001}". È consigliabile utilizzare uno strumento come guidgen.exe per generare un GUID valido. Lo strumento guidgen.exe è incluso in Windows SDK.

    • entityName
      Tipo: stringa; nome dell'entità.

    • viewDisplayName
      Tipo: stringa; nome della visualizzazione.

    • fetchXml
      Stringa: query fetchXml per la visualizzazione.

    • layoutXml
      Tipo: stringa: XML che definisce il layout della visualizzazione.

    • Impostazione predefinita
      Tipo: booleano; stabilisce se la visualizzazione deve essere predefinita.

  • Note
    Questo metodo non funziona con le ricerche Proprietario. Le ricerche proprietario sono utilizzate per assegnare i record di proprietà dell'utente.

DefaultView

È possibile rilevare quale visualizzazione sia quella predefinita da mostrare per consentire agli utenti di selezionare i record in una ricerca e modificare la visualizzazione predefinita utilizzando getDefaultView e setDefaultView.

getDefaultView

Restituisce il valore ID della visualizzazione della finestra di dialogo di ricerca predefinita.

Xrm.Page.getControl(arg).getDefaultView()
  • Valore restituito
    Tipo: stringa. Valore ID della visualizzazione predefinita.

setDefaultView

Imposta la visualizzazione predefinita per la finestra di dialogo del controllo di ricerca.

Xrm.Page.getControl(arg).setDefaultView(viewGuid)
  • Argomenti
    Tipo: stringa. ID della visualizzazione da impostare come visualizzazione predefinita.

Esempio: questa funzione setDefaultViewSample imposterà la visualizzazione ricerca predefinita dei contatti primari del modulo entità sulla visualizzazione accountContatti attivi personali.

function setDefaultViewSample() {
    Xrm.Page.getControl("primarycontactid").setDefaultView("{00000000-0000-0000-00AA-000010001003}");
}​

Evento PreSearch

È possibile aggiungere o rimuovere i gestori eventi per Evento PreSearch di controllo di ricerca utilizzando i metodi removePreSearch e addPreSearch.

Utilizzare l'evento PreSearch per controllare quali risultati vengono visualizzati per il controllo utilizzando i dati del modulo correnti quando l'utente inizia a cercare i record.

Entrambi i metodi hanno Contesto di esecuzione (riferimento sul lato client) passato come primo parametro.

addPreSearch

Utilizzare questo metodo per applicare le modifiche alle ricerche basate su valori correnti quando l'utente si accinge a visualizzare i risultati per la ricerca.

Xrm.Page.getControl(arg).addPreSearch(handler)

  • Argomenti
    Tipo: funzione da aggiungere.

  • Note
    Questo metodo è disponibile solo per Entità aggiornate.

L'argomento è una funzione che verrà eseguita subito prima dell'esecuzione della ricerca per fornire i risultati di una ricerca. È possibile utilizzare il gestore per chiamare una delle altre funzioni del controllo di ricerca e ottimizzare i risultati da visualizzare nella ricerca.

removePreSearch

Utilizzare questo metodo per rimuovere le funzioni del gestore eventi impostate in precedenza per l'evento PreSearch.

Xrm.Page.getControl(arg).removePreSearch(handler)

  • Argomenti
    Tipo: funzione da rimuovere.

  • Note
    Questo metodo è disponibile solo per Entità aggiornate.

Notifica

Utilizza questi metodi per visualizzare e cancellare le notifiche di un controllo.

setNotification

Visualizza un messaggio di errore del controllo per indicare che i dati non sono validi. Quando questo metodo è utilizzato viene visualizzata un'icona rossa a forma di "X" accanto al controllo. Nei client mobili Dynamics 365, toccando l'icona viene visualizzato il messaggio.

Xrm.Page.getControl(arg).setNotification(message,uniqueId)

Note

L'impostazione di una notifica di errore su un controllo blocca il salvataggio del modulo.

Questo metodo è disponibile solo per Entità aggiornate.

Argomenti

  • messaggio
    Tipo: stringa; messaggio da visualizzare.

  • uniqueId
    Tipo: stringa; ID da utilizzare per cancellare solo questo messaggio quando si utilizza clearNotification. (Facoltativo).

Valore restituito

**Tipo: booleano; indica se il metodo ha esito positivo.

addNotification

Visualizza una notifica di errore o elemento consigliato di un controllo e ti consente di specificare le azioni da eseguire in base alla notifica. Quando specifichi un tipo di errore di notifica, un'icona rossa "X" viene visualizzata accanto al controllo. Quando specifichi un tipo di elemento consigliato di notifica, un'icona "i" viene visualizzata accanto al controllo. Nei client mobili Dynamics 365, toccando l'icona viene visualizzato il messaggio e ti consente di eseguire l'azione configurata facendo clic sul pulsante Applica o di ignorare il messaggio.

Xrm.Page.getControl(arg).addNotification(object)

Note

L'impostazione di una notifica di errore su un controllo blocca il salvataggio del modulo; l'impostazione di notifica di elemento consigliato non blocca il salvataggio del modulo.

Questo metodo è stato introdotto in Aggiornamento di dicembre 2016 per Dynamics 365 (online e locale) ed è disponibile solo per Entità aggiornate.

Argomenti

Il metodo accetta un oggetto con gli attributi seguenti:

Attributo

Tipo di dati

Necessario

Descrizione

messages

Matrice

Sì

Il messaggio da visualizzare nella notifica. Nella versione corrente, solo il primo messaggio specificato nella matrice viene visualizzato. La stringa specificata qui viene visualizzata come testo in grassetto nella notifica e viene in genere utilizzata per il titolo o l'oggetto della notifica. È consigliabile limitare il messaggio a 50 caratteri per ottenere un'esperienza utente ottimale.

notificationLevel

Stringa

No

Definisce il tipo di notifica. I valori validi sono ERROR o RECOMMENDATION. Se non specifichi questo attributo nella definizione dell'oggetto, viene impostato su ERROR per impostazione predefinita.

uniqueId

Stringa

No

L'ID da utilizzare per cancellare la notifica quando usi clearNotification.

actions

Matrice di oggetti

No

Raccolta di oggetti con gli attributi seguenti:

  • message: stringa. Il messaggio del corpo o secondario della notifica da visualizzare all'utente. Limita il messaggio a 100 caratteri per ottenere un'esperienza utente ottimale.

  • actions: matrice. Le azioni corrispondenti per il messaggio.

Nella versione corrente, solo il singolo corpo del messaggio e l'azione corrispondente sono supportati. Tuttavia, puoi definire più attività da eseguire tramite il codice JavaScript nel blocco delle azioni.

Nota

Il metodo addNotification visualizza una notifica con i messaggi specificati e due pulsanti standard: Applica e Ignora. Se fai clic su Applica vengono eseguite le azioni definite; se fai clic su Ignora viene chiuso il messaggio di notifica.

Valore restituito

**Tipo: booleano; indica se il metodo ha esito positivo.

Esempio

Nel seguente esempio di codice viene visualizzata una notifica nel campo Nome account del modulo Account per impostare il Simbolo del titolo se il campo Nome account contiene "Microsoft". Facendo clic su Applica nella notifica imposti il campo Simbolo del titolo su "MSFT".

function addTickerSymbolRecommendation() {
    var myControl = Xrm.Page.getControl('name');
    var accountName = Xrm.Page.data.entity.attributes.get('name');
    var tickerSymbol = Xrm.Page.data.entity.attributes.get('tickersymbol');

    if (accountName.getValue('Microsoft') && tickerSymbol.getValue() != 'MSFT') {
        var actionCollection = {
            message: 'Set the Ticker Symbol to MSFT?',
            actions: null
        };

        actionCollection.actions = [function () {
            tickerSymbol.setValue('MSFT');
            myControl.clearNotification('my_unique_id');
        }];

        myControl.addNotification({
            messages: ['Set Ticker Symbol'],
            notificationLevel: 'RECOMMENDATION',
            uniqueId: 'my_unique_id',
            actions: [actionCollection]
        });
    }
    else
        console.log("Notification not set");
}

clearNotification

Rimuovere un messaggi già visualizzato per un controllo.

Xrm.Page.getControl(arg).clearNotification(uniqueId)

Argomenti

  • uniqueId
    Tipo: stringa; ID da utilizzare per cancellare un messaggio specifico impostato utilizzando setNotification o addNotification.

    Se il parametro uniqueId non viene specificato, la notifica corrente visualizzata verrà rimossa.

Note

Questo metodo è disponibile solo per Entità aggiornate.

Valore restituito

**Tipo: booleano; indica se il metodo ha esito positivo.

Metodi del controllo OptionSet

Utilizzare i metodi addOption, clearOptions e removeOption per modificare le opzioni disponibili per i controlli OptionSet.

addOption

Aggiunge un'opzione a un controllo di set di opzioni.

Xrm.Page.getControl(arg).addOption(option, [index])

Importante

Questo metodo non verifica la validità dei valori nelle opzioni aggiunte. Se si aggiungono opzioni non valide, non funzioneranno correttamente. Si devono aggiungere solo opzioni che sono state definite per l'attributo specifico del set di opzioni a cui il controllo è associato. Utilizzare l'attributo getOptions o metodi getOption per ottenere oggetti opzione validi per l'aggiunta tramite questo metodo.

  • Argomenti**

    • option
      Tipo: oggetto; un oggetto opzione da aggiungere a OptionSet.

    • index
      Tipo: numero; (facoltativo) posizione dell'indice per l'inserimento della nuova opzione. Se non è disponibile, l'opzione verrà aggiunta alla fine.

clearOptions

Cancella tutte le opzioni da un controllo del set di opzioni.

Xrm.Page.getControl(arg).clearOptions()

removeOption

Rimuove un'opzione da un controllo del set di opzioni.

Xrm.Page.getControl(arg).removeOption(number)
  • Argomenti
    Tipo**: numero; valore dell'opzione che si desidera rimuovere.

setFocus

Imposta lo stato attivo sul controllo.

Xrm.Page.getControl(arg).setFocus()

ShowTime

Utilizza setShowTime per specificare se un controllo di data deve mostrare la parte dell'ora della data e utilizzare getShowTime per determinare se la parte dell'ora della data è attualmente visualizzata.

getShowTime

Indica se il controllo di data mostra la porzione di tempo della data.

**Tipi di controllo: controllo standard per gli attributi di tipo datetime.

var showsTime = Xrm.Page.getControl(arg).getShowTime();

Note

Questo metodo è stato introdotto con Aggiornamento 1 di Microsoft Dynamics CRM Online 2015.

setShowTime

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

**Tipi di controllo: controllo standard per gli attributi di tipo datetime.

Xrm.Page.getControl(arg).setShowTime(bool)

Note

Questo metodo è disponibile solo per Entità aggiornate. Questo metodo nasconderà o visualizzerà il componente ora di un controllo di data, dove l'attributo utilizza il formato DateAndTime. Questo metodo non avrà effetto quando si utilizza il formato DateOnly.

Metodi di controllo della griglia secondaria

Per le versioni precedenti a Aggiornamento 1 di Microsoft Dynamics CRM Online 2015, l'unico metodo disponibile per il controllo di una griglia secondaria è refresh. Con Aggiornamento 1 di CRM Online 2015 puoi utilizzare nuove funzionalità.Ulteriori informazioni:Oggetti e metodi (sola lettura) della griglia (riferimento lato client)

refresh

Aggiorna i dati visualizzati in una griglia secondaria.

Xrm.Page.getControl(arg).refresh()

Nota

Il metodo di aggiornamento non è disponibile nel modulo Evento OnLoad perché le griglie secondarie vengono caricate in modalità asincrona. Con la griglia secondaria Evento OnLoad introdotta in Aggiornamento 1 di CRM Online 2015 puoi rilevare quando la griglia secondaria viene caricata e utilizzare questo metodo nei gestori di tale evento.

Visibile

Determinare quali comandi sono visibili e mostrarli o nasconderli utilizzando i metodi setVisible e getVisible.

getVisible

Restituisce un valore che indica se il controllo è attualmente disponibile.

Nota

Se la sezione o la scheda contenente del controllo non è visibile, questo metodo restituisce comunque true. Per accertarsi che il controllo sia effettivamente visibile; è inoltre necessario controllare la visibilità degli elementi contenenti.

Xrm.Page.getControl(arg).getVisible()
  • Valore restituito
    Tipo: booleano.True se il controllo è visibile; in caso contrario, false.

setVisible

Imposta un valore che indica se il controllo è visibile.

Xrm.Page.getControl(arg).setVisible(bool)
  • Argomenti
    Tipo: booleano.True se il controllo deve essere visibile; in caso contrario false.

Nota

Quando vengono visualizzati i campi in modo selettivo agli utenti nel codice eseguito nell'evento Onload, è consigliabile configurare i campi come non visibili per impostazione predefinita e quindi utilizzare setVisible(true) per visualizzare i campi nelle condizioni corrette. Utilizzando setVisible(false) per nascondere i campi nell'evento Onload può comportare la breve visualizzazione del campo all'utente prima che venga nascosto.

Se si nasconde un numero elevato di campi utilizzando setVisible(false), valutare se è possibile raggrupparli insieme in schede o sezioni in e nascondere la scheda o la sezione anziché i campi separatamente. Ciò può migliorare le prestazioni.

Metodi dei controlli di risorsa Web e IFRAME

Utilizzare questi metodi per interagire con controlli di risorsa Web e IFRAME.

Dati

Le risorse Web hanno un parametro stringa di query speciale denominato data per passare i dati personalizzati. I metodi setData e getData funzionano solo per le risorse Web Silverlight aggiunte a un modulo.Ulteriori informazioni:Passare i dati da un modulo a una risorsa Web Silverlight incorporata

Per le risorse Web (HTML) della pagina Web, il parametro dati può essere estratto dal metodo getSrc o impostato utilizzando il metodo setSrc.

Nota

I metodi getData e setData non sono supportati per l'hub di servizio interattivo.

getData

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

Xrm.Page.getControl(arg).getData()
  • Valore restituito
    Tipo: stringa. Il valore dei dati passato alla risorsa Web Silverlight.

setData

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

Xrm.Page.getControl(arg).setData(string)
  • Argomenti
    Tipo: stringa. Il valore dei dati da passare alla risorsa Web Silverlight.

getInitialUrl

Restituisce l'URL predefinito che un controllo IFRAME è configurato per visualizzare. Questo metodo non è disponibile per le risorse Web.

Xrm.Page.getControl(arg).getInitialUrl()
  • Valore restituito
    Tipo: stringa. URL iniziale.

getObject

Restituisce l'oggetto nel modulo che rappresenta un I-frame o una risorsa Web.

Xrm.Page.getControl(arg).getObject()

  • Valore restituito
    Tipo: oggetto. L'oggetto dipende dal tipo di controllo.

    Un IFRAME restituisce l'elemento IFrame da Document Object Model (DOM).

    Una risorsa Web Silverlight restituirà l'elemento Object da DOM che rappresenta il plug-in Silverlight incorporato.

Src

IFRAME o risorse Web hanno una proprietà src per definire cosa visualizzare nella finestra incorporata. È possibile ottenere o modificare la proprietà src utilizzando i metodi setSrc e getSrc.

getSrc

Restituisce l'URL corrente visualizzato in un IFRAME o una risorsa Web.

Xrm.Page.getControl(arg).getSrc()
  • Valore restituito
    Tipo: stringa.URL che rappresenta la proprietà src dell'IFRAME o della risorsa Web.

setSrc

Imposta l'URL da visualizzare in un IFRAME o una risorsa Web.

Xrm.Page.getControl(arg).setSrc(string)
  • Argomenti
    Tipo: stringa; URL.

Vedere anche

Riferimento programmazione sul lato client
Riferimento rapido dello scripting dei moduli
Xrm.Page.ui (riferimento lato client)
Creare il codice per moduli di Microsoft Dynamics 365
Utilizzare il modello a oggetti Xrm.Page

Microsoft Dynamics 365

© 2017 Microsoft. Tutti i diritti sono riservati. Copyright