Элементы управления (справочник по клиентскому API)

В приложениях на основе модели элемент управления представляет элемент HTML в форме. Некоторые элементы управления привязаны к определенному столбцу, а другие представляют несвязанные элементы управления, такие как IFRAME, веб-ресурс или вложенный элемент управления, добавленный в форму.

Объект элемента управления предоставляет методы для изменения представления или поведения элемента управления и определения соответствующего столбца. Элементы управления доступом с помощью одной из следующих коллекций:

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

FormContext. Метод getControl — это ярлык метода для доступа к formContext.ui.controls.get.

Замечание

При выполнении действий над элементами управления, привязанными к столбцу, следует учитывать, что элемент управления может отображаться на странице несколько раз. Как правило, следует выполнять те же действия для каждого элемента управления для столбца. Вы можете выполнять циклы по коллекции элементов управления столбцами и выполнять действия для каждого элемента управления.

Элементы управления классифицируются по типу. Используйте метод getControlType для определения типа элемента управления. Некоторые методы управления доступны только для определенных типов элементов управления.

В этой статье содержатся сведения о методах, доступных для каждого типа элемента управления.

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

Эти методы доступны для стандартного элемента управления.

Method Description
addNotification Отображает уведомление об ошибке или рекомендации с необязательными действиями.
clearNotification Удаляет уведомление из элемента управления.
getAttribute Возвращает столбец, к которому привязан элемент управления.
getControlType Возвращает тип элемента управления.
getDisabled Возвращает значение, указывающее, отключен ли элемент управления.
getLabel Возвращает метку элемента управления.
getName Возвращает имя элемента управления.
getOutputs Возвращает словарь выходных свойств элемента управления.
getParent Возвращает раздел, содержащий элемент управления.
getVisible Возвращает значение, отображается ли элемент управления.
setDisabled Включает или отключает элемент управления.
setFocus Перемещает фокус на элемент управления.
setLabel Изменяет метку элемента управления.
setNotification Отображает сообщение об ошибке, указывающее, что данные недопустимы.
setVisible Показывает или скрывает элемент управления.

Следующие методы для стандартного элемента управления устарели: addOnKeyPress, fireOnKeyPress и removeOnKeyPress.

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

Эти методы доступны для элемента управления IFRAME.

Method Description
getContentWindow Возвращает окно содержимого IFRAME или веб-ресурса.
getControlType Возвращает тип элемента управления.
getDisabled Возвращает значение, указывающее, отключен ли элемент управления.
getInitialUrl Возвращает URL-адрес по умолчанию, настроенный для IFRAME.
getLabel Возвращает метку элемента управления.
getName Возвращает имя элемента управления.
getObject Возвращает объект формы, представляющий IFRAME или веб-ресурс.
getParent Возвращает раздел, содержащий элемент управления.
getSrc Возвращает URL-адрес, отображаемый в IFRAME или веб-ресурсе.
getVisible Возвращает значение, отображается ли элемент управления.
setDisabled Включает или отключает элемент управления.
setFocus Перемещает фокус на элемент управления.
setLabel Изменяет метку элемента управления.
setSrc Задает URL-адрес для отображения в IFRAME или веб-ресурсе.
setVisible Показывает или скрывает элемент управления.

Тип элемента управления Kbsearch (поиск базы знаний)

Эти методы доступны для элемента управления поиском базы знаний.

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

Замечание

При добавлении элемента управления поиска базы знаний в социальную область имя элемента управления — searchwidgetcontrol_notescontrolэто имя. Ты не можешь изменить это имя.

Тип элемента управления lookup

Эти методы доступны для элемента управления подстановкой.

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

Выбор и типы элементов управления выбором

Элементы управления выбором и выбором имеют одинаковый набор методов.

Method Description
addNotification Отображает уведомление об ошибке или рекомендации с необязательными действиями.
addOption Добавляет параметр в элемент управления.
clearNotification Удаляет уведомление из элемента управления.
clearOptions Удаляет все параметры из элемента управления.
getAttribute Возвращает столбец, к которому привязан элемент управления.
getControlType Возвращает тип элемента управления.
getDisabled Возвращает значение, указывающее, отключен ли элемент управления.
getLabel Возвращает метку элемента управления.
getName Возвращает имя элемента управления.
getOptions Возвращает доступные параметры, включая пустой параметр и исключение удаленных параметров.
getParent Возвращает раздел, содержащий элемент управления.
getVisible Возвращает значение, отображается ли элемент управления.
removeOption Удаляет параметр из элемента управления.
setDisabled Включает или отключает элемент управления.
setFocus Перемещает фокус на элемент управления.
setLabel Изменяет метку элемента управления.
setNotification Отображает сообщение об ошибке, указывающее, что данные недопустимы.
setVisible Показывает или скрывает элемент управления.

Тип элемента управления быстрой формой

Сведения о методах, поддерживаемых для этого типа элемента управления, см. в formContext.ui.quickForms .

Тип элемента управления Subgrid

Сведения о методах, поддерживаемых для этого типа элемента управления, см. в сетках и подопределениях .

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

Элемент управления временной шкалы представляет записи, действия и заметки в едином представлении. Эти методы доступны для этого типа элемента управления.

Method Description
getControlType Возвращает тип элемента управления.
getDisabled Возвращает значение, указывающее, отключен ли элемент управления.
getLabel Возвращает метку элемента управления.
getName Возвращает имя элемента управления.
getParent Возвращает раздел, содержащий элемент управления.
getVisible Возвращает значение, отображается ли элемент управления.
освежать Обновляет данные, отображаемые на временной шкале.
setDisabled Включает или отключает элемент управления.
setFocus Перемещает фокус на элемент управления.
setLabel Изменяет метку элемента управления.
setVisible Показывает или скрывает элемент управления.

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

Эти методы доступны для элемента управления таймером.

Method Description
getControlType Возвращает тип элемента управления.
getDisabled Возвращает значение, указывающее, отключен ли элемент управления.
getLabel Возвращает метку элемента управления.
getName Возвращает имя элемента управления.
getParent Возвращает раздел, содержащий элемент управления.
getState Возвращает текущее состояние таймера.
getVisible Возвращает значение, отображается ли элемент управления.
освежать Обновляет данные, отображаемые в таймере.
setDisabled Включает или отключает элемент управления.
setFocus Перемещает фокус на элемент управления.
setLabel Изменяет метку элемента управления.
setVisible Показывает или скрывает элемент управления.

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

Элемент управления веб-ресурсами имеет тот же набор методов, что и элемент управления iframe. См. тип элемента управления iframe.

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

Тип элемента управления компонентом формы имеет тот же набор методов, что и formContext в основной форме. См. api клиента клиентского интерфейса компонента > формы.

Columns