Форма.ОткрытьСправкуФормы

Методы · OpenFormHelp

Открывает окно справочной информации по форме.

Синтаксис

ОткрытьСправкуФормы()

Примеры платформы

ОткрытьСправку();
Полное описание, параметры и ограничения

Форма.ОткрытьСправкуФормы (Form.OpenFormHelp)

Форма (Form)

ОткрытьСправкуФормы (OpenFormHelp)

Доступен, начиная с версии 8.0.

Синтаксис:
ОткрытьСправкуФормы()
Возвращаемое значение:
Тип: Булево.
Истина - окно со справочной информацией по форме открыто; Ложь - в противном случае.
Описание:

Открывает окно справочной информации по форме.

Доступность:

Толстый клиент.

Пример:

ОткрытьСправку();

Использование в версии:

Доступен, начиная с версии 8.0.

Методическая информация

Практические примеры

Снабдить обычную форму учебной справкой

Собственные главы справки открываются по полной строке Конфигурация и по форме. Отдельные кнопки показывают содержание, индекс и закрывают окна справки; результат открытия проверяется как Булево.

Где и как запускать

Полный модуль собственной обычной формы; операции справки только на клиенте, не запускались.

Подготовка

  1. Создайте НОВУЮ пустую учебную конфигурацию УчебныеФормы85 на платформе 8.5.1.1343. Бизнес-объектов, расширений, подписок и регламентных заданий нет. Для уроков подбора добавьте только собственную обработку УчебныйПодбор85 и две обычные формы Пульт/Подбор. Другие уроки используют отдельные новые внешние обработки. Рабочие УТ, КА, УНФ и БП не изменяйте. Здесь никакие формы или базы не создавались и код не запускался: runtimeVerifiedScenarios=0.

  2. Создайте общий модуль УчебныеФормы85: Клиент (обычное приложение)=Да, Сервер=Да, Глобальный=Нет, Вызов сервера=Нет. Вставьте целиком отдельный модуль проверки стенда ниже. Обычная форма вызывает его в толстом клиенте; управляемая — только из серверного события создания.

  3. В конфигураторе у самой конфигурации заполните Справочная информация: заголовок Учебные формы и текст «Этот стенд показывает собственные формы и значения без бизнес-данных». Добавьте ключевое слово Учебные формы для индекса. Это раздел приложения, не ссылка на наш автономный HTML и не синтакс-помощник.

  4. Создайте свою новую внешнюю обработку с обычной формой. Заполните Справочная информация самой формы заголовком Учебная форма и инструкцией о пяти кнопках. Сохраните обработку; незаполненная справка не является доказательством ошибки метода.

  5. Добавьте обычные кнопки Раздел, Содержание, Индекс, СправкаФормы, ЗакрытьОкнаСправки. Назначьте одноимённые обработчики и событие создания/открытия из кода. Вставьте полный модуль формы и проверьте F7.

  6. Обычный вариант запускайте толстым клиентом с обычными формами; управляемый — тонким/толстым клиентом или отдельно веб-клиентом. Создание новой учебной базы и заполнение её справки — будущие ручные действия, здесь не выполнялись.

Процедура ПриОткрытии()
    УчебныеФормы85.ПроверитьСвойПустойСтенд();
КонецПроцедуры

Процедура Раздел(Кнопка)
    Успех = ОткрытьСправку("Конфигурация");
    Если ТипЗнч(Успех) <> Тип("Булево") Тогда
        ВызватьИсключение "Результат открытия справки должен быть Булево";
    КонецЕсли;
    Если Не Успех Тогда
        Сообщить("Окно справки открыть не удалось");
    КонецЕсли;
КонецПроцедуры

Процедура Содержание(Кнопка)
    Успех = ОткрытьСодержаниеСправки();
    Если ТипЗнч(Успех) <> Тип("Булево") Тогда
        ВызватьИсключение "Результат открытия справки должен быть Булево";
    КонецЕсли;
    Если Не Успех Тогда
        Сообщить("Окно справки открыть не удалось");
    КонецЕсли;
КонецПроцедуры

Процедура Индекс(Кнопка)
    Успех = ОткрытьИндексСправки("Учебные формы");
    Если ТипЗнч(Успех) <> Тип("Булево") Тогда
        ВызватьИсключение "Результат открытия справки должен быть Булево";
    КонецЕсли;
    Если Не Успех Тогда
        Сообщить("Окно справки открыть не удалось");
    КонецЕсли;
КонецПроцедуры

Процедура СправкаФормы(Кнопка)
    Успех = ЭтаФорма.ОткрытьСправкуФормы();
    Если ТипЗнч(Успех) <> Тип("Булево") Тогда
        ВызватьИсключение "Результат открытия справки должен быть Булево";
    КонецЕсли;
    Если Не Успех Тогда
        Сообщить("Окно справки открыть не удалось");
    КонецЕсли;
КонецПроцедуры

Процедура ЗакрытьОкнаСправки(Кнопка)
    ЗакрытьСправку();
КонецПроцедуры
УчебныеФормы85.ПроверкаСтенда

Своя пустая конфигурация УчебныеФормы85 → Общие → Общие модули → УчебныеФормы85

Полный общий модуль: обычный клиент и сервер, без глобального доступа и вызова сервера. Не выполнялся.

Процедура ПроверитьСвойПустойСтенд() Экспорт
    Если Метаданные.Справочники.Количество() <> 0 Или Метаданные.Документы.Количество() <> 0 Или Метаданные.Перечисления.Количество() <> 0 Или Метаданные.РегистрыСведений.Количество() <> 0 Или Метаданные.РегистрыНакопления.Количество() <> 0 Или Метаданные.РегистрыБухгалтерии.Количество() <> 0 Или Метаданные.РегистрыРасчета.Количество() <> 0 Или Метаданные.ПланыВидовХарактеристик.Количество() <> 0 Или Метаданные.ПланыВидовРасчета.Количество() <> 0 Или Метаданные.ПланыСчетов.Количество() <> 0 Или Метаданные.ПланыОбмена.Количество() <> 0 Или Метаданные.Последовательности.Количество() <> 0 Или Метаданные.БизнесПроцессы.Количество() <> 0 Или Метаданные.Задачи.Количество() <> 0 Или Метаданные.ОбщиеРеквизиты.Количество() <> 0 Или Метаданные.ПодпискиНаСобытия.Количество() <> 0 Или Метаданные.РегламентныеЗадания.Количество() <> 0 Или Метаданные.ВнешниеИсточникиДанных.Количество() <> 0 Тогда
        ВызватьИсключение "Нужен только свой новый пустой учебный стенд";
    КонецЕсли;
    Если Метаданные.ЕстьИзмененияРасширениямиКонфигурации() Тогда
        ВызватьИсключение "Свой сеанс не должен изменяться расширениями";
    КонецЕсли;
    Источники = Новый Массив;
    Источники.Добавить(ИсточникРасширенийКонфигурации.БазаДанных);
    Источники.Добавить(ИсточникРасширенийКонфигурации.СеансАктивные);
    Источники.Добавить(ИсточникРасширенийКонфигурации.СеансОтключенные);
    Для Каждого Источник Из Источники Цикл
        Расширения = РасширенияКонфигурации.Получить(, Источник);
        Если ТипЗнч(Расширения) <> Тип("Массив") Тогда
            ВызватьИсключение "Native список расширений должен иметь тип Массив";
        КонецЕсли;
        Если Расширения.Количество() <> 0 Тогда
            ВызватьИсключение "В своём новом стенде нет расширений базы или сеанса";
        КонецЕсли;
    КонецЦикла;
    Если ТранзакцияАктивна() Тогда
        ВызватьИсключение "Чужая или вложенная активная транзакция не допускается";
    КонецЕсли;
КонецПроцедуры

Разбор по шагам

  1. Раздел передаёт точное полное имя Конфигурация. Оно обозначает подготовленную справку собственного приложения; строка "Запрос" не подставляется как выдуманный путь к метаданным.

  2. Содержание и Индекс — разные окна. Индекс получает строку Учебные формы для позиционирования на собственном ключевом слове, не произвольный поиск по всем исходникам.

  3. СправкаФормы вызывает метод именно текущей собственной формы. Булево-результат означает возможность открытия окна, а не проверку содержания главы или фактического чтения пользователем.

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

  5. ОткрытьСодержаниеСправки и ОткрытьИндексСправки обращаются к серверу; для управляемой формы это касается и ОткрытьСправкуФормы. Урок не обещает чистую операцию памяти или отсутствие серверных запросов.

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

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

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

  3. Для отрицательного опыта удалите текст только своей учебной главы на копии стенда, сохраните изменение и наблюдайте доступность/содержание. Не заменяйте Булево-проверку ожиданием успеха и не трогайте рабочие главы.

Ожидаемый результат

Подготовлен полный клиентский модуль для своей справки приложения и формы. Ожидаемые окна здесь не открывались, текст и интерфейс в 1С не проверены.

На что обратить внимание

  1. Возвращаемое Булево не доказывает корректность текста главы.

  2. ЗакрытьСправку относится ко всем окнам справки данного приложения, а не только к одному окну, созданному последней кнопкой.

  3. Объект метаданных как аргумент ОткрытьСправку допустим только в толстом клиенте. Здесь используется поддерживаемая строка Конфигурация; внешних URL и рабочих объектов нет.

Пример не запускался в вашей базе. Перед применением проверьте его в указанном учебном контексте.

Не хотите разбираться сами?

Адаптируем это решение под вашу базу. Оценка бесплатно.

Оставить задачу

1С, 1С:Предприятие — товарные знаки ООО «1С». Сайт не является официальным представительством фирмы «1С» и не аффилирован с ней.