Aspose.Note FOSS for Python

Ця довідка охоплює повну публічну поверхню API aspose-note версії 26.3.1. Лише символи, експортовані з aspose.note пакету документуються тут. Все, що знаходиться під aspose.note._internal є деталлю реалізації і може змінитися без попередження.

Enumerations: pip install aspose-note (core) або pip install "aspose-note[pdf]" (з експортом у PDF)

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

Enumerations

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

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

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

EnumerationsEnumerations
PageПредставляє сторінку OneNote.
TitleБлок заголовка сторінки, що містить TitleText, TitleDate, TitleTime.
OutlineПозиційний контейнер для вузлів OutlineElement.
OutlineElementЛистковий контейнер; містить RichText, Image, Table, AttachedFile.

Enumerations

EnumerationsEnumerations
RichTextТекстовий блок з форматованими ділянками, тегами та гіперпосиланнями.
TextRunОдин форматований текстовий сегмент у межах RichText.
TextStyleВластивості форматування для TextRun.
ImageВбудоване зображення з необробленими байтами та метаданими.
AttachedFileВбудоване файлове вкладення з необробленими байтами.
TableТаблиця з рядками, клітинками та ширинами стовпців.
TableRowРядок у таблиці.
TableCellКлітинка у TableRow; містить вузли вмісту.
NoteTagТег OneNote (зірочка, прапорець тощо), прикріплений до вузла вмісту.
NumberListМетадані нумерованого списку в OutlineElement.

Enumerations

EnumerationsEnumerations
LoadOptionsПараметри завантаження a .one файл.
SaveOptionsБазовий клас для параметрів збереження.
PdfSaveOptionsПараметри збереження, специфічні для PDF (значки тегів).

Заглушки сумісності

EnumerationsEnumerations
LicenseЗаглушка сумісності: SetLicense() не виконує жодних дій у цій FOSS-реалізації.
MeteredЗаглушка сумісності: SetMeteredKey() є нульовою операцією в цій FOSS-реалізації.

Деталі класу

Enumerations

Клас кореневого документа. Завантажте .one файл за шляхом до файлу, pathlib.Path,або бінарний потік.

from aspose.note import Document, LoadOptions

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

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

EnumerationsEnumerationsEnumerations
source`strPath
load_options`LoadOptionsNone`

Enumerations:

EnumerationsEnumerationsEnumerations
DisplayName`strNone`
CreationTime`datetimeNone`
FileFormatFileFormatНайкраща спроба вказати версію формату файлу OneNote

Enumerations:

EnumerationsEnumerationsEnumerations
Count()() -> intКількість прямих дочірніх сторінок
GetPageHistory(page)(Page) -> list[Page]Enumerations [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, які вам потрібні:

EnumerationsВикликається коли
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

Enumerations

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

Властивість / МетодEnumerationsEnumerations
ParentNode`NodeNone`
Document`DocumentNone`
Accept(visitor)(DocumentVisitor) -> NoneВикликати відвідувача для цього вузла

CompositeNode

Enumerations Node. Додає керування дочірніми елементами:

Властивість / МетодEnumerations
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

Enumerations

Enumerations CompositeNode. Представляє сторінку OneNote.

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

Enumerations:

EnumerationsEnumerations
Clone(deep=False)Повернути поверхневий або глибокий клон сторінки

Enumerations

Enumerations CompositeNode. Містить блок заголовка Page.

EnumerationsEnumerationsEnumerations
TitleText`RichTextNone`
TitleDate`RichTextNone`
TitleTime`RichTextNone`

Enumerations

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

EnumerationsEnumerationsEnumerations
X`floatNone`
Y`floatNone`
Width`floatNone`

OutlineElement

Enumerations CompositeNode. Контейнер‑лист, який містить вузли вмісту.

EnumerationsEnumerationsEnumerations
IndentLevelintГлибина вкладення (0 = найзовнішня)
NumberList`NumberListNone`
Tagslist[NoteTag]Теги OneNote, прикріплені до цього елемента

RichText

Enumerations CompositeNode. Блок стилізованого тексту.

EnumerationsEnumerationsEnumerations
TextstrПовний рядок простого тексту (усі фрагменти об’єднані)
Runslist[TextRun]Впорядкований список форматованих сегментів
FontSize`floatNone`
Tagslist[NoteTag]Теги OneNote, прикріплені до цього блоку

Enumerations:

EnumerationsEnumerationsEnumerations
Append(text, style=None)`(str, TextStyleNone) -> RichText`
Replace(old_value, new_value)(str, str) -> NoneЗаміна рядка у пам’яті на Text; не оновлюється Runs

TextRun

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

EnumerationsEnumerationsEnumerations
TextstrТекстовий вміст сегмента (за замовчуванням "")
StyleTextStyleВластивості форматування
Start`intNone`
End`intNone`

TextStyle

Enumerations Node. Властивості форматування на символ для TextRun.

EnumerationsEnumerationsEnumerationsEnumerations
BoldboolFalseEnumerations
ItalicboolFalseEnumerations
UnderlineboolFalseEnumerations
StrikethroughboolFalseEnumerations
SuperscriptboolFalseEnumerations
SubscriptboolFalseEnumerations
FontName`strNone`None
FontSize`floatNone`None
FontColor`intNone`None
HighlightColor`intNone`None
LanguageId`intNone`None
IsHyperlinkboolFalseЧи є цей фрагмент гіперпосиланням
HyperlinkAddress`strNone`None

Enumerations

Enumerations CompositeNode. Вбудоване зображення.

EnumerationsEnumerationsEnumerations
FileName`strNone`
BytesbytesНеоброблені дані зображення (за замовчуванням b"")
Width`floatNone`
Height`floatNone`
AlternativeTextTitle`strNone`
AlternativeTextDescription`strNone`
HyperlinkUrl`strNone`
Tagslist[NoteTag]Теги OneNote, прикріплені до цього зображення

Enumerations:

EnumerationsEnumerations
Replace(image)Enumerations Bytes і FileName з іншого Image вузла в цей

AttachedFile

Enumerations CompositeNode. Вбудоване вкладення файлу.

EnumerationsEnumerationsEnumerations
FileName`strNone`
BytesbytesНеоброблені дані файлу (за замовчуванням b"")
Tagslist[NoteTag]Теги OneNote, прикріплені до цього вкладення

Enumerations

Enumerations CompositeNode. Таблиця всередині OutlineElement.

EnumerationsEnumerationsEnumerationsEnumerations
Columnslist[float][]Ширина кожного стовпця в пунктах
IsBordersVisibleboolTrueЧи видимі межі таблиці
Tagslist[NoteTag][]Теги OneNote, прикріплені до цієї таблиці

TableRow

Enumerations CompositeNode. Рядок всередині a Table. Ітерувати GetChildNodes(TableCell) для доступу до клітинок.

TableCell

Enumerations CompositeNode. Клітинка всередині a TableRow. Містить RichText, Image, та інші вузли вмісту.

NoteTag

Enumerations Node. Тег OneNote, прикріплений до вузла вмісту.

EnumerationsEnumerationsEnumerationsEnumerations
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 об’єктами.

Методи фабрики:

EnumerationsEnumerations
NoteTag.CreateYellowStar()Створює a NoteTag(shape=None, label="Yellow Star")

NumberList

Enumerations Node. Метадані нумерованих або маркованих списків у OutlineElement.

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

LoadOptions

EnumerationsEnumerationsEnumerationsEnumerations
DocumentPassword`strNone`None
LoadHistoryboolFalseПоле сумісності API; функціонально не використовується у v26.3.1

SaveOptions

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

EnumerationsEnumerationsEnumerations
SaveFormatSaveFormatЦільовий формат збереження

PdfSaveOptions

Enumerations SaveOptions. Специфічна для PDF конфігурація експорту. Створюється за допомогою PdfSaveOptions(SaveFormat.Pdf).

EnumerationsEnumerationsEnumerationsEnumerations
PageIndexint0Поле існує; не передається експортеру PDF у v26.3.1: не впливає на результат
PageCount`intNone`None
TagIconDir`strNone`None
TagIconSize`floatNone`None
TagIconGap`floatNone`None

PageIndex / PageCount застереження: Ці поля оголошені в PdfSaveOptions для сумісності API, але the Document.Save() реалізація у v26.3.1 не читає їх і не передає їх у PDF-експортер. Усі сторінки завжди експортуються.

Ліцензія та облік використання

Експортовані заглушки сумісності для забезпечення сумісної форми API з Aspose.Note для .NET. У цій 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 не потрібен ліцензійний ключ.

Enumerations

Повний перелік перерахувань: Enumerations

SaveFormat

EnumerationsEnumerations
SaveFormat.PdfPDF export: реалізовано; вимагає pip install "aspose-note[pdf]"
SaveFormat.OneOneNote format: лише оголошено; викликає UnsupportedSaveFormatException

FileFormat

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

EnumerationsРядкове значення
FileFormat.OneNote2010"onenote2010"
FileFormat.OneNoteOnline"onenoteonline"
FileFormat.OneNote2007"onenote2007"

HorizontalAlignment

EnumerationsРядкове значення
HorizontalAlignment.Left"left"
HorizontalAlignment.Center"center"
HorizontalAlignment.Right"right"

NodeType

EnumerationsРядкове значення
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"

Enumerations

Повна довідка про виключення: Enumerations

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

Див. також

 Українська