Тип: Булево. Признак отображения узла документа DOM. Истина - отображается.
Полное описание, параметры и ограничения
ФильтрУзловDOM.ОтображатьДокумент (DOMNodeFilter.ShowDocument)
ФильтрУзловDOM (DOMNodeFilter)
ОтображатьДокумент (ShowDocument)
Доступен, начиная с версии 8.1.
Использование:
Только чтение.
Описание:
Тип: Булево.
Признак отображения узла документа DOM.
Истина - отображается.
Доступность:
Сервер, толстый клиент, внешнее соединение, мобильное приложение (сервер), мобильный автономный сервер.
Использование в версии:
Доступен, начиная с версии 8.1.
Методическая информация
Практические примеры
Отобрать документ, DOCTYPE и узлы собственных объявлений DTD
Используем фиксированный внутренний DTD: документ и тип документа обходятся вместе, сущность и нотация — от своих отдельных корней.
Где и как запускать
Полный серверный общий модуль собственной учебной базы; работа с собственными DOM в памяти.
Подготовка
Собственная учебная база 8.5.1.1343. Создайте серверный общий модуль УчебныйОбходXML с флагом Сервер. Вставьте полный модуль одного урока и вызовите УчебныйОбходXML.ВыполнитьПример() из серверной команды собственной обработки.
Деревья создаются из фиксированных учебных данных. Нет чтения файлов, запросов сети, записей базы или произвольного внешнего XML.
Свойства ФильтрУзловDOM доступны только для чтения. Набор видов узлов задаётся параметрами конструктора, а не присваиванием ОтображатьЭлемент=Истина.
Параметры конструктора — значения перечисления ПараметрыОтбораУзловDOM, не Булево. Пустые позиции в коде оставляют соответствующие виды не включёнными согласно справке.
Подсчёт относится к дереву без форматирующих пробелов, построенному этим уроком. Запуск внутри 1С здесь ещё не подтверждён.
XML содержит только собственный внутренний DTD. Внешнего подмножества DOCTYPE нет, SYSTEM/PUBLIC в двух объявлениях — учебные URN, не пути и не HTTP-адреса.
guideIcon — неразбираемая сущность NDATA; она объявлена, но не используется как &guideIcon; в тексте. Её ресурс не загружается. Нотация описывает формат, не изображение.
Параметры и построитель создаются заново для этой известной строки. Никогда не переносите разрешение DTD на произвольный XML из интернета или API.
Процедура ВыполнитьПример() Экспорт
Параметры = Новый ПараметрыЧтенияXML(, , , , , Ложь);
Чтение = Новый ЧтениеXML;
Чтение.УстановитьСтроку("<?xml version=""1.0""?>
|<!DOCTYPE products [
|<!NOTATION guideMark PUBLIC ""guide-marker"" ""urn:guide:marker-format"">
|<!ENTITY guideIcon SYSTEM ""urn:guide:marker-payload"" NDATA guideMark>
|]>
|<products xmlns:g=""urn:guide:dtd""><product>Книга</product></products>", Параметры);
Построитель = Новый ПостроительDOM;
Настройки = Построитель.КонфигурацияDOM;
Если НЕ Настройки.ВозможноУстановитьПараметр("disallow-doctype", Ложь) Тогда
Чтение.Закрыть();
ВызватьИсключение "Построитель не разрешает собственный внутренний DTD";
КонецЕсли;
Настройки.УстановитьПараметр("disallow-doctype", Ложь);
Попытка
Документ = Построитель.Прочитать(Чтение);
Исключение
Чтение.Закрыть();
ВызватьИсключение;
КонецПопытки;
Чтение.Закрыть();
ОписаниеТипа = Документ.ОпределениеТипаДокумента;
Если ОписаниеТипа = Неопределено Тогда
ВызватьИсключение "Включите чтение типа документа, не подменяйте его пустым новым DOCTYPE";
КонецЕсли;
Сущность = ОписаниеТипа.Сущности.ПолучитьИменованныйЭлемент("guideIcon");
Нотация = ОписаниеТипа.Нотации.ПолучитьИменованныйЭлемент("guideMark");
Если ТипЗнч(Сущность) <> Тип("СущностьDOM") ИЛИ ТипЗнч(Нотация) <> Тип("НотацияDOM") Тогда
ВызватьИсключение "Построитель не сохранил ожидаемые собственные объявления DTD";
КонецЕсли;
Узлы = Новый Массив;
Узлы.Добавить(Сущность);
Узлы.Добавить(Нотация);
ФильтрДокумента = Новый ФильтрУзловDOM(, , , , , , , , , ПараметрыОтбораУзловDOM.ОтображатьДокумент, ПараметрыОтбораУзловDOM.ОтображатьОпределениеТипаДокумента);
Сообщить(ФильтрДокумента.ОтображатьДокумент);
Сообщить(ФильтрДокумента.ОтображатьОпределениеТипаДокумента);
ДокументИТип = СобратьУчебныеУзлы(Документ, Документ, ФильтрДокумента);
Сообщить(ДокументИТип.Количество() = 2);
Сообщить(ДокументИТип[0] = Документ);
Сообщить(ДокументИТип[1] = ОписаниеТипа);
ФильтрОбъявлений = Новый ФильтрУзловDOM(, , , , , , ПараметрыОтбораУзловDOM.ОтображатьСущность, , , , , , ПараметрыОтбораУзловDOM.ОтображатьНотацию);
Сообщить(ФильтрОбъявлений.ОтображатьСущность);
Сообщить(ФильтрОбъявлений.ОтображатьНотацию);
Для Каждого Узел Из Узлы Цикл
Объявление = СобратьУчебныеУзлы(Документ, Узел, ФильтрОбъявлений);
Сообщить(Объявление.Количество() = 1);
Сообщить(Объявление[0] = Узел);
КонецЦикла;
Ссылка = Документ.СоздатьСсылкуНаСущность("guideDetached");
ФильтрСсылки = Новый ФильтрУзловDOM(, , , , , ПараметрыОтбораУзловDOM.ОтображатьСсылкуНаСущность);
Сообщить(ФильтрСсылки.ОтображатьСсылкуНаСущность);
Ссылки = СобратьУчебныеУзлы(Документ, Ссылка, ФильтрСсылки);
Сообщить(Ссылки.Количество() = 1);
Сообщить(Ссылки[0] = Ссылка);
Сообщить(Документ.ЭлементДокумента.ТекстовоеСодержимое = "Книга");
КонецПроцедуры
Функция СобратьУчебныеУзлы(Документ, Корень, Фильтр)
Результат = Новый Массив;
Итератор = Документ.СоздатьИтераторУзлов(Корень, Фильтр, Ложь);
ОшибкаОбхода = "";
Попытка
Узел = Итератор.СледующийУзел();
Пока Узел <> Неопределено Цикл
Результат.Добавить(Узел);
Узел = Итератор.СледующийУзел();
КонецЦикла;
Исключение
ОшибкаОбхода = ОписаниеОшибки();
КонецПопытки;
ОшибкаЗавершения = "";
Попытка
Итератор.Отсоединить();
Исключение
ОшибкаЗавершения = ОписаниеОшибки();
КонецПопытки;
Если Не ПустаяСтрока(ОшибкаОбхода) Или Не ПустаяСтрока(ОшибкаЗавершения) Тогда
ВызватьИсключение ОшибкаОбхода + " " + ОшибкаЗавершения;
КонецЕсли;
Возврат Результат;
КонецФункцииРазбор по шагам
Фиксированный XML разрешает только собственный внутренний DTD. Неразбираемая guideIcon NDATA и нотация guideMark существуют в коллекциях объявлений; их URN не загружаются.
Первый фильтр включает ДокументDOM и ОпределениеТипаДокументаDOM, но не теги/текст. Итератор от документа возвращает именно документ и его DOCTYPE.
Сущности и нотации находятся в специальных коллекциях, не в обычных дочерних тегах. Для каждого реального объявления создаём отдельный обход от него самого.
СоздатьСсылкуНаСущность создаёт отдельный, не вставленный в документ узел guideDetached. Это не ссылка на NDATA-ресурс и не загрузка файла; её содержимое не обходится, третий аргумент итератора Ложь.
ОтображатьСсылкуНаСущность выбирает вид узла, а ОбходитьСсылкиНаСущности управляет обходом его содержимого. Эти параметры не одно и то же.
Все readonly-флаги проверяются у созданных фильтров. Из текста документа по-прежнему получается только Книга.
Как проверить результат
Пятнадцать логических проверок ожидаются Истина: пять для документа/DOCTYPE, шесть для двух объявлений, три для отдельной ссылки и одна для исходного текста.
Внешние схемы/файлы не запрашиваются; отдельно созданная ссылка не вставлена и не сериализуется в исходный XML.
Если построитель не сохранил реальные объявления, урок останавливается, не подменяет их фиктивными объектами.
Ожидаемый результат
Показаны пять редких видов DOM-фильтра на собственных реальных узлах, с правильными отдельными корнями.
На что обратить внимание
Не разрешать DTD для неизвестного входного XML из API или интернета.
Нельзя вставлять неразбираемую сущность NDATA как обычное текстовое содержимое через &guideIcon;.
Отбор ссылки не доказывает наличие раскрытого содержимого сущности.
Пример не запускался в вашей базе. Перед применением проверьте его в указанном учебном контексте.
Обойти только XML-элементы и прочитать настройки фильтра
У products два товара с текстом. Фильтр элементов возвращает три тега, но не текст Книга/Ручка и не атрибуты code.
Где и как запускать
Полный серверный общий модуль собственной учебной базы; работа с собственными DOM в памяти.
Подготовка
Собственная учебная база 8.5.1.1343. Создайте серверный общий модуль УчебныйОбходXML с флагом Сервер. Вставьте полный модуль одного урока и вызовите УчебныйОбходXML.ВыполнитьПример() из серверной команды собственной обработки.
Деревья создаются из фиксированных учебных данных. Нет чтения файлов, запросов сети, записей базы или произвольного внешнего XML.
Свойства ФильтрУзловDOM доступны только для чтения. Набор видов узлов задаётся параметрами конструктора, а не присваиванием ОтображатьЭлемент=Истина.
Параметры конструктора — значения перечисления ПараметрыОтбораУзловDOM, не Булево. Пустые позиции в коде оставляют соответствующие виды не включёнными согласно справке.
Подсчёт относится к дереву без форматирующих пробелов, построенному этим уроком. Запуск внутри 1С здесь ещё не подтверждён.
Процедура ВыполнитьПример() Экспорт
Документ = Новый ДокументDOM("", "products");
Корень = Документ.ЭлементДокумента;
Для Номер = 1 По 2 Цикл
Товар = Документ.СоздатьЭлемент("product");
Товар.УстановитьАтрибут("code", ?(Номер = 1, "A-01", "B-02"));
Товар.ДобавитьДочерний(Документ.СоздатьТекстовыйУзел(?(Номер = 1, "Книга", "Ручка")));
Корень.ДобавитьДочерний(Товар);
КонецЦикла;
ПоУмолчанию = Новый ФильтрУзловDOM;
Сообщить(СтрШаблон("ОтображатьВсе=%1", ПоУмолчанию.ОтображатьВсе));
Сообщить(СтрШаблон("ОтображатьЭлемент=%1", ПоУмолчанию.ОтображатьЭлемент));
Сообщить(СтрШаблон("ОтображатьАтрибут=%1", ПоУмолчанию.ОтображатьАтрибут));
Сообщить(СтрШаблон("ОтображатьТекст=%1", ПоУмолчанию.ОтображатьТекст));
Сообщить(СтрШаблон("ОтображатьСекцииCDATA=%1", ПоУмолчанию.ОтображатьСекцииCDATA));
Сообщить(СтрШаблон("ОтображатьСсылкуНаСущность=%1", ПоУмолчанию.ОтображатьСсылкуНаСущность));
Сообщить(СтрШаблон("ОтображатьСущность=%1", ПоУмолчанию.ОтображатьСущность));
Сообщить(СтрШаблон("ОтображатьИнструкциюОбработки=%1", ПоУмолчанию.ОтображатьИнструкциюОбработки));
Сообщить(СтрШаблон("ОтображатьКомментарий=%1", ПоУмолчанию.ОтображатьКомментарий));
Сообщить(СтрШаблон("ОтображатьДокумент=%1", ПоУмолчанию.ОтображатьДокумент));
Сообщить(СтрШаблон("ОтображатьОпределениеТипаДокумента=%1", ПоУмолчанию.ОтображатьОпределениеТипаДокумента));
Сообщить(СтрШаблон("ОтображатьФрагментДокумента=%1", ПоУмолчанию.ОтображатьФрагментДокумента));
Сообщить(СтрШаблон("ОтображатьНотацию=%1", ПоУмолчанию.ОтображатьНотацию));
ТолькоЭлементы = Новый ФильтрУзловDOM(, ПараметрыОтбораУзловDOM.ОтображатьЭлемент);
Сообщить(ТолькоЭлементы.ОтображатьЭлемент);
Сообщить(НЕ ТолькоЭлементы.ОтображатьВсе);
Элементы = СобратьУчебныеУзлы(Документ, Корень, ТолькоЭлементы);
Сообщить(Элементы.Количество() = 3);
Сообщить(Элементы[0] = Корень);
Сообщить(Элементы[1].ПолучитьАтрибут("code") = "A-01");
Сообщить(Элементы[2].ПолучитьАтрибут("code") = "B-02");
Все = Новый ФильтрУзловDOM(ПараметрыОтбораУзловDOM.ОтображатьВсе);
Сообщить(Все.ОтображатьВсе);
ВсеУзлы = СобратьУчебныеУзлы(Документ, Корень, Все);
Сообщить(ВсеУзлы.Количество() = 5);
КонецПроцедуры
Функция СобратьУчебныеУзлы(Документ, Корень, Фильтр)
Результат = Новый Массив;
Итератор = Документ.СоздатьИтераторУзлов(Корень, Фильтр, Ложь);
ОшибкаОбхода = "";
Попытка
Узел = Итератор.СледующийУзел();
Пока Узел <> Неопределено Цикл
Результат.Добавить(Узел);
Узел = Итератор.СледующийУзел();
КонецЦикла;
Исключение
ОшибкаОбхода = ОписаниеОшибки();
КонецПопытки;
ОшибкаЗавершения = "";
Попытка
Итератор.Отсоединить();
Исключение
ОшибкаЗавершения = ОписаниеОшибки();
КонецПопытки;
Если Не ПустаяСтрока(ОшибкаОбхода) Или Не ПустаяСтрока(ОшибкаЗавершения) Тогда
ВызватьИсключение ОшибкаОбхода + " " + ОшибкаЗавершения;
КонецЕсли;
Возврат Результат;
КонецФункцииРазбор по шагам
Сначала создаём фильтр без параметров и читаем все тринадцать readonly-признаков. Их фактические значения диагностические: справка конструктора по умолчанию не обещает набор включённых видов.
Для реального отбора явно создаём новый фильтр с ОтображатьЭлемент во второй позиции конструктора. Это значение перечисления, не Истина.
Итератор стартует перед корнем, поэтому products также попадает в результат элементов. Текстовые дети пропускаются, а обход поддерева продолжается.
Атрибуты code не становятся дочерними узлами product. Их читаем у найденных элементов, не ожидаем в обычном обходе.
Отдельный фильтр ОтображатьВсе показывает пять узлов: корень, два product и два текста. Каждый итератор отсоединяется после обхода и при ошибке.
Как проверить результат
Сначала тринадцать подписанных диагностических значений фильтра по умолчанию, затем восемь проверок ожидаются Истина.
Только элементы: products, product A-01, product B-02. Все узлы: дополнительно Книга и Ручка.
Ни одно readonly-свойство фильтра не должно быть присвоено.
Ожидаемый результат
Получен реальный отбор элементов, сравнение с полным обходом и честный паспорт конструктора по умолчанию.
На что обратить внимание
Не считать, что ОтображатьВсе делает атрибуты обычными детьми элемента.
Нельзя присваивать readonly-флаги после создания; создайте другой фильтр.
Не полагаться на неописанные настройки конструктора по умолчанию для критичного отбора.
Пример не запускался в вашей базе. Перед применением проверьте его в указанном учебном контексте.