Controllo Xrm.Page.ui (riferimento lato client)

  • Articolo

 

Data di pubblicazione: novembre 2016

Si applica a: Dynamics CRM 2015

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.

Proprietà dei controlli e metodi

  • 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.

  • Metodi di controllo nella Knowledge Base
    Questi metodi sono disponibili solo per il controllo di ricerca nella knowledge quando l'organizzazione Microsoft Dynamics CRM Online è integrata con Parature. Questi metodi sono stati introdotti con Aggiornamento 1 di Microsoft Dynamics CRM Online 2015.

    Per informazioni sui controlli, vedi Controllo di ricerca nella Knowledge Base di Parature (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 clearNotification e setNotification.

  • 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 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.

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 nasconderà 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.

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

Metodi di controllo nella Knowledge Base

Questi metodi sono disponibili solo per il controllo di ricerca nella knowledge quando l'organizzazione Microsoft Dynamics CRM Online è integrata con Parature. Questi metodi sono stati introdotti con Aggiornamento 1 di Microsoft Dynamics CRM Online 2015.

Per informazioni sui controlli, vedi Controllo di ricerca nella Knowledge Base di Parature (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

Utilizzare setNotification per visualizzare una notifica sul controllo e clearNotification per rimuoverla.

setNotification

Visualizzare un messaggio accanto al controllo per indicare che i dati non sono validi. Se questo metodo è utilizzato in Microsoft Dynamics CRM per tablet viene visualizzata un'icona a forma di "X" rossa accanto al controllo. Toccando l'icona viene visualizzato il messaggio.

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

Note

L'impostazione di una notifica 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.

Valore restituito

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

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.

    Se il parametro uniqueId non viene utilizzato, 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. Per un esempio dell'utilizzo di queste funzioni, vedere Esempio: creare set di opzioni dipendenti (elenchi a discesa).

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 con Aggiornamento 1 di Microsoft Dynamics CRM Online 2015 o versione successiva, utilizza 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 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.

Nota

Questi metodi non funzionano con Microsoft Dynamics CRM per tablet.

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.

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 CRM 2015
Utilizzare il modello a oggetti Xrm.Page

© 2017 Microsoft. Tutti i diritti sono riservati. Copyright