Kontroller (klient-API-referens)

I modelldrivna appar representerar en kontroll ett HTML-element i formuläret. Vissa kontroller är bundna till en specifik kolumn, medan andra representerar obundna kontroller, till exempel en IFRAME, webbresurs eller underrutnät som läggs till i formuläret.

Kontrollobjektet innehåller metoder för att ändra presentationen eller beteendet för en kontroll och identifiera motsvarande kolumn. Åtkomstkontroller med hjälp av någon av följande samlingar:

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

FormContext. getControl-metoden är en genvägsmetod för att komma åt formContext.ui.controls.get.

Anmärkning

När du utför åtgärder för kontroller som är knutna till en kolumn bör du tänka på att kontrollen kan visas på sidan mer än en gång. I allmänhet bör du utföra samma åtgärder för varje kontroll för kolumnen. Du kan loopa igenom samlingen med kolumnkontroller och utföra åtgärderna på varje kontroll.

Kontroller kategoriseras efter typ. Använd metoden getControlType för att fastställa typen av kontroll. Vissa kontrollmetoder är endast tillgängliga för specifika typer av kontroller.

Den här artikeln innehåller information om de metoder som är tillgängliga för varje kontrolltyp.

Standardkontrolltyp

Dessa metoder är tillgängliga för en Standard-kontroll.

Method	Description
addNotification	Visar ett meddelande om fel eller rekommendation med valfria åtgärder.
clearNotification	Tar bort ett meddelande från kontrollen.
getAttribute	Returnerar kolumnen som kontrollen är bunden till.
getControlType	Returnerar kontrollens typ.
getDisabled	Returnerar om kontrollen är inaktiverad.
getLabel	Returnerar kontrollens etikett.
getName	Returnerar kontrollens namn.
getOutputs	Returnerar en ordlista över kontrollens utdataegenskaper.
getParent	Returnerar avsnittet som innehåller kontrollen.
getVisible	Returnerar om kontrollen är synlig.
setDisabled	Aktiverar eller inaktiverar kontrollen.
setFocus	Flyttar fokus till kontrollen.
setLabel	Ändrar kontrollens etikett.
setNotification	Visar ett felmeddelande som anger att data inte är giltiga.
setVisible	Visar eller döljer kontrollen.

Följande metoder för Standard-kontrollen är inaktuella: addOnKeyPress, fireOnKeyPress och removeOnKeyPress.

IFRAME-kontrolltyp

Dessa metoder är tillgängliga för en IFRAME-kontroll.

Method	Description
getContentWindow	Returnerar innehållsfönstret för IFRAME- eller webbresursen.
getControlType	Returnerar kontrollens typ.
getDisabled	Returnerar om kontrollen är inaktiverad.
getInitialUrl	Returnerar standard-URL:en som konfigurerats för IFRAME.
getLabel	Returnerar kontrollens etikett.
getName	Returnerar kontrollens namn.
getObject	Returnerar det formulärobjekt som representerar IFRAME eller webbresursen.
getParent	Returnerar avsnittet som innehåller kontrollen.
getSrc	Returnerar den URL som visas i IFRAME eller webbresursen.
getVisible	Returnerar om kontrollen är synlig.
setDisabled	Aktiverar eller inaktiverar kontrollen.
setFocus	Flyttar fokus till kontrollen.
setLabel	Ändrar kontrollens etikett.
setSrc	Anger url:en som ska visas i IFRAME eller webbresursen.
setVisible	Visar eller döljer kontrollen.

Kontrolltyp för Kbsearch (kunskapsbassökning)

De här metoderna är tillgängliga för kunskapsbassökningskontrollen.

Method	Description
addOnPostSearch	Lägger till en händelsehanterare som körs när en sökning har slutförts.
addOnResultOpened	Lägger till en händelsehanterare som körs när ett sökresultat öppnas.
addOnSelection	Lägger till en händelsehanterare som körs när ett sökresultat väljs.
getControlType	Returnerar kontrollens typ.
getDisabled	Returnerar om kontrollen är inaktiverad.
getLabel	Returnerar kontrollens etikett.
getName	Returnerar kontrollens namn.
getParent	Returnerar avsnittet som innehåller kontrollen.
getSearchQuery	Returnerar den text som används som sökvillkor.
getSelectedResults	Returnerar det valda sökresultatet.
getTotalResultCount	Returnerar antalet sökresultat.
getVisible	Returnerar om kontrollen är synlig.
openSearchResult	Öppnar ett angivet sökresultat.
removeOnPostSearch	Tar bort en händelsehanterare för att sökningen ska slutföras.
removeOnResultOpened	Tar bort en händelsehanterare för att öppna ett sökresultat.
removeOnSelection	Tar bort en händelsehanterare för att välja ett sökresultat.
setFocus	Flyttar fokus till kontrollen.
setLabel	Ändrar kontrollens etikett.
setSearchQuery	Anger den text som används som sökvillkor.
setVisible	Visar eller döljer kontrollen.

Anmärkning

När du lägger till sökkontrollen för kunskapsbasen i det sociala fönstret är searchwidgetcontrol_notescontrolkontrollnamnet . Du kan inte ändra det här namnet.

Typ av uppslagskontroll

Dessa metoder är tillgängliga för en uppslagskontroll.

Method	Description
addCustomFilter	Lägger till ett filter i uppslagsresultatet, kombinerat med befintliga filter med hjälp av AND.
addCustomView	Lägger till en vy i uppslagsdialogrutan.
addNotification	Visar ett meddelande om fel eller rekommendation med valfria åtgärder.
addOnLookupTagClick	Lägger till en händelsehanterare som körs när en uppslagstagg klickas.
addPreSearch	Lägger till en händelsehanterare som körs före en sökning.
clearNotification	Tar bort ett meddelande från kontrollen.
getAttribute	Returnerar kolumnen som kontrollen är bunden till.
getControlType	Returnerar kontrollens typ.
getDefaultView	Returnerar ID för standarduppslagsvyn.
getDisabled	Returnerar om kontrollen är inaktiverad.
getEntityTypes	Returnerar de tabelltyper som tillåts i sökningen.
getLabel	Returnerar kontrollens etikett.
getName	Returnerar kontrollens namn.
getParent	Returnerar avsnittet som innehåller kontrollen.
getVisible	Returnerar om kontrollen är synlig.
removeOnLookupTagClick	Tar bort en händelsehanterare för klick på uppslagstaggen.
removePreSearch	Tar bort en händelsehanterare som körs före en sökning.
setDefaultView	Anger standardvyn i uppslagsdialogrutan.
setDisabled	Aktiverar eller inaktiverar kontrollen.
setEntityTypes	Anger vilka tabelltyper som tillåts i sökningen.
setFocus	Flyttar fokus till kontrollen.
setLabel	Ändrar kontrollens etikett.
setNotification	Visar ett felmeddelande som anger att data inte är giltiga.
setVisible	Visar eller döljer kontrollen.

Alternativ och valkontrolltyper

Val och valkontroller har samma uppsättning tillgängliga metoder.

Method	Description
addNotification	Visar ett meddelande om fel eller rekommendation med valfria åtgärder.
addOption	Lägger till ett alternativ i kontrollen.
clearNotification	Tar bort ett meddelande från kontrollen.
clearOptions	Tar bort alla alternativ från kontrollen.
getAttribute	Returnerar kolumnen som kontrollen är bunden till.
getControlType	Returnerar kontrollens typ.
getDisabled	Returnerar om kontrollen är inaktiverad.
getLabel	Returnerar kontrollens etikett.
getName	Returnerar kontrollens namn.
getOptions	Returnerar de tillgängliga alternativen, inklusive det tomma alternativet och exklusive borttagna alternativ.
getParent	Returnerar avsnittet som innehåller kontrollen.
getVisible	Returnerar om kontrollen är synlig.
removeOption	Tar bort ett alternativ från kontrollen.
setDisabled	Aktiverar eller inaktiverar kontrollen.
setFocus	Flyttar fokus till kontrollen.
setLabel	Ändrar kontrollens etikett.
setNotification	Visar ett felmeddelande som anger att data inte är giltiga.
setVisible	Visar eller döljer kontrollen.

Typ av snabbformulärskontroll

Mer information om metoder som stöds för den här kontrolltypen finns i formContext.ui.quickForms .

Underrutekontrolltyp

Mer information om metoder som stöds för den här kontrolltypen finns i Rutnät och underrutnät .

Tidslinjens väggkontrolltyp

Tidslinjekontrollen visar inlägg, aktiviteter och anteckningar i en enhetlig vy. Dessa metoder är tillgängliga för den här kontrolltypen.

Method	Description
getControlType	Returnerar kontrollens typ.
getDisabled	Returnerar om kontrollen är inaktiverad.
getLabel	Returnerar kontrollens etikett.
getName	Returnerar kontrollens namn.
getParent	Returnerar avsnittet som innehåller kontrollen.
getVisible	Returnerar om kontrollen är synlig.
svalka	Uppdaterar data som visas på tidslinjen.
setDisabled	Aktiverar eller inaktiverar kontrollen.
setFocus	Flyttar fokus till kontrollen.
setLabel	Ändrar kontrollens etikett.
setVisible	Visar eller döljer kontrollen.

Timerkontrolltyp

Dessa metoder är tillgängliga för timerkontrollen.

Method	Description
getControlType	Returnerar kontrollens typ.
getDisabled	Returnerar om kontrollen är inaktiverad.
getLabel	Returnerar kontrollens etikett.
getName	Returnerar kontrollens namn.
getParent	Returnerar avsnittet som innehåller kontrollen.
getState	Returnerar timerns aktuella tillstånd.
getVisible	Returnerar om kontrollen är synlig.
svalka	Uppdaterar data som visas i timern.
setDisabled	Aktiverar eller inaktiverar kontrollen.
setFocus	Flyttar fokus till kontrollen.
setLabel	Ändrar kontrollens etikett.
setVisible	Visar eller döljer kontrollen.

Typ av webbresurskontroll

En webbresurskontroll har samma uppsättning metoder som är tillgängliga som iframe-kontrollen. Se kontrolltypen iframe.

Typ av formulärkomponentkontroll

En typ av formulärkomponentkontroll har samma uppsättning metoder som är tillgängliga som formContext i ett huvudformulär. Se Klient-API för formulärkomponentbeteende>.

Relaterade artiklar

Columns