Kontrolki (dokumentacja interfejsu API klienta)

W aplikacjach opartych na modelu kontrolka reprezentuje element HTML w formularzu. Niektóre kontrolki są powiązane z określoną kolumną, a inne reprezentują niezwiązane kontrolki, takie jak element IFRAME, zasób internetowy lub podsieć dodane do formularza.

Obiekt kontrolny udostępnia metody zmiany prezentacji lub zachowania kontrolki i identyfikowania odpowiedniej kolumny. Kontrola dostępu przy użyciu jednej z następujących kolekcji:

• formContext.ui.controls
• formContext.ui Section.controls
• formContext.data.entity Attribute.controls

FormContext. metoda getControl to metoda skrótu umożliwiająca dostęp do pliku formContext.ui.controls.get.

Uwaga / Notatka

Podczas wykonywania akcji dotyczących kontrolek powiązanych z kolumną należy wziąć pod uwagę, że kontrolka może pojawić się na stronie więcej niż raz. Ogólnie rzecz biorąc, należy wykonać te same akcje dla każdej kontrolki dla kolumny. Możesz przeprowadzić pętlę przez kolekcję kontrolek kolumn i wykonać akcje dla każdej kontrolki.

Kontrolki są klasyfikowane według typu. Użyj metody getControlType , aby określić typ kontrolki. Niektóre metody sterowania są dostępne tylko dla określonych typów kontrolek.

Ten artykuł zawiera informacje o metodach dostępnych dla każdego typu kontrolki.

Standardowy typ kontrolki

Te metody są dostępne dla kontrolki w warstwie Standardowa.

Method	Description
addNotification	Wyświetla powiadomienie o błędzie lub rekomendacji z opcjonalnymi akcjami.
clearNotification	Usuwa powiadomienie z kontrolki.
getAttribute	Zwraca kolumnę, z którą jest powiązana kontrolka.
getControlType	Zwraca typ kontrolki.
getDisabled	Zwraca informację, czy kontrolka jest wyłączona.
getLabel	Zwraca etykietę kontrolki.
getName	Zwraca nazwę kontrolki.
getOutputs	Zwraca słownik właściwości wyjściowych kontrolki.
getParent	Zwraca sekcję zawierającą kontrolkę.
getVisible	Zwraca, czy kontrolka jest widoczna.
setDisabled	Włącza lub wyłącza kontrolkę.
setFocus	Przenosi fokus do kontrolki.
setLabel	Zmienia etykietę kontrolki.
setNotification	Wyświetla komunikat o błędzie wskazujący, że dane są nieprawidłowe.
setVisible	Wyświetla lub ukrywa kontrolkę.

Następujące metody dla kontrolki Standard są przestarzałe: addOnKeyPress, fireOnKeyPress i removeOnKeyPress.

Typ kontrolki IFRAME

Te metody są dostępne dla kontrolki IFRAME.

Method	Description
getContentWindow	Zwraca okno zawartości elementu IFRAME lub zasobu internetowego.
getControlType	Zwraca typ kontrolki.
getDisabled	Zwraca informację, czy kontrolka jest wyłączona.
getInitialUrl	Zwraca domyślny adres URL skonfigurowany dla elementu IFRAME.
getLabel	Zwraca etykietę kontrolki.
getName	Zwraca nazwę kontrolki.
getObject	Zwraca obiekt formularza reprezentujący element IFRAME lub zasób internetowy.
getParent	Zwraca sekcję zawierającą kontrolkę.
getSrc	Zwraca adres URL wyświetlany obecnie w elemecie IFRAME lub zasobie internetowym.
getVisible	Zwraca, czy kontrolka jest widoczna.
setDisabled	Włącza lub wyłącza kontrolkę.
setFocus	Przenosi fokus do kontrolki.
setLabel	Zmienia etykietę kontrolki.
setSrc	Ustawia adres URL wyświetlany w elemecie IFRAME lub zasobie internetowym.
setVisible	Wyświetla lub ukrywa kontrolkę.

Typ kontrolki Kbsearch (wyszukiwanie bazy wiedzy)

Te metody są dostępne dla kontrolki wyszukiwania bazy wiedzy.

Method	Description
addOnPostSearch	Dodaje procedurę obsługi zdarzeń uruchamianą po zakończeniu wyszukiwania.
addOnResultOpened	Dodaje procedurę obsługi zdarzeń uruchamianą po otwarciu wyniku wyszukiwania.
addOnSelection	Dodaje procedurę obsługi zdarzeń uruchamianą po wybraniu wyniku wyszukiwania.
getControlType	Zwraca typ kontrolki.
getDisabled	Zwraca informację, czy kontrolka jest wyłączona.
getLabel	Zwraca etykietę kontrolki.
getName	Zwraca nazwę kontrolki.
getParent	Zwraca sekcję zawierającą kontrolkę.
getSearchQuery	Zwraca tekst używany jako kryteria wyszukiwania.
getSelectedResults	Zwraca aktualnie wybrany wynik wyszukiwania.
getTotalResultCount	Zwraca liczbę wyników wyszukiwania.
getVisible	Zwraca, czy kontrolka jest widoczna.
openSearchResult	Otwiera określony wynik wyszukiwania.
removeOnPostSearch	Usuwa procedurę obsługi zdarzeń na potrzeby uzupełniania wyszukiwania.
removeOnResultOpened	Usuwa program obsługi zdarzeń do otwierania wyniku wyszukiwania.
removeOnSelection	Usuwa procedurę obsługi zdarzeń w celu wybrania wyniku wyszukiwania.
setFocus	Przenosi fokus do kontrolki.
setLabel	Zmienia etykietę kontrolki.
setSearchQuery	Ustawia tekst używany jako kryteria wyszukiwania.
setVisible	Wyświetla lub ukrywa kontrolkę.

Uwaga / Notatka

Po dodaniu kontrolki wyszukiwania bazy wiedzy do okienka społecznościowego nazwa kontrolki to searchwidgetcontrol_notescontrol. Nie możesz zmienić tego imienia.

Typ kontrolki odnośnika

Te metody są dostępne dla kontrolki odnośników.

Method	Description
addCustomFilter	Dodaje filtr do wyników wyszukiwania w połączeniu z istniejącymi filtrami przy użyciu funkcji AND.
addCustomView	Dodaje widok do okna dialogowego wyszukiwania.
addNotification	Wyświetla powiadomienie o błędzie lub rekomendacji z opcjonalnymi akcjami.
addOnLookupTagClick	Dodaje procedurę obsługi zdarzeń uruchamianą po kliknięciu tagu wyszukiwania.
addPreSearch	Dodaje procedurę obsługi zdarzeń uruchamianą przed wyszukiwaniem odnośników.
clearNotification	Usuwa powiadomienie z kontrolki.
getAttribute	Zwraca kolumnę, z którą jest powiązana kontrolka.
getControlType	Zwraca typ kontrolki.
getDefaultView	Zwraca identyfikator domyślnego widoku odnośnika.
getDisabled	Zwraca informację, czy kontrolka jest wyłączona.
getEntityTypes	Zwraca typy tabel dozwolone w odnośniku.
getLabel	Zwraca etykietę kontrolki.
getName	Zwraca nazwę kontrolki.
getParent	Zwraca sekcję zawierającą kontrolkę.
getVisible	Zwraca, czy kontrolka jest widoczna.
removeOnLookupTagClick	Usuwa procedurę obsługi zdarzeń dla kliknięć tagów wyszukiwania.
removePreSearch	Usuwa procedurę obsługi zdarzeń uruchamianą przed wyszukiwaniem wyszukiwania.
setDefaultView	Ustawia widok domyślny w oknie dialogowym wyszukiwania.
setDisabled	Włącza lub wyłącza kontrolkę.
setEntityTypes	Ustawia typy tabel dozwolone w odnośniku.
setFocus	Przenosi fokus do kontrolki.
setLabel	Zmienia etykietę kontrolki.
setNotification	Wyświetla komunikat o błędzie wskazujący, że dane są nieprawidłowe.
setVisible	Wyświetla lub ukrywa kontrolkę.

Opcje i typy kontrolek wyboru

Kontrolki wyboru i wyboru mają ten sam zestaw dostępnych metod.

Method	Description
addNotification	Wyświetla powiadomienie o błędzie lub rekomendacji z opcjonalnymi akcjami.
addOption	Dodaje opcję do kontrolki.
clearNotification	Usuwa powiadomienie z kontrolki.
clearOptions	Usuwa wszystkie opcje z kontrolki.
getAttribute	Zwraca kolumnę, z którą jest powiązana kontrolka.
getControlType	Zwraca typ kontrolki.
getDisabled	Zwraca informację, czy kontrolka jest wyłączona.
getLabel	Zwraca etykietę kontrolki.
getName	Zwraca nazwę kontrolki.
getOptions	Zwraca dostępne opcje, w tym pustą opcję i z wyłączeniem usuniętych opcji.
getParent	Zwraca sekcję zawierającą kontrolkę.
getVisible	Zwraca, czy kontrolka jest widoczna.
removeOption	Usuwa opcję z kontrolki.
setDisabled	Włącza lub wyłącza kontrolkę.
setFocus	Przenosi fokus do kontrolki.
setLabel	Zmienia etykietę kontrolki.
setNotification	Wyświetla komunikat o błędzie wskazujący, że dane są nieprawidłowe.
setVisible	Wyświetla lub ukrywa kontrolkę.

Szybki typ kontrolki formularza

Aby uzyskać informacje o metodach obsługiwanych dla tego typu formantu, zobacz formContext.ui.quickForms .

Typ kontrolki podsieci

Zobacz Siatki i podsieci, aby uzyskać informacje o metodach obsługiwanych dla tego typu kontrolki.

Typ sterowania ścianą osi czasu

Kontrolka osi czasu przedstawia wpisy, działania i notatki w ujednoliconym widoku. Te metody są dostępne dla tego typu kontrolki.

Method	Description
getControlType	Zwraca typ kontrolki.
getDisabled	Zwraca informację, czy kontrolka jest wyłączona.
getLabel	Zwraca etykietę kontrolki.
getName	Zwraca nazwę kontrolki.
getParent	Zwraca sekcję zawierającą kontrolkę.
getVisible	Zwraca, czy kontrolka jest widoczna.
odświeżyć	Odświeża dane wyświetlane na osi czasu.
setDisabled	Włącza lub wyłącza kontrolkę.
setFocus	Przenosi fokus do kontrolki.
setLabel	Zmienia etykietę kontrolki.
setVisible	Wyświetla lub ukrywa kontrolkę.

Typ kontrolki czasomierza

Te metody są dostępne dla kontrolki czasomierza.

Method	Description
getControlType	Zwraca typ kontrolki.
getDisabled	Zwraca informację, czy kontrolka jest wyłączona.
getLabel	Zwraca etykietę kontrolki.
getName	Zwraca nazwę kontrolki.
getParent	Zwraca sekcję zawierającą kontrolkę.
getState	Zwraca bieżący stan czasomierza.
getVisible	Zwraca, czy kontrolka jest widoczna.
odświeżyć	Odświeża dane wyświetlane w czasomierzu.
setDisabled	Włącza lub wyłącza kontrolkę.
setFocus	Przenosi fokus do kontrolki.
setLabel	Zmienia etykietę kontrolki.
setVisible	Wyświetla lub ukrywa kontrolkę.

Typ kontroli zasobów internetowych

Kontrolka zasobów internetowych ma ten sam zestaw metod, które są dostępne jako kontrolka elementu iframe. Zobacz typ kontrolki iframe.

Typ kontrolki składnika formularza

Typ kontrolki składnika formularza ma ten sam zestaw metod, które są dostępne jako formContext w formularzu głównym. Zobacz Zachowanie > składnika formularza Interfejs API klienta.

Powiązane artykuły

Columns