Aspose.Note FOSS for Python
Referensi ini mencakup seluruh permukaan API publik dari aspose-note versi 26.3.1. Hanya simbol yang diekspor dari aspose.note paket yang didokumentasikan di sini. Apa pun di bawah aspose.note._internal adalah detail implementasi dan dapat berubah tanpa pemberitahuan.
ImageRenderOptions: pip install aspose-note (core) atau pip install "aspose-note[pdf]" (dengan ekspor PDF)
ImageRenderOptions: from aspose.note import Document, RichText, ...
ImageRenderOptions
Dokumen dan Penelusuran
| ImageRenderOptions | ImageRenderOptions |
|---|---|
Document | Objek dokumen akar. Muat sebuah .one file, iterasi halaman, dan simpan ke PDF. |
DocumentVisitor | Basis abstrak untuk penelusuran pola pengunjung pada pohon dokumen. |
Node | Kelas dasar untuk semua node dokumen. |
CompositeNode | Kelas dasar untuk node yang dapat berisi node anak. |
Struktur Dokumen
| ImageRenderOptions | ImageRenderOptions |
|---|---|
Page | Mewakili halaman OneNote. |
Title | Blok judul halaman yang berisi TitleText, TitleDate, TitleTime. |
Outline | Kontainer posisi untuk node OutlineElement. |
OutlineElement | Kontainer daun; menyimpan RichText, Image, Table, AttachedFile. |
ImageRenderOptions
| ImageRenderOptions | ImageRenderOptions |
|---|---|
RichText | Blok teks dengan rangkaian format, tag, dan hyperlink. |
TextRun | Segmen teks terformat tunggal dalam RichText. |
TextStyle | Properti pemformatan untuk TextRun. |
Image | Gambar tersemat dengan byte mentah dan metadata. |
AttachedFile | Lampiran file tersemat dengan byte mentah. |
Table | Tabel dengan baris, sel, dan lebar kolom. |
TableRow | Sebuah baris dalam Tabel. |
TableCell | Sebuah sel dalam TableRow; berisi node konten. |
NoteTag | Tag OneNote (bintang, kotak centang, dll.) yang terlampir pada node konten. |
NumberList | Metadata daftar bernomor pada OutlineElement. |
ImageRenderOptions
| ImageRenderOptions | ImageRenderOptions |
|---|---|
LoadOptions | Opsi untuk memuat sebuah .one file. |
SaveOptions | Kelas dasar untuk opsi penyimpanan. |
PdfSaveOptions | Opsi penyimpanan khusus PDF (ikon tag). |
Stub Kompatibilitas
| ImageRenderOptions | ImageRenderOptions |
|---|---|
License | Stub kompatibilitas: SetLicense() adalah no-op dalam implementasi FOSS ini. |
Metered | Stub kompatibilitas: SetMeteredKey() adalah no-op dalam implementasi FOSS ini. |
Detail Kelas
ImageRenderOptions
Kelas dokumen root. Muat sebuah .one berkas dari jalur berkas, sebuah pathlib.Path, atau aliran biner.
from aspose.note import Document, LoadOptions
doc = Document(source=None, load_options=None)Parameter konstruktor:
| ImageRenderOptions | ImageRenderOptions | ImageRenderOptions |
|---|---|---|
source | `str | Path |
load_options | `LoadOptions | None` |
ImageRenderOptions:
| ImageRenderOptions | ImageRenderOptions | ImageRenderOptions |
|---|---|---|
DisplayName | `str | None` |
CreationTime | `datetime | None` |
FileFormat | FileFormat | Indikasi upaya terbaik versi format file OneNote |
ImageRenderOptions:
| ImageRenderOptions | ImageRenderOptions | ImageRenderOptions |
|---|---|---|
Count() | () -> int | Jumlah halaman anak langsung |
GetPageHistory(page) | (Page) -> list[Page] | ImageRenderOptions [page] (stub; riwayat lengkap belum diimplementasikan) |
DetectLayoutChanges() | () -> None | Stub kompatibilitas; tidak ada operasi |
Save(target, format_or_options) | `(str | Path |
Accept(visitor) | (DocumentVisitor) -> None | Panggil penelusuran pengunjung |
for page in doc | N/A | Iterasi anak langsung Page node |
Document.FileFormat catatan: Properti ini memberikan indikasi upaya terbaik versi format file OneNote. The FileFormat enum memiliki tiga nilai: OneNote2010, OneNoteOnline, dan OneNote2007.
Document.Save() dukungan aliran: target bisa berupa aliran biner (io.BytesIO, handle file yang dibuka dalam mode tulis biner, dll). Ini dikonfirmasi oleh rangkaian tes: doc.Save(io.BytesIO(), PdfSaveOptions(SaveFormat.Pdf)).
DocumentVisitor
Kelas dasar abstrak untuk penelusuran pola visitor. Timpa metode kunjungan yang Anda perlukan:
| ImageRenderOptions | Dipanggil ketika |
|---|---|
VisitDocumentStart(doc) | Memasuki node Document |
VisitDocumentEnd(doc) | Meninggalkan node Document |
VisitPageStart(page) | Memasuki node Page |
VisitPageEnd(page) | Meninggalkan node Page |
VisitTitleStart(title) | Memasuki node Title |
VisitTitleEnd(title) | Meninggalkan node Title |
VisitOutlineStart(outline) | Memasuki node Outline |
VisitOutlineEnd(outline) | Meninggalkan node Outline |
VisitOutlineElementStart(oe) | Memasuki node OutlineElement |
VisitOutlineElementEnd(oe) | Meninggalkan node OutlineElement |
VisitRichTextStart(rt) | Memasuki node RichText |
VisitRichTextEnd(rt) | Meninggalkan node RichText |
VisitImageStart(img) | Memasuki node Image |
VisitImageEnd(img) | Meninggalkan node Image |
ImageRenderOptions
Kelas dasar untuk semua node pohon dokumen.
| Properti / Metode | ImageRenderOptions | ImageRenderOptions |
|---|---|---|
ParentNode | `Node | None` |
Document | `Document | None` |
Accept(visitor) | (DocumentVisitor) -> None | Kirim pengunjung untuk node ini |
CompositeNode
ImageRenderOptions Node. Menambahkan manajemen anak:
| Properti / Metode | ImageRenderOptions |
|---|---|
FirstChild | Node anak pertama, atau None |
LastChild | Node anak terakhir, atau None |
AppendChildLast(node) | Tambahkan node anak di akhir; mengatur node.ParentNode = self |
AppendChildFirst(node) | Tambahkan node anak di awal |
InsertChild(index, node) | Sisipkan anak pada posisi yang diberikan |
RemoveChild(node) | Hapus node anak; mengatur node.ParentNode = None |
GetEnumerator() | Mengembalikan iterator atas anak langsung |
for child in node | Iterasi anak langsung |
GetChildNodes(Type) | (Type) -> list[Type]: rekursif, pencarian depth-first seluruh subtree termasuk self |
ImageRenderOptions
ImageRenderOptions CompositeNode. Mewakili halaman 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) | Kembalikan klon dangkal atau mendalam dari halaman |
ImageRenderOptions
ImageRenderOptions CompositeNode. Menyimpan blok judul dari sebuah Page.
| ImageRenderOptions | ImageRenderOptions | ImageRenderOptions |
|---|---|---|
TitleText | `RichText | None` |
TitleDate | `RichText | None` |
TitleTime | `RichText | None` |
ImageRenderOptions
ImageRenderOptions CompositeNode. Sebuah kontainer posisi untuk OutlineElement node.
| ImageRenderOptions | ImageRenderOptions | ImageRenderOptions |
|---|---|---|
X | `float | None` |
Y | `float | None` |
Width | `float | None` |
OutlineElement
ImageRenderOptions CompositeNode. Sebuah kontainer daun yang menyimpan node konten.
| ImageRenderOptions | ImageRenderOptions | ImageRenderOptions |
|---|---|---|
IndentLevel | int | Kedalaman penumpukan (0 = terluar) |
NumberList | `NumberList | None` |
Tags | list[NoteTag] | Tag OneNote yang terlampir pada elemen ini |
RichText
ImageRenderOptions CompositeNode. Sebuah blok teks bergaya.
| ImageRenderOptions | ImageRenderOptions | ImageRenderOptions |
|---|---|---|
Text | str | String teks polos lengkap (semua rangkaian digabungkan) |
Runs | list[TextRun] | Daftar terurut segmen yang diformat |
FontSize | `float | None` |
Tags | list[NoteTag] | Tag OneNote yang terlampir pada blok ini |
ImageRenderOptions:
| ImageRenderOptions | ImageRenderOptions | ImageRenderOptions |
|---|---|---|
Append(text, style=None) | `(str, TextStyle | None) -> RichText` |
Replace(old_value, new_value) | (str, str) -> None | Penggantian string di memori pada Text; tidak memperbarui Runs |
TextRun
ImageRenderOptions Node. Sebuah segmen teks terformat tunggal.
| ImageRenderOptions | ImageRenderOptions | ImageRenderOptions |
|---|---|---|
Text | str | Konten teks segmen (default "") |
Style | TextStyle | Properti pemformatan |
Start | `int | None` |
End | `int | None` |
TextStyle
ImageRenderOptions Node. Properti pemformatan per-karakter untuk sebuah 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 | Apakah run ini merupakan hyperlink |
HyperlinkAddress | `str | None` | None |
ImageRenderOptions
ImageRenderOptions CompositeNode. Gambar tersemat.
| ImageRenderOptions | ImageRenderOptions | ImageRenderOptions |
|---|---|---|
FileName | `str | None` |
Bytes | bytes | Data gambar mentah (default b"") |
Width | `float | None` |
Height | `float | None` |
AlternativeTextTitle | `str | None` |
AlternativeTextDescription | `str | None` |
HyperlinkUrl | `str | None` |
Tags | list[NoteTag] | Tag OneNote yang terlampir pada gambar ini |
ImageRenderOptions:
| ImageRenderOptions | ImageRenderOptions |
|---|---|
Replace(image) | ImageRenderOptions Bytes dan FileName dari yang lain Image node ke yang ini |
AttachedFile
ImageRenderOptions CompositeNode. Lampiran file tersemat.
| ImageRenderOptions | ImageRenderOptions | ImageRenderOptions |
|---|---|---|
FileName | `str | None` |
Bytes | bytes | Data file mentah (default b"") |
Tags | list[NoteTag] | Tag OneNote yang terlampir pada lampiran ini |
ImageRenderOptions
ImageRenderOptions CompositeNode. Sebuah tabel dalam OutlineElement.
| ImageRenderOptions | ImageRenderOptions | ImageRenderOptions | ImageRenderOptions |
|---|---|---|---|
Columns | list[float] | [] | Lebar setiap kolom dalam poin |
IsBordersVisible | bool | True | Apakah batas tabel terlihat |
Tags | list[NoteTag] | [] | Tag OneNote yang terlampir pada tabel ini |
TableRow
ImageRenderOptions CompositeNode. Sebuah baris dalam a Table. Iterasi GetChildNodes(TableCell) untuk mengakses sel.
TableCell
ImageRenderOptions CompositeNode. Sebuah sel dalam a TableRow. Berisi RichText, Image, dan node konten lainnya.
NoteTag
ImageRenderOptions Node. Sebuah tag OneNote yang terlampir pada node konten.
| 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 |
Catatan timestamp: created dan completed adalah timestamp integer mentah yang diurai dari format biner MS-ONE, bukan datetime objek.
Metode pabrik:
| ImageRenderOptions | ImageRenderOptions |
|---|---|
NoteTag.CreateYellowStar() | Membuat sebuah NoteTag(shape=None, label="Yellow Star") |
NumberList
ImageRenderOptions Node. Metadata daftar bernomor atau berpoin pada sebuah OutlineElement.
| ImageRenderOptions | ImageRenderOptions | ImageRenderOptions | ImageRenderOptions |
|---|---|---|---|
Format | `str | None` | None |
Restart | `int | None` | None |
IsNumbered | bool | False | True untuk daftar terurut (bernomor) |
LoadOptions
| ImageRenderOptions | ImageRenderOptions | ImageRenderOptions | ImageRenderOptions |
|---|---|---|---|
DocumentPassword | `str | None` | None |
LoadHistory | bool | False | Bidang kompatibilitas API; tidak digunakan secara fungsional di v26.3.1 |
SaveOptions
Kelas dasar untuk semua opsi penyimpanan. Argumen posisi yang diperlukan.
| ImageRenderOptions | ImageRenderOptions | ImageRenderOptions |
|---|---|---|
SaveFormat | SaveFormat | Format penyimpanan target |
PdfSaveOptions
ImageRenderOptions SaveOptions. Konfigurasi ekspor khusus PDF. Buat dengan PdfSaveOptions(SaveFormat.Pdf).
| ImageRenderOptions | ImageRenderOptions | ImageRenderOptions | ImageRenderOptions |
|---|---|---|---|
PageIndex | int | 0 | Bidang ada; tidak diteruskan ke pengekspor PDF di v26.3.1: tidak berpengaruh pada output |
PageCount | `int | None` | None |
TagIconDir | `str | None` | None |
TagIconSize | `float | None` | None |
TagIconGap | `float | None` | None |
PageIndex / PageCount peringatan: Bidang-bidang ini dideklarasikan pada PdfSaveOptions untuk kompatibilitas API, tetapi the Document.Save() implementasi dalam v26.3.1 tidak membaca atau meneruskannya ke pengekspor PDF. Semua halaman selalu diekspor.
Lisensi dan Metered
Stub kompatibilitas diekspor untuk kompatibilitas bentuk API dengan Aspose.Note untuk .NET. Semua metode tidak melakukan apa-apa dalam implementasi FOSS ini.
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-opTidak diperlukan kunci lisensi untuk menggunakan fitur apa pun dari Aspose.Note FOSS untuk Python.
ImageRenderOptions
Referensi enumerasi lengkap: ImageRenderOptions
SaveFormat
| ImageRenderOptions | ImageRenderOptions |
|---|---|
SaveFormat.Pdf | Ekspor PDF: diimplementasikan; memerlukan pip install "aspose-note[pdf]" |
SaveFormat.One | Format OneNote: hanya dideklarasikan; menghasilkan UnsupportedSaveFormatException |
FileFormat
Nilai enum yang mewakili versi format file OneNote. Document.FileFormat menyediakan indikasi sebaik mungkin.
| ImageRenderOptions | Nilai string |
|---|---|
FileFormat.OneNote2010 | "onenote2010" |
FileFormat.OneNoteOnline | "onenoteonline" |
FileFormat.OneNote2007 | "onenote2007" |
HorizontalAlignment
| ImageRenderOptions | Nilai string |
|---|---|
HorizontalAlignment.Left | "left" |
HorizontalAlignment.Center | "center" |
HorizontalAlignment.Right | "right" |
NodeType
| ImageRenderOptions | Nilai string |
|---|---|
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
Referensi pengecualian lengkap: ImageRenderOptions
| ImageRenderOptions | ImageRenderOptions |
|---|---|
AsposeNoteError | Kelas dasar untuk semua pengecualian Aspose.Note FOSS |
FileCorruptedException | ImageRenderOptions .one file tidak dapat diparsing (rusak atau biner yang tidak terbentuk dengan benar) |
IncorrectDocumentStructureException | Struktur file tidak valid atau tidak didukung |
IncorrectPasswordException | Dilempar ketika LoadOptions.DocumentPassword diatur; dokumen terenkripsi tidak didukung |
UnsupportedFileFormatException | Format file tidak dikenali; mengungkapkan sebuah FileFormat field (string) |
UnsupportedSaveFormatException | Yang diminta SaveFormat tidak diimplementasikan dalam versi ini |