Aspose.Note FOSS for Python
Táto referencia pokrýva kompletný verejný povrch API verzie aspose-note 26.3.1. Iba symboly exportované z aspose.note balíka sú dokumentované tu. Čokoľvek pod aspose.note._internal je detail implementácie a môže sa zmeniť bez upozornenia.
ImageRenderOptions: pip install aspose-note (core) alebo pip install "aspose-note[pdf]" (s exportom PDF)
ImageRenderOptions: from aspose.note import Document, RichText, ...
ImageRenderOptions
Dokument a prechádzanie
| ImageRenderOptions | ImageRenderOptions |
|---|---|
Document | Koreňový objekt dokumentu. Načítajte .one súbor, prechádzajte stránky a uložte do PDF. |
DocumentVisitor | Abstraktný základ pre prechádzanie stromom dokumentu pomocou vzoru návštevníka. |
Node | Základná trieda pre všetky uzly dokumentu. |
CompositeNode | Základná trieda pre uzly, ktoré môžu obsahovať poduzly. |
Štruktúra dokumentu
| ImageRenderOptions | ImageRenderOptions |
|---|---|
Page | Reprezentuje stránku OneNote. |
Title | Blok titulku stránky obsahujúci TitleText, TitleDate, TitleTime. |
Outline | Pozicionálny kontajner pre uzly OutlineElement. |
OutlineElement | Listový kontajner; obsahuje RichText, Image, Table, AttachedFile. |
ImageRenderOptions
| ImageRenderOptions | ImageRenderOptions |
|---|---|
RichText | Textový blok s formátovacími úsekmi, značkami a hyperodkazmi. |
TextRun | Jednotlivý formátovaný textový segment v RichText. |
TextStyle | Formátovacie vlastnosti pre TextRun. |
Image | Vložený obrázok s nespracovanými bajtmi a metadátami. |
AttachedFile | Vložená príloha súboru s nespracovanými bajtmi. |
Table | Tabuľka s riadkami, bunkami a šírkami stĺpcov. |
TableRow | Riadok v tabuľke. |
TableCell | Bunka v TableRow; obsahuje uzly obsahu. |
NoteTag | Značka OneNote (hviezdička, zaškrtávacie políčko atď.) pripojená k uzlu obsahu. |
NumberList | Metadáta číslovaného zoznamu na OutlineElement. |
ImageRenderOptions
| ImageRenderOptions | ImageRenderOptions |
|---|---|
LoadOptions | Možnosti načítania .one súbor. |
SaveOptions | Základná trieda pre možnosti ukladania. |
PdfSaveOptions | Možnosti ukladania špecifické pre PDF (ikony značiek). |
Kompatibilné stuby
| ImageRenderOptions | ImageRenderOptions |
|---|---|
License | Kompatibilná náhrada: SetLicense() je v tejto FOSS implementácii nečinná operácia. |
Metered | Kompatibilná náhrada: SetMeteredKey() je v tejto FOSS implementácii nečinná operácia. |
Detaily triedy
ImageRenderOptions
Koreňová trieda dokumentu. Načítajte .one súbor z cesty k súboru, a pathlib.Path, alebo binárny prúd.
from aspose.note import Document, LoadOptions
doc = Document(source=None, load_options=None)Parametre konštruktora:
| ImageRenderOptions | ImageRenderOptions | ImageRenderOptions |
|---|---|---|
source | `str | Path |
load_options | `LoadOptions | None` |
ImageRenderOptions:
| ImageRenderOptions | ImageRenderOptions | ImageRenderOptions |
|---|---|---|
DisplayName | `str | None` |
CreationTime | `datetime | None` |
FileFormat | FileFormat | Najlepšia snaha o určenie verzie formátu súboru OneNote |
ImageRenderOptions:
| ImageRenderOptions | ImageRenderOptions | ImageRenderOptions |
|---|---|---|
Count() | () -> int | Počet priamych podstránok |
GetPageHistory(page) | (Page) -> list[Page] | ImageRenderOptions [page] (zástupný kód; úplná história ešte nie je implementovaná) |
DetectLayoutChanges() | () -> None | Zástupný kód kompatibility; žiadna operácia |
Save(target, format_or_options) | `(str | Path |
Accept(visitor) | (DocumentVisitor) -> None | Vyvolať prechádzku návštevníka |
for page in doc | N/A | Iterovať priamych potomkov Page uzlov |
Document.FileFormat poznámka: Vlastnosť poskytuje najlepšiu snahu o určenie verzie formátu súboru OneNote. The FileFormat enum má tri hodnoty: OneNote2010, OneNoteOnline, a OneNote2007.
Document.Save() podpora streamu: target môže byť binárny stream (io.BytesIO, súborový handle otvorený v binárnom režime zápisu, atď.). Toto je potvrdené testovacou sadou: doc.Save(io.BytesIO(), PdfSaveOptions(SaveFormat.Pdf)).
DocumentVisitor
Abstraktná základná trieda pre prechádzanie podľa vzoru návštevníka. Predefinujte metódy návštevy, ktoré potrebujete:
| ImageRenderOptions | Volané, keď |
|---|---|
VisitDocumentStart(doc) | Vstup do uzla Document |
VisitDocumentEnd(doc) | Opustenie uzla Document |
VisitPageStart(page) | Vstup do uzla Page |
VisitPageEnd(page) | Opustenie uzla Page |
VisitTitleStart(title) | Vstup do uzla Title |
VisitTitleEnd(title) | Opustenie uzla Title |
VisitOutlineStart(outline) | Vstup do uzla Outline |
VisitOutlineEnd(outline) | Opustenie uzla Outline |
VisitOutlineElementStart(oe) | Vstup do uzla OutlineElement |
VisitOutlineElementEnd(oe) | Opustenie uzla OutlineElement |
VisitRichTextStart(rt) | Vstup do uzla RichText |
VisitRichTextEnd(rt) | Opustenie uzla RichText |
VisitImageStart(img) | Vstup do uzla Image |
VisitImageEnd(img) | Opustenie uzla Image |
ImageRenderOptions
Základná trieda pre všetky uzly stromu dokumentu.
| Vlastnosť / Metóda | ImageRenderOptions | ImageRenderOptions |
|---|---|---|
ParentNode | `Node | None` |
Document | `Document | None` |
Accept(visitor) | (DocumentVisitor) -> None | Rozposlať návštevníka pre tento uzol |
CompositeNode
ImageRenderOptions Node. Pridáva správu podriadených:
| Vlastnosť / Metóda | ImageRenderOptions |
|---|---|
FirstChild | Prvý podriadený uzol, alebo None |
LastChild | Posledný podriadený uzol, alebo None |
AppendChildLast(node) | Pridá podriadený uzol na koniec; nastaví node.ParentNode = self |
AppendChildFirst(node) | Pridá podriadený uzol na začiatok |
InsertChild(index, node) | Vloží podriadený uzol na zadanú pozíciu |
RemoveChild(node) | Odstráni podriadený uzol; nastaví node.ParentNode = None |
GetEnumerator() | Vráti iterátor nad priamymi podriadenými uzlami |
for child in node | Iterovať priamych podriadených |
GetChildNodes(Type) | (Type) -> list[Type]: rekurzívne, hĺbkové prehľadávanie celého podstromu vrátane self |
ImageRenderOptions
ImageRenderOptions CompositeNode. Predstavuje stránku OneNote.
| ImageRenderOptions | ImageRenderOptions | ImageRenderOptions |
|---|---|---|
Title | `Title | None` |
Author | `str | None` |
CreationTime | `datetime | None` |
LastModifiedTime | `datetime | None` |
Level | `int | None` |
ImageRenderOptions:
| ImageRenderOptions | ImageRenderOptions |
|---|---|
Clone(deep=False) | Vráti plytkú alebo hlbokú kópiu stránky |
ImageRenderOptions
ImageRenderOptions CompositeNode. Uchováva blok názvu Page.
| ImageRenderOptions | ImageRenderOptions | ImageRenderOptions |
|---|---|---|
TitleText | `RichText | None` |
TitleDate | `RichText | None` |
TitleTime | `RichText | None` |
ImageRenderOptions
ImageRenderOptions CompositeNode. Pozíciový kontajner pre OutlineElement uzly.
| ImageRenderOptions | ImageRenderOptions | ImageRenderOptions |
|---|---|---|
X | `float | None` |
Y | `float | None` |
Width | `float | None` |
OutlineElement
ImageRenderOptions CompositeNode. Listový kontajner, ktorý obsahuje obsahové uzly.
| ImageRenderOptions | ImageRenderOptions | ImageRenderOptions |
|---|---|---|
IndentLevel | int | Hĺbka vnorenia (0 = najvonkajší) |
NumberList | `NumberList | None` |
Tags | list[NoteTag] | OneNote značky pripojené k tomuto prvku |
RichText
ImageRenderOptions CompositeNode. Blok štýlovaného textu.
| ImageRenderOptions | ImageRenderOptions | ImageRenderOptions |
|---|---|---|
Text | str | Úplný reťazec obyčajného textu (všetky úseky zreťazené) |
Runs | list[TextRun] | Usporiadaný zoznam formátovaných segmentov |
FontSize | `float | None` |
Tags | list[NoteTag] | OneNote značky pripojené k tomuto bloku |
ImageRenderOptions:
| ImageRenderOptions | ImageRenderOptions | ImageRenderOptions |
|---|---|---|
Append(text, style=None) | `(str, TextStyle | None) -> RichText` |
Replace(old_value, new_value) | (str, str) -> None | Nahradenie reťazca v pamäti na Text; neaktualizuje sa Runs |
TextRun
ImageRenderOptions Node. Jeden formátovaný textový segment.
| ImageRenderOptions | ImageRenderOptions | ImageRenderOptions |
|---|---|---|
Text | str | Textový obsah segmentu (predvolené "") |
Style | TextStyle | Vlastnosti formátovania |
Start | `int | None` |
End | `int | None` |
TextStyle
ImageRenderOptions Node. Vlastnosti formátovania na znak pre TextRun.
| ImageRenderOptions | ImageRenderOptions | ImageRenderOptions | ImageRenderOptions |
|---|---|---|---|
Bold | bool | False | ImageRenderOptions |
Italic | bool | False | ImageRenderOptions |
Underline | bool | False | ImageRenderOptions |
Strikethrough | bool | False | ImageRenderOptions |
Superscript | bool | False | ImageRenderOptions |
Subscript | bool | False | ImageRenderOptions |
FontName | `str | None` | None |
FontSize | `float | None` | None |
FontColor | `int | None` | None |
HighlightColor | `int | None` | None |
LanguageId | `int | None` | None |
IsHyperlink | bool | False | Či je tento úsek hyperodkazom |
HyperlinkAddress | `str | None` | None |
ImageRenderOptions
ImageRenderOptions CompositeNode. Vložený obrázok.
| ImageRenderOptions | ImageRenderOptions | ImageRenderOptions |
|---|---|---|
FileName | `str | None` |
Bytes | bytes | Surové dáta obrázka (predvolené b"") |
Width | `float | None` |
Height | `float | None` |
AlternativeTextTitle | `str | None` |
AlternativeTextDescription | `str | None` |
HyperlinkUrl | `str | None` |
Tags | list[NoteTag] | OneNote značky pripojené k tomuto obrázku |
ImageRenderOptions:
| ImageRenderOptions | ImageRenderOptions |
|---|---|
Replace(image) | ImageRenderOptions Bytes a FileName z iného Image uzla do tohto |
AttachedFile
ImageRenderOptions CompositeNode. Vložená príloha súboru.
| ImageRenderOptions | ImageRenderOptions | ImageRenderOptions |
|---|---|---|
FileName | `str | None` |
Bytes | bytes | Surové dáta súboru (predvolené b"") |
Tags | list[NoteTag] | OneNote značky pripojené k tejto prílohe |
ImageRenderOptions
ImageRenderOptions CompositeNode. Tabuľka v rámci OutlineElementu.
| ImageRenderOptions | ImageRenderOptions | ImageRenderOptions | ImageRenderOptions |
|---|---|---|---|
Columns | list[float] | [] | Šírka každého stĺpca v bodoch |
IsBordersVisible | bool | True | Či sú okraje tabuľky viditeľné |
Tags | list[NoteTag] | [] | OneNote značky pripojené k tejto tabuľke |
TableRow
ImageRenderOptions CompositeNode. Riadok v rámci Table. Iterovať GetChildNodes(TableCell) na prístup k bunkám.
TableCell
ImageRenderOptions CompositeNode. Bunka v TableRow. Obsahuje RichText, Image, a ďalšie uzly obsahu.
NoteTag
ImageRenderOptions Node. Štítok OneNote pripojený k uzlu obsahu.
| ImageRenderOptions | ImageRenderOptions | ImageRenderOptions | ImageRenderOptions |
|---|---|---|---|
shape | `int | None` | None |
label | `str | None` | None |
text_color | `int | None` | None |
highlight_color | `int | None` | None |
created | `int | None` | None |
completed | `int | None` | None |
Poznámka k časovej značke: created a completed sú surové celočíselné časové značky parsované z binárneho formátu MS-ONE, nie datetime objekty.
Továrenské metódy:
| ImageRenderOptions | ImageRenderOptions |
|---|---|
NoteTag.CreateYellowStar() | Vytvára NoteTag(shape=None, label="Yellow Star") |
NumberList
ImageRenderOptions Node. Metadáta číslovaného alebo odrážkového zoznamu na OutlineElement.
| ImageRenderOptions | ImageRenderOptions | ImageRenderOptions | ImageRenderOptions |
|---|---|---|---|
Format | `str | None` | None |
Restart | `int | None` | None |
IsNumbered | bool | False | True pre usporiadané (číslované) zoznamy |
LoadOptions
| ImageRenderOptions | ImageRenderOptions | ImageRenderOptions | ImageRenderOptions |
|---|---|---|---|
DocumentPassword | `str | None` | None |
LoadHistory | bool | False | Pole kompatibility API; funkčne nepoužívané vo verzii v26.3.1 |
SaveOptions
Základná trieda pre všetky možnosti ukladania. Povinný pozičný argument.
| ImageRenderOptions | ImageRenderOptions | ImageRenderOptions |
|---|---|---|
SaveFormat | SaveFormat | Cieľový formát ukladania |
PdfSaveOptions
ImageRenderOptions SaveOptions. PDF‑špecifická konfigurácia exportu. Vytvorte pomocou PdfSaveOptions(SaveFormat.Pdf).
| ImageRenderOptions | ImageRenderOptions | ImageRenderOptions | ImageRenderOptions |
|---|---|---|---|
PageIndex | int | 0 | Pole existuje; neodovzdávané PDF exportéru vo verzii v26.3.1: nemá vplyv na výstup |
PageCount | `int | None` | None |
TagIconDir | `str | None` | None |
TagIconSize | `float | None` | None |
TagIconGap | `float | None` | None |
PageIndex / PageCount výhrada: Tieto polia sú deklarované na PdfSaveOptions pre kompatibilitu API, ale the Document.Save() implementácia vo verzii v26.3.1 nečítá ich ani ich neodovzdáva PDF exportéru. Všetky stránky sú vždy exportované.
Licencia a merané použitie
Exportované kompatibilné stuby pre zhodu tvaru API s Aspose.Note pre .NET. V tejto FOSS implementácii sú všetky metódy nečinné (no‑ops).
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-opNa použitie akejkoľvek funkcie Aspose.Note FOSS pre Python nie je potrebný licenčný kľúč.
ImageRenderOptions
Úplná referencia výčtu: ImageRenderOptions
SaveFormat
| ImageRenderOptions | ImageRenderOptions |
|---|---|
SaveFormat.Pdf | PDF export: implementovaný; vyžaduje pip install "aspose-note[pdf]" |
SaveFormat.One | Formát OneNote: iba deklarovaný; vyvoláva UnsupportedSaveFormatException |
FileFormat
Hodnoty výčtu predstavujúce verziu formátu súboru OneNote. Document.FileFormat poskytuje najlepšiu možnú indikáciu.
| ImageRenderOptions | Reťazcová hodnota |
|---|---|
FileFormat.OneNote2010 | "onenote2010" |
FileFormat.OneNoteOnline | "onenoteonline" |
FileFormat.OneNote2007 | "onenote2007" |
HorizontalAlignment
| ImageRenderOptions | Reťazcová hodnota |
|---|---|
HorizontalAlignment.Left | "left" |
HorizontalAlignment.Center | "center" |
HorizontalAlignment.Right | "right" |
NodeType
| ImageRenderOptions | Reťazcová hodnota |
|---|---|
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
Úplná referencia výnimiek: ImageRenderOptions
| ImageRenderOptions | ImageRenderOptions |
|---|---|
AsposeNoteError | Základná trieda pre všetky Aspose.Note FOSS výnimky |
FileCorruptedException | ImageRenderOptions .one súbor nie je možné analyzovať (poškodený alebo nesprávne formátovaný binárny súbor) |
IncorrectDocumentStructureException | Štruktúra súboru je neplatná alebo nepodporovaná |
IncorrectPasswordException | Vyvolané keď LoadOptions.DocumentPassword je nastavené; šifrované dokumenty nie sú podporované |
UnsupportedFileFormatException | Formát súboru nie je rozpoznaný; odhaľuje a FileFormat pole (string) |
UnsupportedSaveFormatException | Požadované SaveFormat nie je implementované v tejto verzii |