Aspose.Note FOSS for Python
הפנייה הזו מכסה את כל המשטח הציבורי של 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 | תמונה משובצת עם בייטים גולמיים ונתוני מטא. |
AttachedFile | קובץ מצורף משובץ עם בייטים גולמיים. |
Table | טבלה עם שורות, תאים ורוחבי עמודות. |
TableRow | שורה בתוך טבלה. |
TableCell | תא בתוך TableRow; מכיל צמתים של תוכן. |
NoteTag | תג OneNote (כוכב, תיבת סימון, וכו’) מצורף לצומת תוכן. |
NumberList | מטא‑נתונים של רשימה ממוספרת על OutlineElement. |
ImageRenderOptions
| ImageRenderOptions | ImageRenderOptions |
|---|---|
LoadOptions | אפשרויות לטעינת .one קובץ. |
SaveOptions | מחלקת בסיס לאפשרויות שמירה. |
PdfSaveOptions | אפשרויות שמירה ספציפיות ל-PDF (איקוני תגיות). |
תבניות תאימות
| ImageRenderOptions | ImageRenderOptions |
|---|---|
License | קוד תואם: SetLicense() הוא פעולה ריקה (no‑op) במימוש ה‑FOSS הזה. |
Metered | קוד תואם: SetMeteredKey() הוא פעולה ריקה (no‑op) במימוש ה‑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 | הצגה best-effort של גרסת פורמט הקובץ של OneNote |
ImageRenderOptions:
| ImageRenderOptions | ImageRenderOptions | ImageRenderOptions |
|---|---|---|
Count() | () -> int | מספר דפי ילדים ישירים |
GetPageHistory(page) | (Page) -> list[Page] | ImageRenderOptions [page] (stub; היסטוריה מלאה עדיין לא מיושמת) |
DetectLayoutChanges() | () -> None | stub תאימות; ללא פעולה |
Save(target, format_or_options) | `(str | Path |
Accept(visitor) | (DocumentVisitor) -> None | הפעל מעבר מבקר |
for page in doc | N/A | חזור על ילד ישיר Page צמתים |
Document.FileFormat הערה: property מספק הצגה best-effort של גרסת פורמט הקובץ של OneNote. The FileFormat enum מכיל שלוש ערכים: 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. מכולה מיקומית עבור OutlineElement צמתים.
| ImageRenderOptions | ImageRenderOptions | ImageRenderOptions |
|---|---|---|
X | `float | None` |
Y | `float | None` |
Width | `float | None` |
OutlineElement
ImageRenderOptions CompositeNode. מכולת עלה שמחזיקה צמתים של תוכן.
| 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 | In-memory החלפת מחרוזת על 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 | פורמט הקובץ אינו מזוהה; חושף a FileFormat שדה (string) |
UnsupportedSaveFormatException | המתבקש SaveFormat לא מיושם בגרסה זו |