formContext.getControl (посилання на API клієнта)

Отримує елемент керування у формі.

Нотатка

getControl працює лише з елементами керування в основному тексті та верхньому колонтитулі форми. Він не підтримується для елементів керування в іншому місці на сторінці, навіть якщо вони посилаються на той самий стовпець.

• Елементи керування в потоках бізнес-процесів див. в них за допомогою префікса header_process_.
• Елементи керування в інших елементах керування, наприклад вкладених сітках і елементах керування часової шкали , не підтримуються.

Синтаксис

formContext.getControl(arg);

Метод formContext.getControl(arg) – це ярлик для доступу до formContext.ui.controls.get.

Параметр

arg: Необов'язковий аргумент. Ви можете отримати доступ до елемента керування у формі, передавши аргумент як ім'я або значення індексу елемента керування у формі. Наприклад: formContext.getControl("firstname") або formContext.getControl(0). Якщо ім'я arg написано неправильно та відсутнє у формі, воно повертає null-значення.

arg Якщо значення не вказано, воно повертає масив усіх елементів керування у формі.

Повернуте значення

Тип: колекція об'єктів, об'єкт або null-значення.

Опис. Колекція об'єктів, якщо ви використовуєте метод без будь-яких параметрів. Об'єкт або null, якщо використовується метод із параметром. Якщо ім'я використовується як параметр і є кілька елементів керування для одного стовпця, повертається лише перший елемент керування.

Чайові

Якщо потрібно змінити всі елементи керування, прив'язані до стовпця у формі, скористайтеся колекцією елементів керування всередині типу стовпця. Наприклад, щоб додати сповіщення до кожного елемента керування, прив'язаного name до стовпця, виконайте такі дії:

 const notification = {
 messages: ['Sample Notification on Name Controls'],
 notificationLevel: 'RECOMMENDATION',
 uniqueId: 'my_unique_id'};
formContext.getAttribute("name").controls.forEach(control => control.addNotification(notification));

Пов’язані статті

formContext