Aspose.Note FOSS for Python
Deze referentie behandelt de volledige publieke API-oppervlakte van aspose-note versie 26.3.1. Alleen symbolen die geëxporteerd zijn vanuit de aspose.note package worden hier gedocumenteerd. Alles onder aspose.note._internal is een implementatiedetail en kan zonder kennisgeving wijzigen.
ImageRenderOptions: pip install aspose-note (core) of pip install "aspose-note[pdf]" (met PDF-export)
ImageRenderOptions: from aspose.note import Document, RichText, ...
ImageRenderOptions
Document en Traversal
| ImageRenderOptions | ImageRenderOptions |
|---|---|
Document | Root documentobject. Laad een .one bestand, doorloop pagina’s en sla op als PDF. |
DocumentVisitor | Abstracte basis voor traverseren van de documentboom volgens het visitor-patroon. |
Node | Basisklasse voor alle documentknooppunten. |
CompositeNode | Basisklasse voor knooppunten die onderliggende knooppunten kunnen bevatten. |
Documentstructuur
| ImageRenderOptions | ImageRenderOptions |
|---|---|
Page | Stelt een OneNote-pagina voor. |
Title | Paginatitelblok dat TitleText, TitleDate, TitleTime bevat. |
Outline | Positionele container voor OutlineElement-knooppunten. |
OutlineElement | Bladcontainer; bevat RichText, Image, Table, AttachedFile. |
ImageRenderOptions
| ImageRenderOptions | ImageRenderOptions |
|---|---|
RichText | Tekstblok met opmaakreeksen, tags en hyperlinks. |
TextRun | Enkele geformatteerd tekstsegment binnen een RichText. |
TextStyle | Opmaak‑eigenschappen voor een TextRun. |
Image | Ingesloten afbeelding met ruwe bytes en metadata. |
AttachedFile | Ingesloten bestandsbijlage met ruwe bytes. |
Table | Tabel met rijen, cellen en kolombreedtes. |
TableRow | Een rij binnen een tabel. |
TableCell | Een cel binnen een TableRow; bevat content nodes. |
NoteTag | OneNote-tag (ster, selectievakje, enz.) gekoppeld aan een content node. |
NumberList | Genummerde lijstmetadata op een OutlineElement. |
ImageRenderOptions
| ImageRenderOptions | ImageRenderOptions |
|---|---|
LoadOptions | Opties voor het laden van een .one bestand. |
SaveOptions | Basisklasse voor opslaanopties. |
PdfSaveOptions | PDF-specifieke opslaanopties (tag‑iconen). |
Compatibiliteitsstubs
| ImageRenderOptions | ImageRenderOptions |
|---|---|
License | Compatibiliteitsstub: SetLicense() is een no‑op in deze FOSS-implementatie. |
Metered | Compatibiliteitsstub: SetMeteredKey() is een no‑op in deze FOSS-implementatie. |
Klasse-details
ImageRenderOptions
De root‑documentklasse. Laad een .one bestand vanaf een bestandspad, een pathlib.Path, of een binaire stream.
from aspose.note import Document, LoadOptions
doc = Document(source=None, load_options=None)Constructorparameters:
| ImageRenderOptions | ImageRenderOptions | ImageRenderOptions |
|---|---|---|
source | `str | Path |
load_options | `LoadOptions | None` |
ImageRenderOptions:
| ImageRenderOptions | ImageRenderOptions | ImageRenderOptions |
|---|---|---|
DisplayName | `str | None` |
CreationTime | `datetime | None` |
FileFormat | FileFormat | Indicatie, voor zover mogelijk, van de OneNote‑bestandsformaatversie |
ImageRenderOptions:
| ImageRenderOptions | ImageRenderOptions | ImageRenderOptions |
|---|---|---|
Count() | () -> int | Aantal directe onderliggende pagina’s |
GetPageHistory(page) | (Page) -> list[Page] | ImageRenderOptions [page] (stub; volledige geschiedenis nog niet geïmplementeerd) |
DetectLayoutChanges() | () -> None | Compatibiliteitsstub; geen bewerking |
Save(target, format_or_options) | `(str | Path |
Accept(visitor) | (DocumentVisitor) -> None | Bezoekertraversie aanroepen |
for page in doc | N/A | Itereer directe onderliggende Page knooppunten |
Document.FileFormat opmerking: De eigenschap geeft een indicatie, voor zover mogelijk, van de OneNote‑bestandsformaatversie. De FileFormat enum heeft drie waarden: OneNote2010, OneNoteOnline, en OneNote2007.
Document.Save() streamondersteuning: target kan een binaire stream zijn (io.BytesIO, bestandshandle geopend in binaire schrijfmethode, enz.). Dit wordt bevestigd door de testsuite: doc.Save(io.BytesIO(), PdfSaveOptions(SaveFormat.Pdf)).
DocumentVisitor
Abstracte basisklasse voor visitor‑pattern traversals. Overschrijf de bezoek‑methoden die je nodig hebt:
| ImageRenderOptions | Aangeroepen wanneer |
|---|---|
VisitDocumentStart(doc) | Documentknooppunt betreden |
VisitDocumentEnd(doc) | Documentknooppunt verlaten |
VisitPageStart(page) | Paginaknooppunt betreden |
VisitPageEnd(page) | Paginaknooppunt verlaten |
VisitTitleStart(title) | Titelknooppunt betreden |
VisitTitleEnd(title) | Titelknooppunt verlaten |
VisitOutlineStart(outline) | Outline‑knooppunt betreden |
VisitOutlineEnd(outline) | Outline‑knooppunt verlaten |
VisitOutlineElementStart(oe) | OutlineElement‑knooppunt betreden |
VisitOutlineElementEnd(oe) | OutlineElement‑knooppunt verlaten |
VisitRichTextStart(rt) | RichText‑knooppunt betreden |
VisitRichTextEnd(rt) | RichText‑knooppunt verlaten |
VisitImageStart(img) | Afbeeldingsknooppunt betreden |
VisitImageEnd(img) | Afbeeldingsknooppunt verlaten |
ImageRenderOptions
Basisklasse voor alle documentboomknooppunten.
| Eigenschap / Methode | ImageRenderOptions | ImageRenderOptions |
|---|---|---|
ParentNode | `Node | None` |
Document | `Document | None` |
Accept(visitor) | (DocumentVisitor) -> None | Verstuur bezoeker voor dit knooppunt |
CompositeNode
ImageRenderOptions Node. Voegt kindbeheer toe:
| Eigenschap / Methode | ImageRenderOptions |
|---|---|
FirstChild | Eerste kindknooppunt, of None |
LastChild | Laatste kindknooppunt, of None |
AppendChildLast(node) | Voeg een kindknooppunt toe aan het einde; stelt node.ParentNode = self |
AppendChildFirst(node) | Voeg een kindknooppunt toe aan het begin |
InsertChild(index, node) | Voeg een kind in op de opgegeven positie |
RemoveChild(node) | Verwijder een kindknooppunt; stelt node.ParentNode = None |
GetEnumerator() | Retourneert een iterator over directe kinderen |
for child in node | Itereer over directe kinderen |
GetChildNodes(Type) | (Type) -> list[Type]: recursief, diepte-eerst zoekopdracht van de volledige subboom inclusief self |
ImageRenderOptions
ImageRenderOptions CompositeNode. Vertegenwoordigt een OneNote-pagina.
| ImageRenderOptions | ImageRenderOptions | ImageRenderOptions |
|---|---|---|
Title | `Title | None` |
Author | `str | None` |
CreationTime | `datetime | None` |
LastModifiedTime | `datetime | None` |
Level | `int | None` |
ImageRenderOptions:
| ImageRenderOptions | ImageRenderOptions |
|---|---|
Clone(deep=False) | Retourneer een ondiepe of diepe kloon van de pagina |
ImageRenderOptions
ImageRenderOptions CompositeNode. Bevat het titelblok van een Page.
| ImageRenderOptions | ImageRenderOptions | ImageRenderOptions |
|---|---|---|
TitleText | `RichText | None` |
TitleDate | `RichText | None` |
TitleTime | `RichText | None` |
ImageRenderOptions
ImageRenderOptions CompositeNode. Een positionele container voor OutlineElement knooppunten.
| ImageRenderOptions | ImageRenderOptions | ImageRenderOptions |
|---|---|---|
X | `float | None` |
Y | `float | None` |
Width | `float | None` |
OutlineElement
ImageRenderOptions CompositeNode. Een bladcontainer die inhoudsknooppunten bevat.
| ImageRenderOptions | ImageRenderOptions | ImageRenderOptions |
|---|---|---|
IndentLevel | int | Nestingdiepte (0 = buitenste) |
NumberList | `NumberList | None` |
Tags | list[NoteTag] | OneNote-tags gekoppeld aan dit element |
RichText
ImageRenderOptions CompositeNode. Een blok met opgemaakte tekst.
| ImageRenderOptions | ImageRenderOptions | ImageRenderOptions |
|---|---|---|
Text | str | Volledige platte-tekstreeks (alle runs aaneengeschakeld) |
Runs | list[TextRun] | Geordende lijst van opgemaakte segmenten |
FontSize | `float | None` |
Tags | list[NoteTag] | OneNote-tags gekoppeld aan dit blok |
ImageRenderOptions:
| ImageRenderOptions | ImageRenderOptions | ImageRenderOptions |
|---|---|---|
Append(text, style=None) | `(str, TextStyle | None) -> RichText` |
Replace(old_value, new_value) | (str, str) -> None | In‑memory tekenreeksvervanging op Text; wordt niet bijgewerkt Runs |
TextRun
ImageRenderOptions Node. Een enkel opgemaakte tekstsegment.
| ImageRenderOptions | ImageRenderOptions | ImageRenderOptions |
|---|---|---|
Text | str | De tekstinhoud van het segment (standaard "") |
Style | TextStyle | Opmaak-eigenschappen |
Start | `int | None` |
End | `int | None` |
TextStyle
ImageRenderOptions Node. Per-teken opmaak-eigenschappen voor een 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 | Of dit deel een hyperlink is |
HyperlinkAddress | `str | None` | None |
ImageRenderOptions
ImageRenderOptions CompositeNode. Een ingesloten afbeelding.
| ImageRenderOptions | ImageRenderOptions | ImageRenderOptions |
|---|---|---|
FileName | `str | None` |
Bytes | bytes | Ruwe afbeeldingsgegevens (standaard b"") |
Width | `float | None` |
Height | `float | None` |
AlternativeTextTitle | `str | None` |
AlternativeTextDescription | `str | None` |
HyperlinkUrl | `str | None` |
Tags | list[NoteTag] | OneNote-tags gekoppeld aan deze afbeelding |
ImageRenderOptions:
| ImageRenderOptions | ImageRenderOptions |
|---|---|
Replace(image) | ImageRenderOptions Bytes en FileName van een andere Image node in deze |
AttachedFile
ImageRenderOptions CompositeNode. Een ingebedde bestandsbijlage.
| ImageRenderOptions | ImageRenderOptions | ImageRenderOptions |
|---|---|---|
FileName | `str | None` |
Bytes | bytes | Ruwe bestandsgegevens (standaard b"") |
Tags | list[NoteTag] | OneNote-tags gekoppeld aan deze bijlage |
ImageRenderOptions
ImageRenderOptions CompositeNode. Een tabel binnen een OutlineElement.
| ImageRenderOptions | ImageRenderOptions | ImageRenderOptions | ImageRenderOptions |
|---|---|---|---|
Columns | list[float] | [] | Breedte van elke kolom in punten |
IsBordersVisible | bool | True | Of tabelranden zichtbaar zijn |
Tags | list[NoteTag] | [] | OneNote-tags gekoppeld aan deze tabel |
TableRow
ImageRenderOptions CompositeNode. Een rij binnen een Table. Itereren GetChildNodes(TableCell) om cellen te benaderen.
TableCell
ImageRenderOptions CompositeNode. Een cel binnen een TableRow. Bevat RichText, Image, en andere inhoudsknooppunten.
NoteTag
ImageRenderOptions Node. Een OneNote-tag gekoppeld aan een inhoudsknooppunt.
| 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 |
Tijdstempelnotitie: created en completed zijn ruwe integer‑tijdstempels zoals geparseerd uit het MS-ONE‑binaire formaat, niet datetime objecten.
Factory‑methoden:
| ImageRenderOptions | ImageRenderOptions |
|---|---|
NoteTag.CreateYellowStar() | Maakt een NoteTag(shape=None, label="Yellow Star") |
NumberList
ImageRenderOptions Node. Genummerde of opsommingstekenlijstmetadata op een OutlineElement.
| ImageRenderOptions | ImageRenderOptions | ImageRenderOptions | ImageRenderOptions |
|---|---|---|---|
Format | `str | None` | None |
Restart | `int | None` | None |
IsNumbered | bool | False | Waar voor geordende (genummerde) lijsten |
LoadOptions
| ImageRenderOptions | ImageRenderOptions | ImageRenderOptions | ImageRenderOptions |
|---|---|---|---|
DocumentPassword | `str | None` | None |
LoadHistory | bool | False | API-compatibiliteitsveld; functioneel niet gebruikt in v26.3.1 |
SaveOptions
Basisklasse voor alle opslaan‑opties. Vereist positioneel argument.
| ImageRenderOptions | ImageRenderOptions | ImageRenderOptions |
|---|---|---|
SaveFormat | SaveFormat | Doelopslagformaat |
PdfSaveOptions
ImageRenderOptions SaveOptions. PDF-specifieke exportconfiguratie. Opbouwen met PdfSaveOptions(SaveFormat.Pdf).
| ImageRenderOptions | ImageRenderOptions | ImageRenderOptions | ImageRenderOptions |
|---|---|---|---|
PageIndex | int | 0 | Veld bestaat; niet doorgestuurd naar PDF-exporteur in v26.3.1: heeft geen effect op de output |
PageCount | `int | None` | None |
TagIconDir | `str | None` | None |
TagIconSize | `float | None` | None |
TagIconGap | `float | None` | None |
PageIndex / PageCount voorbehoud: Deze velden zijn gedeclareerd op PdfSaveOptions voor API-compatibiliteit, maar de Document.Save() implementatie in v26.3.1 leest ze niet en stuurt ze niet door naar de PDF-exporteur. Alle pagina’s worden altijd geëxporteerd.
Licentie en Metered
Compatibiliteits‑stubs geëxporteerd voor API‑vormcompatibiliteit met Aspose.Note voor .NET. Alle methoden zijn no‑ops in deze FOSS‑implementatie.
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-opEr is geen licentiesleutel vereist om enige functie van Aspose.Note FOSS voor Python te gebruiken.
ImageRenderOptions
Volledige enumeratie‑referentie: ImageRenderOptions
SaveFormat
| ImageRenderOptions | ImageRenderOptions |
|---|---|
SaveFormat.Pdf | PDF-export: geïmplementeerd; vereist pip install "aspose-note[pdf]" |
SaveFormat.One | OneNote-indeling: alleen gedeclareerd; werpt UnsupportedSaveFormatException |
FileFormat
Enum-waarden die de OneNote‑bestandsindelingsversie vertegenwoordigen. Document.FileFormat biedt een best‑effort indicatie.
| ImageRenderOptions | String-waarde |
|---|---|
FileFormat.OneNote2010 | "onenote2010" |
FileFormat.OneNoteOnline | "onenoteonline" |
FileFormat.OneNote2007 | "onenote2007" |
HorizontalAlignment
| ImageRenderOptions | String-waarde |
|---|---|
HorizontalAlignment.Left | "left" |
HorizontalAlignment.Center | "center" |
HorizontalAlignment.Right | "right" |
NodeType
| ImageRenderOptions | String-waarde |
|---|---|
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
Volledige exceptiereferentie: ImageRenderOptions
| ImageRenderOptions | ImageRenderOptions |
|---|---|
AsposeNoteError | Basisklasse voor alle Aspose.Note FOSS-excepties |
FileCorruptedException | ImageRenderOptions .one bestand kan niet worden geparseerd (beschadigd of misvormde binaire data) |
IncorrectDocumentStructureException | De bestandsstructuur is ongeldig of niet ondersteund |
IncorrectPasswordException | Wordt opgegooid wanneer LoadOptions.DocumentPassword is ingesteld; versleutelde documenten worden niet ondersteund |
UnsupportedFileFormatException | Het bestandsformaat wordt niet herkend; exposeert een FileFormat veld (string) |
UnsupportedSaveFormatException | De aangevraagde SaveFormat is niet geïmplementeerd in deze versie |