Controlli (informazioni di riferimento sulle API client)

Nelle app basate su modello, un controllo rappresenta un elemento HTML nel form. Alcuni controlli sono associati a una colonna specifica, mentre altri rappresentano controlli non associati, ad esempio un IFRAME, una risorsa Web o una sottogrid aggiunta al modulo.

L'oggetto control fornisce metodi per modificare la presentazione o il comportamento di un controllo e identificare la colonna corrispondente. Controlli di accesso usando una delle raccolte seguenti:

  • formContext.ui.controls
  • formContext.ui Section.controls
  • formContext.data.entityAttribute.controls

FormContext. il metodo getControl è un metodo di scelta rapida per accedere a formContext.ui.controls.get.

Annotazioni

Quando si eseguono azioni sui controlli associati a una colonna, tenere presente che il controllo potrebbe essere visualizzato più volte nella pagina. In genere, è consigliabile eseguire le stesse azioni per ogni controllo per la colonna. È possibile scorrere la raccolta di controlli di colonna ed eseguire le azioni su ogni controllo.

I controlli vengono categorizzati per tipo. Utilizzare il metodo getControlType per determinare il tipo di un controllo. Alcuni metodi di controllo sono disponibili solo per tipi specifici di controlli.

Questo articolo fornisce informazioni sui metodi disponibili per ogni tipo di controllo.

Tipo di controllo standard

Questi metodi sono disponibili per un controllo Standard.

Method Description
addNotification Visualizza una notifica di errore o raccomandazione con azioni facoltative.
clearNotification Rimuove una notifica dal controllo .
getAttribute Restituisce la colonna a cui è associato il controllo.
getControlType Restituisce il tipo del controllo.
getDisabled Restituisce un valore che indica se il controllo è disabilitato.
getLabel Restituisce l'etichetta del controllo.
getName Restituisce il nome del controllo.
getOutputs Restituisce un dizionario delle proprietà di output del controllo.
getParent Restituisce la sezione che contiene il controllo .
getVisible Restituisce un valore che indica se il controllo è visibile.
setDisabled Abilita o disabilita il controllo.
setFocus Sposta lo stato attivo sul controllo.
setLabel Modifica l'etichetta del controllo.
setNotification Visualizza un messaggio di errore per indicare che i dati non sono validi.
setVisible Mostra o nasconde il controllo.

I metodi seguenti per il controllo Standard sono deprecati: addOnKeyPress, fireOnKeyPress e removeOnKeyPress.

Tipo di controllo IFRAME

Questi metodi sono disponibili per un controllo IFRAME.

Method Description
getContentWindow Restituisce la finestra del contenuto della risorsa IFRAME o Web.
getControlType Restituisce il tipo del controllo.
getDisabled Restituisce un valore che indica se il controllo è disabilitato.
getInitialUrl Restituisce l'URL predefinito configurato per l'IFRAME.
getLabel Restituisce l'etichetta del controllo.
getName Restituisce il nome del controllo.
getObject Restituisce l'oggetto modulo che rappresenta l'IFRAME o la risorsa Web.
getParent Restituisce la sezione che contiene il controllo .
getSrc Restituisce l'URL attualmente visualizzato nella risorsa IFRAME o Web.
getVisible Restituisce un valore che indica se il controllo è visibile.
setDisabled Abilita o disabilita il controllo.
setFocus Sposta lo stato attivo sul controllo.
setLabel Modifica l'etichetta del controllo.
setSrc Imposta l'URL da visualizzare nell'IFRAME o nella risorsa Web.
setVisible Mostra o nasconde il controllo.

Tipo di controllo Kbsearch (ricerca knowledge base)

Questi metodi sono disponibili per il controllo di ricerca della Knowledge Base.

Method Description
addOnPostSearch Aggiunge un gestore eventi che viene eseguito dopo il completamento di una ricerca.
addOnResultOpened Aggiunge un gestore eventi che viene eseguito all'apertura di un risultato di ricerca.
addOnSelection Aggiunge un gestore eventi che viene eseguito quando viene selezionato un risultato della ricerca.
getControlType Restituisce il tipo del controllo.
getDisabled Restituisce un valore che indica se il controllo è disabilitato.
getLabel Restituisce l'etichetta del controllo.
getName Restituisce il nome del controllo.
getParent Restituisce la sezione che contiene il controllo .
getSearchQuery Restituisce il testo utilizzato come criteri di ricerca.
getSelectedResults Restituisce il risultato della ricerca attualmente selezionato.
getTotalResultCount Restituisce il numero di risultati della ricerca.
getVisible Restituisce un valore che indica se il controllo è visibile.
openSearchResult Apre un risultato di ricerca specificato.
removeOnPostSearch Rimuove un gestore eventi per il completamento della ricerca.
removeOnResultOpened Rimuove un gestore eventi per l'apertura di un risultato di ricerca.
removeOnSelection Rimuove un gestore eventi per la selezione di un risultato della ricerca.
setFocus Sposta lo stato attivo sul controllo.
setLabel Modifica l'etichetta del controllo.
setSearchQuery Imposta il testo utilizzato come criteri di ricerca.
setVisible Mostra o nasconde il controllo.

Annotazioni

Quando si aggiunge il controllo di ricerca della Knowledge Base al riquadro social, il nome del controllo è searchwidgetcontrol_notescontrol. Non puoi cambiare questo nome.

Tipo di controllo di ricerca

Questi metodi sono disponibili per un controllo di ricerca.

Method Description
addCustomFilter Aggiunge un filtro ai risultati della ricerca, combinati con i filtri esistenti tramite AND.
addCustomView Aggiunge una visualizzazione alla finestra di dialogo di ricerca.
addNotification Visualizza una notifica di errore o raccomandazione con azioni facoltative.
addOnLookupTagClick Aggiunge un gestore eventi che viene eseguito quando si fa clic su un tag di ricerca.
addPreSearch Aggiunge un gestore eventi eseguito prima di una ricerca di ricerca.
clearNotification Rimuove una notifica dal controllo .
getAttribute Restituisce la colonna a cui è associato il controllo.
getControlType Restituisce il tipo del controllo.
getDefaultView Restituisce l'ID della visualizzazione di ricerca predefinita.
getDisabled Restituisce un valore che indica se il controllo è disabilitato.
getEntityTypes Restituisce i tipi di tabella consentiti nella ricerca.
getLabel Restituisce l'etichetta del controllo.
getName Restituisce il nome del controllo.
getParent Restituisce la sezione che contiene il controllo .
getVisible Restituisce un valore che indica se il controllo è visibile.
removeOnLookupTagClick Rimuove un gestore eventi per i clic sui tag di ricerca.
removePreSearch Rimuove un gestore eventi eseguito prima di una ricerca di ricerca.
setDefaultView Imposta la visualizzazione predefinita nella finestra di dialogo di ricerca.
setDisabled Abilita o disabilita il controllo.
setEntityTypes Imposta i tipi di tabella consentiti nella ricerca.
setFocus Sposta lo stato attivo sul controllo.
setLabel Modifica l'etichetta del controllo.
setNotification Visualizza un messaggio di errore per indicare che i dati non sono validi.
setVisible Mostra o nasconde il controllo.

Scelte e tipi di controllo di scelta

Le scelte e i controlli di scelta hanno lo stesso set di metodi disponibili.

Method Description
addNotification Visualizza una notifica di errore o raccomandazione con azioni facoltative.
addOption Aggiunge un'opzione al controllo .
clearNotification Rimuove una notifica dal controllo .
clearOptions Rimuove tutte le opzioni dal controllo .
getAttribute Restituisce la colonna a cui è associato il controllo.
getControlType Restituisce il tipo del controllo.
getDisabled Restituisce un valore che indica se il controllo è disabilitato.
getLabel Restituisce l'etichetta del controllo.
getName Restituisce il nome del controllo.
getOptions Restituisce le opzioni disponibili, inclusa l'opzione vuota ed escluse le opzioni rimosse.
getParent Restituisce la sezione che contiene il controllo .
getVisible Restituisce un valore che indica se il controllo è visibile.
removeOption Rimuove un'opzione dal controllo .
setDisabled Abilita o disabilita il controllo.
setFocus Sposta lo stato attivo sul controllo.
setLabel Modifica l'etichetta del controllo.
setNotification Visualizza un messaggio di errore per indicare che i dati non sono validi.
setVisible Mostra o nasconde il controllo.

Tipo di controllo modulo rapido

Per informazioni sui metodi supportati per questo tipo di controllo , vedere formContext.ui.quickForms .

Tipo di controllo Sottogrid

Per informazioni sui metodi supportati per questo tipo di controllo, vedere Griglie e sottogrid .

Tipo di controllo muro sequenza temporale

Il controllo sequenza temporale presenta i post, le attività e le note in una visualizzazione unificata. Questi metodi sono disponibili per questo tipo di controllo.

Method Description
getControlType Restituisce il tipo del controllo.
getDisabled Restituisce un valore che indica se il controllo è disabilitato.
getLabel Restituisce l'etichetta del controllo.
getName Restituisce il nome del controllo.
getParent Restituisce la sezione che contiene il controllo .
getVisible Restituisce un valore che indica se il controllo è visibile.
aggiornare Aggiorna i dati visualizzati nella sequenza temporale.
setDisabled Abilita o disabilita il controllo.
setFocus Sposta lo stato attivo sul controllo.
setLabel Modifica l'etichetta del controllo.
setVisible Mostra o nasconde il controllo.

Tipo di controllo timer

Questi metodi sono disponibili per il controllo timer.

Method Description
getControlType Restituisce il tipo del controllo.
getDisabled Restituisce un valore che indica se il controllo è disabilitato.
getLabel Restituisce l'etichetta del controllo.
getName Restituisce il nome del controllo.
getParent Restituisce la sezione che contiene il controllo .
getState Restituisce lo stato corrente del timer.
getVisible Restituisce un valore che indica se il controllo è visibile.
aggiornare Aggiorna i dati visualizzati nel timer.
setDisabled Abilita o disabilita il controllo.
setFocus Sposta lo stato attivo sul controllo.
setLabel Modifica l'etichetta del controllo.
setVisible Mostra o nasconde il controllo.

Tipo di controllo delle risorse Web

Un controllo risorsa Web ha lo stesso set di metodi disponibili per il controllo iframe. Vedere tipo di controllo iframe.

Tipo di controllo componente modulo

Un tipo di controllo componente modulo ha lo stesso set di metodi disponibili come formContext in una maschera principale. Vedere Api client per il comportamento > dei componenti del modulo.

Columns