Aspose.Note FOSS for Python
Rujukan ini merangkumi keseluruhan permukaan API awam bagi aspose-note versi 26.3.1. Hanya simbol yang dieksport dari aspose.note pakej didokumentasikan di sini. Apa-apa yang berada di bawah aspose.note._internal adalah butiran pelaksanaan dan mungkin berubah tanpa notis.
ImageRenderOptions: pip install aspose-note (core) atau pip install "aspose-note[pdf]" (dengan eksport PDF)
ImageRenderOptions: from aspose.note import Document, RichText, ...
ImageRenderOptions
Dokumen dan Penelusuran
| ImageRenderOptions | ImageRenderOptions |
|---|---|
Document | Objek dokumen akar. Muatkan satu .one fail, ulangi halaman, dan simpan ke PDF. |
DocumentVisitor | Asas abstrak untuk penelusuran corak pelawat pada pokok dokumen. |
Node | Kelas asas untuk semua nod dokumen. |
CompositeNode | Kelas asas untuk nod yang boleh mengandungi nod anak. |
Struktur Dokumen
| ImageRenderOptions | ImageRenderOptions |
|---|---|
Page | Mewakili halaman OneNote. |
Title | Blok tajuk halaman yang mengandungi TitleText, TitleDate, TitleTime. |
Outline | Bekas kedudukan untuk nod OutlineElement. |
OutlineElement | Bekas daun; menyimpan RichText, Image, Table, AttachedFile. |
ImageRenderOptions
| ImageRenderOptions | ImageRenderOptions |
|---|---|
RichText | Blok teks dengan jalur pemformatan, tag, dan pautan. |
TextRun | Segmen teks berformat tunggal dalam RichText. |
TextStyle | Sifat pemformatan untuk TextRun. |
Image | Imej terbenam dengan bait mentah dan metadata. |
AttachedFile | Lampiran fail terbenam dengan bait mentah. |
Table | Jadual dengan baris, sel, dan lebar lajur. |
TableRow | Satu baris dalam Jadual. |
TableCell | Sebuah sel dalam TableRow; mengandungi nod kandungan. |
NoteTag | Tag OneNote (bintang, kotak semak, dll.) yang dilampirkan pada nod kandungan. |
NumberList | Metadata senarai bernombor pada OutlineElement. |
ImageRenderOptions
| ImageRenderOptions | ImageRenderOptions |
|---|---|
LoadOptions | Pilihan untuk memuatkan .one fail. |
SaveOptions | Kelas asas untuk pilihan simpan. |
PdfSaveOptions | Pilihan simpan khusus PDF (ikon tag). |
Stub Keserasian
| ImageRenderOptions | ImageRenderOptions |
|---|---|
License | Stub keserasian: SetLicense() adalah tiada operasi dalam pelaksanaan FOSS ini. |
Metered | Stub keserasian: SetMeteredKey() adalah tiada operasi dalam pelaksanaan FOSS ini. |
Butiran Kelas
ImageRenderOptions
Kelas dokumen akar. Muatkan satu .one fail dari laluan fail, satu pathlib.Path, atau aliran binari.
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 | Petunjuk usaha terbaik bagi versi format fail OneNote |
ImageRenderOptions:
| ImageRenderOptions | ImageRenderOptions | ImageRenderOptions |
|---|---|---|
Count() | () -> int | Bilangan halaman anak langsung |
GetPageHistory(page) | (Page) -> list[Page] | ImageRenderOptions [page] (stub; sejarah penuh belum dilaksanakan lagi) |
DetectLayoutChanges() | () -> None | Stub keserasian; tiada operasi |
Save(target, format_or_options) | `(str | Path |
Accept(visitor) | (DocumentVisitor) -> None | Panggil penelusuran pelawat |
for page in doc | N/A | Iterasi anak langsung Page nod |
Document.FileFormat nota: Sifat ini memberikan petunjuk usaha terbaik bagi versi format fail OneNote. The FileFormat enum mempunyai tiga nilai: OneNote2010, OneNoteOnline, dan OneNote2007.
Document.Save() sokongan aliran: target boleh menjadi aliran binari (io.BytesIO, pemegang fail dibuka dalam mod tulis binari, dll). Ini disahkan oleh suite ujian: doc.Save(io.BytesIO(), PdfSaveOptions(SaveFormat.Pdf)).
DocumentVisitor
Kelas asas abstrak untuk penelusuran corak pelawat. Gantikan kaedah lawatan yang anda perlukan:
| ImageRenderOptions | Dipanggil apabila |
|---|---|
VisitDocumentStart(doc) | Memasuki nod Dokumen |
VisitDocumentEnd(doc) | Meninggalkan nod Dokumen |
VisitPageStart(page) | Memasuki nod Halaman |
VisitPageEnd(page) | Meninggalkan nod Halaman |
VisitTitleStart(title) | Memasuki nod Tajuk |
VisitTitleEnd(title) | Meninggalkan nod Tajuk |
VisitOutlineStart(outline) | Memasuki nod Outline |
VisitOutlineEnd(outline) | Meninggalkan nod Outline |
VisitOutlineElementStart(oe) | Memasuki nod OutlineElement |
VisitOutlineElementEnd(oe) | Meninggalkan nod OutlineElement |
VisitRichTextStart(rt) | Memasuki node RichText |
VisitRichTextEnd(rt) | Meninggalkan node RichText |
VisitImageStart(img) | Memasuki node Imej |
VisitImageEnd(img) | Meninggalkan node Imej |
ImageRenderOptions
Kelas asas untuk semua nod pokok dokumen.
| Harta / Kaedah | ImageRenderOptions | ImageRenderOptions |
|---|---|---|
ParentNode | `Node | None` |
Document | `Document | None` |
Accept(visitor) | (DocumentVisitor) -> None | Hantar pelawat untuk node ini |
CompositeNode
ImageRenderOptions Node. Menambah pengurusan anak:
| Sifat / Kaedah | ImageRenderOptions |
|---|---|
FirstChild | Node anak pertama, atau None |
LastChild | Node anak terakhir, atau None |
AppendChildLast(node) | Tambah node anak di akhir; menetapkan node.ParentNode = self |
AppendChildFirst(node) | Tambah node anak di permulaan |
InsertChild(index, node) | Sisipkan anak pada kedudukan yang diberikan |
RemoveChild(node) | Buang node anak; menetapkan node.ParentNode = None |
GetEnumerator() | Mengembalikan iterator ke atas anak langsung |
for child in node | Iterasi anak langsung |
GetChildNodes(Type) | (Type) -> list[Type]: rekursif, carian kedalaman pertama bagi seluruh subpokok 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 cetek atau klon mendalam bagi halaman |
ImageRenderOptions
ImageRenderOptions CompositeNode. Menyimpan blok tajuk bagi satu Page.
| ImageRenderOptions | ImageRenderOptions | ImageRenderOptions |
|---|---|---|
TitleText | `RichText | None` |
TitleDate | `RichText | None` |
TitleTime | `RichText | None` |
ImageRenderOptions
ImageRenderOptions CompositeNode. Bekas kedudukan untuk OutlineElement nodes.
| ImageRenderOptions | ImageRenderOptions | ImageRenderOptions |
|---|---|---|
X | `float | None` |
Y | `float | None` |
Width | `float | None` |
OutlineElement
ImageRenderOptions CompositeNode. Kontena daun yang menyimpan nod kandungan.
| ImageRenderOptions | ImageRenderOptions | ImageRenderOptions |
|---|---|---|
IndentLevel | int | Kedalaman bersarang (0 = paling luar) |
NumberList | `NumberList | None` |
Tags | list[NoteTag] | Tag OneNote yang dilampirkan pada elemen ini |
RichText
ImageRenderOptions CompositeNode. Sekumpulan teks berformat.
| ImageRenderOptions | ImageRenderOptions | ImageRenderOptions |
|---|---|---|
Text | str | Rentetan teks biasa penuh (semua jalur digabungkan) |
Runs | list[TextRun] | Senarai bertertib segmen berformat |
FontSize | `float | None` |
Tags | list[NoteTag] | Tag OneNote yang dilampirkan pada blok ini |
ImageRenderOptions:
| ImageRenderOptions | ImageRenderOptions | ImageRenderOptions |
|---|---|---|
Append(text, style=None) | `(str, TextStyle | None) -> RichText` |
Replace(old_value, new_value) | (str, str) -> None | Penggantian rentetan dalam memori pada Text; tidak mengemas kini Runs |
TextRun
ImageRenderOptions Node. Segmen teks berformat tunggal.
| ImageRenderOptions | ImageRenderOptions | ImageRenderOptions |
|---|---|---|
Text | str | Kandungan teks segmen (lalai "") |
Style | TextStyle | Ciri pemformatan |
Start | `int | None` |
End | `int | None` |
TextStyle
ImageRenderOptions Node. Sifat pemformatan per-aksara untuk a 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 | Sama ada run ini merupakan hyperlink |
HyperlinkAddress | `str | None` | None |
ImageRenderOptions
ImageRenderOptions CompositeNode. Gambar terbenam.
| ImageRenderOptions | ImageRenderOptions | ImageRenderOptions |
|---|---|---|
FileName | `str | None` |
Bytes | bytes | Data imej mentah (lalai b"") |
Width | `float | None` |
Height | `float | None` |
AlternativeTextTitle | `str | None` |
AlternativeTextDescription | `str | None` |
HyperlinkUrl | `str | None` |
Tags | list[NoteTag] | Tag OneNote yang dilampirkan pada imej ini |
ImageRenderOptions:
| ImageRenderOptions | ImageRenderOptions |
|---|---|
Replace(image) | ImageRenderOptions Bytes dan FileName dari yang lain Image node ke dalam yang ini |
AttachedFile
ImageRenderOptions CompositeNode. Lampiran fail terbenam.
| ImageRenderOptions | ImageRenderOptions | ImageRenderOptions |
|---|---|---|
FileName | `str | None` |
Bytes | bytes | Data fail mentah (lalai b"") |
Tags | list[NoteTag] | Tag OneNote yang dilampirkan pada lampiran ini |
ImageRenderOptions
ImageRenderOptions CompositeNode. Jadual dalam OutlineElement.
| ImageRenderOptions | ImageRenderOptions | ImageRenderOptions | ImageRenderOptions |
|---|---|---|---|
Columns | list[float] | [] | Lebar setiap lajur dalam mata |
IsBordersVisible | bool | True | Sama ada sempadan jadual dapat dilihat |
Tags | list[NoteTag] | [] | Tag OneNote yang dilampirkan pada jadual ini |
TableRow
ImageRenderOptions CompositeNode. Baris dalam satu Table. Ulang GetChildNodes(TableCell) untuk mengakses sel.
TableCell
ImageRenderOptions CompositeNode. Sel dalam satu TableRow. Mengandungi RichText, Image, dan nod kandungan lain.
NoteTag
ImageRenderOptions Node. Tag OneNote yang dilampirkan pada nod kandungan.
| 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 cap masa: created dan completed adalah cap masa integer mentah yang diurai daripada format binari MS-ONE, bukan datetime objek.
Kaedah kilang:
| ImageRenderOptions | ImageRenderOptions |
|---|---|
NoteTag.CreateYellowStar() | Mencipta satu NoteTag(shape=None, label="Yellow Star") |
NumberList
ImageRenderOptions Node. Metadata senarai bernombor atau berbulet pada satu OutlineElement.
| ImageRenderOptions | ImageRenderOptions | ImageRenderOptions | ImageRenderOptions |
|---|---|---|---|
Format | `str | None` | None |
Restart | `int | None` | None |
IsNumbered | bool | False | Benar untuk senarai teratur (bernombor) |
LoadOptions
| ImageRenderOptions | ImageRenderOptions | ImageRenderOptions | ImageRenderOptions |
|---|---|---|---|
DocumentPassword | `str | None` | None |
LoadHistory | bool | False | medan keserasian API; tidak digunakan secara fungsional dalam v26.3.1 |
SaveOptions
Kelas asas untuk semua pilihan simpan. Argumen posisi diperlukan.
| ImageRenderOptions | ImageRenderOptions | ImageRenderOptions |
|---|---|---|
SaveFormat | SaveFormat | Format simpanan sasaran |
PdfSaveOptions
ImageRenderOptions SaveOptions. Konfigurasi eksport khusus PDF. Bina dengan PdfSaveOptions(SaveFormat.Pdf).
| ImageRenderOptions | ImageRenderOptions | ImageRenderOptions | ImageRenderOptions |
|---|---|---|---|
PageIndex | int | 0 | Medan wujud; tidak dihantar ke pengeksport PDF dalam v26.3.1: tidak memberi kesan pada output |
PageCount | `int | None` | None |
TagIconDir | `str | None` | None |
TagIconSize | `float | None` | None |
TagIconGap | `float | None` | None |
PageIndex / PageCount peringatan: Medan-medan ini diisytiharkan pada PdfSaveOptions untuk keserasian API, tetapi the Document.Save() pelaksanaan dalam v26.3.1 tidak membaca atau memajukannya kepada pengekspor PDF. Semua halaman sentiasa dieksport.
Lesen dan Bermeter
Stub keserasian dieksport untuk keserasian bentuk API dengan Aspose.Note bagi .NET. Semua kaedah tidak melakukan apa-apa dalam pelaksanaan 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-opTiada kunci lesen diperlukan untuk menggunakan sebarang ciri Aspose.Note FOSS bagi Python.
ImageRenderOptions
Rujukan enumerasi penuh: ImageRenderOptions
SaveFormat
| ImageRenderOptions | ImageRenderOptions |
|---|---|
SaveFormat.Pdf | Eksport PDF: dilaksanakan; memerlukan pip install "aspose-note[pdf]" |
SaveFormat.One | Format OneNote: hanya diisytiharkan; menimbulkan UnsupportedSaveFormatException |
FileFormat
Nilai enum yang mewakili versi format fail OneNote. Document.FileFormat menyediakan indikasi sebaik mungkin.
| ImageRenderOptions | Nilai rentetan |
|---|---|
FileFormat.OneNote2010 | "onenote2010" |
FileFormat.OneNoteOnline | "onenoteonline" |
FileFormat.OneNote2007 | "onenote2007" |
HorizontalAlignment
| ImageRenderOptions | Nilai rentetan |
|---|---|
HorizontalAlignment.Left | "left" |
HorizontalAlignment.Center | "center" |
HorizontalAlignment.Right | "right" |
NodeType
| ImageRenderOptions | Nilai rentetan |
|---|---|
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
Rujukan pengecualian penuh: ImageRenderOptions
| ImageRenderOptions | ImageRenderOptions |
|---|---|
AsposeNoteError | Kelas asas untuk semua pengecualian FOSS Aspose.Note |
FileCorruptedException | ImageRenderOptions .one fail tidak dapat diurai (korup atau binari cacat) |
IncorrectDocumentStructureException | Struktur fail tidak sah atau tidak disokong |
IncorrectPasswordException | Dibangkitkan apabila LoadOptions.DocumentPassword ditetapkan; dokumen yang dienkripsi tidak disokong |
UnsupportedFileFormatException | Format fail tidak dikenali; mendedahkan satu FileFormat medan (string) |
UnsupportedSaveFormatException | Yang diminta SaveFormat tidak dilaksanakan dalam versi ini |