Ova referenca pokriva cijelu javnu površinu API-ja aspose-note verzija 26.3.1. Samo simboli izvezeni iz aspose.note paketa su dokumentirani ovdje. Sve što je pod aspose.note._internal je detalj implementacije i može se promijeniti bez najave.
: pip install aspose-note (core) ili pip install "aspose-note[pdf]" (s PDF izvozom)
: from aspose.note import Document, RichText, ...
Dokument i traversiranje
| |
|---|
Document | Korijenski objekt dokumenta. Učitaj .one datoteku, iteriraj stranice i spremi u PDF. |
DocumentVisitor | Apstraktna baza za obilazak uzorakom posjetitelja stabla dokumenta. |
Node | Osnovna klasa za sve čvorove dokumenta. |
CompositeNode | Osnovna klasa za čvorove koji mogu sadržavati podčvorove. |
Struktura dokumenta
| |
|---|
Page | Predstavlja OneNote stranicu. |
Title | Blok naslova stranice koji sadrži TitleText, TitleDate, TitleTime. |
Outline | Pozicijski kontejner za OutlineElement čvorove. |
OutlineElement | Kontejner list; sadrži RichText, Image, Table, AttachedFile. |
| |
|---|
RichText | Tekstualni blok s formatiranim dijelovima, oznakama i hiperveznama. |
TextRun | Jedinstveni formatirani tekstualni segment unutar RichText-a. |
TextStyle | Svojstva formatiranja za TextRun. |
Image | Ugrađena slika s sirovim bajtovima i metapodacima. |
AttachedFile | Ugrađeni privitak datoteke s sirovim bajtovima. |
Table | Tablica s redovima, ćelijama i širinama stupaca. |
TableRow | Redak unutar tablice. |
TableCell | Ćelija unutar TableRow; sadrži čvorove sadržaja. |
NoteTag | OneNote oznaka (zvijezda, potvrdni okvir, itd.) pričvršćena uz čvor sadržaja. |
NumberList | Metapodaci numerirane liste na OutlineElementu. |
Kompatibilnostni stubovi
| |
|---|
License | Kompatibilni stub: SetLicense() je ne‑operacija u ovoj FOSS implementaciji. |
Metered | Kompatibilni stub: SetMeteredKey() je ne‑operacija u ovoj FOSS implementaciji. |
Detalji klase
Klasa korijenskog dokumenta. Učitaj .one datoteku s putanje, a pathlib.Path, ili binarni tok.
Parametri konstruktora:
| | |
|---|
source | `str | Path |
load_options | `LoadOptions | None` |
:
| | |
|---|
DisplayName | `str | None` |
CreationTime | `datetime | None` |
FileFormat | FileFormat | Najbolji mogući pokazatelj verzije formata OneNote datoteke |
:
| | |
|---|
Count() | () -> int | Broj izravnih podređenih stranica |
GetPageHistory(page) | (Page) -> list[Page] | [page] (stub; cijela povijest još nije implementirana) |
DetectLayoutChanges() | () -> None | Kompatibilni stub; bez operacije |
Save(target, format_or_options) | `(str | Path |
Accept(visitor) | (DocumentVisitor) -> None | Pozovi obilazak posjetitelja |
for page in doc | N/A | Iteriraj izravno dijete Page čvorove |
Document.FileFormat napomena: Svojstvo pruža najbolji mogući pokazatelj verzije formata OneNote datoteke. The FileFormat enumeracija ima tri vrijednosti: OneNote2010, OneNoteOnline, i OneNote2007.
Document.Save() podrška za stream: target može biti binarni stream (io.BytesIO, rukovatelj datotekom otvoren u binarnom načinu pisanja, itd.). Ovo je potvrđeno testnim paketom: doc.Save(io.BytesIO(), PdfSaveOptions(SaveFormat.Pdf)).
DocumentVisitor
Apstraktna bazna klasa za traversiranje po uzorku posjetitelja. Nadjačajte metode posjete koje su vam potrebne:
| Poziva se kada |
|---|
VisitDocumentStart(doc) | Ulazak u čvor Dokumenta |
VisitDocumentEnd(doc) | Napustanje čvora Dokumenta |
VisitPageStart(page) | Ulazak u čvor Stranice |
VisitPageEnd(page) | Napustanje čvora Stranice |
VisitTitleStart(title) | Ulazak u čvor Naslova |
VisitTitleEnd(title) | Napustanje čvora Naslova |
VisitOutlineStart(outline) | Ulazak u čvor Konture |
VisitOutlineEnd(outline) | Napustanje čvora Konture |
VisitOutlineElementStart(oe) | Ulazak u čvor Elementa Konture |
VisitOutlineElementEnd(oe) | Napustanje čvora Elementa Konture |
VisitRichTextStart(rt) | Ulazak u čvor RichText |
VisitRichTextEnd(rt) | Napustanje čvora RichText |
VisitImageStart(img) | Ulazak u čvor Slike |
VisitImageEnd(img) | Napustanje čvora Slike |
Osnovna klasa za sve čvorove stabla dokumenta.
| Svojstvo / Metoda | | |
|---|
ParentNode | `Node | None` |
Document | `Document | None` |
Accept(visitor) | (DocumentVisitor) -> None | Pokreni posjetitelja za ovaj čvor |
CompositeNode
Node. Dodaje upravljanje podređenim elementima:
| Svojstvo / Metoda | |
|---|
FirstChild | Prvi podređeni čvor, ili None |
LastChild | Zadnji podređeni čvor, ili None |
AppendChildLast(node) | Dodaj podređeni čvor na kraj; postavlja node.ParentNode = self |
AppendChildFirst(node) | Dodaj podređeni čvor na početak |
InsertChild(index, node) | Umetni podređenog na zadanu poziciju |
RemoveChild(node) | Ukloni podređeni čvor; postavlja node.ParentNode = None |
GetEnumerator() | Vraća iterator preko izravnih podređenih |
for child in node | Iteriraj izravne podređene |
GetChildNodes(Type) | (Type) -> list[Type]: rekurzivno, pretraga po dubini cijelog podstabla uključujući self |
CompositeNode. Predstavlja OneNote stranicu.
| | |
|---|
Title | `Title | None` |
Author | `str | None` |
CreationTime | `datetime | None` |
LastModifiedTime | `datetime | None` |
Level | `int | None` |
:
| |
|---|
Clone(deep=False) | Vrati plitki ili duboki klon stranice |
CompositeNode. Drži blok naslova od
Page.
| | |
|---|
TitleText | `RichText | None` |
TitleDate | `RichText | None` |
TitleTime | `RichText | None` |
CompositeNode. Pozicijski kontejner za
OutlineElement čvorove.
| | |
|---|
X | `float | None` |
Y | `float | None` |
Width | `float | None` |
OutlineElement
CompositeNode. Listni kontejner koji sadrži čvorove sadržaja.
| | |
|---|
IndentLevel | int | Dubina ugniježđivanja (0 = najvanjsko) |
NumberList | `NumberList | None` |
Tags | list[NoteTag] | OneNote oznake pridružene ovom elementu |
RichText
CompositeNode. Blok stiliziranog teksta.
| | |
|---|
Text | str | Cijeli obični tekst (svi dijelovi spojeni) |
Runs | list[TextRun] | Uređeni popis formatiranih segmenata |
FontSize | `float | None` |
Tags | list[NoteTag] | OneNote oznake pridružene ovom bloku |
:
| | |
|---|
Append(text, style=None) | `(str, TextStyle | None) -> RichText` |
Replace(old_value, new_value) | (str, str) -> None | Zamjena stringa u memoriji na Text; ne ažurira Runs |
TextRun
Node. Jedan formatirani tekstualni segment.
| | |
|---|
Text | str | Tekstualni sadržaj segmenta (zadano "") |
Style | TextStyle | Svojstva formatiranja |
Start | `int | None` |
End | `int | None` |
TextStyle
Node. Svojstva formatiranja po znaku za a
TextRun.
| | | |
|---|
Bold | bool | False | |
Italic | bool | False | |
Underline | bool | False | |
Strikethrough | bool | False | |
Superscript | bool | False | |
Subscript | bool | False | |
FontName | `str | None` | None |
FontSize | `float | None` | None |
FontColor | `int | None` | None |
HighlightColor | `int | None` | None |
LanguageId | `int | None` | None |
IsHyperlink | bool | False | Je li ovaj segment hiperveza |
HyperlinkAddress | `str | None` | None |
CompositeNode. Ugrađena slika.
| | |
|---|
FileName | `str | None` |
Bytes | bytes | Sirovi podaci slike (zadano b"") |
Width | `float | None` |
Height | `float | None` |
AlternativeTextTitle | `str | None` |
AlternativeTextDescription | `str | None` |
HyperlinkUrl | `str | None` |
Tags | list[NoteTag] | OneNote oznake pridružene ovoj slici |
:
| |
|---|
Replace(image) | Bytes i FileName iz druge Image čvora u ovaj |
AttachedFile
CompositeNode. Ugrađeni privitak datoteke.
| | |
|---|
FileName | `str | None` |
Bytes | bytes | Sirovi podaci datoteke (zadano b"") |
Tags | list[NoteTag] | OneNote oznake pridružene ovom privitku |
CompositeNode. Tablica unutar OutlineElementa.
| | | |
|---|
Columns | list[float] | [] | Širina svake kolone u točkama |
IsBordersVisible | bool | True | Jesu li rubovi tablice vidljivi |
Tags | list[NoteTag] | [] | OneNote oznake pridružene ovoj tablici |
TableRow
CompositeNode. Redak unutar a
Table. Iteriraj
GetChildNodes(TableCell) za pristup ćelijama.
TableCell
CompositeNode. Ćelija unutar a
TableRow. Sadrži
RichText,
Image, i drugi čvorovi sadržaja.
NoteTag
Node. OneNote oznaka priložena čvoru sadržaja.
| | | |
|---|
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 |
Bilješka vremenskog žiga: created i completed su sirovi cijeli brojevi vremenskih žigova parsirani iz MS-ONE binarnog formata, ne datetime objekti.
Metode tvornice:
| |
|---|
NoteTag.CreateYellowStar() | Stvara NoteTag(shape=None, label="Yellow Star") |
NumberList
Node. Metapodaci numerirane ili nabrojane liste na
OutlineElement.
| | | |
|---|
Format | `str | None` | None |
Restart | `int | None` | None |
IsNumbered | bool | False | True za uređene (numerirane) liste |
LoadOptions
| | | |
|---|
DocumentPassword | `str | None` | None |
LoadHistory | bool | False | Polje kompatibilnosti API-ja; funkcionalno se ne koristi u v26.3.1 |
SaveOptions
Osnovna klasa za sve opcije spremanja. Potreban pozicijski argument.
| | |
|---|
SaveFormat | SaveFormat | Ciljani format spremanja |
PdfSaveOptions
SaveOptions. PDF-specifična konfiguracija izvoza. Izradi s
PdfSaveOptions(SaveFormat.Pdf).
| | | |
|---|
PageIndex | int | 0 | Polje postoji; ne prosljeđuje PDF izvozniku u v26.3.1: nema učinka na izlaz |
PageCount | `int | None` | None |
TagIconDir | `str | None` | None |
TagIconSize | `float | None` | None |
TagIconGap | `float | None` | None |
PageIndex / PageCount napomena: Ova polja su deklarirana na PdfSaveOptions za kompatibilnost API-ja, ali the Document.Save() implementacija u v26.3.1 ne čita niti prosljeđuje ih PDF izvozniku. Sve se stranice uvijek izvoze.
Licenca i mjereni
Izvezeni stubovi kompatibilnosti radi usklađenosti API strukture s Aspose.Note za .NET. Sve metode su bez učinka u ovoj FOSS implementaciji.
Nije potreban licencni ključ za korištenje bilo koje značajke Aspose.Note FOSS za Python.
Potpuna referenca enumeracije:
SaveFormat
| |
|---|
SaveFormat.Pdf | PDF izvoz: implementiran; zahtijeva pip install "aspose-note[pdf]" |
SaveFormat.One | OneNote format: samo deklariran; podiže UnsupportedSaveFormatException |
FileFormat
Vrijednosti enumeracije koje predstavljaju verziju OneNote formata datoteke. Document.FileFormat pruža indikaciju najbolje moguće točnosti.
| String vrijednost |
|---|
FileFormat.OneNote2010 | "onenote2010" |
FileFormat.OneNoteOnline | "onenoteonline" |
FileFormat.OneNote2007 | "onenote2007" |
HorizontalAlignment
| String vrijednost |
|---|
HorizontalAlignment.Left | "left" |
HorizontalAlignment.Center | "center" |
HorizontalAlignment.Right | "right" |
NodeType
| String vrijednost |
|---|
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" |
Potpuna referenca izuzetka:
| |
|---|
AsposeNoteError | Osnovna klasa za sve Aspose.Note FOSS izuzetke |
FileCorruptedException | .one datoteka se ne može parsirati (oštećena ili neispravna binarna datoteka) |
IncorrectDocumentStructureException | Struktura datoteke je neispravna ili nepodržana |
IncorrectPasswordException | Podignuto kada LoadOptions.DocumentPassword je postavljeno; šifrirani dokumenti nisu podržani |
UnsupportedFileFormatException | Format datoteke nije prepoznat; otkriva a FileFormat polje (string) |
UnsupportedSaveFormatException | Zatraženo SaveFormat nije implementirano u ovoj verziji |
Vidi također