К статье
Практический материал

Разработка и Конфигурация · 8 мин

Как добавить справку на форму в 1С

Как добавить справку, подсказку и пояснение на форму в 1С: через конфигуратор, программно и через расширение. Разбор ошибок и проверка результата.

Под «справкой на форме» в 1С обычно понимают один из трёх механизмов: контекстную подсказку у элемента (всплывающий текст), поясняющую надпись или гиперссылку, открывающую раздел встроенной справки, и собственный текст помощника, который разработчик добавляет для пользователей. Все три варианта реализуются в конфигураторе, но отличаются по трудозатратам и по тому, что увидит пользователь.

Перед началом работы определите, чего именно нужно добиться: чтобы пользователь видел краткую подсказку при наведении на поле, чтобы на форме был видимый текст с инструкцией или чтобы по кнопке открывалась отдельная справочная страница. От этого зависит выбор инструмента — свойство «Подсказка», элемент «Надпись» или справочная информация объекта метаданных.

Ниже разобраны все основные способы: через конфигуратор, программно из модуля формы и через расширение конфигурации, когда типовую конфигурацию менять нельзя. Также приведены проверка результата, типичные ошибки и ответы на частые вопросы.

Какие виды справки бывают на форме 1С

Платформа 1С:Предприятие предлагает несколько штатных механизмов вывода поясняющей информации. Всплывающая подсказка появляется при наведении курсора или по кнопке с вопросительным знаком рядом с полем. Надпись — это статичный текст, всегда видимый на форме. Гиперссылка может открывать раздел встроенной справки, другую форму или внешний ресурс.

Отдельный вариант — справочная информация объекта метаданных (справочника, документа, отчёта). Она заполняется на вкладке «Справочная информация» в палитре свойств объекта и отображается пользователю при вызове справки по объекту. Это удобно для общих инструкций по работе с целым документом, а не с отдельным полем.

Добавление подсказки к полю через конфигуратор

Откройте конфигуратор, найдите нужный объект (например, справочник или документ), перейдите на вкладку «Формы» и откройте форму элемента или документа. В редакторе формы выделите нужное поле в дереве элементов — справа откроется палитра свойств.

В палитре найдите свойство «Подсказка» и введите текст. Дополнительно настройте свойство «Отображение подсказки»: значение «Кнопка» покажет рядом с полем значок вопроса, по нажатию на который откроется текст; «Всплывающая» выведет подсказку при наведении курсора. Для длинных текстов удобнее кнопка, для коротких — всплывающий вариант.

Если подсказка должна быть многострочной, используйте расширенное редактирование текста — кнопка выбора в поле свойства открывает редактор, где можно ввести несколько строк. Сохраните конфигурацию и обновите конфигурацию базы данных, если форма принадлежит объекту, хранящемуся в метаданных.

Порядок действий
  1. 1
    Откройте конфигуратор и найдите нужный объект метаданных
  2. 2
    Откройте форму объекта в редакторе форм
  3. 3
    Выделите элемент и заполните свойство «Подсказка» в палитре свойств
  4. 4
    Настройте «Отображение подсказки»: кнопка или всплывающая
  5. 5
    Обновите конфигурацию базы данных и проверьте результат в режиме предприятия

Добавление видимой надписи и гиперссылки на форму

Если справка должна быть видна постоянно, добавьте на форму элемент «Надпись». В редакторе формы нажмите кнопку добавления элемента, выберите тип «Надпись» (в новых версиях — «Декорация» с видом «Надпись»), задайте заголовок с текстом инструкции и расположите элемент в нужном месте дерева формы. Положение в дереве определяет, где надпись появится визуально.

Для оформления используйте свойства шрифта и цвета текста. Не злоупотребляйте яркими цветами: красный текст пользователи воспринимают как ошибку. Для нейтральных пояснений подходит стандартный или приглушённый цвет.

Чтобы сделать из надписи ссылку, установите свойство «Гиперссылка» в значение «Истина» и создайте обработчик события «Нажатие» (или «ОбработкаНавигационнойСсылки» для форматированной строки). В обработчике можно открыть другую форму, раздел справки или внешнюю страницу через «ПерейтиПоНавигационнойСсылке».

bsl
&НаКлиенте
Процедура ДекорацияСправкаНажатие(Элемент)
    ПерейтиПоНавигационнойСсылке("https://its.1c.ru");
КонецПроцедуры

Программное добавление подсказки из модуля формы

Если текст подсказки зависит от условий — роли пользователя, статуса документа, выбранного значения — задавайте её программно. В модуле формы обратитесь к элементу через коллекцию «Элементы» и присвойте значение свойству «Подсказка». Например, в обработчике «ПриСозданииНаСервере» или при изменении ключевого поля.

Программный способ удобен и для динамического скрытия: свойство «Видимость» элемента-надписи позволяет показывать справку только новичкам или только при определённом режиме работы. Учитывайте, что обращение к элементам формы возможно только в контексте формы, а не из модулей объекта или менеджера.

Справка на форме через расширение конфигурации

Когда типовая конфигурация находится на поддержке и изменять её нельзя, используйте расширение. Создайте расширение, добавьте в него нужную форму через «Добавить в расширение», затем в заимствованной форме измените свойство «Подсказка» существующих элементов или добавьте новые элементы — надписи и декорации.

Ограничение: в расширении нельзя удалять элементы типовой формы, а добавленные элементы размещаются с учётом правил заимствования — порядок следования иногда требует ручной настройки свойств «Группа» и родительского элемента. После сохранения расширения проверьте форму под пользователем без прав администратора, чтобы убедиться, что расширение применяется корректно.

Сравнение вариантов

Свойство «Подсказка»

Быстро и без изменения структуры формы; подходит для кратких пояснений к полям. Не видна постоянно

Надпись на форме

Всегда видна пользователю; занимает место на форме, требует аккуратной компоновки

Расширение конфигурации

Единственный безопасный путь для типовых конфигураций на поддержке; требует навыков работы с расширениями

Справочная информация объекта

Подходит для общих инструкций по объекту целиком; открывается только по вызову справки

Проверка результата и типичные ошибки

После изменений откройте форму в режиме «1С:Предприятие» и проверьте: подсказка появляется при наведении или по кнопке, надпись видна и не перекрывает другие элементы, гиперссылка открывает нужный объект. Проверьте форму при разной ширине окна — длинные надписи могут сжиматься или «уезжать» при неправильных настройках растягивания.

Частая ошибка — заполнение подсказки у реквизита формы вместо элемента формы: свойство реквизита в этом контексте не выводится пользователю. Другая типичная ситуация — изменения внесены, но пользователь их не видит, потому что конфигурация базы данных не обновлена или расширение не подключено в сеансе пользователя.

Типичные ошибки
01
Подсказка задана у реквизита формы, а не у элемента — пользователь её не видит
02
Забыто обновление конфигурации базы данных — изменения не применяются
03
Длинная надпись без настройки автопереноса — текст обрезается на узких экранах
04
Изменение типовой формы вместо расширения — конфигурация снимается с поддержки и усложняется обновление
Контрольные точки

Как проверить результат

Отображение подсказки
Норма

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

Тревожный признак

Подсказки нет — проверьте, у какого элемента заполнено свойство

Надпись на форме
Норма

Текст виден полностью при любой ширине окна

Тревожный признак

Текст обрезан или перекрывает поля ввода

Работа под обычным пользователем
Норма

Справка видна и без прав администратора

Тревожный признак

У пользователя форма выглядит по-старому — проверьте применение расширения

FAQ

Можно ли добавить справку на форму без конфигуратора?

Штатными средствами — нет: изменение состава и свойств элементов формы выполняется в конфигураторе или через расширение. Пользователю доступно только чтение встроенной справки платформы по клавише F1.

Как сделать многострочную подсказку у поля?

В палитре свойств откройте расширенный редактор свойства «Подсказка» (кнопка выбора) и введите текст с переносами строк. Для отображения выберите режим «Кнопка» — всплывающие подсказки хуже подходят для длинных текстов.

Изменения в форме не видны пользователям. Что проверить?

Убедитесь, что выполнено обновление конфигурации базы данных (F7 в конфигураторе). Если используется расширение — проверьте, что оно подключено, активно и не отключено механизмом защиты от опасных действий у конкретного пользователя.

Как открыть по гиперссылке свою инструкцию, а не сайт?

Создайте общий макет с текстом или HTML-документом и в обработчике нажатия откройте его программно, либо сформируйте отдельную форму-инструкцию и вызывайте её через «ОткрытьФорму». Так инструкция будет доступна офлайн внутри базы.

Можно ли показывать справку только определённым пользователям?

Да. В модуле формы проверьте роль или функциональную опцию пользователя и установите свойство «Видимость» элемента-надписи или измените текст подсказки программно в обработчике «ПриСозданииНаСервере».

Итог

Что важно запомнить

Для краткой справки используйте свойство «Подсказка» элемента формы, для постоянно видимого текста — надпись, для типовых конфигураций на поддержке — расширение. После изменений обновите конфигурацию базы данных и проверьте форму под обычным пользователем.