Елементи керування (довідник із інтерфейсу API клієнта)

У програмах на основі моделі елемент керування представляє елемент HTML у формі. Деякі елементи керування зв'язані з певним стовпцем, а інші – незв'язаними елементами керування, наприклад IFRAME, веб-ресурсом або вкладеною сіткою, доданими до форми.

Об'єкт керування надає способи змінення презентації або поведінки елемента керування та визначення відповідного стовпця. Access controls by using one of the following collections:

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

ФормаКонтекст. метод getControl – це ярлик для доступу до formContext.ui.controls.get.

Нотатка

Коли ви виконуєте дії з елементами керування, прив'язаними до стовпця, слід пам'ятайте, що елемент керування може відображатися на сторінці кілька разів. Зазвичай для кожного елемента керування стовпця слід виконувати однакові дії. Ви можете циклічного перегляду колекції елементів керування стовпцями та виконувати дії з кожним елементом керування.

Елементи керування класифікуються за типом. Щоб визначити тип елемента керування, скористайтеся методом getControlType . Певні методи керування доступні лише для певних типів елементів керування.

У цій статті наведено відомості про методи, доступні для кожного типу елемента керування.

Стандартний тип елемента керування

Ці методи доступні для стандартного елемента керування.

Метод Опис
додавання приміток Відображає сповіщення про помилку або рекомендацію з необов'язковими діями.
очистити примітку Видалення сповіщення з елемента керування.
getAttribute Повертає стовпець, до який прив'язано елемент керування.
getControlType Повертає тип елемента керування.
getDisabled Повертає, чи вимкнено елемент керування.
getLabel Повертає підпис елемента керування.
getName Повертає ім'я елемента керування.
getOutputs Повертає словник властивостей виводу елемента керування.
отриматипарент Повертає розділ, який містить елемент керування.
getVisible Повертає, чи відображається елемент керування.
setDisabled Вмикає або вимикає елемент керування.
setFocus Переміщує фокус до елемента керування.
setLabel Змінює підпис елемента керування.
setNotification Відображає повідомлення про помилку, яке вказує на неприпустимість даних.
setVisible Відображення або приховування елементу керування.

Вилучено такі методи для стандартного елемента керування:addOnKeyPress, fireOnKeyPress і removeOnKeyPress.

Тип елемента керування IFRAME

Ці методи доступні для елемента керування IFRAME.

Метод Опис
getContentWindow Повертає вікно вмісту веб-ресурсу IFRAME або IFRAME.
getControlType Повертає тип елемента керування.
getDisabled Повертає, чи вимкнено елемент керування.
getInitialUrl Повертає URL-адресу за промовчанням, налаштовану для IFRAME.
getLabel Повертає підпис елемента керування.
getName Повертає ім'я елемента керування.
getObject Повертає об'єкт форми, який представляє об'єкт IFRAME або веб-ресурс.
отриматипарент Повертає розділ, який містить елемент керування.
getSrc Повертає URL-адресу, яка зараз відображається в IFRAME або веб-ресурсі.
getVisible Повертає, чи відображається елемент керування.
setDisabled Вмикає або вимикає елемент керування.
setFocus Переміщує фокус до елемента керування.
setLabel Змінює підпис елемента керування.
setSrc Задає URL-адресу для відображення в IFRAME або веб-ресурсі.
setVisible Відображення або приховування елементу керування.

Тип елемента керування Kbsearch (пошук бази знань)

Ці методи доступні для елемента керування пошуком бази знань.

Метод Опис
addOnPostSearch Додає обробник подій, який запускається після завершення пошуку.
addOnResultOpened Додає обробник подій, який запускається в разі відкриття результату пошуку.
addOnSelection Додає обробник подій, який запускається, коли вибрано результат пошуку.
getControlType Повертає тип елемента керування.
getDisabled Повертає, чи вимкнено елемент керування.
getLabel Повертає підпис елемента керування.
getName Повертає ім'я елемента керування.
отриматипарент Повертає розділ, який містить елемент керування.
getSearchQuery Повертає текст, який використовується як умова пошуку.
getSelectedResults Повертає вибраний результат пошуку.
getTotalResultCount Повертає кількість результатів пошуку.
getVisible Повертає, чи відображається елемент керування.
openSearchResult Відкриття вказаного результату пошуку.
removeOnPostSearch Видалення обробника подій для завершення пошуку.
removeOnResultOpened Видалення обробника подій для відкриття результату пошуку.
removeOnSelection Видалення обробника подій для вибору результату пошуку.
setFocus Переміщує фокус до елемента керування.
setLabel Змінює підпис елемента керування.
setSearchQuery Визначає текст, який використовується як умова пошуку.
setVisible Відображення або приховування елементу керування.

Нотатка

Коли ви додаєте елемент керування пошуком бази знань до області соціальних мереж, ім'я елемента керування – .searchwidgetcontrol_notescontrol Це ім'я змінити не можна.

Тип елемента керування підстановки

Ці методи доступні для елемента керування підстановкою.

Метод Опис
addCustomFilter Додає фільтр до результатів підстановки в поєднанні з наявними фільтрами за допомогою функції AND.
addCustomView Додає подання до діалогового вікна підстановки.
додавання приміток Відображає сповіщення про помилку або рекомендацію з необов'язковими діями.
addOnLookupTagClick Додає обробник подій, який запускається, якщо клацнути тег підстановки.
addPreSearch Додає обробник подій, який запускається перед пошуком підстановки.
очистити примітку Видалення сповіщення з елемента керування.
getAttribute Повертає стовпець, до який прив'язано елемент керування.
getControlType Повертає тип елемента керування.
getDefaultView Повертає ідентифікатор подання підстановки за промовчанням.
getDisabled Повертає, чи вимкнено елемент керування.
getEntityTypes Повертає типи таблиць, дозволені в підстановці.
getLabel Повертає підпис елемента керування.
getName Повертає ім'я елемента керування.
отриматипарент Повертає розділ, який містить елемент керування.
getVisible Повертає, чи відображається елемент керування.
removeOnLookupTagClick Видалення обробника подій для клацань тегів підстановки.
removePreSearch Видалення обробника подій, який запускається перед пошуком підстановки.
setDefaultView Установлення стандартного подання в діалоговому вікні підстановки.
setDisabled Вмикає або вимикає елемент керування.
setEntityTypes Установлює типи таблиць, дозволені під час підстановки.
setFocus Переміщує фокус до елемента керування.
setLabel Змінює підпис елемента керування.
setNotification Відображає повідомлення про помилку, яке вказує на неприпустимість даних.
setVisible Відображення або приховування елементу керування.

Типи елементів керування "Вибір" і "Вибір"

Варіанти та елементи керування вибором мають однаковий набір доступних методів.

Метод Опис
додавання приміток Відображає сповіщення про помилку або рекомендацію з необов'язковими діями.
addOption Додає параметр до елемента керування.
очистити примітку Видалення сповіщення з елемента керування.
clearOptions Видалення всіх параметрів елемента керування.
getAttribute Повертає стовпець, до який прив'язано елемент керування.
getControlType Повертає тип елемента керування.
getDisabled Повертає, чи вимкнено елемент керування.
getLabel Повертає підпис елемента керування.
getName Повертає ім'я елемента керування.
getOptions Повертає доступні параметри, включно з пустим параметром і виключенням видалених параметрів.
отриматипарент Повертає розділ, який містить елемент керування.
getVisible Повертає, чи відображається елемент керування.
removeOption Видалення параметра з елемента керування.
setDisabled Вмикає або вимикає елемент керування.
setFocus Переміщує фокус до елемента керування.
setLabel Змінює підпис елемента керування.
setNotification Відображає повідомлення про помилку, яке вказує на неприпустимість даних.
setVisible Відображення або приховування елементу керування.

Тип елемента керування "Експрес-форма"

Відомості про методи, які підтримуються для цього типу елемента керування, див. в статті formContext.ui.quickForms .

Тип елемента керування вкладеної сітки

Відомості про методи, які підтримуються для цього типу елемента керування, див. в статті Сітки та вкладені сітки .

Тип керування стіною часової шкали

Елемент керування часовою шкалою відображає дописи, дії та нотатки в єдиному поданні. Ці методи доступні для цього типу елемента керування.

Метод Опис
getControlType Повертає тип елемента керування.
getDisabled Повертає, чи вимкнено елемент керування.
getLabel Повертає підпис елемента керування.
getName Повертає ім'я елемента керування.
отриматипарент Повертає розділ, який містить елемент керування.
getVisible Повертає, чи відображається елемент керування.
Оновити Оновлює дані, які відображаються на часовій шкалі.
setDisabled Вмикає або вимикає елемент керування.
setFocus Переміщує фокус до елемента керування.
setLabel Змінює підпис елемента керування.
setVisible Відображення або приховування елементу керування.

Тип елемента керування таймером

Ці методи доступні для елемента керування таймером.

Метод Опис
getControlType Повертає тип елемента керування.
getDisabled Повертає, чи вимкнено елемент керування.
getLabel Повертає підпис елемента керування.
getName Повертає ім'я елемента керування.
отриматипарент Повертає розділ, який містить елемент керування.
отримати стан Повертає поточний стан таймера.
getVisible Повертає, чи відображається елемент керування.
Оновити Оновлює дані, які відображаються в таймері.
setDisabled Вмикає або вимикає елемент керування.
setFocus Переміщує фокус до елемента керування.
setLabel Змінює підпис елемента керування.
setVisible Відображення або приховування елементу керування.

Тип елемента керування веб-ресурсами

Елемент керування веб-ресурсами має такий самий набір методів, що й елемент керування iframe. Див. тип елемента керування iframe.

Тип елемента керування компонентом форми

Тип елемента керування компонентом форми має такий самий набір методів, що й формаContext у головній формі. Див . статтю API клієнта поведінки компонента > форми.

Стовпці