Xrm.Page.ui (riferimento lato client)
Data di pubblicazione: gennaio 2017
Si applica a: Dynamics 365 (online), Dynamics 365 (on-premises), Dynamics CRM 2016, Dynamics CRM Online
Xrm.Page.ui contiene proprietà e metodi per recuperare informazioni sull'interfaccia utente e sulle raccolte per diversi sottocomponenti del modulo.
Proprietà e metodi di Xrm.Page.ui
Chiudi
Metodo per chiudere il modulo.controls
Una raccolta di tutti i controlli nella pagina.formSelector
Utilizzare il metodo formSelector.getCurrentItem per recuperare le informazioni sul modulo in uso e la raccolta formSelector.items contenente le informazioni su tutti i moduli disponibili per l'utente.getCurrentControl
Metodo per ottenere l'oggetto di controllo che attualmente ha lo stato attivo nel modulo.Nota
Questo metodo è stato dichiarato deprecato in Aggiornamento cumulativo 2 di Microsoft Dynamics CRM 2013.
getFormType
Metodo per ottenere il contesto del modulo per il record.navigation.items
Una raccolta di tutti gli articoli di navigazione nella pagina.Notifica del modulo
Utilizzare setFormNotification per visualizzare le notifiche a livello di modulo e clearFormNotification per rimuovere le notifiche.quickForms
Una raccolta di tutti i controlli di visualizzazione rapida nella pagina.refreshRibbon
Metodo per fare in modo che la barra multifunzione rivaluti i dati che controllano ciò che viene visualizzato.schede
Una raccolta di tutte le schede nella pagina.Metodi ViewPort
ViewPort è l'area della pagina che contiene i dati del modulo. Corrisponde al corpo del modulo e non include le aree di navigazione, intestazione, piè di pagina o Informazioni e selezione rapida della pagina. Utilizzare i metodi getViewPortHeight e getViewPortWidth per ottenere la dimensione corrente di ViewPort.
Chiudi
Metodo per chiudere il modulo.
Xrm.Page.ui.close()
Note:
Il metodo HTML Window.close viene eliminato. Per chiudere una finestra del modulo è necessario utilizzare questo metodo. Se sono disponibili le modifiche non salvate nel modulo verrà richiesto all'utente se desidera salvare le modifiche prima che la finestra venga chiusa.
Con Microsoft Dynamics 365 per tablet questo metodo riproduce il comportamento del pulsante di spostamento posteriore.
controls
Una raccolta di tutti i controlli nella pagina.
Vedere Raccolte (riferimento lato client) per informazioni sui metodi di raccolta e Controllo Xrm.Page.ui (riferimento lato client) per informazioni sugli oggetti di controllo nella raccolta.
formSelector
Utilizzare il metodo formSelector.getCurrentItem per recuperare le informazioni sul modulo in uso e la raccolta formSelector.items contenente le informazioni su tutti i moduli disponibili per l'utente.
Nota
La raccolta formSelectoritems non esiste e il metodo formSelector.getCurrentItem non è supportato per i client mobili Dynamics 365 (telefoni e tablet) e l'hub interattivo di servizio.
formSelector.getCurrentItem
Metodo per restituire un riferimento nel modulo al momento visualizzato.
Nota
Quando è disponibile solo un modulo, questo metodo restituirà null.
- Valore restituito
Tipo:Oggetto
formSelector.items
Una raccolta di tutti gli elementi del modulo accessibili all'utente corrente.
Nota
Solo tali moduli che condividono un'associazione con uno dei ruoli di sicurezza dell'utente sono disponibili in questa raccolta.
Vedere Raccolte (riferimento lato client) per informazioni sui metodi di raccolta e Elemento Xrm.Page.ui.formSelector (riferimento sul lato client) per informazioni sugli articoli nella raccolta.
getCurrentControl
Metodo per ottenere l'oggetto di controllo che attualmente ha lo stato attivo nel modulo. I controlli della risorsa Web e IFRAME non vengono restituiti da questo metodo.
Nota
Questo metodo è stato dichiarato deprecato in Aggiornamento cumulativo 2 di Microsoft Dynamics CRM 2013.
Questo metodo non restituisce un riferimento al controllo corrente quando l'ultimo campo modificato dall'utente era un attributo booleano formattato come pulsante di opzione o controllo della casella di controllo. Questo metodo non riesce inoltre a restituire un riferimento subito dopo l'utilizzo del metodo setFocus del controllo Xrm.Page.ui.
Xrm.Page.ui.getCurrentControl()
- Valore restituito
Tipo:Oggetto
getFormType
Metodo per ottenere il contesto del modulo per il record.
Xrm.Page.ui.getFormType()
Valore restituito
Tipo:NumeroNella tabella seguente sono elencati i tipi di modulo che corrispondono al valore restituito.
Valore
Tipo di modulo
0
Indefinito
1
Crea
2
Aggiornamento
3
Sola lettura
4
Disabilitata
6
Modifica in blocco
Nota
I moduli Creazione guidata restituiscono 1. Il valore 5 è stato utilizzato per un tipo precedente di modulo di creazione rapida che è stato rimosso.
navigation.items
Una raccolta di tutti gli articoli di navigazione nella pagina.
Nota
Questa raccolta non esiste con Microsoft Dynamics 365 per tablet.
Vedere Raccolte (riferimento lato client) per informazioni sui metodi di raccolta e Elemento Xrm.Page.ui.navigation (riferimento sul lato client) per informazioni sugli articoli nella raccolta.
Notifica del modulo
Utilizzare setFormNotification per visualizzare le notifiche a livello di modulo e clearFormNotification per rimuovere le notifiche.
clearFormNotification
Utilizzare questo metodo per rimuovere le notifiche a livello di modulo.
Xrm.Page.ui.clearFormNotification(uniqueId)
Parametri
- uniqueId
Tipo: stringa. Un identificatore univoco per il messaggio utilizzato con setFormNotification per impostare la notifica.
- uniqueId
Valore restituito
Tipo: booleano. True se il metodo ha esito positivo, in caso contrario, false.Note
Questo metodo è disponibile solo per Entità aggiornate.
setFormNotification
Utilizzare questo metodo per visualizzare le notifiche a livello di modulo. È possibile visualizzare un numero di notifiche e verranno visualizzate fino a che non vengono eliminate utilizzando clearFormNotification. L'altezza dell'area di notifica è limitata in modo che ogni nuovo messaggio verrà aggiunto in alto. Gli utenti possono scorrere verso il basso i messaggi precedenti che non sono ancora stati rimossi.
Xrm.Page.ui.setFormNotification(message, level, uniqueId);
Parametri
message
Tipo: stringa. Il testo del messaggio.level
Tipo: stringa. Il livello del messaggio.Il livello definisce il modo in cui il messaggio verrà visualizzato.
ERROR : La notifica utilizzerà l'icona di errore del sistema.
WARNING : La notifica utilizzerà l'icona di avviso del sistema.
INFO : La notifica utilizzerà l'icona di informazioni del sistema.
uniqueId
Tipo: stringa. Un identificatore univoco per il messaggio utilizzato con clearFormNotification per rimuovere la notifica.
Valore restituito
Tipo: booleano. True se il metodo ha esito positivo, in caso contrario, false.Note
Questo metodo è disponibile solo per Entità aggiornate.
quickForms
Una raccolta di tutti i controlli di visualizzazione rapida in un modulo tramite il nuovo motore di rendering moduli (detto anche "turbo modulo"). Per informazioni sui metodi e le proprietà supportati per questa raccolta e per gli oggetti nella raccolta, vedere quickForms Xrm.Page.ui (riferimento lato client)
refreshRibbon
Metodo per fare in modo che la barra multifunzione rivaluti i dati che controllano ciò che viene visualizzato.
Xrm.Page.ui.refreshRibbon()
Valore restituito
Tipo: NessunoNota: Questa funzione in genere viene utilizzato quando una barra multifunzione <EnableRule> (RibbonDiffXml) dipende da un valore nel modulo. Dopo che il codice cambia un valore utilizzato da una regola, utilizzare questo metodo per forzare la barra multifunzione a rivalutare i dati nel modulo in modo da consentire l'applicazione della regola.
schede
Una raccolta di tutte le schede nella pagina.
Vedere Raccolte (riferimento lato client) per informazioni sui metodi di raccolta e Scheda Xrm.Page.ui (riferimento lato client) per informazioni sugli articoli nella raccolta.
Metodi ViewPort
ViewPort è l'area della pagina che contiene i dati del modulo. Corrisponde al corpo del modulo e non include le aree di navigazione, intestazione, piè di pagina o Informazioni e selezione rapida della pagina. Utilizzare i metodi getViewPortHeight e getViewPortWidth per ottenere la dimensione corrente di ViewPort.
Nota
Questi metodi non funzionano con Microsoft Dynamics 365 per tablet.
getViewPortHeight
Metodo per ottenere l'altezza di viewport in pixel.
Xrm.Page.ui.getViewPortHeight()
- Valore restituito
Tipo:Numero
getViewPortWidth
Metodo per ottenere la larghezza di viewport in pixel.
Xrm.Page.ui.getViewPortWidth()
- Valore restituito
Tipo:Numero
Vedere anche
Riferimento programmazione sul lato client
Riferimento rapido dello scripting dei moduli
Creare il codice per moduli di Microsoft Dynamics 365
Utilizzare il modello a oggetti Xrm.Page
Xrm.Page.data.entity (riferimento lato client)
Microsoft Dynamics 365
© 2017 Microsoft. Tutti i diritti sono riservati. Copyright