Aspose.Note FOSS for Python
Šī atsauce aptver pilnīgu publiskā API virsmu aspose-note versija 26.3.1. Tikai simboli, kas eksportēti no aspose.note pakotnes, ir dokumentēti šeit. Viss, kas atrodas zem aspose.note._internal ir īstenošanas detaļa un var mainīties bez brīdinājuma.
ImageRenderOptions: pip install aspose-note (core) vai pip install "aspose-note[pdf]" (ar PDF eksportu)
ImageRenderOptions: from aspose.note import Document, RichText, ...
ImageRenderOptions
Dokuments un pārlūkošana
| ImageRenderOptions | ImageRenderOptions |
|---|---|
Document | Saknes dokumenta objekts. Ielādēt a .one failu, iterēt lapas un saglabāt PDF. |
DocumentVisitor | Abstrakts pamats apmeklētāja modeļa pārlūkošanai dokumenta kokā. |
Node | Pamatklase visiem dokumenta mezgliem. |
CompositeNode | Bāzes klase mezgliem, kas var saturēt apakšmezglus. |
Dokumenta struktūra
| ImageRenderOptions | ImageRenderOptions |
|---|---|
Page | Attēlo OneNote lapu. |
Title | Lapas virsraksta bloks, kas satur TitleText, TitleDate, TitleTime. |
Outline | Pozicionēts konteineris OutlineElement mezgliem. |
OutlineElement | Lapas konteineris; satur RichText, Image, Table, AttachedFile. |
ImageRenderOptions
| ImageRenderOptions | ImageRenderOptions |
|---|---|
RichText | Teksta bloks ar formatēšanas sekcijām, tagiem un hipersaitēm. |
TextRun | Viens formatēts teksta fragments RichText ietvaros. |
TextStyle | Formatēšanas īpašības TextRun. |
Image | Iegultais attēls ar neapstrādātiem baitiem un metadatiem. |
AttachedFile | Iegultais faila pielikums ar neapstrādātiem baitiem. |
Table | Tabula ar rindām, šūnām un kolonnu platumiem. |
TableRow | Rinda tabulā. |
TableCell | Šūna TableRow ietvarā; satur satura mezglus. |
NoteTag | OneNote tags (zvaigzne, izvēles rūtiņa utt.) pievienots satura mezglam. |
NumberList | Numurēta saraksta metadati uz OutlineElement. |
ImageRenderOptions
| ImageRenderOptions | ImageRenderOptions |
|---|---|
LoadOptions | Iespējas ielādēt .one failu. |
SaveOptions | Bāzes klase saglabāšanas opcijām. |
PdfSaveOptions | PDF specifiskas saglabāšanas iespējas (tagu ikonas). |
Saderības stubi
| ImageRenderOptions | ImageRenderOptions |
|---|---|
License | Saderības stub: SetLicense() ir neizpildes darbība šajā FOSS īstenošanā. |
Metered | Saderības stub: SetMeteredKey() ir neizpildes darbība šajā FOSS īstenošanā. |
Klases detaļas
ImageRenderOptions
Saknes dokumenta klase. Ielādēt a .one failu no faila ceļa, a pathlib.Path, vai bināro plūsmu.
from aspose.note import Document, LoadOptions
doc = Document(source=None, load_options=None)Konstruktora parametri:
| ImageRenderOptions | ImageRenderOptions | ImageRenderOptions |
|---|---|---|
source | `str | Path |
load_options | `LoadOptions | None` |
ImageRenderOptions:
| ImageRenderOptions | ImageRenderOptions | ImageRenderOptions |
|---|---|---|
DisplayName | `str | None` |
CreationTime | `datetime | None` |
FileFormat | FileFormat | Labākas piepēšanas indikācija par OneNote faila formāta versiju |
ImageRenderOptions:
| ImageRenderOptions | ImageRenderOptions | ImageRenderOptions |
|---|---|---|
Count() | () -> int | Tiešo apakšlapu skaits |
GetPageHistory(page) | (Page) -> list[Page] | ImageRenderOptions [page] (stub; pilna vēsture vēl nav īstenota) |
DetectLayoutChanges() | () -> None | Saderības stub; nav darbības |
Save(target, format_or_options) | `(str | Path |
Accept(visitor) | (DocumentVisitor) -> None | Izsaukt apmeklētāja pārlūkošanu |
for page in doc | N/A | Iterēt tiešo bērna elementu Page mezgli |
Document.FileFormat piezīme: Īpašība sniedz labāko iespējamā mēģinājuma norādi par OneNote faila formāta versiju. The FileFormat enum satur trīs vērtības: OneNote2010, OneNoteOnline, un OneNote2007.
Document.Save() plūsmas atbalsts: target var būt bināra plūsma (io.BytesIO, faila rokturis atvērts binārā rakstīšanas režīmā, utt.). Tas ir apstiprināts ar testu komplektu: doc.Save(io.BytesIO(), PdfSaveOptions(SaveFormat.Pdf)).
DocumentVisitor
Abstrakta pamata klase apmeklētāja modeļa pārlūkošanai. Pārrakstiet vajadzīgās apmeklējuma metodes:
| ImageRenderOptions | Izsauc, kad |
|---|---|
VisitDocumentStart(doc) | Ienākot Document mezglā |
VisitDocumentEnd(doc) | Iziet no Document mezgla |
VisitPageStart(page) | Ienākot Page mezglā |
VisitPageEnd(page) | Iziet no Page mezgla |
VisitTitleStart(title) | Ienākot Title mezglā |
VisitTitleEnd(title) | Iziet no Title mezgla |
VisitOutlineStart(outline) | Ienākot Outline mezglā |
VisitOutlineEnd(outline) | Iziet no Outline mezgla |
VisitOutlineElementStart(oe) | Ienākot OutlineElement mezglā |
VisitOutlineElementEnd(oe) | Iziet no OutlineElement mezgla |
VisitRichTextStart(rt) | Ienākot RichText mezglā |
VisitRichTextEnd(rt) | Iziet no RichText mezgla |
VisitImageStart(img) | Ienākot Image mezglā |
VisitImageEnd(img) | Iziet no Image mezgla |
ImageRenderOptions
Bāzes klase visiem dokumenta koka mezgliem.
| Īpašība / Metode | ImageRenderOptions | ImageRenderOptions |
|---|---|---|
ParentNode | `Node | None` |
Document | `Document | None` |
Accept(visitor) | (DocumentVisitor) -> None | Izsūtīt apmeklētāju šim mezglam |
CompositeNode
ImageRenderOptions Node. Pievieno bērnu pārvaldību:
| Īpašība / Metode | ImageRenderOptions |
|---|---|
FirstChild | Pirmais bērna mezgls, vai None |
LastChild | Pēdējais bērna mezgls, vai None |
AppendChildLast(node) | Pievieno bērna mezglu beigās; iestata node.ParentNode = self |
AppendChildFirst(node) | Pievieno bērna mezglu sākumā |
InsertChild(index, node) | Ievieto bērnu norādītajā pozīcijā |
RemoveChild(node) | Noņem bērna mezglu; iestata node.ParentNode = None |
GetEnumerator() | Atgriež iteratoru pār tiešajiem bērniem |
for child in node | Iterēt tiešos bērnus |
GetChildNodes(Type) | (Type) -> list[Type]: rekursīvs, dziļuma pirmas meklēšanas (depth-first) visā apakškokā, ieskaitot self |
ImageRenderOptions
ImageRenderOptions CompositeNode. Attēlo OneNote lapu.
| ImageRenderOptions | ImageRenderOptions | ImageRenderOptions |
|---|---|---|
Title | `Title | None` |
Author | `str | None` |
CreationTime | `datetime | None` |
LastModifiedTime | `datetime | None` |
Level | `int | None` |
ImageRenderOptions:
| ImageRenderOptions | ImageRenderOptions |
|---|---|
Clone(deep=False) | Atgriež virspusēju vai dziļu lapas klonu |
ImageRenderOptions
ImageRenderOptions CompositeNode. Satur virsraksta bloku no Page.
| ImageRenderOptions | ImageRenderOptions | ImageRenderOptions |
|---|---|---|
TitleText | `RichText | None` |
TitleDate | `RichText | None` |
TitleTime | `RichText | None` |
ImageRenderOptions
ImageRenderOptions CompositeNode. Pozicionēts konteiners priekš OutlineElement mezgli.
| ImageRenderOptions | ImageRenderOptions | ImageRenderOptions |
|---|---|---|
X | `float | None` |
Y | `float | None` |
Width | `float | None` |
OutlineElement
ImageRenderOptions CompositeNode. Koka konteineris, kas satur satura mezglus.
| ImageRenderOptions | ImageRenderOptions | ImageRenderOptions |
|---|---|---|
IndentLevel | int | Iekļaušanas dziļums (0 = ārējais) |
NumberList | `NumberList | None` |
Tags | list[NoteTag] | OneNote tagi, kas pievienoti šim elementam |
RichText
ImageRenderOptions CompositeNode. Stilizēta teksta bloks.
| ImageRenderOptions | ImageRenderOptions | ImageRenderOptions |
|---|---|---|
Text | str | Pilna vienkāršā teksta virkne (visi fragmenti savienoti) |
Runs | list[TextRun] | Sakārtots saraksts ar formatētiem segmentiem |
FontSize | `float | None` |
Tags | list[NoteTag] | OneNote birkas pievienotas šim blokam |
ImageRenderOptions:
| ImageRenderOptions | ImageRenderOptions | ImageRenderOptions |
|---|---|---|
Append(text, style=None) | `(str, TextStyle | None) -> RichText` |
Replace(old_value, new_value) | (str, str) -> None | Virknes aizvietošana atmiņā uz Text; neatjaunina Runs |
TextRun
ImageRenderOptions Node. Viena formatēta teksta segments.
| ImageRenderOptions | ImageRenderOptions | ImageRenderOptions |
|---|---|---|
Text | str | Segmenta teksta saturs (noklusējums "") |
Style | TextStyle | Formatēšanas īpašības |
Start | `int | None` |
End | `int | None` |
TextStyle
ImageRenderOptions Node. Per-rakstzīmes formatēšanas īpašības priekš 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 | Vai šis fragments ir hipersaite |
HyperlinkAddress | `str | None` | None |
ImageRenderOptions
ImageRenderOptions CompositeNode. Iegultais attēls.
| ImageRenderOptions | ImageRenderOptions | ImageRenderOptions |
|---|---|---|
FileName | `str | None` |
Bytes | bytes | Neapstrādāti attēla dati (noklusējums b"") |
Width | `float | None` |
Height | `float | None` |
AlternativeTextTitle | `str | None` |
AlternativeTextDescription | `str | None` |
HyperlinkUrl | `str | None` |
Tags | list[NoteTag] | OneNote birkas, kas pievienotas šim attēlam |
ImageRenderOptions:
| ImageRenderOptions | ImageRenderOptions |
|---|---|
Replace(image) | ImageRenderOptions Bytes un FileName no cita Image mezglu šajā |
AttachedFile
ImageRenderOptions CompositeNode. Iegultais faila pielikums.
| ImageRenderOptions | ImageRenderOptions | ImageRenderOptions |
|---|---|---|
FileName | `str | None` |
Bytes | bytes | Neapstrādāti faila dati (noklusējums b"") |
Tags | list[NoteTag] | OneNote birkas, kas pievienotas šim pielikumam |
ImageRenderOptions
ImageRenderOptions CompositeNode. Tabula iekš OutlineElement.
| ImageRenderOptions | ImageRenderOptions | ImageRenderOptions | ImageRenderOptions |
|---|---|---|---|
Columns | list[float] | [] | Katras kolonnas platums punktos |
IsBordersVisible | bool | True | Vai tabulas robežas ir redzamas |
Tags | list[NoteTag] | [] | OneNote birkas pievienotas šai tabulai |
TableRow
ImageRenderOptions CompositeNode. Rinda iekš Table. Iterēt GetChildNodes(TableCell) lai piekļūtu šūnām.
TableCell
ImageRenderOptions CompositeNode. Šūna iekš TableRow. Satur RichText, Image, un citi satura mezgli.
NoteTag
ImageRenderOptions Node. OneNote iezīme, kas pievienota satura mezglam.
| 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 |
Laika zīmes piezīme: created un completed ir neapstrādātas veselu skaitļu laika zīmes, kas izparsētas no MS-ONE binārā formāta, nevis datetime objekti.
Fabrikas metodes:
| ImageRenderOptions | ImageRenderOptions |
|---|---|
NoteTag.CreateYellowStar() | Izveido NoteTag(shape=None, label="Yellow Star") |
NumberList
ImageRenderOptions Node. Numurēta vai aizzīmēta saraksta metadati uz OutlineElement.
| ImageRenderOptions | ImageRenderOptions | ImageRenderOptions | ImageRenderOptions |
|---|---|---|---|
Format | `str | None` | None |
Restart | `int | None` | None |
IsNumbered | bool | False | True sakārtotiem (numurētiem) sarakstiem |
LoadOptions
| ImageRenderOptions | ImageRenderOptions | ImageRenderOptions | ImageRenderOptions |
|---|---|---|---|
DocumentPassword | `str | None` | None |
LoadHistory | bool | False | API saderības lauks; funkcionāli neizmantots versijā v26.3.1 |
SaveOptions
Bāzes klase visām saglabāšanas opcijām. Nepieciešams pozīcijas arguments.
| ImageRenderOptions | ImageRenderOptions | ImageRenderOptions |
|---|---|---|
SaveFormat | SaveFormat | Mērķa saglabāšanas formāts |
PdfSaveOptions
ImageRenderOptions SaveOptions. PDF-specifiska eksporta konfigurācija. Izveidot ar PdfSaveOptions(SaveFormat.Pdf).
| ImageRenderOptions | ImageRenderOptions | ImageRenderOptions | ImageRenderOptions |
|---|---|---|---|
PageIndex | int | 0 | Lauks pastāv; nav pārsūtīts uz PDF eksportētāju versijā v26.3.1: nav ietekmes uz izvadi |
PageCount | `int | None` | None |
TagIconDir | `str | None` | None |
TagIconSize | `float | None` | None |
TagIconGap | `float | None` | None |
PageIndex / PageCount brīdinājums: Šie lauki ir deklarēti uz PdfSaveOptions API saderībai, bet the Document.Save() implementācija versijā v26.3.1 nolasīs vai nepārsūta tos PDF eksportētājam. Visas lapas vienmēr tiek eksportētas.
Licence un tarifēts
Saderības stubi eksportēti API struktūras saderībai ar Aspose.Note priekš .NET. Visi metodes šajā FOSS implementācijā ir neizpildes (no‑ops).
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-opLai izmantotu jebkuru Aspose.Note FOSS funkciju Python, nav nepieciešama licences atslēga.
ImageRenderOptions
Pilna uzskaitījuma atsauce: ImageRenderOptions
SaveFormat
| ImageRenderOptions | ImageRenderOptions |
|---|---|
SaveFormat.Pdf | PDF eksports: implementēts; nepieciešams pip install "aspose-note[pdf]" |
SaveFormat.One | OneNote formāts: tikai deklarēts; izraisa UnsupportedSaveFormatException |
FileFormat
Uzskaitījuma vērtības, kas pārstāv OneNote faila formāta versiju. Document.FileFormat sniedz labāko iespējamā mēģinājuma indikāciju.
| ImageRenderOptions | Virknes vērtība |
|---|---|
FileFormat.OneNote2010 | "onenote2010" |
FileFormat.OneNoteOnline | "onenoteonline" |
FileFormat.OneNote2007 | "onenote2007" |
HorizontalAlignment
| ImageRenderOptions | Virknes vērtība |
|---|---|
HorizontalAlignment.Left | "left" |
HorizontalAlignment.Center | "center" |
HorizontalAlignment.Right | "right" |
NodeType
| ImageRenderOptions | Virknes vērtība |
|---|---|
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
Pilna izņēmuma atsauce: ImageRenderOptions
| ImageRenderOptions | ImageRenderOptions |
|---|---|
AsposeNoteError | Bāzes klase visiem Aspose.Note FOSS izņēmumiem |
FileCorruptedException | ImageRenderOptions .one fails nevar tikt parsēts (bojāts vai nepareizi strukturēts binārais fails) |
IncorrectDocumentStructureException | Faila struktūra ir nederīga vai neatbalstīta |
IncorrectPasswordException | Izraisīts, kad LoadOptions.DocumentPassword ir iestatīts; šifrēti dokumenti netiek atbalstīti |
UnsupportedFileFormatException | Faila formāts nav atpazīts; atklāj a FileFormat lauks (string) |
UnsupportedSaveFormatException | Pieprasītais SaveFormat nav īstenots šajā versijā |