Kontroller (klient-API-referanse)

I modelldrevne apper representerer en kontroll et HTML-element i skjemaet. Noen kontroller er bundet til en bestemt kolonne, mens andre representerer ubundne kontroller som IFRAME, nettressurs eller delnett lagt til i skjemaet.

Kontrollobjektet inneholder metoder for å endre presentasjonen eller virkemåten til en kontroll og identifisere den tilsvarende kolonnen. Tilgangskontroller ved hjelp av én av følgende samlinger:

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

FormContext. getControl-metoden er en snarveismetode for å få tilgang til formContext.ui.controls.get.

Note

Når du utfører handlinger på kontroller som er knyttet til en kolonne, bør du vurdere at kontrollen kan vises på siden mer enn én gang. Vanligvis bør du utføre de samme handlingene for hver kontroll for kolonnen. Du kan gå gjennom kolonnekontrollsamlingen og utføre handlingene på hver kontroll.

Kontroller kategoriseres etter type. Bruk getControlType-metoden til å bestemme typen kontroll. Enkelte kontrollmetoder er bare tilgjengelige for bestemte typer kontroller.

Denne artikkelen inneholder informasjon om metodene som er tilgjengelige for hver kontrolltype.

Standard kontrolltype

Disse metodene er tilgjengelige for en standardkontroll.

Metode Description
addNotification Viser en feil- eller anbefalingsvarsling med valgfrie handlinger.
clearNotification Fjerner et varsel fra kontrollen.
getAttribute Returnerer kolonnen som kontrollen er bundet til.
getControlType Returnerer kontrolltypen.
getDisabled Returnerer om kontrollen er deaktivert.
getLabel Returnerer kontrollens etikett.
getName Returnerer kontrollens navn.
getOutputs Returnerer en ordliste over kontrollens utdataegenskaper.
getParent Returnerer inndelingen som inneholder kontrollen.
getVisible Returnerer om kontrollen er synlig.
setDisabled Aktiverer eller deaktiverer kontrollen.
setFocus Flytter fokus til kontrollen.
setLabel Endrer kontrollens etikett.
setNotification Viser en feilmelding som angir at dataene ikke er gyldige.
setVisible Viser eller skjuler kontrollen.

Følgende metoder for Standard-kontrollen avskrives: addOnKeyPress, fireOnKeyPress og removeOnKeyPress.

IFRAME-kontrolltype

Disse metodene er tilgjengelige for en IFRAME-kontroll.

Metode Description
getContentWindow Returnerer innholdsvinduet for IFRAME eller nettressursen.
getControlType Returnerer kontrolltypen.
getDisabled Returnerer om kontrollen er deaktivert.
getInitialUrl Returnerer standard URL-adresse som er konfigurert for IFRAME.
getLabel Returnerer kontrollens etikett.
getName Returnerer kontrollens navn.
getObject Returnerer skjemaobjektet som representerer IFRAME eller nettressursen.
getParent Returnerer inndelingen som inneholder kontrollen.
getSrc Returnerer nettadressen som for øyeblikket vises i IFRAME eller nettressursen.
getVisible Returnerer om kontrollen er synlig.
setDisabled Aktiverer eller deaktiverer kontrollen.
setFocus Flytter fokus til kontrollen.
setLabel Endrer kontrollens etikett.
setSrc Angir nettadressen som skal vises i IFRAME eller nettressursen.
setVisible Viser eller skjuler kontrollen.

Kontrolltype for Kbsearch -kontroll (kunnskapsbasesøk)

Disse metodene er tilgjengelige for søkekontrollen for kunnskapsbasen.

Metode Description
addOnPostSearch Legger til en hendelsesbehandling som kjøres etter at et søk er fullført.
addOnResultOpened Legger til en hendelsesbehandling som kjøres når et søkeresultat åpnes.
addOnSelection Legger til en hendelsesbehandling som kjøres når et søkeresultat er valgt.
getControlType Returnerer kontrolltypen.
getDisabled Returnerer om kontrollen er deaktivert.
getLabel Returnerer kontrollens etikett.
getName Returnerer kontrollens navn.
getParent Returnerer inndelingen som inneholder kontrollen.
getSearchQuery Returnerer teksten som brukes som søkevilkår.
getSelectedResults Returnerer det valgte søkeresultatet.
getTotalResultCount Returnerer antall søkeresultater.
getVisible Returnerer om kontrollen er synlig.
openSearchResult Åpner et angitt søkeresultat.
removeOnPostSearch Fjerner en hendelsesbehandling for fullføring av søk.
removeOnResultOpened Fjerner en hendelsesbehandling for åpning av et søkeresultat.
removeOnSelection Fjerner en hendelsesbehandling for å velge et søkeresultat.
setFocus Flytter fokus til kontrollen.
setLabel Endrer kontrollens etikett.
setSearchQuery Angir teksten som brukes som søkevilkår.
setVisible Viser eller skjuler kontrollen.

Note

Når du legger til søkekontrollen for kunnskapsbasen i den sosiale ruten, er searchwidgetcontrol_notescontrolkontrollnavnet . Du kan ikke endre dette navnet.

Kontrolltype for oppslag

Disse metodene er tilgjengelige for en oppslagskontroll.

Metode Description
addCustomFilter Legger til et filter i oppslagsresultatene, kombinert med eksisterende filtre ved hjelp av AND.
addCustomView Legger til en visning i oppslagsdialogboksen.
addNotification Viser en feil- eller anbefalingsvarsling med valgfrie handlinger.
addOnLookupTagClick Legger til en hendelsesbehandling som kjøres når et oppslagsmerke klikkes.
addPreSearch Legger til en hendelsesbehandling som kjører før et oppslagssøk.
clearNotification Fjerner et varsel fra kontrollen.
getAttribute Returnerer kolonnen som kontrollen er bundet til.
getControlType Returnerer kontrolltypen.
getDefaultView Returnerer ID-en for standard oppslagsvisning.
getDisabled Returnerer om kontrollen er deaktivert.
getEntityTypes Returnerer tabelltypene som er tillatt i oppslaget.
getLabel Returnerer kontrollens etikett.
getName Returnerer kontrollens navn.
getParent Returnerer inndelingen som inneholder kontrollen.
getVisible Returnerer om kontrollen er synlig.
removeOnLookupTagClick Fjerner en hendelsesbehandling for oppslagskodeklikk.
removePreSearch Fjerner en hendelsesbehandling som kjører før et oppslagssøk.
setDefaultView Angir standardvisningen i oppslagsdialogboksen.
setDisabled Aktiverer eller deaktiverer kontrollen.
setEntityTypes Angir tabelltypene som er tillatt i oppslaget.
setFocus Flytter fokus til kontrollen.
setLabel Endrer kontrollens etikett.
setNotification Viser en feilmelding som angir at dataene ikke er gyldige.
setVisible Viser eller skjuler kontrollen.

Valg- og valgkontrolltyper

Valg- og valgkontroller har samme sett med tilgjengelige metoder.

Metode Description
addNotification Viser en feil- eller anbefalingsvarsling med valgfrie handlinger.
addOption Legger til et alternativ i kontrollen.
clearNotification Fjerner et varsel fra kontrollen.
clearOptions Fjerner alle alternativer fra kontrollen.
getAttribute Returnerer kolonnen som kontrollen er bundet til.
getControlType Returnerer kontrolltypen.
getDisabled Returnerer om kontrollen er deaktivert.
getLabel Returnerer kontrollens etikett.
getName Returnerer kontrollens navn.
getOptions Returnerer de tilgjengelige alternativene, inkludert det tomme alternativet og utelater fjernede alternativer.
getParent Returnerer inndelingen som inneholder kontrollen.
getVisible Returnerer om kontrollen er synlig.
removeOption Fjerner et alternativ fra kontrollen.
setDisabled Aktiverer eller deaktiverer kontrollen.
setFocus Flytter fokus til kontrollen.
setLabel Endrer kontrollens etikett.
setNotification Viser en feilmelding som angir at dataene ikke er gyldige.
setVisible Viser eller skjuler kontrollen.

Kontrolltype for hurtigskjema

Se formContext.ui.quickForms for informasjon om metoder som støttes for denne kontrolltypen.

Kontrolltype for delnett

Se Rutenett og delnett for informasjon om metoder som støttes for denne kontrolltypen.

Kontrolltype for tidslinjevegg

Tidslinjekontrollen presenterer innlegg, aktiviteter og notater i en enhetlig visning. Disse metodene er tilgjengelige for denne kontrolltypen.

Metode Description
getControlType Returnerer kontrolltypen.
getDisabled Returnerer om kontrollen er deaktivert.
getLabel Returnerer kontrollens etikett.
getName Returnerer kontrollens navn.
getParent Returnerer inndelingen som inneholder kontrollen.
getVisible Returnerer om kontrollen er synlig.
forfriske Oppdaterer dataene som vises på tidslinjen.
setDisabled Aktiverer eller deaktiverer kontrollen.
setFocus Flytter fokus til kontrollen.
setLabel Endrer kontrollens etikett.
setVisible Viser eller skjuler kontrollen.

Tidtakerkontrolltype

Disse metodene er tilgjengelige for tidtakerkontrollen.

Metode Description
getControlType Returnerer kontrolltypen.
getDisabled Returnerer om kontrollen er deaktivert.
getLabel Returnerer kontrollens etikett.
getName Returnerer kontrollens navn.
getParent Returnerer inndelingen som inneholder kontrollen.
getState Returnerer gjeldende status for tidtakeren.
getVisible Returnerer om kontrollen er synlig.
forfriske Oppdaterer dataene som vises i tidtakeren.
setDisabled Aktiverer eller deaktiverer kontrollen.
setFocus Flytter fokus til kontrollen.
setLabel Endrer kontrollens etikett.
setVisible Viser eller skjuler kontrollen.

Kontrolltype for nettressurs

En nettressurskontroll har samme sett med metoder som er tilgjengelige som iframe-kontrollen. Se iframe-kontrolltypen.

Kontrolltype for skjemakomponent

En skjemakomponentkontrolltype har samme sett med metoder som er tilgjengelige som formContext i et hovedskjema. Se klient-API for skjemakomponentvirkemåte>.

Kolonner