Другое · 10 мин
Как вызвать процедуру формы в 1С
Разберём способы вызова процедур формы в 1С: из того же модуля, из другой формы, с параметрами, серверным контекстом и проверкой результата.
Процедура формы — это подпрограмма, описанная в модуле формы и привязанная к конкретной форме объекта: документа, справочника, обработки или отчёта. Такая процедура может реагировать на события элементов управления, выполнять действия по команде пользователя или обрабатывать данные, уже находящиеся на форме. Вызов такой процедуры зависит от того, из какого места конфигурации выполняется обращение: из самой формы, из другой формы или из общего модуля.
В платформе 1С:Предприятие форма и её модуль связаны тесно, но процедура формы не становится доступной автоматически из любого места программы. Если процедура описана в модуле формы, то напрямую обратиться к ней по имени из обычного модуля или другого объекта не получится без получения ссылки на форму. Поэтому первым шагом всегда стоит определить, где находится вызывающий код и какая форма является целевой.
Вызов процедуры формы может быть клиентским или серверным. Клиентские процедуры выполняются на рабочем месте пользователя и имеют доступ к элементам формы, а серверные — на сервере приложения и работают с данными без прямой привязки к интерфейсу. Неправильный выбор контекста приводит к ошибкам выполнения, поэтому перед вызовом нужно уточнить, где процедура описана и где она будет исполняться.
Вызов процедуры из модуля той же формы
Если код пишется непосредственно в модуле формы, обращение к процедуре осуществляется по её имени без указания объекта формы. Достаточно указать имя процедуры и передать необходимые параметры в скобках. Это самый простой и надёжный способ, потому что форма уже загружена в память, а процедура находится в той же области видимости.
Примерно такой вызов выглядит внутри обработчика события кнопки или другого элемента формы: вызывается процедура, описанная ниже в том же модуле, и после её выполнения управление возвращается к вызывающему коду. Если процедура возвращает значение, результат можно присвоить переменной или использовать в условии.
Они доступны внутри модуля формы, а извне к ним обращаются через объект формы, если такая возможность предусмотрена платформой. Поэтому внутри одной формы вызывайте процедуру напрямую, не создавая лишних ссылок.
Вызов процедуры из другой формы или общего модуля
Чтобы вызвать процедуру чужой формы, нужно получить объект этой формы. В managed-формах чаще всего используется функция ПолучитьФорму, которой передаётся путь к форме в виде строки. Результатом является ссылка на форму, через которую можно обратиться к процедурам модуля этой формы, если платформа и права доступа позволяют такое взаимодействие.
Порядок действий обычно такой: получить форму по имени, проверить, что ссылка не пустая, и только затем вызвать нужную процедуру у полученного объекта. Если форма уже открыта в сессии, иногда можно работать с уже существующим экземпляром, но надёжнее получать форму через стандартные механизмы платформы, а не полагаться на глобальные коллекции открытых окон.
Из общего модуля процедуру формы вызвать напрямую по имени нельзя, потому что общий модуль не знает о конкретной форме. Нужно передать в общий модуль ссылку на форму как параметр или получить форму внутри общего модуля через ПолучитьФорму. Это разграничивает ответственность: общий модуль содержит логику, а форма отвечает за интерфейс и вызов своих процедур.
- 1Определите имя и путь к целевой форме
- 2Получите ссылку на форму через ПолучитьФорму
- 3Проверьте, что ссылка получена и форма доступна
- 4Вызовите процедуру у объекта формы с нужными параметрами
- 5Проверьте результат выполнения
Клиентский и серверный контекст вызова
Процедуры формы могут быть помечены директивами &НаКлиенте и &НаСервере. Клиентская процедура имеет доступ к элементам управления, значениям полей и текущему состоянию формы, но не должна выполнять тяжёлые расчёты с большими объёмами данных. Серверная процедура выполняется на сервере и подходит для работы с базой данных, но не может напрямую обращаться к визуальным элементам формы.
Если клиентский код вызывает серверную процедуру формы, платформа обычно выполняет вызов через вызов на сервер с передачей параметров. Результат возвращается на клиент. При этом важно следить за типами параметров: сложные объекты формы могут не передаваться на сервер в исходном виде, поэтому иногда приходится передавать только идентификаторы или значения реквизитов.
Наоборот, вызов клиентской процедуры из серверного кода невозможен напрямую, потому что сервер не имеет доступа к клиентскому интерфейсу конкретного пользователя. В таких случаях логика выносится в серверную процедуру, а клиентская часть отвечает только за отображение результата и взаимодействие с пользователем.
Параметры, возврат результата и проверка
Процедура формы может принимать параметры по значению или по ссылке, в зависимости от объявления в модуле. При вызове нужно соблюдать порядок и типы параметров, иначе возникнет ошибка несоответствия типов или процедура просто не будет найдена. Если процедура изменяет переданный объект по ссылке, изменения будут видны вызывающему коду после завершения процедуры.
Если процедура является функцией, она возвращает значение. Вызывающий код должен обработать этот результат: проверить на пустоту, сравнить с ожидаемым значением или использовать в дальнейших расчётах. Игнорирование возвращаемого значения часто приводит к тому, что ошибка в вызываемой процедуре остаётся незамеченной.
Проверка результата включает в себя подтверждение, что форма открыта, процедура выполнилась без исключений, и данные на форме изменились соответствующим образом. Если процедура должна была записать документ или обновить реквизит, после вызова стоит проверить соответствующие поля и, при необходимости, обновить отображение формы.
Ограничения и типичные ошибки
Основное ограничение: процедура формы не всегда доступна извне, даже если вы получили ссылку на форму. Платформа может ограничить доступ к процедурам модуля формы в зависимости от режима работы, типа формы и контекста вызова. Также нельзя вызывать клиентскую процедуру формы из фонового задания или серверного процесса, где нет клиентского сеанса пользователя.
Частая ошибка — попытка вызвать процедуру несуществующей формы или формы с опечаткой в имени. ПолучитьФорму вернёт пустую ссылку, и дальнейший вызов процедуры приведёт к ошибке. Другая ошибка — передача в процедуру формы объектов, которые существуют только на клиенте, из серверного кода. Третья — вызов процедуры до того, как форма полностью инициализирована, что вызывает обращение к пустым реквизитам.
Безопасная самостоятельная работа возможна, если вы меняете только клиентский код формы, не трогаете серверную логику и проверяете каждый вызов на тестовой базе. При работе с документами, регистрами или движками лучше сначала протестировать вызов на копии базы, чтобы случайно не изменить данные.
Альтернативы и выбор подходящего способа
Если процедура нужна нескольким формам, лучше вынести общую логику в общий модуль, а формы будут вызывать его процедуры, передавая необходимые данные. Это упрощает поддержку и исключает необходимость получать ссылки на чужие формы. Общий модуль не зависит от конкретного интерфейса и легче тестируется.
Сравнение вариантов вызова
Проще всего, форма уже загружена, ограничений практически нет.
Подходит для открытых форм, требует проверки ссылки и контекста.
Универсальный способ, но форма не доступна напрямую без передачи ссылки.
Когда логика тесно связана с отображением на форме, например с изменением видимости элементов или работой с табличной частью, процедуру оставляют в модуле формы. В этом случае вызов извне оправдан только если форма уже открыта и вы можете получить на неё ссылку. Для фоновой обработки данных подходят серверные процедуры общих модулей или обработчики событий, не требующие открытой формы.
Выбор способа зависит от того, где хранятся данные, кто инициирует действие и нужен ли пользовательский интерфейс. Если пользователь нажимает кнопку на форме — используйте процедуру формы. Если действие запускается расписанием или другим процессом — общий модуль. Если нужно изменить данные другой открытой формы — получайте форму и вызывайте её процедуру осторожно.
Как проверить результат
Ссылка не пустая, процедура вызывается
Пустая ссылка или ошибка при получении формы
Ошибок выполнения нет
Возникло исключение при вызове
Реквизиты и табличные части обновлены
Данные остались прежними после вызова
Как проверить, что вызов прошёл успешно
После вызова процедуры формы проверьте, не возникло ли исключения во время выполнения. Если процедура должна была изменить реквизит или записать данные, откройте форму или запросите значения реквизитов программно и сравните их с ожидаемыми. Для клиентских процедур визуальная проверка на форме тоже допустима, но не заменяет программную проверку.
Если процедура возвращает код ошибки или булевый признак, обработайте его сразу после вызова. При отрицательном результате выведите сообщение пользователю или запишите событие в журнал регистрации, чтобы можно было найти причину неудачи позже. Не оставляйте вызовы без обработки результата в рабочих процедурах.
Часто задаваемые вопросы
Что важно запомнить
Вызов процедуры формы возможен по имени внутри своей формы и через ссылку на форму извне, с учётом клиентского или серверного контекста и обязательной проверки результата.
Можно ли вызвать процедуру формы из общего модуля без ссылки на форму?
Нет, общий модуль не знает о конкретной форме. Нужно либо передать ссылку на форму в параметр, либо получить форму внутри общего модуля через стандартные механизмы платформы, а затем вызывать процедуру у полученного объекта.
Что делать, если ПолучитьФорму вернула пустую ссылку?
Проверьте правильность имени формы, её существование в конфигурации и права доступа текущего пользователя. Пустая ссылка означает, что форма не может быть получена в текущем контексте, поэтому вызов процедуры невозможен без устранения причины.
Может ли серверный код вызвать клиентскую процедуру формы?
Нет, сервер не имеет доступа к клиентскому интерфейсу конкретного пользователя. Клиентская логика должна оставаться на клиенте, а серверный код должен использовать серверные процедуры и возвращать результаты для отображения на форме.
Нужно ли обрабатывать результат вызова процедуры формы?
Да, особенно если процедура является функцией или изменяет данные. Проверка результата позволяет вовремя обнаружить ошибку записи, нехватку прав или некорректные параметры и избежать Silent-ошибок в работе.