Aspose.Note FOSS за Python

Тази референция обхваща цялата публична API повърхност на aspose-note версия 26.3.1. само символи, изнасяни от aspose.note Всичко, което се съдържа в това пакетно съобщение е документирано тук. aspose.note._internal е подробност за изпълнението и може да се промени без предизвестие.

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

Внос на продукти от други държави членки: from aspose.note import Document, RichText, ...

Класове

Install: pip install aspose-note (core) or pip install "aspose-note[pdf]" (with PDF export)

Документ и преминаване през него

Класът	Описание на състоянието
`Document`	Root документ обект. Представя OneNote документ; итерации страници и износ на PDF.
`DocumentVisitor`	Абстрактна база за преминаване на паттерн от посетители в дървото на документа.
`Node`	Базов клас за всички документни възли.
`CompositeNode`	Базов клас за възли, които могат да съдържат деца.

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

Класът	Описание на състоянието
`Page`	Представя страница OneNote.
`Title`	Блок заглавие на страница, съдържащ TitleText, TitleDate,TitleTime.
`Outline`	Позиционен контейнер за OutlineElement възли.
`OutlineElement`	Листово съдче; съдържа RichText, Image, Table, AttachedFile.

Съдържание на документа

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

Възможности за избор

Класът	Описание на състоянието
`LoadOptions`	Възможности за натоварване на а `.one` - Да, сър.
`SaveOptions`	Базов клас за опции за запазване.
`PdfSaveOptions` (вж. опции и параметри)	Класа опции за износ на документи: контролира компресията на изображенията, качеството в JPEG и настройките на страниците за PDF.

Съвместимостни колонки

Класът	Описание на състоянието
`License`	Съвместимост: `SetLicense()` е без операция в тази реализация на FOSS.
`Metered`	Съвместимост: `SetMeteredKey()` е без операция в тази реализация на FOSS.

Детайли за класа

Документът

Класата на коренния документ. .one файл от пътека за файлове, а pathlib.Path,или двоичен поток.

from aspose.note import Document, LoadOptions

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

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

Параметър:	Тип на изпитване	Описание на състоянието
`source`	`str	Path
`load_options`	`LoadOptions	None`

Свойства на веществата:

Имотът	Тип на изпитване	Описание на състоянието
`FileFormat`	`FileFormat`	Показание за най-добрият опит на формата на файла OneNote

Методи за изчисляване на данните:

Методът:	Подписът	Описание на състоянието
`GetPageHistory(page)`	`(Page) -> PageHistory`	Връщане на средства `[page]` (стаб; пълната история все още не е внедрена)
`DetectLayoutChanges()`	`() -> None`	Съвместимост; без операция
`Save(target, format_or_options)`	`(str	Path
`Accept(visitor)`	`(DocumentVisitor) -> None`	Призоваване на преминаването на посетителите
`for page in doc`	N/A	Итеративно пряко дете `Page` възела

Document.FileFormat бележка:: Свойството дава най-доброто указание за формата на файла OneNote. FileFormat enum има три стойности: OneNote2010, OneNoteOnline, и OneNote2007.

Document.Save() Подкрепа за потока: target може да бъде двоичен поток (io.BytesIO, файлов ръководство, отворено в режим на двоично записване и т.н.).

DocumentVisitor

Абстрактен базов клас за преминаване на посетителски модели. Прехвърляне на необходимите ви методи:

Методът:	Обади се, когато…
`VisitDocumentStart(doc)`	Влизане на възел от документ
`VisitDocumentEnd(doc)`	Оставяне на възел за документ
`VisitPageStart(page)`	Влизане на страничен възел
`VisitPageEnd(page)`	Оставяне на страничен възел
`VisitTitleStart(title)`	Вписване на възел за заглавие
`VisitTitleEnd(title)`	Оставяне на възел за заглавие
`VisitOutlineStart(outline)`	Влизане на възел за очертания
`VisitOutlineEnd(outline)`	Оставяне на възел за очертания
`VisitOutlineElementStart(oe)`	Влизане в възел OutlineElement
`VisitOutlineElementEnd(oe)`	Оставяне на OutlineElement възел
`VisitRichTextStart(rt)`	Влизане в възел RichText
`VisitRichTextEnd(rt)`	Оставяне на RichText възел
`VisitImageStart(img)`	Влизане на възел за изображение
`VisitImageEnd(img)`	Оставяне на възел за изображение

Кръголов възел

Базов клас за всички възела на дървото.

Свойство / метод	Тип на изпитване	Описание на състоянието
`ParentNode`	`Node	None`
`Document`	`Document	None`
`Accept(visitor)`	`(DocumentVisitor) -> None`	Изпращане на посетители за този възел

CompositeNode

Разширява се Node.Добавя се:

Свойство / метод	Описание на състоянието
`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`

Страница

Разширява се CompositeNode. Представя страница OneNote.

Имотът	Тип на изпитване	Описание на състоянието
`Title`	`Title	None`
`Author`	`str	None`
`CreationTime`	`datetime	None`
`LastModifiedTime`	`datetime	None`
`Level`	`int	None`

Методи за изчисляване на данните:

Методът:	Описание на състоянието
`Clone(deep=False)`	Върнете плитък или дълбок клон на страницата

Заглавие:

Разширява се CompositeNode.Задържа титулния блок на “А” Page.

Имотът	Тип на изпитване	Описание на състоянието
`TitleText`	`RichText	None`
`TitleDate`	`RichText	None`
`TitleTime`	`RichText	None`

Оригинални данни

Разширява се CompositeNode.Позиционен контейнер за OutlineElement възела.

Имотът	Тип на изпитване	Описание на състоянието
`HorizontalOffset`	`float	None`
`VerticalOffset`	`float	None`
`MaxWidth`	`float	None`
`MaxHeight`	`float	None`
`MinWidth`	`float	None`
`ReservedWidth`	`float	None`
`IndentPosition`	`float	None`

OutlineElement

Разширява се CompositeNode.Контейнер с листа, който съдържа възела.

Имотът	Тип на изпитване	Описание на състоянието
`NumberList`	`NumberList	None`

RichText

Разширява се Node.- Блок от стилизиран текст.

Имотът	Тип на изпитване	Описание на състоянието
`Text`	`str`	Пълен текст на синхрон (всички цикли са свързани)
`TextRuns`	`list[TextRun]`	Поръчен списък на форматираните сегменти
`Tags`	`list[NoteTag]`	OneNote етикети, прикрепени към този блок

Методи за изчисляване на данните:

Методът:	Подписът	Описание на състоянието
`Append(text, style=None)`	`(str, TextStyle	None) -> RichText`
`Replace(old_value, new_value)`	`(str, str) -> None`	Замяната на вградените стълбове от паметта върху `Text`; не актуализира `TextRuns`

TextRun

Един форматиран текстов сегмент в рамките на: RichText.TextRuns.

Имотът	Тип на изпитване	Описание на състоянието
`Text`	`str`	Текстовото съдържание на сегмента (по подразбиране) `""`)
`Style`	`TextStyle`	Свойства на форматиране

TextStyle

Свойства за форматиране на всеки символ за TextRun.

Имотът	Тип на изпитване	По подразбиране:	Описание на състоянието
`IsBold`	`bool`	`False`	Смело.
`IsItalic`	`bool`	`False`	Курсиво
`IsUnderline`	`bool`	`False`	Подчертаване на
`IsStrikethrough`	`bool`	`False`	Продължително действие
`IsSuperscript`	`bool`	`False`	Награден текст
`IsSubscript`	`bool`	`False`	Подписване на документа
`FontName`	`str	None`	`None`
`FontSize`	`float	None`	`None`
`FontColor`	`int	None`	`None`
`Highlight`	`int	None`	`None`
`Language`	`int	None`	`None`
`IsHyperlink`	`bool`	`False`	Дали това е хипервръзка.
`HyperlinkAddress`	`str	None`	`None`

Снимка

Разширява се CompositeNode.Вграден образ.

Имотът	Тип на изпитване	Описание на състоянието
`FileName`	`str	None`
`FilePath`	`str	None`
`Format`	`str	None`
`Bytes`	`bytes`	Необработени данни за байтове на изображение (по подразбиране) `b""`)
`OriginalWidth`	`float	None`
`OriginalHeight`	`float	None`
`Alignment`	`HorizontalAlignment	None`
`Tags`	`list[NoteTag]`	OneNote етикети, свързани с това изображение

Методи за изчисляване на данните:

Методът:	Описание на състоянието
`Replace(image)`	Изключено. `Bytes` и в) `FileName` от друг. `Image` възел в този.

AttachedFile

Разширява се Node.Вграден файл с приложения.

Имотът	Тип на изпитване	Описание на състоянието
`FileName`	`str	None`
`Bytes`	`bytes`	Необработени данни от файл (по подразбиране) `b""`)
`Tags`	`list[NoteTag]`	OneNote етикети, прикрепени към този файл.

Таблица 1

Разширява се CompositeNode.Таблица в OutlineElement.

Имотът	Тип на изпитване	По подразбиране:	Описание на състоянието
`Columns`	`list[TableColumn]`	`[]`	Списък на метаданните от колони; всяка `TableColumn` има: `.Width` (плава) и `.LockedWidth` - Какво?
`Tags`	`list[NoteTag]`	`[]`	OneNote етикети, прикрепени към тази таблица

TableRow

Разширява се CompositeNode. ред в рамките на Table.Итерация GetChildNodes(TableCell) за достъп до клетки.

TableCell

Разширява се CompositeNode.Клетка в рамките на една клетка. TableRow.Съдържа: RichText, Image, и други съдържателни възли.

NoteTag

Тэг OneNote, прикрепен към възел за съдържание.

Имотът	Тип на изпитване	По подразбиране:	Описание на състоянието
`Icon`	`int	None`	`None`
`Label`	`str	None`	`None`
`FontColor`	`int	None`	`None`
`Highlight`	`int	None`	`None`
`CreationTime`	`datetime	None`	`None`
`CompletedTime`	`datetime	None`	`None`
`Status`	`TagStatus`	Произведени от:	`TagStatus.Completed` ако: `CompletedTime` е зададен, друго `TagStatus.Open`

Производствени методи:

Методът:	Описание на състоянието
`NoteTag.CreateYellowStar(label=None)`	Създава се: `NoteTag(Label="Yellow Star", Icon=13)`
`NoteTag.CreateQuestionMark(label=None)`	Създава се: `NoteTag(Label="Question Mark", Icon=15)`
`NoteTag.CreateMusicalNote(label=None)`	Създава се: `NoteTag(Label="Musical Note", Icon=121)`

NumberList

Метаданни от списък с номера или букети на OutlineElement.

Имотът	Тип на изпитване	По подразбиране:	Описание на състоянието
`Format`	`str	None`	`None`
`NumberFormat`	`str	None`	`None`
`Font`	`str	None`	`None`
`FontSize`	`float	None`	`None`
`FontColor`	`int	None`	`None`
`IsBold`	`bool`	`False`	Головочервено тегло за предписанието на списъка
`IsItalic`	`bool`	`False`	Курсивен стил за предписанието на списъка
`Restart`	`int	None`	`None`

LoadOptions

Имотът	Тип на изпитване	По подразбиране:	Описание на състоянието
`DocumentPassword`	`str	None`	`None`
`LoadHistory`	`bool`	`False`	Поле за съвместимост с API; не се използва функционално в версия 26.3.1

SaveOptions

Базов клас за опции за запазване.

Имотът	Тип на изпитване	Описание на състоянието
`SaveFormat`	`SaveFormat`	Формат на запазване на целевата цел

PdfSaveOptions

Разширява се SaveOptions.Конфигурация за износ, специфична за PDF. Създаване с PdfSaveOptions() (всички аргументи са само за ключови думи с депонирани).

Имотът	Тип на изпитване	По подразбиране:	Описание на състоянието
`PageIndex`	`int`	`0`	Поле съществува; не е изпратено на износителя PDF в версия 26.3.1: няма ефект върху продукцията.
`PageCount`	`int	None`	`None`
`ImageCompression`	`Any	None`	`None`
`JpegQuality`	`int	None`	`None`
`PageSettings`	`Any	None`	`None`
`PageSplittingAlgorithm`	`Any	None`	`None`

PageIndex / PageCount Предупреждение::Тези полета се декларират на: PdfSaveOptions за съвместимост с API, но Document.Save() Използването в версия 26.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 for Python.

Изброявания

Пълен преброяване на референтния номер: Изброявания

SaveFormat

Стойност	Описание на състоянието
`SaveFormat.Pdf`	PDF износ: изпълнен; изисква `pip install "aspose-note[pdf]"`

FileFormat

Енуми стойности, представляващи версията на формата на файла OneNote. Document.FileFormat дава индикация за най-добър опит.

Стойност	Стойност на нишката
`FileFormat.OneNote2010`	`"onenote2010"`
`FileFormat.OneNoteOnline`	`"onenoteonline"`
`FileFormat.OneNote2007`	`"onenote2007"`

HorizontalAlignment

Стойност	Стойност на нишката
`HorizontalAlignment.Left`	`"left"`
`HorizontalAlignment.Center`	`"center"`
`HorizontalAlignment.Right`	`"right"`

NodeType

Стойност	Стойност на нишката
`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"`

Изключения

Пълен референтен номер за изключение: Изключения

Изключение	Описание на състоянието
`AsposeNoteError`	Базов клас за всички Aspose.Note FOSS изключения
`FileCorruptedException`	Съветът на ЕС `.one` файлът не може да бъде анализиран (покварен или неправилно оформен двоичен)
`IncorrectDocumentStructureException`	Структурата на файла е невалидна или не поддържана.
`IncorrectPasswordException`	Подигнато когато: `LoadOptions.DocumentPassword` е зададен; не се поддържат криптирани документи
`UnsupportedFileFormatException`	Форматът на файла не е разпознат; излагане на `FileFormat` поле (струнка)
`UnsupportedSaveFormatException`	Заявените от Комисията `SaveFormat` не е внедрена в тази версия.

Aspose.Note FOSS за Python

Класове

Документ и преминаване през него

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

Съдържание на документа

Възможности за избор

Съвместимостни колонки

Детайли за класа

Документът

DocumentVisitor

Кръголов възел

CompositeNode

Страница

Заглавие:

Оригинални данни

OutlineElement

RichText

TextRun

TextStyle

Снимка

AttachedFile

Таблица 1

TableRow

TableCell

NoteTag

NumberList

LoadOptions

SaveOptions

PdfSaveOptions

Лицензия и измерване

Изброявания

SaveFormat

FileFormat

HorizontalAlignment

NodeType

Изключения

Вижте също: