Aspose.Note FOSS for Python
Questa referenza copre l’intera superficie dell’API pubblica di aspose-note versione 26.3.1. Solo i simboli esportati dal aspose.note pacchetto sono documentati qui. Qualsiasi cosa sotto aspose.note._internal è un dettaglio di implementazione e può cambiare senza preavviso.
ImageRenderOptions: pip install aspose-note (core) o pip install "aspose-note[pdf]" (con esportazione PDF)
ImageRenderOptions: from aspose.note import Document, RichText, ...
ImageRenderOptions
Documento e Traversal
| ImageRenderOptions | ImageRenderOptions |
|---|---|
Document | Oggetto documento radice. Carica un .one file, itera le pagine e salva in PDF. |
DocumentVisitor | Base astratta per l’attraversamento dell’albero del documento mediante il pattern visitor. |
Node | Classe base per tutti i nodi del documento. |
CompositeNode | Classe base per i nodi che possono contenere nodi figli. |
Struttura del documento
| ImageRenderOptions | ImageRenderOptions |
|---|---|
Page | Rappresenta una pagina OneNote. |
Title | Blocco del titolo della pagina contenente TitleText, TitleDate, TitleTime. |
Outline | Contenitore posizionale per i nodi OutlineElement. |
OutlineElement | Contenitore foglia; contiene RichText, Image, Table, AttachedFile. |
ImageRenderOptions
| ImageRenderOptions | ImageRenderOptions |
|---|---|
RichText | Blocco di testo con sequenze di formattazione, tag e collegamenti ipertestuali. |
TextRun | Singolo segmento di testo formattato all’interno di un RichText. |
TextStyle | Proprietà di formattazione per un TextRun. |
Image | Immagine incorporata con byte grezzi e metadati. |
AttachedFile | Allegato di file incorporato con byte grezzi. |
Table | Tabella con righe, celle e larghezze delle colonne. |
TableRow | Una riga all’interno di una Tabella. |
TableCell | Una cella all’interno di una TableRow; contiene content nodes. |
NoteTag | Tag OneNote (stella, casella di controllo, ecc.) allegato a un content node. |
NumberList | Metadati della lista numerata su un OutlineElement. |
ImageRenderOptions
| ImageRenderOptions | ImageRenderOptions |
|---|---|
LoadOptions | Opzioni per caricare un .one file. |
SaveOptions | Classe base per le opzioni di salvataggio. |
PdfSaveOptions | Opzioni di salvataggio specifiche per PDF (icone dei tag). |
Stub di compatibilità
| ImageRenderOptions | ImageRenderOptions |
|---|---|
License | Stub di compatibilità: SetLicense() non fa nulla in questa implementazione FOSS. |
Metered | Stub di compatibilità: SetMeteredKey() non fa nulla in questa implementazione FOSS. |
Dettagli della classe
ImageRenderOptions
La classe documento radice. Carica un .one file da un percorso, un pathlib.Path, o un flusso binario.
from aspose.note import Document, LoadOptions
doc = Document(source=None, load_options=None)Parametri del costruttore:
| ImageRenderOptions | ImageRenderOptions | ImageRenderOptions |
|---|---|---|
source | `str | Path |
load_options | `LoadOptions | None` |
ImageRenderOptions:
| ImageRenderOptions | ImageRenderOptions | ImageRenderOptions |
|---|---|---|
DisplayName | `str | None` |
CreationTime | `datetime | None` |
FileFormat | FileFormat | Indicazione approssimativa della versione del formato file OneNote |
ImageRenderOptions:
| ImageRenderOptions | ImageRenderOptions | ImageRenderOptions |
|---|---|---|
Count() | () -> int | Numero di pagine figlio dirette |
GetPageHistory(page) | (Page) -> list[Page] | ImageRenderOptions [page] (stub; cronologia completa non ancora implementata) |
DetectLayoutChanges() | () -> None | Stub di compatibilità; nessuna operazione |
Save(target, format_or_options) | `(str | Path |
Accept(visitor) | (DocumentVisitor) -> None | Invoca il visitor traversal |
for page in doc | N/A | Itera il figlio diretto Page nodi |
Document.FileFormat nota: La proprietà fornisce un’indicazione di massima della versione del formato file OneNote. Il FileFormat l’enum ha tre valori: OneNote2010, OneNoteOnline, e OneNote2007.
Document.Save() supporto stream: target può essere un flusso binario (io.BytesIO, handle di file aperto in modalità scrittura binaria, ecc.). Questo è confermato dalla suite di test: doc.Save(io.BytesIO(), PdfSaveOptions(SaveFormat.Pdf)).
DocumentVisitor
Classe base astratta per il traversal con pattern visitor. Sovrascrivi i metodi visit di cui hai bisogno:
| ImageRenderOptions | Chiamato quando |
|---|---|
VisitDocumentStart(doc) | Entrando in un nodo Document |
VisitDocumentEnd(doc) | Uscendo da un nodo Document |
VisitPageStart(page) | Entrando in un nodo Page |
VisitPageEnd(page) | Uscendo da un nodo Page |
VisitTitleStart(title) | Entrando in un nodo Title |
VisitTitleEnd(title) | Uscendo da un nodo Title |
VisitOutlineStart(outline) | Entrando in un nodo Outline |
VisitOutlineEnd(outline) | Uscendo da un nodo Outline |
VisitOutlineElementStart(oe) | Entrando in un nodo OutlineElement |
VisitOutlineElementEnd(oe) | Uscendo da un nodo OutlineElement |
VisitRichTextStart(rt) | Entrando in un nodo RichText |
VisitRichTextEnd(rt) | Uscendo da un nodo RichText |
VisitImageStart(img) | Entrando in un nodo Image |
VisitImageEnd(img) | Uscendo da un nodo Image |
ImageRenderOptions
Classe base per tutti i nodi dell’albero del documento.
| Proprietà / Metodo | ImageRenderOptions | ImageRenderOptions |
|---|---|---|
ParentNode | `Node | None` |
Document | `Document | None` |
Accept(visitor) | (DocumentVisitor) -> None | Invia il visitatore per questo nodo |
CompositeNode
ImageRenderOptions Node. Aggiunge la gestione dei figli:
| Proprietà / Metodo | ImageRenderOptions |
|---|---|
FirstChild | Primo nodo figlio, oppure None |
LastChild | Ultimo nodo figlio, oppure None |
AppendChildLast(node) | Aggiungi un nodo figlio alla fine; imposta node.ParentNode = self |
AppendChildFirst(node) | Aggiungi un nodo figlio all’inizio |
InsertChild(index, node) | Inserisci un figlio nella posizione indicata |
RemoveChild(node) | Rimuovi un nodo figlio; imposta node.ParentNode = None |
GetEnumerator() | Restituisce un iteratore sui figli diretti |
for child in node | Itera i figli diretti |
GetChildNodes(Type) | (Type) -> list[Type]:ricerca ricorsiva, in profondità dell’intero sottoalbero includendo self |
ImageRenderOptions
ImageRenderOptions CompositeNode. Rappresenta una pagina OneNote.
| ImageRenderOptions | ImageRenderOptions | ImageRenderOptions |
|---|---|---|
Title | `Title | None` |
Author | `str | None` |
CreationTime | `datetime | None` |
LastModifiedTime | `datetime | None` |
Level | `int | None` |
ImageRenderOptions:
| ImageRenderOptions | ImageRenderOptions |
|---|---|
Clone(deep=False) | Restituisce una clonazione superficiale o profonda della pagina |
ImageRenderOptions
ImageRenderOptions CompositeNode. Contiene il blocco titolo di una Page.
| ImageRenderOptions | ImageRenderOptions | ImageRenderOptions |
|---|---|---|
TitleText | `RichText | None` |
TitleDate | `RichText | None` |
TitleTime | `RichText | None` |
ImageRenderOptions
ImageRenderOptions CompositeNode. Un contenitore posizionale per OutlineElement nodi.
| ImageRenderOptions | ImageRenderOptions | ImageRenderOptions |
|---|---|---|
X | `float | None` |
Y | `float | None` |
Width | `float | None` |
OutlineElement
ImageRenderOptions CompositeNode. Un contenitore foglia che contiene nodi di contenuto.
| ImageRenderOptions | ImageRenderOptions | ImageRenderOptions |
|---|---|---|
IndentLevel | int | Profondità di nidificazione (0 = più esterno) |
NumberList | `NumberList | None` |
Tags | list[NoteTag] | Tag OneNote associati a questo elemento |
RichText
ImageRenderOptions CompositeNode. Un blocco di testo formattato.
| ImageRenderOptions | ImageRenderOptions | ImageRenderOptions |
|---|---|---|
Text | str | Stringa di testo semplice completa (tutte le sequenze concatenate) |
Runs | list[TextRun] | Elenco ordinato di segmenti formattati |
FontSize | `float | None` |
Tags | list[NoteTag] | Tag OneNote associati a questo blocco |
ImageRenderOptions:
| ImageRenderOptions | ImageRenderOptions | ImageRenderOptions |
|---|---|---|
Append(text, style=None) | `(str, TextStyle | None) -> RichText` |
Replace(old_value, new_value) | (str, str) -> None | Sostituzione di stringa in memoria su Text; non aggiorna Runs |
TextRun
ImageRenderOptions Node. Un singolo segmento di testo formattato.
| ImageRenderOptions | ImageRenderOptions | ImageRenderOptions |
|---|---|---|
Text | str | Il contenuto testuale del segmento (predefinito "") |
Style | TextStyle | Proprietà di formattazione |
Start | `int | None` |
End | `int | None` |
TextStyle
ImageRenderOptions Node. Proprietà di formattazione per carattere per un 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 | Se questo segmento è un collegamento ipertestuale |
HyperlinkAddress | `str | None` | None |
ImageRenderOptions
ImageRenderOptions CompositeNode. Un’immagine incorporata.
| ImageRenderOptions | ImageRenderOptions | ImageRenderOptions |
|---|---|---|
FileName | `str | None` |
Bytes | bytes | Dati grezzi dell’immagine (predefinito b"") |
Width | `float | None` |
Height | `float | None` |
AlternativeTextTitle | `str | None` |
AlternativeTextDescription | `str | None` |
HyperlinkUrl | `str | None` |
Tags | list[NoteTag] | Tag di OneNote allegati a questa immagine |
ImageRenderOptions:
| ImageRenderOptions | ImageRenderOptions |
|---|---|
Replace(image) | ImageRenderOptions Bytes e FileName da un altro Image nodo in questo |
AttachedFile
ImageRenderOptions CompositeNode. Un allegato di file incorporato.
| ImageRenderOptions | ImageRenderOptions | ImageRenderOptions |
|---|---|---|
FileName | `str | None` |
Bytes | bytes | Dati grezzi del file (predefinito b"") |
Tags | list[NoteTag] | Tag di OneNote allegati a questo allegato |
ImageRenderOptions
ImageRenderOptions CompositeNode. Una tabella all’interno di un OutlineElement.
| ImageRenderOptions | ImageRenderOptions | ImageRenderOptions | ImageRenderOptions |
|---|---|---|---|
Columns | list[float] | [] | Larghezza di ogni colonna in punti |
IsBordersVisible | bool | True | Se i bordi della tabella sono visibili |
Tags | list[NoteTag] | [] | Tag OneNote associati a questa tabella |
TableRow
ImageRenderOptions CompositeNode. Una riga all’interno di una Table. Itera GetChildNodes(TableCell) per accedere alle celle.
TableCell
ImageRenderOptions CompositeNode. Una cella all’interno di una TableRow. Contiene RichText, Image, e altri nodi di contenuto.
NoteTag
ImageRenderOptions Node. Un tag OneNote collegato a un nodo di contenuto.
| 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 |
Nota del timestamp: created e completed sono timestamp interi grezzi analizzati dal formato binario MS-ONE, non datetime oggetti.
Metodi di fabbrica:
| ImageRenderOptions | ImageRenderOptions |
|---|---|
NoteTag.CreateYellowStar() | Crea un NoteTag(shape=None, label="Yellow Star") |
NumberList
ImageRenderOptions Node. Metadati di elenco numerato o puntato su un OutlineElement.
| ImageRenderOptions | ImageRenderOptions | ImageRenderOptions | ImageRenderOptions |
|---|---|---|---|
Format | `str | None` | None |
Restart | `int | None` | None |
IsNumbered | bool | False | Vero per elenchi ordinati (numerati) |
LoadOptions
| ImageRenderOptions | ImageRenderOptions | ImageRenderOptions | ImageRenderOptions |
|---|---|---|---|
DocumentPassword | `str | None` | None |
LoadHistory | bool | False | Campo di compatibilità API; non utilizzato funzionalmente in v26.3.1 |
SaveOptions
Classe base per tutte le opzioni di salvataggio. Argomento posizionale obbligatorio.
| ImageRenderOptions | ImageRenderOptions | ImageRenderOptions |
|---|---|---|
SaveFormat | SaveFormat | Formato di salvataggio di destinazione |
PdfSaveOptions
ImageRenderOptions SaveOptions. Configurazione di esportazione specifica per PDF. Costruire con PdfSaveOptions(SaveFormat.Pdf).
| ImageRenderOptions | ImageRenderOptions | ImageRenderOptions | ImageRenderOptions |
|---|---|---|---|
PageIndex | int | 0 | Il campo esiste; non inoltrato all’esportatore PDF in v26.3.1: non ha alcun effetto sull’output |
PageCount | `int | None` | None |
TagIconDir | `str | None` | None |
TagIconSize | `float | None` | None |
TagIconGap | `float | None` | None |
PageIndex / PageCount avvertenza: Questi campi sono dichiarati su PdfSaveOptions per compatibilità API, ma il Document.Save() implementazione in v26.3.1 non legge né li inoltra all’esportatore PDF. Tutte le pagine vengono sempre esportate.
Licenza e a consumo
Stub di compatibilità esportati per la compatibilità della forma dell’API con Aspose.Note per .NET. Tutti i metodi sono no-op in questa implementazione 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-opNon è necessaria alcuna chiave di licenza per utilizzare qualsiasi funzionalità di Aspose.Note FOSS per Python.
ImageRenderOptions
Riferimento completo dell’enumerazione: ImageRenderOptions
SaveFormat
| ImageRenderOptions | ImageRenderOptions |
|---|---|
SaveFormat.Pdf | Esportazione PDF: implementata; richiede pip install "aspose-note[pdf]" |
SaveFormat.One | Formato OneNote: dichiarato solo; genera UnsupportedSaveFormatException |
FileFormat
Valori enum che rappresentano la versione del formato file OneNote. Document.FileFormat fornisce un’indicazione al meglio delle possibilità.
| ImageRenderOptions | Valore stringa |
|---|---|
FileFormat.OneNote2010 | "onenote2010" |
FileFormat.OneNoteOnline | "onenoteonline" |
FileFormat.OneNote2007 | "onenote2007" |
HorizontalAlignment
| ImageRenderOptions | Valore stringa |
|---|---|
HorizontalAlignment.Left | "left" |
HorizontalAlignment.Center | "center" |
HorizontalAlignment.Right | "right" |
NodeType
| ImageRenderOptions | Valore stringa |
|---|---|
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
Riferimento completo all’eccezione: ImageRenderOptions
| ImageRenderOptions | ImageRenderOptions |
|---|---|
AsposeNoteError | Classe base per tutte le eccezioni Aspose.Note FOSS |
FileCorruptedException | ImageRenderOptions .one file non può essere analizzato (binario corrotto o malformato) |
IncorrectDocumentStructureException | La struttura del file non è valida o non è supportata |
IncorrectPasswordException | Generato quando LoadOptions.DocumentPassword è impostato; i documenti crittografati non sono supportati |
UnsupportedFileFormatException | Il formato del file non è riconosciuto; espone un FileFormat campo (string) |
UnsupportedSaveFormatException | Il richiesto SaveFormat non è implementato in questa versione |