Создает элемент плана глобального поиска по обработчику.
Синтаксис
Новый ЭлементПланаГлобальногоПоиска(<ИмяПроцедуры>, <Модуль>, <НаСервере>, <Фоновый>, <Порядок>, <ДополнительныеПараметры>)Полное описание, параметры и ограничения
ЭлементПланаГлобальногоПоиска.По обработчику
ЭлементПланаГлобальногоПоиска (GlobalSearchPlanItem)
По обработчику
Доступен, начиная с версии 8.3.15.
Синтаксис:
Новый ЭлементПланаГлобальногоПоиска(<ИмяПроцедуры>, <Модуль>, <НаСервере>, <Фоновый>, <Порядок>, <ДополнительныеПараметры>)
Параметры:
<ИмяПроцедуры> (обязательный)
Тип: Строка.
Имя экспортируемой процедуры общего модуля.
Процедура будет вызвана с параметрами:
СтрокаПоиска - тип Строка. Строка. Строка, по которой выполняется поиск.
РезультатыПоиска - тип РезультатГлобальногоПоиска. Выходной параметр. Содержит результаты поиска.
ДополнительныеПараметры - тип Произвольный. Параметры, заданные в свойстве ДополнительныеПараметры у ЭлементПланаГлобальногоПоиска.
<Модуль> (обязательный)
Тип: Строка.
Имя общего модуля.
<НаСервере> (обязательный)
Тип: Булево.
Признак выполнения поиска на сервере.
<Фоновый> (необязательный)
Тип: Булево.
Признак выполнения поиска в фоновом задании.
Значение по умолчанию: Ложь.
<Порядок> (необязательный)
Тип: Число.
Порядок выдачи результатов поиска.
Значение по умолчанию: 0.
<ДополнительныеПараметры> (необязательный)
Тип: Произвольный.
Дополнительные параметры, передаваемые в вызываемую процедуру.
Описание:
Создает элемент плана глобального поиска по обработчику.
Использование в версии:
Доступен, начиная с версии 8.3.15.
Методическая информация
Практические примеры
Подготовить описание собственного обработчика поиска
Настраиваем маршрут к экспортной процедуре и дополнительные параметры. Описание не регистрируется в менеджере и само процедуру не выполняет.
Где и как запускать
Учебная база: создайте серверный общий модуль УчебныеЗадачи (флаг Сервер). Код без директив вставьте в тело процедуры ВыполнитьПример() Экспорт. Вызовите её из серверного обработчика команды учебной обработки. Не запускайте в рабочей базе.
Подготовка
Используйте отдельную учебную базу. В серверном общем модуле УчебныеЗадачи создайте процедуру ВыполнитьПример() Экспорт и вставьте в неё код одного урока. Вызовите её из серверного обработчика собственной учебной обработки.
Каждый урок создаёт новую коллекцию в памяти. Код не загружает и не сохраняет избранное пользователя, не заменяет план ГлобальныйПоиск, не запускает поиск, не открывает ссылку и не читает рабочие документы.
Для трёх уроков избранного создайте в собственной учебной конфигурации два пустых справочника УчебныеКниги и УчебныеАвторы. Учебные ссылки относятся к спискам этих объектов; записи справочников для упражнения не нужны. Право СохранениеДанныхПользователя требуется для использования избранного по справке платформы.
План = Новый ПланГлобальногоПоиска;
Параметры = Новый Структура("Префикс", "guide-");
Обработчик = Новый ЭлементПланаГлобальногоПоиска("НайтиУчебныеКниги", "УчебныйГлобальныйПоиск", Истина, Ложь, 10, Параметры);
План.Добавить(Обработчик);
Найдено = План.Найти("НайтиУчебныеКниги", "УчебныйГлобальныйПоиск");
Если Найдено = Неопределено Тогда
ВызватьИсключение "Описание обработчика не найдено";
КонецЕсли;
Сообщить(Найдено.ВидПоиска = Неопределено);
Сообщить(Найдено.ИмяПроцедуры = "НайтиУчебныеКниги");
Сообщить(Найдено.Модуль = "УчебныйГлобальныйПоиск");
Сообщить(Найдено.НаСервере);
Сообщить(Найдено.Фоновый = Ложь);
Сообщить(Найдено.Порядок = 10);
Сообщить(Найдено.ДополнительныеПараметры.Префикс = "guide-");Разбор по шагам
Первые два аргумента — имена экспортной процедуры и общего модуля, не текст BSL для исполнения и не навигационная ссылка.
НаСервере=Истина и Фоновый=Ложь задают маршрут обычного серверного выполнения, если этот план впоследствии установить и запустить. Здесь это только описание.
ДополнительныеПараметры — собственная Структура. Неопределённые поля нельзя без проверки трактовать как структуру в обработчике.
Для реального запуска вручную создайте общий модуль УчебныйГлобальныйПоиск с серверным флагом и процедуру НайтиУчебныеКниги(СтрокаПоиска, РезультатыПоиска, ДополнительныеПараметры) Экспорт. Её самостоятельный полный пример приведён в отдельном уроке.
Конструктор и поиск описания не являются проверкой существования, прав и работоспособности экспортной процедуры.
Как проверить результат
Семь контрольных Истина, включая отсутствие стандартного вида и собственный префикс.
Фоновое задание не создано, процедура по строковому имени не вызывалась, план интерфейса не изменился.
Ожидаемый результат
Подготовлен проверяемый черновик маршрута собственного обработчика.
На что обратить внимание
Не считайте создание описания доказательством исполнения обработчика.
Не передавайте секреты в дополнительные параметры, выводимые в диагностических сообщениях.
Пример не запускался в вашей базе. Перед применением проверьте его в указанном учебном контексте.