Aspose.Note FOSS for Python
Denne referansen dekker det komplette offentlige API-området til aspose-note versjon 26.3.1. Kun symboler eksportert fra den aspose.note pakken er dokumentert her. Alt under aspose.note._internal er en implementasjonsdetalj og kan endres uten varsel.
ImageRenderOptions: pip install aspose-note (core) eller pip install "aspose-note[pdf]" (med PDF-eksport)
ImageRenderOptions: from aspose.note import Document, RichText, ...
ImageRenderOptions
Dokument og Traversering
| ImageRenderOptions | ImageRenderOptions |
|---|---|
Document | Rotdokumentobjekt. Last inn en .one fil, iterer sider, og lagre til PDF. |
DocumentVisitor | Abstrakt base for besøker-mønster traversering av dokumenttreet. |
Node | Basisklasse for alle dokumentnoder. |
CompositeNode | Basisklasse for noder som kan inneholde undernoder. |
Dokumentstruktur
| ImageRenderOptions | ImageRenderOptions |
|---|---|
Page | Representerer en OneNote-side. |
Title | Side-tittelblokk som inneholder TitleText, TitleDate, TitleTime. |
Outline | Posisjonell beholder for OutlineElement-noder. |
OutlineElement | Løvbeholder; inneholder RichText, Image, Table, AttachedFile. |
ImageRenderOptions
| ImageRenderOptions | ImageRenderOptions |
|---|---|
RichText | Tekstblokk med formateringssekvenser, tagger og hyperlenker. |
TextRun | En enkelt formatert tekstsegment i en RichText. |
TextStyle | Formateringsegenskaper for en TextRun. |
Image | Innebygd bilde med rå bytes og metadata. |
AttachedFile | Innebygd filvedlegg med rå bytes. |
Table | Tabell med rader, celler og kolonnebredder. |
TableRow | En rad i en Table. |
TableCell | En celle i en TableRow; inneholder innholdsnoder. |
NoteTag | OneNote‑tagg (stjerne, avkrysningsboks osv.) festet til en innholdsnod. |
NumberList | Nummerert liste‑metadata på et OutlineElement. |
ImageRenderOptions
| ImageRenderOptions | ImageRenderOptions |
|---|---|
LoadOptions | Alternativer for lasting av en .one fil. |
SaveOptions | Basisklasse for lagringsalternativer. |
PdfSaveOptions | PDF‑spesifikke lagringsalternativer (tagg‑ikoner). |
Kompatibilitetsstubber
| ImageRenderOptions | ImageRenderOptions |
|---|---|
License | Kompatibilitets‑stub: SetLicense() er en ingen‑operasjon i denne FOSS‑implementeringen. |
Metered | Kompatibilitets‑stub: SetMeteredKey() er en ingen‑operasjon i denne FOSS‑implementeringen. |
Klasse detaljer
ImageRenderOptions
Rotdokumentklassen. Last inn en .one fil fra en filsti, en pathlib.Path, eller en binær strøm.
from aspose.note import Document, LoadOptions
doc = Document(source=None, load_options=None)Konstruktørparametere:
| ImageRenderOptions | ImageRenderOptions | ImageRenderOptions |
|---|---|---|
source | `str | Path |
load_options | `LoadOptions | None` |
ImageRenderOptions:
| ImageRenderOptions | ImageRenderOptions | ImageRenderOptions |
|---|---|---|
DisplayName | `str | None` |
CreationTime | `datetime | None` |
FileFormat | FileFormat | Best‑effort‑indikasjon av OneNote‑filformatversjonen |
ImageRenderOptions:
| ImageRenderOptions | ImageRenderOptions | ImageRenderOptions |
|---|---|---|
Count() | () -> int | Antall direkte underliggende sider |
GetPageHistory(page) | (Page) -> list[Page] | ImageRenderOptions [page] (stubb; full historikk er ennå ikke implementert) |
DetectLayoutChanges() | () -> None | Kompatibilitetsstubb; ingen operasjon |
Save(target, format_or_options) | `(str | Path |
Accept(visitor) | (DocumentVisitor) -> None | Kall på besøkertraversering |
for page in doc | N/A | Iterer direkte under Page noder |
Document.FileFormat notat: Egenskapen gir en best‑effort‑indikasjon av OneNote‑filformatversjonen. Den FileFormat enum har tre verdier: OneNote2010, OneNoteOnline, og OneNote2007.
Document.Save() strømmestøtte: target kan være en binær strøm (io.BytesIO, filhåndtak åpnet i binær skrivetilstand, osv.). Dette er bekreftet av testsettet: doc.Save(io.BytesIO(), PdfSaveOptions(SaveFormat.Pdf)).
DocumentVisitor
Abstrakt baseklasse for traversering med visitor-mønster. Overstyr de besøksmetodene du trenger:
| ImageRenderOptions | Kalt når |
|---|---|
VisitDocumentStart(doc) | Går inn i en Document-node |
VisitDocumentEnd(doc) | Forlater en Document-node |
VisitPageStart(page) | Går inn i en Page-node |
VisitPageEnd(page) | Forlater en Page-node |
VisitTitleStart(title) | Går inn i en Title-node |
VisitTitleEnd(title) | Forlater en Title-node |
VisitOutlineStart(outline) | Går inn i en Outline-node |
VisitOutlineEnd(outline) | Forlater en Outline-node |
VisitOutlineElementStart(oe) | Går inn i en OutlineElement-node |
VisitOutlineElementEnd(oe) | Forlater en OutlineElement-node |
VisitRichTextStart(rt) | Går inn i en RichText-node |
VisitRichTextEnd(rt) | Forlater en RichText-node |
VisitImageStart(img) | Går inn i en Image-node |
VisitImageEnd(img) | Forlater en Image-node |
ImageRenderOptions
Basisklasse for alle dokumenttre-noder.
| Egenskap / Metode | ImageRenderOptions | ImageRenderOptions |
|---|---|---|
ParentNode | `Node | None` |
Document | `Document | None` |
Accept(visitor) | (DocumentVisitor) -> None | Send visitor for denne noden |
CompositeNode
ImageRenderOptions Node. Legger til håndtering av barn:
| Egenskap / Metode | ImageRenderOptions |
|---|---|
FirstChild | Første undernode, eller None |
LastChild | Siste undernode, eller None |
AppendChildLast(node) | Legg til en undernode på slutten; setter node.ParentNode = self |
AppendChildFirst(node) | Legg til en undernode i starten |
InsertChild(index, node) | Sett inn en undernode på den angitte posisjonen |
RemoveChild(node) | Fjern en undernode; setter node.ParentNode = None |
GetEnumerator() | Returnerer en iterator over direkte barn |
for child in node | Iterer direkte barn |
GetChildNodes(Type) | (Type) -> list[Type]: rekursiv, dybde‑først søk i hele undertrær inkludert self |
ImageRenderOptions
ImageRenderOptions CompositeNode. Representerer en OneNote-side.
| ImageRenderOptions | ImageRenderOptions | ImageRenderOptions |
|---|---|---|
Title | `Title | None` |
Author | `str | None` |
CreationTime | `datetime | None` |
LastModifiedTime | `datetime | None` |
Level | `int | None` |
ImageRenderOptions:
| ImageRenderOptions | ImageRenderOptions |
|---|---|
Clone(deep=False) | Returner en overfladisk eller dyp klone av siden |
ImageRenderOptions
ImageRenderOptions CompositeNode. Inneholder tittelblokken til en Page.
| ImageRenderOptions | ImageRenderOptions | ImageRenderOptions |
|---|---|---|
TitleText | `RichText | None` |
TitleDate | `RichText | None` |
TitleTime | `RichText | None` |
ImageRenderOptions
ImageRenderOptions CompositeNode. En posisjonsbeholder for OutlineElement noder.
| ImageRenderOptions | ImageRenderOptions | ImageRenderOptions |
|---|---|---|
X | `float | None` |
Y | `float | None` |
Width | `float | None` |
OutlineElement
ImageRenderOptions CompositeNode. En bladbeholder som inneholder innholdsnoder.
| ImageRenderOptions | ImageRenderOptions | ImageRenderOptions |
|---|---|---|
IndentLevel | int | Nøstingsdybde (0 = ytterste) |
NumberList | `NumberList | None` |
Tags | list[NoteTag] | OneNote-tagger knyttet til dette elementet |
RichText
ImageRenderOptions CompositeNode. En blokk med formatert tekst.
| ImageRenderOptions | ImageRenderOptions | ImageRenderOptions |
|---|---|---|
Text | str | Full ren-tekst-streng (alle kjeder sammenkjedet) |
Runs | list[TextRun] | Ordnet liste over formaterte segmenter |
FontSize | `float | None` |
Tags | list[NoteTag] | OneNote-tagger knyttet til denne blokken |
ImageRenderOptions:
| ImageRenderOptions | ImageRenderOptions | ImageRenderOptions |
|---|---|---|
Append(text, style=None) | `(str, TextStyle | None) -> RichText` |
Replace(old_value, new_value) | (str, str) -> None | Strengsubstitusjon i minnet på Text; oppdaterer ikke Runs |
TextRun
ImageRenderOptions Node. Et enkelt formatert tekstsegment.
| ImageRenderOptions | ImageRenderOptions | ImageRenderOptions |
|---|---|---|
Text | str | Segmentets tekstinnhold (standard "") |
Style | TextStyle | Formateringsegenskaper |
Start | `int | None` |
End | `int | None` |
TextStyle
ImageRenderOptions Node. Per-tegn formateringsegenskaper for en 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 | Om dette segmentet er en hyperlenke |
HyperlinkAddress | `str | None` | None |
ImageRenderOptions
ImageRenderOptions CompositeNode. Et innebygd bilde.
| ImageRenderOptions | ImageRenderOptions | ImageRenderOptions |
|---|---|---|
FileName | `str | None` |
Bytes | bytes | Rå bildedata (standard b"") |
Width | `float | None` |
Height | `float | None` |
AlternativeTextTitle | `str | None` |
AlternativeTextDescription | `str | None` |
HyperlinkUrl | `str | None` |
Tags | list[NoteTag] | OneNote‑tagger knyttet til dette bildet |
ImageRenderOptions:
| ImageRenderOptions | ImageRenderOptions |
|---|---|
Replace(image) | ImageRenderOptions Bytes og FileName fra en annen Image node inn i denne |
AttachedFile
ImageRenderOptions CompositeNode. En innebygd filvedlegg.
| ImageRenderOptions | ImageRenderOptions | ImageRenderOptions |
|---|---|---|
FileName | `str | None` |
Bytes | bytes | Rå fildata (standard b"") |
Tags | list[NoteTag] | OneNote‑tagger knyttet til dette vedlegget |
ImageRenderOptions
ImageRenderOptions CompositeNode. En tabell innenfor et OutlineElement.
| ImageRenderOptions | ImageRenderOptions | ImageRenderOptions | ImageRenderOptions |
|---|---|---|---|
Columns | list[float] | [] | Bredde på hver kolonne i punkter |
IsBordersVisible | bool | True | Om tabellrammer er synlige |
Tags | list[NoteTag] | [] | OneNote‑tagger knyttet til denne tabellen |
TableRow
ImageRenderOptions CompositeNode. En rad innenfor en Table. Iterer GetChildNodes(TableCell) for å få tilgang til celler.
TableCell
ImageRenderOptions CompositeNode. En celle innenfor en TableRow. Inneholder RichText, Image, og andre innholdsnoder.
NoteTag
ImageRenderOptions Node. En OneNote‑tagg festet til en innholdsnod.
| 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 |
Tidsstempelnote: created og completed er rå heltalls‑tidsstempler som er tolket fra MS-ONE‑binærformatet, ikke datetime objekter.
Fabrikkmetoder:
| ImageRenderOptions | ImageRenderOptions |
|---|---|
NoteTag.CreateYellowStar() | Oppretter en NoteTag(shape=None, label="Yellow Star") |
NumberList
ImageRenderOptions Node. Nummerert eller punktliste metadata på en OutlineElement.
| ImageRenderOptions | ImageRenderOptions | ImageRenderOptions | ImageRenderOptions |
|---|---|---|---|
Format | `str | None` | None |
Restart | `int | None` | None |
IsNumbered | bool | False | True for ordnede (nummererte) lister |
LoadOptions
| ImageRenderOptions | ImageRenderOptions | ImageRenderOptions | ImageRenderOptions |
|---|---|---|---|
DocumentPassword | `str | None` | None |
LoadHistory | bool | False | API-kompatibilitetsfelt; ikke funksjonelt brukt i v26.3.1 |
SaveOptions
Basisklasse for alle lagringsalternativer. Påkrevd posisjonelt argument.
| ImageRenderOptions | ImageRenderOptions | ImageRenderOptions |
|---|---|---|
SaveFormat | SaveFormat | Mål lagringsformat |
PdfSaveOptions
ImageRenderOptions SaveOptions. PDF-spesifikk eksportkonfigurasjon. Konstruer med PdfSaveOptions(SaveFormat.Pdf).
| ImageRenderOptions | ImageRenderOptions | ImageRenderOptions | ImageRenderOptions |
|---|---|---|---|
PageIndex | int | 0 | Feltet finnes; ikke videresendt til PDF-eksportør i v26.3.1: har ingen effekt på utdata |
PageCount | `int | None` | None |
TagIconDir | `str | None` | None |
TagIconSize | `float | None` | None |
TagIconGap | `float | None` | None |
PageIndex / PageCount forbehold: Disse feltene er deklarert på PdfSaveOptions for API-kompatibilitet, men the Document.Save() implementeringen i v26.3.1 leser dem ikke eller videresender dem til PDF-eksportøren. Alle sider blir alltid eksportert.
Lisens og Metered
Kompatibilitets‑stubber eksportert for API‑form‑kompatibilitet med Aspose.Note for .NET. Alle metoder er ingen‑operasjoner i denne FOSS‑implementasjonen.
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-opIngen lisensnøkkel kreves for å bruke noen funksjon i Aspose.Note FOSS for Python.
ImageRenderOptions
Fullstendig oppregningsreferanse: ImageRenderOptions
SaveFormat
| ImageRenderOptions | ImageRenderOptions |
|---|---|
SaveFormat.Pdf | PDF-eksport: implementert; krever pip install "aspose-note[pdf]" |
SaveFormat.One | OneNote-format: kun deklarert; kaster UnsupportedSaveFormatException |
FileFormat
Enum-verdier som representerer OneNote-filformatversjonen. Document.FileFormat gir en best mulig indikasjon.
| ImageRenderOptions | Strengverdi |
|---|---|
FileFormat.OneNote2010 | "onenote2010" |
FileFormat.OneNoteOnline | "onenoteonline" |
FileFormat.OneNote2007 | "onenote2007" |
HorizontalAlignment
| ImageRenderOptions | Strengverdi |
|---|---|
HorizontalAlignment.Left | "left" |
HorizontalAlignment.Center | "center" |
HorizontalAlignment.Right | "right" |
NodeType
| ImageRenderOptions | Strengverdi |
|---|---|
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
Fullstendig unntaksreferanse: ImageRenderOptions
| ImageRenderOptions | ImageRenderOptions |
|---|---|
AsposeNoteError | Basisklasse for alle Aspose.Note FOSS-unntak |
FileCorruptedException | ImageRenderOptions .one filen kan ikke parses (korrupt eller feilformatert binærfil) |
IncorrectDocumentStructureException | Filstrukturen er ugyldig eller ikke støttet |
IncorrectPasswordException | Kastes når LoadOptions.DocumentPassword er satt; krypterte dokumenter støttes ikke |
UnsupportedFileFormatException | Filformatet er ikke gjenkjent; eksponerer en FileFormat felt (string) |
UnsupportedSaveFormatException | Den forespurte SaveFormat er ikke implementert i denne versjonen |