Тип: Булево. Если это свойство установлено в значение Истина, то справка по данному объекту метаданных (свойство Справка) будет включена в общую справку по конфигурации.
Полное описание, параметры и ограничения
ОбъектМетаданных: Обработка.ВключатьСправкуВСодержание (MetadataObject: DataProcessor.IncludeHelpInContents)
ОбъектМетаданных: Обработка (MetadataObject: DataProcessor)
ВключатьСправкуВСодержание (IncludeHelpInContents)
Доступен, начиная с версии 8.3.2.
Использование:
Только чтение.
Описание:
Тип: Булево.
Если это свойство установлено в значение Истина, то справка по данному объекту метаданных (свойство Справка) будет включена в общую справку по конфигурации.
Доступность:
Сервер, толстый клиент, внешнее соединение.
Использование в версии:
Доступен, начиная с версии 8.3.2.
Методическая информация
Практические примеры
Не путать описание модуля с его исходным текстом
Свойства МодульОбъекта, МодульМенеджера и Справка в API описаны типом Неопределено. Они не служат программным экспортом кода из конфигурации.
Где и как запускать
Учебная база: создайте серверный общий модуль УчебныеЗадачи (флаг Сервер). Код без директив вставьте в тело процедуры ВыполнитьПример() Экспорт. Вызовите её из серверного обработчика команды учебной обработки. Не запускайте в рабочей базе.
Подготовка
Запускайте в учебной копии конфигурации. Примеры читают структуру метаданных, но не создают объекты, не записывают регистры и не проводят документы.
Сверяйте вывод с деревом конфигурации в Конфигураторе. Имена, длины и настройки в УНФ, КА2, БП, УТ 11 и УТ 10.3 могут различаться.
Имена объектов взяты из XML КА2 Progress: C:\claude\KA2\Progress\XML_CF_KA2_PROGRESS. Исходные XML не изменяйте. Выполняйте код только в своей учебной копии соответствующей конфигурации.
В другой конфигурации предварительно найдите аналогичный объект в Конфигураторе и замените только строку имени в поиске. Отсутствие имени обрабатывается до чтения свойств; оно не доказывает отсутствие аналогичной возможности.
Каждый урок запускайте отдельно. Код не вызывает бизнес-функции модулей и обработчики команд, не переключает привилегированный режим и не меняет параметры сеанса.
Отчет = Метаданные.Отчеты.Найти("АнализОстатковТоваровОрганизаций");
Если Отчет = Неопределено Тогда
ВызватьИсключение "В учебной конфигурации отсутствует Отчеты.АнализОстатковТоваровОрганизаций";
КонецЕсли;
Обработка = Метаданные.Обработки.Найти("ВводКонтактнойИнформации");
Если Обработка = Неопределено Тогда
ВызватьИсключение "В учебной конфигурации отсутствует Обработки.ВводКонтактнойИнформации";
КонецЕсли;
Описания = Новый Массив;
Описания.Добавить(Отчет);
Описания.Добавить(Обработка);
Для Каждого Описание Из Описания Цикл
Сообщить(Описание.Имя);
Сообщить(Описание.МодульОбъекта = Неопределено);
Сообщить(Описание.МодульМенеджера = Неопределено);
Сообщить(Описание.Справка = Неопределено);
Сообщить("Включать справку в содержание: " + Строка(Описание.ВключатьСправкуВСодержание));
КонецЦикла;Разбор по шагам
Находим два описания, не создавая прикладные объекты и не исполняя их модули.
Сравниваем значения с Неопределено согласно контракту локальной справки.
ВключатьСправкуВСодержание относится к справке конфигурации, не к выгрузке синтакс-помощника.
Исходный код изучайте в Конфигураторе или в предоставленном XML-экспорте, а не выдуманным методом ПолучитьТекст.
Как проверить результат
Ожидаются три проверки Истина для каждого описания; это не значит, что исходный модуль пуст.
По XML ВключатьСправкуВСодержание выключено у обоих объектов; исходники и конфигурация не изменяются.
Ожидаемый результат
Объяснена граница между runtime-метаданными, справкой и исходным кодом.
На что обратить внимание
Неопределено у свойства МодульОбъекта не доказывает отсутствие бизнес-обработчиков.
Для выгрузки источников нужен отдельный штатный экспорт конфигурации, не обход этого ограничения.
Пример не запускался в вашей базе. Перед применением проверьте его в указанном учебном контексте.