Находит настройки варианта отчета. Используется для настройки размещения. Для использования в ВариантыОтчетовПереопределяемый.НастроитьВариантыОтчетов.

Синтаксис

Функция ОписаниеВарианта(Настройки, Отчет, КлючВарианта) Экспорт

Параметры

• Настройки — см. ВариантыОтчетовПереопределяемый.НастроитьВариантыОтчетов.Настройки.
• Отчет — СтрокаДереваЗначений
  • ОбъектМетаданных - описание настроек, метаданные или ссылка отчета.
• КлючВарианта — Строка - имя варианта отчета как оно задано в схеме компоновки данных.

Возвращаемое значение

СтрокаДереваЗначений - настройки варианта отчета, где:

• Включен - Булево - если Ложь, то вариант отчета не выводится в панели отчетов.
• ВидимостьПоУмолчанию - Булево - если Ложь, то вариант отчета по умолчанию скрыт в панели отчетов.
• ПоказыватьВПодменюВариантов - Булево - если Ложь, то вариант отчета не отображается в подменю выбора вариантов
  отчета в форме отчета. Используется, когда Включен - Ложь.
• Наименование - Строка - наименование варианта отчета.
• Описание - Строка - подсказка к варианту отчета.
• Размещение - Соответствие из КлючИЗначение - настройки размещения варианта отчета в разделах, где: ** Ключ - ОбъектМетаданных - подсистема, в которой размещается отчет или вариант отчета. ** Значение - Строка - настройки размещения в подсистеме (группе), с вариантами значений: "" - вывод варианта в подсистеме без специального выделение. "Важный" - вывод варианта в подсистеме с выделением жирным шрифтом. "СмТакже" - вывод варианта в группе "См. также".
• ФункциональныеОпции - Массив из Строка - имена функциональных опций варианта отчета.
• НастройкиДляПоиска - Структура - дополнительные настройки для поиска этого варианта отчета, где: ** НаименованияПолей - Строка - имена полей варианта отчета. ** НаименованияПараметровИОтборов - Строка - имена настроек варианта отчета. ** КлючевыеСлова - Строка - дополнительная терминология (в т.ч. специализированная или устаревшая). ** ИменаМакетов - Строка - используется вместо НаименованияПолей.
• ФорматНастроекСКД - Булево - отчет использует типовой формат хранения настроек на механике СКД, а его основные формы поддерживают стандартную схему взаимодействия между формами (параметры и тип возвращаемого значения). Если Ложь, тогда для отчета отключаются проверки консистентности и некоторые механизмы, которые рассчитывают на типовой формат.
• ОпределитьНастройкиФормы - Булево - отчет имеет программный интерфейс для тесной интеграции с формой отчета, в том числе может переопределять некоторые настройки формы и подписываться на ее события. Если Истина и отчет подключен к общей форме ФормаОтчета, тогда в модуле объекта отчета следует определить процедуру по шаблону: // Задать настройки формы отчета. // // Параметры: // Форма - ФормаКлиентскогоПриложения, Неопределено // КлючВарианта - Строка, Неопределено // Настройки - см. значение ОтчетыКлиентСервер.НастройкиОтчетаПоУмолчанию // Процедура ОпределитьНастройкиФормы(Форма, КлючВарианта, Настройки) Экспорт // Код процедуры. КонецПроцедуры
• Отчет - СправочникСсылка.ИдентификаторыОбъектовРасширений
  • СправочникСсылка.ДополнительныеОтчетыИОбработки
  • СправочникСсылка.ИдентификаторыОбъектовМетаданных
  • Строка - полное имя или ссылка на отчет.
• Описание - Строка
• Метаданные - ОбъектМетаданныхОтчет - метаданные отчета.
• КлючВарианта - Строка - имя варианта отчета.
• Назначение - ПеречислениеСсылка.НазначенияВариантовОтчетов - назначение использования варианта отчета (по умолчанию - ДляКомпьютеровИПланшетов)
• ОписаниеПолучено - Булево - флажок что описание строки уже получено. Описание получается методом ОписаниеВарианта().
• СистемнаяИнформация - Структура - другая служебная информация. При этом колонки Отчет, Метаданные, КлючВарианта, ОписаниеПолучено, СистемнаяИнформация являются служебными и предназначены только для чтения.

Пример вызова

Результат = ВариантыОтчетов.ОписаниеВарианта(Настройки, Отчет, КлючВарианта)

Доступность

Сервер, Толстый клиент, Внешнее соединение