Aspose.Note FOSS for Python

Эта справка охватывает полную публичную поверхность API aspose-note версии 26.3.1. Экспортируемые из aspose.note пакета документируются здесь. Всё, что находится под aspose.note._internal является деталями реализации и может измениться без предупреждения.

ImageRenderOptions: pip install aspose-note (core) или pip install "aspose-note[pdf]" (с экспортом в PDF)

ImageRenderOptions: from aspose.note import Document, RichText, ...

ImageRenderOptions

Документ и обход

ImageRenderOptionsImageRenderOptions
DocumentКорневой объект документа. Загрузите .one файл, перебирайте страницы и сохраняйте в PDF.
DocumentVisitorАбстрактная база для обхода дерева документа с использованием паттерна посетитель.
NodeБазовый класс для всех узлов документа.
CompositeNodeБазовый класс для узлов, которые могут содержать дочерние узлы.

Структура документа

ImageRenderOptionsImageRenderOptions
PageПредставляет страницу OneNote.
TitleБлок заголовка страницы, содержащий TitleText, TitleDate, TitleTime.
OutlineПозиционный контейнер для узлов OutlineElement.
OutlineElementКонтейнер‑лист; содержит RichText, Image, Table, AttachedFile.

ImageRenderOptions

ImageRenderOptionsImageRenderOptions
RichTextТекстовый блок с форматирующими фрагментами, тегами и гиперссылками.
TextRunОдин форматированный текстовый сегмент внутри RichText.
TextStyleСвойства форматирования для TextRun.
ImageВстроенное изображение с необработанными байтами и метаданными.
AttachedFileВстроенное файловое вложение с необработанными байтами.
TableТаблица с строками, ячейками и ширинами столбцов.
TableRowСтрока внутри таблицы.
TableCellЯчейка внутри TableRow; содержит узлы контента.
NoteTagТег OneNote (звёздочка, флажок и т.д.), прикреплённый к узлу контента.
NumberListМетаданные нумерованного списка в OutlineElement.

ImageRenderOptions

ImageRenderOptionsImageRenderOptions
LoadOptionsПараметры загрузки .one файла.
SaveOptionsБазовый класс для параметров сохранения.
PdfSaveOptionsПараметры сохранения, специфичные для PDF (значки тегов).

Заглушки совместимости

ImageRenderOptionsImageRenderOptions
LicenseЗаглушка совместимости: SetLicense() не выполняет никаких действий в этой реализации FOSS.
MeteredЗаглушка совместимости: SetMeteredKey() является пустой операцией (no‑op) в этой реализации с открытым исходным кодом.

Подробности класса

ImageRenderOptions

Класс корневого документа. Загрузить .one файл из пути к файлу, a pathlib.Path, или бинарный поток.

from aspose.note import Document, LoadOptions

doc = Document(source=None, load_options=None)

Параметры конструктора:

ImageRenderOptionsImageRenderOptionsImageRenderOptions
source`strPath
load_options`LoadOptionsNone`

ImageRenderOptions:

ImageRenderOptionsImageRenderOptionsImageRenderOptions
DisplayName`strNone`
CreationTime`datetimeNone`
FileFormatFileFormatПриблизительное указание версии формата файла OneNote

ImageRenderOptions:

ImageRenderOptionsImageRenderOptionsImageRenderOptions
Count()() -> intКоличество прямых дочерних страниц
GetPageHistory(page)(Page) -> list[Page]ImageRenderOptions [page] (заглушка; полная история ещё не реализована)
DetectLayoutChanges()() -> NoneЗаглушка совместимости; без действия
Save(target, format_or_options)`(strPath
Accept(visitor)(DocumentVisitor) -> NoneВызвать обход посетителя
for page in docN/AИтерировать прямого потомка Page узлы

Document.FileFormat примечание: Свойство предоставляет приблизительное указание версии формата файла OneNote. The FileFormat перечисление имеет три значения: OneNote2010, OneNoteOnline, и OneNote2007.

Document.Save() поддержка потоков: target может быть бинарным потоком (io.BytesIO, файловый дескриптор, открытый в режиме бинарной записи, и т.д.). Это подтверждается набором тестов: doc.Save(io.BytesIO(), PdfSaveOptions(SaveFormat.Pdf)).

DocumentVisitor

Абстрактный базовый класс для обхода по шаблону посетителя. Переопределите необходимые вам методы visit:

ImageRenderOptionsВызывается, когда
VisitDocumentStart(doc)Вход в узел Document
VisitDocumentEnd(doc)Выход из узла Document
VisitPageStart(page)Вход в узел Page
VisitPageEnd(page)Выход из узла Page
VisitTitleStart(title)Вход в узел Title
VisitTitleEnd(title)Выход из узла Title
VisitOutlineStart(outline)Вход в узел Outline
VisitOutlineEnd(outline)Выход из узла Outline
VisitOutlineElementStart(oe)Вход в узел OutlineElement
VisitOutlineElementEnd(oe)Выход из узла OutlineElement
VisitRichTextStart(rt)Вход в узел RichText
VisitRichTextEnd(rt)Выход из узла RichText
VisitImageStart(img)Вход в узел Image
VisitImageEnd(img)Выход из узла Image

ImageRenderOptions

Базовый класс для всех узлов дерева документа.

Свойство / МетодImageRenderOptionsImageRenderOptions
ParentNode`NodeNone`
Document`DocumentNone`
Accept(visitor)(DocumentVisitor) -> NoneВызвать visitor для этого узла

CompositeNode

ImageRenderOptions Node. Добавляет управление дочерними элементами:

Свойство / МетодImageRenderOptions
FirstChildПервый дочерний узел, или None
LastChildПоследний дочерний узел, или None
AppendChildLast(node)Добавить дочерний узел в конец; задаёт node.ParentNode = self
AppendChildFirst(node)Добавить дочерний узел в начало
InsertChild(index, node)Вставить дочерний элемент в заданную позицию
RemoveChild(node)Удалить дочерний узел; задаёт node.ParentNode = None
GetEnumerator()Возвращает итератор по непосредственным дочерним элементам
for child in nodeИтерировать прямых потомков
GetChildNodes(Type)(Type) -> list[Type]: рекурсивный, поиск в глубину всего поддерева, включая self

ImageRenderOptions

ImageRenderOptions CompositeNode. Представляет страницу OneNote.

ImageRenderOptionsImageRenderOptionsImageRenderOptions
Title`TitleNone`
Author`strNone`
CreationTime`datetimeNone`
LastModifiedTime`datetimeNone`
Level`intNone`

ImageRenderOptions:

ImageRenderOptionsImageRenderOptions
Clone(deep=False)Возвращает поверхностную или глубокую копию страницы

ImageRenderOptions

ImageRenderOptions CompositeNode. Содержит блок заголовка Page.

ImageRenderOptionsImageRenderOptionsImageRenderOptions
TitleText`RichTextNone`
TitleDate`RichTextNone`
TitleTime`RichTextNone`

ImageRenderOptions

ImageRenderOptions CompositeNode. Позиционный контейнер для OutlineElement узлов.

ImageRenderOptionsImageRenderOptionsImageRenderOptions
X`floatNone`
Y`floatNone`
Width`floatNone`

OutlineElement

ImageRenderOptions CompositeNode. Листовой контейнер, содержащий узлы контента.

ImageRenderOptionsImageRenderOptionsImageRenderOptions
IndentLevelintГлубина вложения (0 = самая внешняя)
NumberList`NumberListNone`
Tagslist[NoteTag]Теги OneNote, прикреплённые к этому элементу

RichText

ImageRenderOptions CompositeNode. Блок стилизованного текста.

ImageRenderOptionsImageRenderOptionsImageRenderOptions
TextstrПолная строка простого текста (все фрагменты объединены)
Runslist[TextRun]Упорядоченный список отформатированных сегментов
FontSize`floatNone`
Tagslist[NoteTag]Теги OneNote, прикреплённые к этому блоку

ImageRenderOptions:

ImageRenderOptionsImageRenderOptionsImageRenderOptions
Append(text, style=None)`(str, TextStyleNone) -> RichText`
Replace(old_value, new_value)(str, str) -> NoneПодстановка строк в памяти на Text; не обновляется Runs

TextRun

ImageRenderOptions Node. Один отформатированный текстовый сегмент.

ImageRenderOptionsImageRenderOptionsImageRenderOptions
TextstrТекстовое содержимое сегмента (по умолчанию "")
StyleTextStyleСвойства форматирования
Start`intNone`
End`intNone`

TextStyle

ImageRenderOptions Node. Свойства форматирования для каждого символа в TextRun.

ImageRenderOptionsImageRenderOptionsImageRenderOptionsImageRenderOptions
BoldboolFalseImageRenderOptions
ItalicboolFalseImageRenderOptions
UnderlineboolFalseImageRenderOptions
StrikethroughboolFalseImageRenderOptions
SuperscriptboolFalseImageRenderOptions
SubscriptboolFalseImageRenderOptions
FontName`strNone`None
FontSize`floatNone`None
FontColor`intNone`None
HighlightColor`intNone`None
LanguageId`intNone`None
IsHyperlinkboolFalseЯвляется ли этот фрагмент гиперссылкой
HyperlinkAddress`strNone`None

ImageRenderOptions

ImageRenderOptions CompositeNode. Встроенное изображение.

ImageRenderOptionsImageRenderOptionsImageRenderOptions
FileName`strNone`
BytesbytesНеобработанные данные изображения (по умолчанию b"")
Width`floatNone`
Height`floatNone`
AlternativeTextTitle`strNone`
AlternativeTextDescription`strNone`
HyperlinkUrl`strNone`
Tagslist[NoteTag]Теги OneNote, прикреплённые к этому изображению

ImageRenderOptions:

ImageRenderOptionsImageRenderOptions
Replace(image)ImageRenderOptions Bytes и FileName из другого Image узла в этот

AttachedFile

ImageRenderOptions CompositeNode. Встроенное вложение файла.

ImageRenderOptionsImageRenderOptionsImageRenderOptions
FileName`strNone`
BytesbytesНеобработанные данные файла (по умолчанию b"")
Tagslist[NoteTag]Теги OneNote, прикреплённые к этому вложению

ImageRenderOptions

ImageRenderOptions CompositeNode. Таблица внутри OutlineElement.

ImageRenderOptionsImageRenderOptionsImageRenderOptionsImageRenderOptions
Columnslist[float][]Ширина каждого столбца в пунктах
IsBordersVisibleboolTrueОтображаются ли границы таблицы
Tagslist[NoteTag][]Теги OneNote, прикреплённые к этой таблице

TableRow

ImageRenderOptions CompositeNode. Строка внутри a Table. Итерация GetChildNodes(TableCell) для доступа к ячейкам.

TableCell

ImageRenderOptions CompositeNode. Ячейка внутри a TableRow. Содержит RichText, Image, и другие узлы контента.

NoteTag

ImageRenderOptions Node. Тег OneNote, прикреплённый к узлу контента.

ImageRenderOptionsImageRenderOptionsImageRenderOptionsImageRenderOptions
shape`intNone`None
label`strNone`None
text_color`intNone`None
highlight_color`intNone`None
created`intNone`None
completed`intNone`None

Примечание к метке времени: created и completed являются необработанными целочисленными метками времени, полученными из двоичного формата MS-ONE, а не datetime объектами.

Фабричные методы:

ImageRenderOptionsImageRenderOptions
NoteTag.CreateYellowStar()Создаёт a NoteTag(shape=None, label="Yellow Star")

NumberList

ImageRenderOptions Node. Метаданные нумерованных или маркированных списков в OutlineElement.

ImageRenderOptionsImageRenderOptionsImageRenderOptionsImageRenderOptions
Format`strNone`None
Restart`intNone`None
IsNumberedboolFalseTrue для упорядоченных (нумерованных) списков

LoadOptions

ImageRenderOptionsImageRenderOptionsImageRenderOptionsImageRenderOptions
DocumentPassword`strNone`None
LoadHistoryboolFalseПоле совместимости API; функционально не используется в v26.3.1

SaveOptions

Базовый класс для всех параметров сохранения. Требуемый позиционный аргумент.

ImageRenderOptionsImageRenderOptionsImageRenderOptions
SaveFormatSaveFormatЦелевой формат сохранения

PdfSaveOptions

ImageRenderOptions SaveOptions. Специфическая для PDF конфигурация экспорта. Создайте с помощью PdfSaveOptions(SaveFormat.Pdf).

ImageRenderOptionsImageRenderOptionsImageRenderOptionsImageRenderOptions
PageIndexint0Поле существует; не передаётся в PDF‑экспортер в версии v26.3.1: не влияет на вывод
PageCount`intNone`None
TagIconDir`strNone`None
TagIconSize`floatNone`None
TagIconGap`floatNone`None

PageIndex / PageCount предупреждение: Эти поля объявлены в PdfSaveOptions для совместимости API, но Document.Save() реализация в версии v26.3.1 не читает их и не передаёт в PDF‑экспортер. Все страницы всегда экспортируются.

Лицензия и Metered

Экспортированы заглушки совместимости для соответствия форме API Aspose.Note для .NET. Все методы являются пустыми (no‑ops) в этой FOSS‑реализации.

from aspose.note import License, Metered

lic = License()
lic.SetLicense("path/to/license.lic")  # no-op

m = Metered()
m.SetMeteredKey("public_key", "private_key")  # no-op

Для использования любой функции Aspose.Note FOSS для Python ключ лицензии не требуется.

ImageRenderOptions

Полный справочник перечисления: ImageRenderOptions

SaveFormat

ImageRenderOptionsImageRenderOptions
SaveFormat.PdfPDF‑экспорт: реализован; требует pip install "aspose-note[pdf]"
SaveFormat.OneФормат OneNote: только объявлен; вызывает UnsupportedSaveFormatException

FileFormat

Значения перечисления, представляющие версию формата файла OneNote. Document.FileFormat предоставляет максимально возможное указание.

ImageRenderOptionsСтроковое значение
FileFormat.OneNote2010"onenote2010"
FileFormat.OneNoteOnline"onenoteonline"
FileFormat.OneNote2007"onenote2007"

HorizontalAlignment

ImageRenderOptionsСтроковое значение
HorizontalAlignment.Left"left"
HorizontalAlignment.Center"center"
HorizontalAlignment.Right"right"

NodeType

ImageRenderOptionsСтроковое значение
NodeType.Document"document"
NodeType.Page"page"
NodeType.Outline"outline"
NodeType.OutlineElement"outline_element"
NodeType.RichText"rich_text"
NodeType.Image"image"
NodeType.Table"table"
NodeType.AttachedFile"attached_file"

ImageRenderOptions

Полная справка об исключении: ImageRenderOptions

ImageRenderOptionsImageRenderOptions
AsposeNoteErrorБазовый класс для всех Aspose.Note FOSS исключений
FileCorruptedExceptionImageRenderOptions .one файл не может быть разобран (повреждённый или некорректный бинарный)
IncorrectDocumentStructureExceptionСтруктура файла недействительна или не поддерживается
IncorrectPasswordExceptionВызывается, когда LoadOptions.DocumentPassword установлен; зашифрованные документы не поддерживаются
UnsupportedFileFormatExceptionФормат файла не распознан; раскрывает a FileFormat поле (string)
UnsupportedSaveFormatExceptionЗапрошенный SaveFormat не реализовано в этой версии

См. также

 Русский