Ohjausobjektit (asiakasohjelman ohjelmointirajapintaviittaus)

Mallipohjaisissa sovelluksissa ohjausobjekti edustaa lomakkeen HTML-elementtiä. Jotkin ohjausobjektit on sidottu tiettyyn sarakkeeseen, kun taas toiset edustavat sitomattomia ohjausobjekteja, kuten IFRAME-, verkkoresurssi- tai aliruudukkoa, joka on lisätty lomakkeeseen.

Ohjausobjektiobjekti tarjoaa menetelmiä, joilla voidaan muuttaa ohjausobjektin esitystapaa tai toimintaa ja tunnistaa vastaava sarake. Käyttöoikeuksien valvonta käyttämällä jotakin seuraavista kokoelmista:

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

formContext. getControl-menetelmä on pikakuvakemenetelmä formContext.ui.controls.get-yhteyden käyttämiseen.

Note

Kun suoritat toimintoja ohjausobjekteille, jotka on sidottu sarakkeeseen, ota huomioon, että ohjausobjekti saattaa näkyä sivulla useammin kuin kerran. Yleensä samat toiminnot kannattaa suorittaa jokaiselle sarakkeen ohjausobjektille. Voit silmukoi sarakeohjausobjektien kokoelman läpi ja suorittaa toiminnot kullekin ohjausobjektille.

Ohjausobjektit luokitellaan tyypin mukaan. Määritä ohjausobjektin tyyppi getControlType-menetelmän avulla. Tietyt ohjausobjektimenetelmät ovat käytettävissä vain tietyntyyppisille ohjausobjekteille.

Tässä artikkelissa on tietoja eri ohjausobjektityypeille käytettävissä olevista menetelmistä.

Vakio-ohjausobjektin tyyppi

Nämä menetelmät ovat käytettävissä Vakio-ohjausobjektissa.

Menetelmä Kuvaus
addNotification Näyttää virhe- tai suositusilmoituksen valinnaisilla toiminnoilla.
clearNotification Poistaa ilmoituksen ohjausobjektista.
getAttribute Palauttaa sarakkeen, johon ohjausobjekti on sidottu.
getControlType Palauttaa ohjausobjektin tyypin.
getDisabled Palauttaa sen, onko ohjausobjekti poistettu käytöstä.
getLabel Palauttaa ohjausobjektin selitteen.
getName Palauttaa ohjausobjektin nimen.
getOutputs Palauttaa sanaston ohjausobjektin tulosteominaimista.
getParent Palauttaa osan, joka sisältää ohjausobjektin.
getVisible Palauttaa tiedon siitä, onko ohjausobjekti näkyvissä.
setDisabled Ottaa ohjausobjektin käyttöön tai poistaa sen käytöstä.
setFocus Siirtää kohdistuksen ohjausobjektiin.
setLabel Muuttaa ohjausobjektin otsikkoa.
setNotification Näyttää virhesanoman, joka ilmaisee, että tiedot eivät ole kelvollisia.
setVisible Näyttää tai piilottaa ohjausobjektin.

Seuraavat Vakio-ohjausobjektin menetelmät ovat vanhentuneet: addOnKeyPress, fireOnKeyPress ja removeOnKeyPress.

IFRAME-ohjausobjektin tyyppi

Nämä menetelmät ovat käytettävissä IFRAME-ohjausobjektissa.

Menetelmä Kuvaus
getContentWindow Palauttaa IFRAME- tai verkkoresurssin sisältöikkunan.
getControlType Palauttaa ohjausobjektin tyypin.
getDisabled Palauttaa sen, onko ohjausobjekti poistettu käytöstä.
getInitialUrl Palauttaa IFRAME-kehykselle määritetyn oletusarvon mukaisen URL-osoitteen.
getLabel Palauttaa ohjausobjektin selitteen.
getName Palauttaa ohjausobjektin nimen.
getObject Palauttaa lomakeobjektin, joka edustaa IFRAME-kehystä tai verkkoresurssia.
getParent Palauttaa osan, joka sisältää ohjausobjektin.
getSrc Palauttaa IFRAMEssa tai verkkoresurssissa parhaillaan näkyvän URL-osoitteen.
getVisible Palauttaa tiedon siitä, onko ohjausobjekti näkyvissä.
setDisabled Ottaa ohjausobjektin käyttöön tai poistaa sen käytöstä.
setFocus Siirtää kohdistuksen ohjausobjektiin.
setLabel Muuttaa ohjausobjektin otsikkoa.
setSrc Määrittää URL-osoitteen, joka näytetään IFRAMEssa tai verkkoresurssissa.
setVisible Näyttää tai piilottaa ohjausobjektin.

Kbsearch (tietokantahaku) -ohjausobjektin tyyppi

Nämä menetelmät ovat käytettävissä tietokantahaun ohjausobjektissa.

Menetelmä Kuvaus
addOnPostSearch Lisää tapahtumakäsittelijän, joka suoritetaan haun valmistua.
addOnResultOpened Lisää tapahtumakäsittelijän, joka suoritetaan, kun hakutulos avautuu.
addOnSelection Lisää tapahtumakäsittelijän, joka suoritetaan, kun hakutulos valitaan.
getControlType Palauttaa ohjausobjektin tyypin.
getDisabled Palauttaa sen, onko ohjausobjekti poistettu käytöstä.
getLabel Palauttaa ohjausobjektin selitteen.
getName Palauttaa ohjausobjektin nimen.
getParent Palauttaa osan, joka sisältää ohjausobjektin.
getSearchQuery Palauttaa hakuehtoina käytetyn tekstin.
getSelectedResults Palauttaa valittuna olevan hakutuloksen.
getTotalResultCount Palauttaa hakutulosten määrän.
getVisible Palauttaa tiedon siitä, onko ohjausobjekti näkyvissä.
openSearchResult Avaa määritetyn hakutuloksen.
removeOnPostSearch Poistaa tapahtumakäsittelijän haun valmistumista varten.
removeOnResultOpened Poistaa tapahtumakäsittelijän hakutuloksen avaamista varten.
removeOnSelection Poistaa tapahtumakäsittelijän hakutuloksen valitsemista varten.
setFocus Siirtää kohdistuksen ohjausobjektiin.
setLabel Muuttaa ohjausobjektin otsikkoa.
setSearchQuery Määrittää hakuehdoiksi käytetyn tekstin.
setVisible Näyttää tai piilottaa ohjausobjektin.

Note

Kun lisäät tietokantahaun ohjausobjektin yhteisöpalveluruutuun, ohjausobjektin nimi on searchwidgetcontrol_notescontrol. Et voi muuttaa tätä nimeä.

Haun ohjausobjektin tyyppi

Nämä menetelmät ovat käytettävissä hakuohjausobjektissa.

Menetelmä Kuvaus
addCustomFilter Lisää hakutuloksiin suodattimen yhdistettynä olemassa oleviin suodattimiin käyttämällä AND-funktiota.
addCustomView Lisää näkymän hakuvalintaikkunaan.
addNotification Näyttää virhe- tai suositusilmoituksen valinnaisilla toiminnoilla.
addOnLookupTagClick Lisää tapahtumakäsittelijän, joka suoritetaan, kun hakutunnistetta napsautetaan.
addPreSearch Lisää tapahtumakäsittelijän, joka suoritetaan ennen hakua.
clearNotification Poistaa ilmoituksen ohjausobjektista.
getAttribute Palauttaa sarakkeen, johon ohjausobjekti on sidottu.
getControlType Palauttaa ohjausobjektin tyypin.
getDefaultView Palauttaa oletushakunäkymän tunnuksen.
getDisabled Palauttaa sen, onko ohjausobjekti poistettu käytöstä.
getEntityTypes Palauttaa haussa sallitut taulukkotyypit.
getLabel Palauttaa ohjausobjektin selitteen.
getName Palauttaa ohjausobjektin nimen.
getParent Palauttaa osan, joka sisältää ohjausobjektin.
getVisible Palauttaa tiedon siitä, onko ohjausobjekti näkyvissä.
removeOnLookupTagClick Poistaa tapahtumakäsittelijän hakutunnisteen napsautuksia varten.
poistaPreSearch Poistaa tapahtumakäsittelijän, joka suoritetaan ennen hakua.
setDefaultView Määrittää oletusnäkymän valintaikkunassa.
setDisabled Ottaa ohjausobjektin käyttöön tai poistaa sen käytöstä.
setEntityTypes Määrittää haussa sallitut taulukkotyypit.
setFocus Siirtää kohdistuksen ohjausobjektiin.
setLabel Muuttaa ohjausobjektin otsikkoa.
setNotification Näyttää virhesanoman, joka ilmaisee, että tiedot eivät ole kelvollisia.
setVisible Näyttää tai piilottaa ohjausobjektin.

Valinnat ja valinnan hallintatyypit

Valintojen ja vaihtoehtojen ohjausobjekteilla on käytettävissään samat menetelmät.

Menetelmä Kuvaus
addNotification Näyttää virhe- tai suositusilmoituksen valinnaisilla toiminnoilla.
lisää Vaihtoehto Lisää asetuksen ohjausobjektiin.
clearNotification Poistaa ilmoituksen ohjausobjektista.
tyhjennä vaihtoehdot Poistaa ohjausobjektista kaikki asetukset.
getAttribute Palauttaa sarakkeen, johon ohjausobjekti on sidottu.
getControlType Palauttaa ohjausobjektin tyypin.
getDisabled Palauttaa sen, onko ohjausobjekti poistettu käytöstä.
getLabel Palauttaa ohjausobjektin selitteen.
getName Palauttaa ohjausobjektin nimen.
getOptions Palauttaa käytettävissä olevat vaihtoehdot, tyhjän vaihtoehdon lukuun ottamatta poistettuja asetuksia.
getParent Palauttaa osan, joka sisältää ohjausobjektin.
getVisible Palauttaa tiedon siitä, onko ohjausobjekti näkyvissä.
poista vaihtoehto Poistaa asetuksen ohjausobjektista.
setDisabled Ottaa ohjausobjektin käyttöön tai poistaa sen käytöstä.
setFocus Siirtää kohdistuksen ohjausobjektiin.
setLabel Muuttaa ohjausobjektin otsikkoa.
setNotification Näyttää virhesanoman, joka ilmaisee, että tiedot eivät ole kelvollisia.
setVisible Näyttää tai piilottaa ohjausobjektin.

Pikalomake-ohjausobjektin tyyppi

Katso formContext.ui.quickForms-kohdasta tietoja tämän ohjausobjektityypin tukemista menetelmistä.

Aliruudukon ohjausobjektin tyyppi

Katso kohdasta Ruudukot ja aliruudukot tietoja tämän ohjausobjektityypin tukemista menetelmistä.

Aikajanaseinän ohjausobjektin tyyppi

Aikajanan ohjausobjekti näyttää julkaisut, aktiviteetit ja muistiinpanot yhtenäisessä näkymässä. Nämä menetelmät ovat käytettävissä tälle ohjausobjektityypille.

Menetelmä Kuvaus
getControlType Palauttaa ohjausobjektin tyypin.
getDisabled Palauttaa sen, onko ohjausobjekti poistettu käytöstä.
getLabel Palauttaa ohjausobjektin selitteen.
getName Palauttaa ohjausobjektin nimen.
getParent Palauttaa osan, joka sisältää ohjausobjektin.
getVisible Palauttaa tiedon siitä, onko ohjausobjekti näkyvissä.
virkistää Päivittää aikajanalla näkyvät tiedot.
setDisabled Ottaa ohjausobjektin käyttöön tai poistaa sen käytöstä.
setFocus Siirtää kohdistuksen ohjausobjektiin.
setLabel Muuttaa ohjausobjektin otsikkoa.
setVisible Näyttää tai piilottaa ohjausobjektin.

Ajastimen ohjausobjektin tyyppi

Nämä menetelmät ovat käytettävissä ajastimen ohjausobjektille.

Menetelmä Kuvaus
getControlType Palauttaa ohjausobjektin tyypin.
getDisabled Palauttaa sen, onko ohjausobjekti poistettu käytöstä.
getLabel Palauttaa ohjausobjektin selitteen.
getName Palauttaa ohjausobjektin nimen.
getParent Palauttaa osan, joka sisältää ohjausobjektin.
getState Palauttaa ajastimen nykyisen tilan.
getVisible Palauttaa tiedon siitä, onko ohjausobjekti näkyvissä.
virkistää Päivittää ajastimen näyttämät tiedot.
setDisabled Ottaa ohjausobjektin käyttöön tai poistaa sen käytöstä.
setFocus Siirtää kohdistuksen ohjausobjektiin.
setLabel Muuttaa ohjausobjektin otsikkoa.
setVisible Näyttää tai piilottaa ohjausobjektin.

Verkkoresurssin hallinnan tyyppi

Verkkoresurssin ohjausobjektilla on käytettävissä samat menetelmät kuin iframe-ohjausobjektilla. Tarkista iframe-ohjausobjektin tyyppi.

Lomakekomponentin ohjausobjektityyppi

Lomakekomponentin ohjausobjektityypissä on samat menetelmät kuin päälomakkeen formContext-funktiossa . Katso Lomakekomponentin toiminta > asiakkaan ohjelmointirajapinta.

Sarakkeet