api.commentSettings Управление настройками комментариев
Методы вносят изменения в метаинформацию, при использовании методов необходимо включать блокировку входа на время технических работ
-
api.commentSettings.isHighlightPrivateCommentInList()
Получение признака выделения цветным фоном приватных комментариев в списке.
Возвращает true — приватные комментарии выделяются, иначе false.
-
api.commentSettings.isHighlightPrivateCommentOnForm()
Получение признака выделения цветным фоном поля "Текст" приватных комментариев на форме.
Возвращает true — поле выделяется цветным фоном, иначе false.
-
api.commentSettings.getPrivateCommentColor()
Получение объекта цвета для выделения приватных комментариев.
Возвращает объект цвета.
-
api.commentSettings.setPrivateCommentHighlightingInList(highlightPrivateCommentInList)
Установка признака необходимости выделения приватных комментариев в списке.
Параметр метода:
-
highlightPrivateCommentInList. Boolean.
- true — приватные комментарии выделяются цветным фоном;
- false — не выделяются.
-
-
api.commentSettings.setPrivateCommentHighlightingOnForm(highlightPrivateCommentOnForm)
Установка признака необходимости выделения приватных комментариев на форме.
Параметр метода:
-
highlightPrivateCommentOnForm. Boolean.
- true — приватные комментарии выделяются цветным фоном;
- false — не выделяются.
-
-
api.commentSettings.setPrivateCommentColor(privateCommentColor)
Установка цвета для выделения приватных комментариев.
Параметр метода:
- privateCommentColor — объект цвета.
Создание объекта цвета, см. Работа с цветом.
Пример 1. Получение настроенных значений:
// нужно ли выделять цветным фоном приватные комментарии в списке boolean highlightPrivateCommentInList = api.commentSettings.isHighlightPrivateCommentInList() // нужно ли выделять цветным фоном поле Текст для приватных комментариев на форме boolean highlightPrivateCommentOnForm = api.commentSettings.isHighlightPrivateCommentOnForm() // получить цвет для выделения приватных комментариев String privateCommentColor = api.commentSettings.getPrivateCommentColor()?.string;
Пример 2. Изменение настроек:
// установить признак необходимости выделения приватных комментариев в списке
api.commentSettings.setPrivateCommentHighlightingInList(true)
// установить признак необходимости выделения приватных комментариев на форме
api.commentSettings.setPrivateCommentHighlightingOnForm(false)
// установить цвет для выделения приватных комментариев
api.commentSettings.setPrivateCommentColor(api.types.newColor('FFFFFF'))