Aspose.Note FOSS for Python

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

DocumentKorijenski objekt dokumenta. Učitaj .one datoteku, iteriraj stranice i spremi u PDF.
DocumentVisitorApstraktna baza za obilazak uzorakom posjetitelja stabla dokumenta.
NodeOsnovna klasa za sve čvorove dokumenta.
CompositeNodeOsnovna klasa za čvorove koji mogu sadržavati podčvorove.

Struktura dokumenta

PagePredstavlja OneNote stranicu.
TitleBlok naslova stranice koji sadrži TitleText, TitleDate, TitleTime.
OutlinePozicijski kontejner za OutlineElement čvorove.
OutlineElementKontejner list; sadrži RichText, Image, Table, AttachedFile.

RichTextTekstualni blok s formatiranim dijelovima, oznakama i hiperveznama.
TextRunJedinstveni formatirani tekstualni segment unutar RichText-a.
TextStyleSvojstva formatiranja za TextRun.
ImageUgrađena slika s sirovim bajtovima i metapodacima.
AttachedFileUgrađeni privitak datoteke s sirovim bajtovima.
TableTablica s redovima, ćelijama i širinama stupaca.
TableRowRedak unutar tablice.
TableCellĆelija unutar TableRow; sadrži čvorove sadržaja.
NoteTagOneNote oznaka (zvijezda, potvrdni okvir, itd.) pričvršćena uz čvor sadržaja.
NumberListMetapodaci numerirane liste na OutlineElementu.

LoadOptionsOpcije za učitavanje .one datoteke.
SaveOptionsOsnovna klasa za opcije spremanja.
PdfSaveOptionsPDF‑specifične opcije spremanja (ikone oznaka).

Kompatibilnostni stubovi

LicenseKompatibilni stub: SetLicense() je ne‑operacija u ovoj FOSS implementaciji.
MeteredKompatibilni 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.

from aspose.note import Document, LoadOptions

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

Parametri konstruktora:

source`strPath
load_options`LoadOptionsNone`

:

DisplayName`strNone`
CreationTime`datetimeNone`
FileFormatFileFormatNajbolji mogući pokazatelj verzije formata OneNote datoteke

:

Count()() -> intBroj izravnih podređenih stranica
GetPageHistory(page)(Page) -> list[Page]
[page] (stub; cijela povijest još nije implementirana)
DetectLayoutChanges()() -> NoneKompatibilni stub; bez operacije
Save(target, format_or_options)`(strPath
Accept(visitor)(DocumentVisitor) -> NonePozovi obilazak posjetitelja
for page in docN/AIteriraj 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`NodeNone`
Document`DocumentNone`
Accept(visitor)(DocumentVisitor) -> NonePokreni posjetitelja za ovaj čvor

CompositeNode

Node. Dodaje upravljanje podređenim elementima:

Svojstvo / Metoda
FirstChildPrvi podređeni čvor, ili None
LastChildZadnji 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 nodeIteriraj izravne podređene
GetChildNodes(Type)(Type) -> list[Type]: rekurzivno, pretraga po dubini cijelog podstabla uključujući self

CompositeNode. Predstavlja OneNote stranicu.

Title`TitleNone`
Author`strNone`
CreationTime`datetimeNone`
LastModifiedTime`datetimeNone`
Level`intNone`

:

Clone(deep=False)Vrati plitki ili duboki klon stranice

CompositeNode. Drži blok naslova od Page.

TitleText`RichTextNone`
TitleDate`RichTextNone`
TitleTime`RichTextNone`

CompositeNode. Pozicijski kontejner za OutlineElement čvorove.

X`floatNone`
Y`floatNone`
Width`floatNone`

OutlineElement

CompositeNode. Listni kontejner koji sadrži čvorove sadržaja.

IndentLevelintDubina ugniježđivanja (0 = najvanjsko)
NumberList`NumberListNone`
Tagslist[NoteTag]OneNote oznake pridružene ovom elementu

RichText

CompositeNode. Blok stiliziranog teksta.

TextstrCijeli obični tekst (svi dijelovi spojeni)
Runslist[TextRun]Uređeni popis formatiranih segmenata
FontSize`floatNone`
Tagslist[NoteTag]OneNote oznake pridružene ovom bloku

:

Append(text, style=None)`(str, TextStyleNone) -> RichText`
Replace(old_value, new_value)(str, str) -> NoneZamjena stringa u memoriji na Text; ne ažurira Runs

TextRun

Node. Jedan formatirani tekstualni segment.

TextstrTekstualni sadržaj segmenta (zadano "")
StyleTextStyleSvojstva formatiranja
Start`intNone`
End`intNone`

TextStyle

Node. Svojstva formatiranja po znaku za a TextRun.

BoldboolFalse
ItalicboolFalse
UnderlineboolFalse
StrikethroughboolFalse
SuperscriptboolFalse
SubscriptboolFalse
FontName`strNone`None
FontSize`floatNone`None
FontColor`intNone`None
HighlightColor`intNone`None
LanguageId`intNone`None
IsHyperlinkboolFalseJe li ovaj segment hiperveza
HyperlinkAddress`strNone`None

CompositeNode. Ugrađena slika.

FileName`strNone`
BytesbytesSirovi podaci slike (zadano b"")
Width`floatNone`
Height`floatNone`
AlternativeTextTitle`strNone`
AlternativeTextDescription`strNone`
HyperlinkUrl`strNone`
Tagslist[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`strNone`
BytesbytesSirovi podaci datoteke (zadano b"")
Tagslist[NoteTag]OneNote oznake pridružene ovom privitku

CompositeNode. Tablica unutar OutlineElementa.

Columnslist[float][]Širina svake kolone u točkama
IsBordersVisibleboolTrueJesu li rubovi tablice vidljivi
Tagslist[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`intNone`None
label`strNone`None
text_color`intNone`None
highlight_color`intNone`None
created`intNone`None
completed`intNone`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`strNone`None
Restart`intNone`None
IsNumberedboolFalseTrue za uređene (numerirane) liste

LoadOptions

DocumentPassword`strNone`None
LoadHistoryboolFalsePolje kompatibilnosti API-ja; funkcionalno se ne koristi u v26.3.1

SaveOptions

Osnovna klasa za sve opcije spremanja. Potreban pozicijski argument.

SaveFormatSaveFormatCiljani format spremanja

PdfSaveOptions

SaveOptions. PDF-specifična konfiguracija izvoza. Izradi s PdfSaveOptions(SaveFormat.Pdf).

PageIndexint0Polje postoji; ne prosljeđuje PDF izvozniku u v26.3.1: nema učinka na izlaz
PageCount`intNone`None
TagIconDir`strNone`None
TagIconSize`floatNone`None
TagIconGap`floatNone`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.

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

Nije potreban licencni ključ za korištenje bilo koje značajke Aspose.Note FOSS za Python.


Potpuna referenca enumeracije:

SaveFormat

SaveFormat.PdfPDF izvoz: implementiran; zahtijeva pip install "aspose-note[pdf]"
SaveFormat.OneOneNote 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:

AsposeNoteErrorOsnovna klasa za sve Aspose.Note FOSS izuzetke
FileCorruptedException
.one datoteka se ne može parsirati (oštećena ili neispravna binarna datoteka)
IncorrectDocumentStructureExceptionStruktura datoteke je neispravna ili nepodržana
IncorrectPasswordExceptionPodignuto kada LoadOptions.DocumentPassword je postavljeno; šifrirani dokumenti nisu podržani
UnsupportedFileFormatExceptionFormat datoteke nije prepoznat; otkriva a FileFormat polje (string)
UnsupportedSaveFormatExceptionZatraženo SaveFormat nije implementirano u ovoj verziji

Vidi također

 Hrvatski