Включая защищенные члены
Включая унаследованные члены

Include .NET Framework Members
Include .NET Compact Framework Members
Include XNA Framework Members

SDK Unitext programming reference for Python 3

UnitextDocument - класс

Unitext - документ

Пространство имен: pullenti.unitext

Иерархия наследования

Синтаксис

Свойства (get/set)

	Имя	Тип	Описание
	content_items	list	Получить список всех элементов (включая и сам документ как элемент). Порядок последовательный, как они входят в дерево и в какой последовательности генерируется плоский текст. Колонтитулы не включаются.

Методы

	Имя	Тип значения	Описание
	deserialize	нет	Восстановить документ из байтового потока, полученного функцией serialize(). Если что не так, то выдаст Exception.
	find_by_id	UnitextItem	Найти элемент по его идентификатору
	from_xml	нет	Десериализовать из XML, полученный функцией get_xml().
	generate_ids	нет	Сгенерировать внутренние идентификаторы у элементов. Если у элемента Id установлен, то он не меняется. У колонтитулов Id не устанавливается. По умолчанию, Id генерируются при создании документа.
	get_html	нет	Сгенерировать HTML
	get_html_string	str	Сгенерировать HTML
	get_plaintext	нет	Сгенерировать плоский текст
	get_plaintext_string	str	Сгенерировать плоский текст
	get_xml	нет	Сериализовать в XML. Потом можно восстановить фукнцией from_xml().
	implantate	bool	Встроить контейнер в дерево элементов. ВНИМАНИЕ! Встраивание возможно только после вызова get_plaintext(), когда значения BeginChar и EndChar установлены у всех элементов, и встраивание происходит относительно этих значений. Идентификатор у встраиваемого контейнера устанавливать самим, если нужно потом производить к нему навигацию в HTML.
	implantate_block	UnitextDocblock	Встроить в дерево структурирующий блок UnitextDocblock. Его идентификатор Id нужно устанавливать самим, если нужно.
	implantate_hyperlink	bool	Встроить гиперссылку в дерево элементов. ВНИМАНИЕ! Встраивание возможно только после вызова get_plaintext(), когда значения BeginChar и EndChar установлены у всех элементов, и встраивание происходит относительно этих значений. Идентификатор у встраиваемого контейнера устанавливать самим, если нужно потом производить к нему навигацию в HTML.
	merge_with	нет	Объединить содержимое с содержимым другого документа
	refresh_content_by_pages	нет	После OCR-распознавания обновить СТП (content) на основе нового ТГП (pages)
	remove_all_hyperlinks	int	Удалить все гиперссылки, сделав их обычными текстами
	remove_item_by_id	bool	Удалить элемент по его идентификатору Id. Сейчас работает только для тех элементов, которые были встроены через implantate
	serialize	bytearray	Преобразовать в байтовый поток (со сжатием). Восстанавливать потом функцией deserialize().

Поля

	Имя	Тип	Описание
	attrs	dict	Некоторые дополнительные атрибуты (зависят от формата)
	content	UnitextItem	Содержимое (тело) структурно-текстового представления (СТП)
	error_message	str	Сообщение об ошибке, формируемое при обработке исходного файла (например, что файл зашифрован)
	html_styles	str	Это дополнительные определения стилей для вывода полноценного документа в HTML (содержимое секции styles)
	inner_documents	list	Внутренние документы (например, для архива его разархивированные файлы или вложения для писем)
	pages	list	Последовательность страниц UnilayPage с расположенными на них прямоугольниками с текстами и картинками. Тексто-графическое представление (ТГП) - для форматов PDF, DJVU
	sections	list	Информация о страницах и колонтитулах
	source_file_name	str	Имя исходного файла (если есть)
	source_file_pages	str	Страницы исходного файла (это когда файл PDF разбивается на несколько документов)
	source_format	FileFormat	Формат исходного документа
	source_plain_text	str	Если документ получен функцией CreateFromText, то это входной текст, причём никак не корректированный. Функция get_plaintext возвращает его независимо от настроек параметров генерации.
	styles	list	Стили текста и абзацев