Aspose.Note FOSS for Python

Această referință acoperă suprafața completă a API-ului public al aspose-note versiunii 26.3.1. Doar simbolurile exportate din aspose.note pachet sunt documentate aici. Orice aflat sub aspose.note._internal este un detaliu de implementare și poate fi modificat fără notificare.

ImageRenderOptions: pip install aspose-note (core) sau pip install "aspose-note[pdf]" (cu export PDF)

ImageRenderOptions: from aspose.note import Document, RichText, ...

ImageRenderOptions

Document și Traversare

ImageRenderOptionsImageRenderOptions
DocumentObiectul rădăcină al documentului. Încarcă un .one fișier, iterează paginile și salvează în PDF.
DocumentVisitorBază abstractă pentru traversarea în stil vizitator a arborelui de documente.
NodeClasă de bază pentru toate nodurile de document.
CompositeNodeClasă de bază pentru nodurile care pot conține noduri copil.

Structura Documentului

ImageRenderOptionsImageRenderOptions
PageReprezintă o pagină OneNote.
TitleBloc de titlu al paginii care conține TitleText, TitleDate, TitleTime.
OutlineContainer pozițional pentru nodurile OutlineElement.
OutlineElementContainer frunză; conține RichText, Image, Table, AttachedFile.

ImageRenderOptions

ImageRenderOptionsImageRenderOptions
RichTextBloc de text cu ruluri de formatare, etichete și hyperlinkuri.
TextRunSegment unic de text formatat în interiorul unui RichText.
TextStyleProprietăți de formatare pentru un TextRun.
ImageImagine încorporată cu octeți brute și metadate.
AttachedFileFișier atașat încorporat cu octeți brute.
TableTabel cu rânduri, celule și lățimi de coloană.
TableRowUn rând într-un tabel.
TableCellO celulă într-un TableRow; conține noduri de conținut.
NoteTagEtichetă OneNote (stea, casetă de bifare etc.) atașată unui nod de conținut.
NumberListMetadate de listă numerotată pe un OutlineElement.

ImageRenderOptions

ImageRenderOptionsImageRenderOptions
LoadOptionsOpțiuni pentru încărcarea unui .one fișier.
SaveOptionsClasă de bază pentru opțiunile de salvare.
PdfSaveOptionsOpțiuni de salvare specifice PDF (iconițe de etichetă).

Stub-uri de Compatibilitate

ImageRenderOptionsImageRenderOptions
LicenseStub de compatibilitate: SetLicense() este o operație nulă în această implementare FOSS.
MeteredStub de compatibilitate: SetMeteredKey() este o operație nulă în această implementare FOSS.

Detalii de Clasă

ImageRenderOptions

Clasa documentului rădăcină. Încarcă un .one fișier dintr-o cale de fișier, un pathlib.Path, sau un flux binar.

from aspose.note import Document, LoadOptions

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

Parametrii constructorului:

ImageRenderOptionsImageRenderOptionsImageRenderOptions
source`strPath
load_options`LoadOptionsNone`

ImageRenderOptions:

ImageRenderOptionsImageRenderOptionsImageRenderOptions
DisplayName`strNone`
CreationTime`datetimeNone`
FileFormatFileFormatIndicație de tip best‑effort a versiunii formatului de fișier OneNote

ImageRenderOptions:

ImageRenderOptionsImageRenderOptionsImageRenderOptions
Count()() -> intNumăr de pagini copil directe
GetPageHistory(page)(Page) -> list[Page]ImageRenderOptions [page] (stub; istoricul complet nu a fost încă implementat)
DetectLayoutChanges()() -> NoneStub de compatibilitate; nicio operație
Save(target, format_or_options)`(strPath
Accept(visitor)(DocumentVisitor) -> NoneInvocă parcurgerea vizitatorului
for page in docN/AIterează copilul direct Page noduri

Document.FileFormat notă: Proprietatea oferă o indicație de bună credință a versiunii formatului de fișier OneNote. The FileFormat enum are trei valori: OneNote2010, OneNoteOnline, și OneNote2007.

Document.Save() suport pentru flux: target poate fi un flux binar (io.BytesIO, descriptor de fișier deschis în modul de scriere binar, etc.). Acest lucru este confirmat de suita de teste: doc.Save(io.BytesIO(), PdfSaveOptions(SaveFormat.Pdf)).

DocumentVisitor

Clasă de bază abstractă pentru traversarea prin modelul vizitatorului. Suprascrie metodele de vizitare de care ai nevoie:

ImageRenderOptionsApelat când
VisitDocumentStart(doc)Intrarea într-un nod Document
VisitDocumentEnd(doc)Părăsirea unui nod Document
VisitPageStart(page)Intrarea într-un nod Page
VisitPageEnd(page)Părăsirea unui nod Page
VisitTitleStart(title)Intrarea într-un nod Title
VisitTitleEnd(title)Părăsirea unui nod Title
VisitOutlineStart(outline)Intrare în nodul Outline
VisitOutlineEnd(outline)Ieșire din nodul Outline
VisitOutlineElementStart(oe)Intrare în nodul OutlineElement
VisitOutlineElementEnd(oe)Ieșire din nodul OutlineElement
VisitRichTextStart(rt)Intrare în nodul RichText
VisitRichTextEnd(rt)Ieșire din nodul RichText
VisitImageStart(img)Intrare în nodul Image
VisitImageEnd(img)Ieșire din nodul Image

ImageRenderOptions

Clasă de bază pentru toate nodurile arborelui de documente.

Proprietate / MetodăImageRenderOptionsImageRenderOptions
ParentNode`NodeNone`
Document`DocumentNone`
Accept(visitor)(DocumentVisitor) -> NoneDispecerează vizitatorul pentru acest nod

CompositeNode

ImageRenderOptions Node. Adaugă gestionarea copiilor:

Proprietate / MetodăImageRenderOptions
FirstChildPrimul nod copil, sau None
LastChildUltimul nod copil, sau None
AppendChildLast(node)Adaugă un nod copil la sfârșit; setează node.ParentNode = self
AppendChildFirst(node)Adaugă un nod copil la început
InsertChild(index, node)Inserează un copil la poziția dată
RemoveChild(node)Elimină un nod copil; setează node.ParentNode = None
GetEnumerator()Returnează un iterator peste copiii direcți
for child in nodeIterează copiii direcți
GetChildNodes(Type)(Type) -> list[Type]: recursiv, căutare în adâncime a întregului subarbore, inclusiv self

ImageRenderOptions

ImageRenderOptions CompositeNode. Reprezintă o pagină OneNote.

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

ImageRenderOptions:

ImageRenderOptionsImageRenderOptions
Clone(deep=False)Returnează o clonă superficială sau profundă a paginii

ImageRenderOptions

ImageRenderOptions CompositeNode. Conține blocul de titlu al unui Page.

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

ImageRenderOptions

ImageRenderOptions CompositeNode. Un container pozițional pentru OutlineElement noduri.

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

OutlineElement

ImageRenderOptions CompositeNode. Un container frunză care conține noduri de conținut.

ImageRenderOptionsImageRenderOptionsImageRenderOptions
IndentLevelintAdâncime de imbricare (0 = cea mai exterioară)
NumberList`NumberListNone`
Tagslist[NoteTag]Etichete OneNote atașate acestui element

RichText

ImageRenderOptions CompositeNode. Un bloc de text stilizat.

ImageRenderOptionsImageRenderOptionsImageRenderOptions
TextstrȘir complet de text simplu (toate secvențele concatenate)
Runslist[TextRun]Listă ordonată de segmente formatate
FontSize`floatNone`
Tagslist[NoteTag]Etichete OneNote atașate acestui bloc

ImageRenderOptions:

ImageRenderOptionsImageRenderOptionsImageRenderOptions
Append(text, style=None)`(str, TextStyleNone) -> RichText`
Replace(old_value, new_value)(str, str) -> NoneSubstituție de șir în memorie pe Text; nu actualizează Runs

TextRun

ImageRenderOptions Node. Un segment de text formatat unic.

ImageRenderOptionsImageRenderOptionsImageRenderOptions
TextstrConținutul textului segmentului (implicit "")
StyleTextStyleProprietăți de formatare
Start`intNone`
End`intNone`

TextStyle

ImageRenderOptions Node. Proprietăți de formatare per caracter pentru un TextRun.

ImageRenderOptionsImageRenderOptionsImageRenderOptionsImageRenderOptions
BoldboolFalseImageRenderOptions
ItalicboolFalseImageRenderOptions
UnderlineboolFalseImageRenderOptions
StrikethroughboolFalseImageRenderOptions
SuperscriptboolFalseImageRenderOptions
SubscriptboolFalseImageRenderOptions
FontName`strNone`None
FontSize`floatNone`None
FontColor`intNone`None
HighlightColor`intNone`None
LanguageId`intNone`None
IsHyperlinkboolFalseDacă acest segment este un hyperlink
HyperlinkAddress`strNone`None

ImageRenderOptions

ImageRenderOptions CompositeNode. O imagine încorporată.

ImageRenderOptionsImageRenderOptionsImageRenderOptions
FileName`strNone`
BytesbytesDate brute ale imaginii (implicit b"")
Width`floatNone`
Height`floatNone`
AlternativeTextTitle`strNone`
AlternativeTextDescription`strNone`
HyperlinkUrl`strNone`
Tagslist[NoteTag]Etichete OneNote atașate acestei imagini

ImageRenderOptions:

ImageRenderOptionsImageRenderOptions
Replace(image)ImageRenderOptions Bytes și FileName de la altul Image nod în acestul

AttachedFile

ImageRenderOptions CompositeNode. O atașare de fișier încorporată.

ImageRenderOptionsImageRenderOptionsImageRenderOptions
FileName`strNone`
BytesbytesDate brute ale fișierului (implicit b"")
Tagslist[NoteTag]Etichete OneNote atașate acestui atașament

ImageRenderOptions

ImageRenderOptions CompositeNode. Un tabel în interiorul unui OutlineElement.

ImageRenderOptionsImageRenderOptionsImageRenderOptionsImageRenderOptions
Columnslist[float][]Lățimea fiecărei coloane în puncte
IsBordersVisibleboolTrueDacă marginile tabelului sunt vizibile
Tagslist[NoteTag][]Etichete OneNote atașate acestui tabel

TableRow

ImageRenderOptions CompositeNode. Un rând într-un Table. Iterați GetChildNodes(TableCell) pentru a accesa celulele.

TableCell

ImageRenderOptions CompositeNode. O celulă într-un TableRow. Conține RichText, Image, și alte noduri de conținut.

NoteTag

ImageRenderOptions Node. O etichetă OneNote atașată unui nod de conținut.

ImageRenderOptionsImageRenderOptionsImageRenderOptionsImageRenderOptions
shape`intNone`None
label`strNone`None
text_color`intNone`None
highlight_color`intNone`None
created`intNone`None
completed`intNone`None

Notă de timestamp: created și completed sunt timestamp-uri brute ca numere întregi, parsate din formatul binar MS-ONE, nu datetime obiecte.

Metode de fabrică:

ImageRenderOptionsImageRenderOptions
NoteTag.CreateYellowStar()Creează un NoteTag(shape=None, label="Yellow Star")

NumberList

ImageRenderOptions Node. Metadatele listelor numerotate sau cu marcatori pe un OutlineElement.

ImageRenderOptionsImageRenderOptionsImageRenderOptionsImageRenderOptions
Format`strNone`None
Restart`intNone`None
IsNumberedboolFalseAdevărat pentru liste ordonate (numerotate)

LoadOptions

ImageRenderOptionsImageRenderOptionsImageRenderOptionsImageRenderOptions
DocumentPassword`strNone`None
LoadHistoryboolFalseCâmp de compatibilitate API; nu este utilizat funcțional în v26.3.1

SaveOptions

Clasă de bază pentru toate opțiunile de salvare. Argument pozițional obligatoriu.

ImageRenderOptionsImageRenderOptionsImageRenderOptions
SaveFormatSaveFormatFormatul de salvare țintă

PdfSaveOptions

ImageRenderOptions SaveOptions. Configurație de export specifică PDF. Construiți cu PdfSaveOptions(SaveFormat.Pdf).

ImageRenderOptionsImageRenderOptionsImageRenderOptionsImageRenderOptions
PageIndexint0Câmpul există; nu este transmis exportatorului PDF în v26.3.1: nu are niciun efect asupra ieșirii
PageCount`intNone`None
TagIconDir`strNone`None
TagIconSize`floatNone`None
TagIconGap`floatNone`None

PageIndex / PageCount avertisment: Aceste câmpuri sunt declarate pe PdfSaveOptions pentru compatibilitate API, dar Document.Save() implementarea în v26.3.1 nu le citește sau le transmite exportatorului PDF. Toate paginile sunt întotdeauna exportate.

Licență și tarifare pe bază de consum

Stub-uri de compatibilitate exportate pentru compatibilitatea formei API cu Aspose.Note pentru .NET. Toate metodele sunt fără efect în această implementare FOSS.

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

Nu este necesară nicio cheie de licență pentru a utiliza orice funcționalitate a Aspose.Note FOSS pentru Python.

ImageRenderOptions

Referință completă a enumerării: ImageRenderOptions

SaveFormat

ImageRenderOptionsImageRenderOptions
SaveFormat.PdfExport PDF: implementat; necesită pip install "aspose-note[pdf]"
SaveFormat.OneFormat OneNote: declarat doar; declanșează UnsupportedSaveFormatException

FileFormat

Valorile enum care reprezintă versiunea formatului de fișier OneNote. Document.FileFormat furnizează o indicație de tip best‑effort.

ImageRenderOptionsValoare șir
FileFormat.OneNote2010"onenote2010"
FileFormat.OneNoteOnline"onenoteonline"
FileFormat.OneNote2007"onenote2007"

HorizontalAlignment

ImageRenderOptionsValoare șir
HorizontalAlignment.Left"left"
HorizontalAlignment.Center"center"
HorizontalAlignment.Right"right"

NodeType

ImageRenderOptionsValoare șir
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

Referință completă a excepțiilor: ImageRenderOptions

ImageRenderOptionsImageRenderOptions
AsposeNoteErrorClasa de bază pentru toate excepțiile Aspose.Note FOSS
FileCorruptedExceptionImageRenderOptions .one fișierul nu poate fi analizat (corupt sau binar malformat)
IncorrectDocumentStructureExceptionStructura fișierului este invalidă sau nesuportată
IncorrectPasswordExceptionRidicată când LoadOptions.DocumentPassword este setat; documentele criptate nu sunt suportate
UnsupportedFileFormatExceptionFormatul fișierului nu este recunoscut; expune un FileFormat câmp (string)
UnsupportedSaveFormatExceptionCea solicitată SaveFormat nu este implementat în această versiune

Vezi și

 Română