Aspose.Note FOSS for Python
Αυτό το εγχειρίδιο καλύπτει την πλήρη δημόσια επιφάνεια του API aspose-note έκδοση 26.3.1. Μόνο σύμβολα που εξάγονται από το aspose.note πακέτο τεκμηριώνονται εδώ. Οτιδήποτε κάτω από aspose.note._internal είναι λεπτομέρεια υλοποίησης και μπορεί να αλλάξει χωρίς προειδοποίηση.
ImageRenderOptions: pip install aspose-note (core) ή pip install "aspose-note[pdf]" (με εξαγωγή PDF)
ImageRenderOptions: from aspose.note import Document, RichText, ...
ImageRenderOptions
Έγγραφο και Διάσχιση
| ImageRenderOptions | ImageRenderOptions |
|---|---|
Document | Αντικείμενο ρίζας εγγράφου. Φορτώστε ένα .one αρχείο, επαναλάβετε τις σελίδες και αποθηκεύστε σε PDF. |
DocumentVisitor | Αφηρημένη βάση για τη διέλευση με το μοτίβο επισκέπτη του δέντρου εγγράφου. |
Node | Βασική κλάση για όλους τους κόμβους εγγράφου. |
CompositeNode | Βασική κλάση για κόμβους που μπορούν να περιέχουν υποκόμβους. |
Δομή Εγγράφου
| ImageRenderOptions | ImageRenderOptions |
|---|---|
Page | Αναπαριστά μια σελίδα OneNote. |
Title | Μπλοκ τίτλου σελίδας που περιέχει TitleText, TitleDate, TitleTime. |
Outline | Θέση-υποδοχέας για κόμβους OutlineElement. |
OutlineElement | Φύλλο υποδοχέας· περιέχει RichText, Image, Table, AttachedFile. |
ImageRenderOptions
| ImageRenderOptions | ImageRenderOptions |
|---|---|
RichText | Μπλοκ κειμένου με τμήματα μορφοποίησης, ετικέτες και υπερσυνδέσμους. |
TextRun | Μονό μορφοποιημένο τμήμα κειμένου μέσα σε RichText. |
TextStyle | Ιδιότητες μορφοποίησης για ένα TextRun. |
Image | Ενσωματωμένη εικόνα με raw bytes και metadata. |
AttachedFile | Ενσωματωμένο αρχείο συνημμένο με raw bytes. |
Table | Πίνακας με γραμμές, κελιά και πλάτη στηλών. |
TableRow | Μια γραμμή μέσα σε έναν Πίνακα. |
TableCell | Ένα κελί μέσα σε μια TableRow; περιέχει κόμβους περιεχομένου. |
NoteTag | Ετικέτα OneNote (αστέρι, πλαίσιο ελέγχου κ.λπ.) συνδεδεμένη με έναν κόμβο περιεχομένου. |
NumberList | Μεταδεδομένα αριθμημένης λίστας σε ένα OutlineElement. |
ImageRenderOptions
| ImageRenderOptions | ImageRenderOptions |
|---|---|
LoadOptions | Επιλογές για τη φόρτωση ενός .one αρχείου. |
SaveOptions | Βασική κλάση για επιλογές αποθήκευσης. |
PdfSaveOptions | Επιλογές αποθήκευσης ειδικές για PDF (εικονίδια ετικετών). |
Stub Συμβατότητας
| ImageRenderOptions | ImageRenderOptions |
|---|---|
License | Κώδικας συμβατότητας: SetLicense() είναι μια λειτουργία μη-ενεργής σε αυτήν την υλοποίηση FOSS. |
Metered | Κώδικας συμβατότητας: SetMeteredKey() είναι μια λειτουργία μη-ενεργής σε αυτήν την υλοποίηση FOSS. |
Λεπτομέρειες Κλάσης
ImageRenderOptions
Η κλάση ριζικού εγγράφου. Φορτώστε ένα .one αρχείο από διαδρομή αρχείου, ένα pathlib.Path, ή ένα δυαδικό ρεύμα.
from aspose.note import Document, LoadOptions
doc = Document(source=None, load_options=None)Παράμετροι κατασκευής:
| ImageRenderOptions | ImageRenderOptions | ImageRenderOptions |
|---|---|---|
source | `str | Path |
load_options | `LoadOptions | None` |
ImageRenderOptions:
| ImageRenderOptions | ImageRenderOptions | ImageRenderOptions |
|---|---|---|
DisplayName | `str | None` |
CreationTime | `datetime | None` |
FileFormat | FileFormat | Ένδειξη, κατά το δυνατόν, της έκδοσης μορφής αρχείου OneNote |
ImageRenderOptions:
| ImageRenderOptions | ImageRenderOptions | ImageRenderOptions |
|---|---|---|
Count() | () -> int | Αριθμός άμεσων θυγατρικών σελίδων |
GetPageHistory(page) | (Page) -> list[Page] | ImageRenderOptions [page] (πρόχειρο; η πλήρης ιστορία δεν έχει ακόμη υλοποιηθεί) |
DetectLayoutChanges() | () -> None | Πρόχειρο συμβατότητας· χωρίς λειτουργία |
Save(target, format_or_options) | `(str | Path |
Accept(visitor) | (DocumentVisitor) -> None | Κλήση διέλευσης επισκέπτη |
for page in doc | N/A | Επανάληψη άμεσου παιδιού Page κόμβων |
Document.FileFormat σημείωση: Η ιδιότητα παρέχει μια, κατά το δυνατόν, ένδειξη της έκδοσης μορφής αρχείου OneNote. Η FileFormat η απαρίθμηση έχει τρεις τιμές: OneNote2010, OneNoteOnline, και OneNote2007.
Document.Save() υποστήριξη ροής: target μπορεί να είναι μια δυαδική ροή (io.BytesIO, χειριστής αρχείου ανοιγμένος σε δυαδική λειτουργία εγγραφής, κ.λπ.). Αυτό επιβεβαιώνεται από το σύνολο δοκιμών: doc.Save(io.BytesIO(), PdfSaveOptions(SaveFormat.Pdf)).
DocumentVisitor
Αφηρημένη βασική κλάση για διάσχιση με το πρότυπο επισκέπτη. Υπερκαλύψτε τις μεθόδους επισκέψεων που χρειάζεστε:
| ImageRenderOptions | Καλείται όταν |
|---|---|
VisitDocumentStart(doc) | Είσοδος σε κόμβο Εγγράφου |
VisitDocumentEnd(doc) | Έξοδος από κόμβο Εγγράφου |
VisitPageStart(page) | Είσοδος σε κόμβο Σελίδας |
VisitPageEnd(page) | Έξοδος από κόμβο Σελίδας |
VisitTitleStart(title) | Είσοδος σε κόμβο Τίτλου |
VisitTitleEnd(title) | Έξοδος από κόμβο Τίτλου |
VisitOutlineStart(outline) | Είσοδος σε κόμβο Περιγράμματος |
VisitOutlineEnd(outline) | Έξοδος από κόμβο Περιγράμματος |
VisitOutlineElementStart(oe) | Είσοδος σε κόμβο Στοιχείου Περιγράμματος |
VisitOutlineElementEnd(oe) | Έξοδος από κόμβο Στοιχείου Περιγράμματος |
VisitRichTextStart(rt) | Είσοδος σε κόμβο Πλούσιου Κειμένου |
VisitRichTextEnd(rt) | Έξοδος από κόμβο Πλούσιου Κειμένου |
VisitImageStart(img) | Είσοδος σε κόμβο Εικόνας |
VisitImageEnd(img) | Έξοδος από κόμβο Εικόνας |
ImageRenderOptions
Βασική κλάση για όλους τους κόμβους του δέντρου εγγράφων.
| Ιδιότητα / Μέθοδος | ImageRenderOptions | ImageRenderOptions |
|---|---|---|
ParentNode | `Node | None` |
Document | `Document | None` |
Accept(visitor) | (DocumentVisitor) -> None | Αποστολή επισκέπτη για αυτόν τον κόμβο |
CompositeNode
ImageRenderOptions Node. Προσθέτει διαχείριση παιδιών:
| Ιδιότητα / Μέθοδος | ImageRenderOptions |
|---|---|
FirstChild | Πρώτος κόμβος παιδί, ή None |
LastChild | Τελευταίος κόμβος παιδί, ή None |
AppendChildLast(node) | Προσθήκη κόμβου παιδιού στο τέλος· ορίζει node.ParentNode = self |
AppendChildFirst(node) | Προσθήκη κόμβου παιδιού στην αρχή |
InsertChild(index, node) | Εισαγωγή παιδιού στη δοσμένη θέση |
RemoveChild(node) | Αφαίρεση κόμβου παιδιού· ορίζει node.ParentNode = None |
GetEnumerator() | Επιστρέφει έναν επαναλήπτη πάνω από τα άμεσα παιδιά |
for child in node | Επανάληψη άμεσων παιδιών |
GetChildNodes(Type) | (Type) -> list[Type]: αναδρομική, αναζήτηση βάθους-πρώτα σε ολόκληρο το υποδέντρο συμπεριλαμβανομένου self |
ImageRenderOptions
ImageRenderOptions CompositeNode. Αντιπροσωπεύει μια σελίδα 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) | Επιστρέφει ένα ρηχό ή βαθύ κλώνο της σελίδας |
ImageRenderOptions
ImageRenderOptions CompositeNode. Περιέχει το μπλοκ τίτλου ενός Page.
| ImageRenderOptions | ImageRenderOptions | ImageRenderOptions |
|---|---|---|
TitleText | `RichText | None` |
TitleDate | `RichText | None` |
TitleTime | `RichText | None` |
ImageRenderOptions
ImageRenderOptions CompositeNode. Ένα positional container για OutlineElement nodes.
| ImageRenderOptions | ImageRenderOptions | ImageRenderOptions |
|---|---|---|
X | `float | None` |
Y | `float | None` |
Width | `float | None` |
OutlineElement
ImageRenderOptions CompositeNode. Ένα leaf container που περιέχει content nodes.
| ImageRenderOptions | ImageRenderOptions | ImageRenderOptions |
|---|---|---|
IndentLevel | int | Βάθος ένθεσης (0 = εξωτερικότερο) |
NumberList | `NumberList | None` |
Tags | list[NoteTag] | Ετικέτες OneNote συνδεδεμένες με αυτό το στοιχείο |
RichText
ImageRenderOptions CompositeNode. Ένα μπλοκ μορφοποιημένου κειμένου.
| ImageRenderOptions | ImageRenderOptions | ImageRenderOptions |
|---|---|---|
Text | str | Πλήρης αλφαριθμητική συμβολοσειρά (όλες οι ακολουθίες ενωμένες) |
Runs | list[TextRun] | Ταξινομημένη λίστα μορφοποιημένων τμημάτων |
FontSize | `float | None` |
Tags | list[NoteTag] | Ετικέτες OneNote συνδεδεμένες με αυτό το μπλοκ |
ImageRenderOptions:
| ImageRenderOptions | ImageRenderOptions | ImageRenderOptions |
|---|---|---|
Append(text, style=None) | `(str, TextStyle | None) -> RichText` |
Replace(old_value, new_value) | (str, str) -> None | Αντικατάσταση συμβολοσειράς στη μνήμη σε Text; δεν ενημερώνεται Runs |
TextRun
ImageRenderOptions Node. Ένα ενιαίο μορφοποιημένο τμήμα κειμένου.
| ImageRenderOptions | ImageRenderOptions | ImageRenderOptions |
|---|---|---|
Text | str | Το κείμενο του τμήματος (προεπιλογή "") |
Style | TextStyle | Ιδιότητες μορφοποίησης |
Start | `int | None` |
End | `int | None` |
TextStyle
ImageRenderOptions Node. Ιδιότητες μορφοποίησης ανά χαρακτήρα για ένα 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 | Εάν αυτή η εκτέλεση είναι υπερσύνδεσμος |
HyperlinkAddress | `str | None` | None |
ImageRenderOptions
ImageRenderOptions CompositeNode. Μια ενσωματωμένη εικόνα.
| ImageRenderOptions | ImageRenderOptions | ImageRenderOptions |
|---|---|---|
FileName | `str | None` |
Bytes | bytes | Ακατέργαστα δεδομένα εικόνας (προεπιλογή b"") |
Width | `float | None` |
Height | `float | None` |
AlternativeTextTitle | `str | None` |
AlternativeTextDescription | `str | None` |
HyperlinkUrl | `str | None` |
Tags | list[NoteTag] | Ετικέτες OneNote που συνδέονται με αυτήν την εικόνα |
ImageRenderOptions:
| ImageRenderOptions | ImageRenderOptions |
|---|---|
Replace(image) | ImageRenderOptions Bytes και FileName από άλλο Image κόμβο σε αυτόν |
AttachedFile
ImageRenderOptions CompositeNode. Ένα ενσωματωμένο συνημμένο αρχείο.
| ImageRenderOptions | ImageRenderOptions | ImageRenderOptions |
|---|---|---|
FileName | `str | None` |
Bytes | bytes | Ακατέργαστα δεδομένα αρχείου (προεπιλογή b"") |
Tags | list[NoteTag] | Ετικέτες OneNote που συνδέονται με αυτό το συνημμένο |
ImageRenderOptions
ImageRenderOptions CompositeNode. Ένας πίνακας μέσα σε OutlineElement.
| ImageRenderOptions | ImageRenderOptions | ImageRenderOptions | ImageRenderOptions |
|---|---|---|---|
Columns | list[float] | [] | Πλάτος κάθε στήλης σε σημεία |
IsBordersVisible | bool | True | Εάν τα σύνορα του πίνακα είναι ορατά |
Tags | list[NoteTag] | [] | Ετικέτες OneNote που συνδέονται με αυτόν τον πίνακα |
TableRow
ImageRenderOptions CompositeNode. Μια σειρά μέσα σε ένα Table. Επανάληψη GetChildNodes(TableCell) για πρόσβαση σε κελιά.
TableCell
ImageRenderOptions CompositeNode. Ένα κελί μέσα σε ένα TableRow. Περιέχει RichText, Image, και άλλους κόμβους περιεχομένου.
NoteTag
ImageRenderOptions Node. Μια ετικέτα OneNote συνδεδεμένη με έναν κόμβο περιεχομένου.
| 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 |
Σημείωση χρονοσήμανσης: created και completed είναι ακατέργαστες ακέραιες χρονοσημάνσεις όπως αναλύονται από τη δυαδική μορφή MS-ONE, όχι datetime αντικείμενα.
Μεθόδους κατασκευής:
| ImageRenderOptions | ImageRenderOptions |
|---|---|
NoteTag.CreateYellowStar() | Δημιουργεί ένα NoteTag(shape=None, label="Yellow Star") |
NumberList
ImageRenderOptions Node. Μεταδεδομένα αριθμημένης ή κουκίδας λίστας σε ένα OutlineElement.
| ImageRenderOptions | ImageRenderOptions | ImageRenderOptions | ImageRenderOptions |
|---|---|---|---|
Format | `str | None` | None |
Restart | `int | None` | None |
IsNumbered | bool | False | Αληθές για διατεταγμένες (αριθμημένες) λίστες |
LoadOptions
| ImageRenderOptions | ImageRenderOptions | ImageRenderOptions | ImageRenderOptions |
|---|---|---|---|
DocumentPassword | `str | None` | None |
LoadHistory | bool | False | Πεδίο συμβατότητας API· δεν χρησιμοποιείται λειτουργικά στην έκδοση v26.3.1 |
SaveOptions
Βασική κλάση για όλες τις επιλογές αποθήκευσης. Απαιτούμενο ορίσμα θέσης.
| ImageRenderOptions | ImageRenderOptions | ImageRenderOptions |
|---|---|---|
SaveFormat | SaveFormat | Μορφή αποθήκευσης προορισμού |
PdfSaveOptions
ImageRenderOptions SaveOptions. Ρύθμιση εξαγωγής ειδικής για PDF. Κατασκευάστε με PdfSaveOptions(SaveFormat.Pdf).
| ImageRenderOptions | ImageRenderOptions | ImageRenderOptions | ImageRenderOptions |
|---|---|---|---|
PageIndex | int | 0 | Το πεδίο υπάρχει; δεν προωθείται στον εξαγωγέα PDF στην έκδοση v26.3.1: δεν έχει καμία επίδραση στην έξοδο |
PageCount | `int | None` | None |
TagIconDir | `str | None` | None |
TagIconSize | `float | None` | None |
TagIconGap | `float | None` | None |
PageIndex / PageCount προειδοποίηση: Αυτά τα πεδία δηλώνονται στο PdfSaveOptions για συμβατότητα API, αλλά το Document.Save() η υλοποίηση στην έκδοση v26.3.1 δεν διαβάζει ή προωθεί τα στοιχεία στον εξαγωγέα PDF. Όλες οι σελίδες εξάγονται πάντα.
Άδεια και Μετρημένη
Εξάγονται υποδομές συμβατότητας για συμβατότητα σχήματος API με Aspose.Note για .NET. Όλες οι μέθοδοι είναι μη-ενεργές σε αυτήν την υλοποίηση 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Δεν απαιτείται κλειδί άδειας για τη χρήση οποιουδήποτε χαρακτηριστικού του Aspose.Note FOSS για Python.
ImageRenderOptions
Πλήρης αναφορά απαρίθμησης: ImageRenderOptions
SaveFormat
| ImageRenderOptions | ImageRenderOptions |
|---|---|
SaveFormat.Pdf | Εξαγωγή PDF: υλοποιήθηκε· απαιτεί pip install "aspose-note[pdf]" |
SaveFormat.One | Μορφή OneNote: δηλωμένη μόνο· προκαλεί UnsupportedSaveFormatException |
FileFormat
Τιμές enum που αντιπροσωπεύουν την έκδοση του αρχείου OneNote. Document.FileFormat παρέχει μια ένδειξη με τις καλύτερες προσπάθειες.
| ImageRenderOptions | Τιμή συμβολοσειράς |
|---|---|
FileFormat.OneNote2010 | "onenote2010" |
FileFormat.OneNoteOnline | "onenoteonline" |
FileFormat.OneNote2007 | "onenote2007" |
HorizontalAlignment
| ImageRenderOptions | Τιμή συμβολοσειράς |
|---|---|
HorizontalAlignment.Left | "left" |
HorizontalAlignment.Center | "center" |
HorizontalAlignment.Right | "right" |
NodeType
| ImageRenderOptions | Τιμή συμβολοσειράς |
|---|---|
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
Πλήρης αναφορά εξαίρεσης: ImageRenderOptions
| ImageRenderOptions | ImageRenderOptions |
|---|---|
AsposeNoteError | Βασική κλάση για όλες τις εξαιρέσεις Aspose.Note FOSS |
FileCorruptedException | ImageRenderOptions .one αδυναμία ανάλυσης του αρχείου (κατεστραμμένο ή εσφαλμένο δυαδικό) |
IncorrectDocumentStructureException | Η δομή του αρχείου είναι άκυρη ή μη υποστηριζόμενη |
IncorrectPasswordException | Εγείρεται όταν LoadOptions.DocumentPassword είναι ορισμένο· τα κρυπτογραφημένα έγγραφα δεν υποστηρίζονται |
UnsupportedFileFormatException | Η μορφή αρχείου δεν αναγνωρίζεται· αποκαλύπτει ένα FileFormat πεδίο (string) |
UnsupportedSaveFormatException | Το ζητούμενο SaveFormat δεν έχει υλοποιηθεί σε αυτήν την έκδοση |
