Aspose.Note FOSS لـ Python
تغطي هذه المرجعية سطح API العام الكامل لـ: aspose-note النسخة 26.3.1 فقط الرموز المصدرة من المنتج الإلكتروني. aspose.note كل شيء تحت الرابط aspose.note._internal هو تفاصيل التنفيذ وقد يتغير دون إشعار.
التثبيت: pip install aspose-note (الذرة) أو pip install "aspose-note[pdf]" (مع تصدير PDF)
الاستيراد: from aspose.note import Document, RichText, ...
فئات
الوثيقة والمسار عبر الموقع
| الفئة | وصف |
|---|---|
Document | عنصر وثيقة الجذر يمثل مستند OneNote؛ إعادة صياغة الصفحات وتصديرها إلى PDF. |
DocumentVisitor | قاعدة تجريدية لمتابعة نمط الزائر في شجرة المستندات. |
Node | طبقة أساسية لجميع عقد الوثائق. |
CompositeNode | فئة أساسية للعقدة التي يمكن أن تحتوي على عقدات طفلية. |
هيكل الوثيقة
| الفئة | وصف |
|---|---|
Page | يمثل صفحة OneNote. |
Title | كتلة عنوان الصفحة التي تحتوي على TitleText، TitleDate و TitleTime. |
Outline | حاوية وضعية لعقد OutlineElement. |
OutlineElement | حاوية ورقة; تحتوي RichText, الصورة، الجدول، AttachedFile. |
المحتوى
| الفئة | وصف |
|---|---|
RichText | كتلة نصية مع تشكيل التشغيلات، العلامات والروابط الفائقة. |
TextRun | قطعة نصية ذات تنسيق واحد داخل RichText. |
TextStyle | صيغة خصائص TextRun. |
Image | صورة مدمجة مع بايتات خام وبيانات. |
AttachedFile | ملف ملحق مع بايتات خام. |
Table | الجدول مع صفوف وخلايا وعرض الأعمدة. |
TableRow | صف داخل طاولة. |
TableCell | خلية داخل TableRow ؛ تحتوي على عقدة المحتوى. |
NoteTag | علامة OneNote (نجم، مربع تحديد، إلخ) المرتبطة بعقدة المحتوى. |
NumberList | بيانات الميتاداتا المدرجة على OutlineElement. |
خيارات
| الفئة | وصف |
|---|---|
LoadOptions | خيارات تحميل a .one الملف. |
SaveOptions | طبقة أساسية لخيارات الحفاظ. |
PdfSaveOptions (انظر خيارات ومعايير) | فئة الخيارات لتصدير المستند: تحكم ضغط الصورة، جودة JPEG، وإعدادات الصفحة للخروج PDF. |
الموافقة Stubs
| الفئة | وصف |
|---|---|
License | الموافقة: SetLicense() هو no-op في هذا التنفيذ FOSS. |
Metered | الموافقة: SetMeteredKey() هو no-op في هذا التنفيذ FOSS. |
تفاصيل الفئة
وثيقة
طبقة المستند الجذري. تحميل a .one ملف من مسار الملف، a pathlib.Path,أو تيار ثنائي.
from aspose.note import Document, LoadOptions
doc = Document(source=None, load_options=None)معايير المكونات:
| المعلمة | النوع | وصف |
|---|---|---|
source | `str | Path |
load_options | `LoadOptions | None` |
خصائص:
| الممتلكات | النوع | وصف |
|---|---|---|
FileFormat | FileFormat | إشارة أفضل جهد للإصدار الصيغة للفيلم OneNote |
الطرق:
| طريقة | التوقيع | وصف |
|---|---|---|
GetPageHistory(page) | (Page) -> PageHistory | العوائد [page] (مؤلفة؛ التاريخ الكامل لم يتم تنفيذه بعد) |
DetectLayoutChanges() | () -> None | المقابلة: لا عملية |
Save(target, format_or_options) | `(str | Path |
Accept(visitor) | (DocumentVisitor) -> None | استدعاء زائر عبر |
for page in doc | N/A | التكرار المباشر للطفل Page العقدة |
Document.FileFormatملاحظة: توفر خاصية إشارة أفضل جهد للإصدار الصيغة لملف OneNote.FileFormatenum له ثلاث قيم:OneNote2010,OneNoteOnline,، وOneNote2007.
Document.Save()دعم البث:targetيمكن أن يكون جريان ثنائي (io.BytesIO,، ملف التعامل مفتوح في وضع الكتابة الثنائي، الخ).
DocumentVisitor
فئة أساسية مجردة لمتابعة نمط الزائر. قم بتجاوز طرق الزيارة التي تحتاجها:
| طريقة | اتصلت عندما |
|---|---|
VisitDocumentStart(doc) | إدخال عقدة مستند |
VisitDocumentEnd(doc) | ترك عقدة مستند |
VisitPageStart(page) | إدخال عقدة صفحة |
VisitPageEnd(page) | ترك عقدة صفحة |
VisitTitleStart(title) | إدخال عقدة عنوان |
VisitTitleEnd(title) | ترك عقدة عنوان |
VisitOutlineStart(outline) | إدخال عقدة المخططات |
VisitOutlineEnd(outline) | ترك عقدة المخططات |
VisitOutlineElementStart(oe) | دخول عقدة OutlineElement |
VisitOutlineElementEnd(oe) | ترك عقدة OutlineElement |
VisitRichTextStart(rt) | إدخال عقدة RichText |
VisitRichTextEnd(rt) | ترك عقدة RichText |
VisitImageStart(img) | إدخال عقدة الصورة |
VisitImageEnd(img) | ترك عقدة الصورة |
العقدة
الطبقة الأساسية لجميع عقدة شجرة المستندات.
| خاصية / طريقة | النوع | وصف |
|---|---|---|
ParentNode | `Node | None` |
Document | `Document | None` |
Accept(visitor) | (DocumentVisitor) -> None | إرسال زائر لهذه العقدة |
CompositeNode
المدى Node.يضيف إدارة الأطفال:
| خاصية / طريقة | وصف |
|---|---|
FirstChild | العقدة الأولى، أو None |
LastChild | العقدة الأخيرة، أو None |
AppendChildLast(node) | إضافة عقدة طفل في النهاية؛ مجموعات node.ParentNode = self |
AppendChildFirst(node) | إضافة عقدة طفلية في البداية |
InsertChild(index, node) | أدخل الطفل في الموقف المعين |
RemoveChild(node) | إزالة عقدة طفلية؛ sets node.ParentNode = None |
GetEnumerator() | يعيد التكرار على الأطفال المباشرين |
for child in node | الأطفال المباشرين المتكررين |
GetChildNodes(Type) | (Type) -> list[Type]: البحث التكراري، والعمق الأول من جميع الأشجار الفرعية بما في ذلك self |
الصفحة
المدى CompositeNode.يمثل صفحة OneNote.
| الممتلكات | النوع | وصف |
|---|---|---|
Title | `Title | None` |
Author | `str | None` |
CreationTime | `datetime | None` |
LastModifiedTime | `datetime | None` |
Level | `int | None` |
الطرق:
| طريقة | وصف |
|---|---|
Clone(deep=False) | إرجاع نسخة عميقة أو ضحلة للصفحة |
العنوان:
المدى CompositeNode.يحمل عنوان الكتلة من Page.
| الممتلكات | النوع | وصف |
|---|---|---|
TitleText | `RichText | None` |
TitleDate | `RichText | None` |
TitleTime | `RichText | None` |
المخططات
المدى CompositeNode.حاوية وضعية لـ: OutlineElement العقدة.
| الممتلكات | النوع | وصف |
|---|---|---|
HorizontalOffset | `float | None` |
VerticalOffset | `float | None` |
MaxWidth | `float | None` |
MaxHeight | `float | None` |
MinWidth | `float | None` |
ReservedWidth | `float | None` |
IndentPosition | `float | None` |
OutlineElement
المدى CompositeNode.حاوية ورقة تحتوي على عقدة المحتوى.
| الممتلكات | النوع | وصف |
|---|---|---|
NumberList | `NumberList | None` |
RichText
المدى Node.كتلة من النص المُنَشَّط.
| الممتلكات | النوع | وصف |
|---|---|---|
Text | str | سلسلة النص العادي الكامل (كل التشغيلات مرتبطة) |
TextRuns | list[TextRun] | قائمة مرتبة من الشرائح المنسقّة |
Tags | list[NoteTag] | علامات OneNote المرفقة بهذا الكتلة |
الطرق:
| طريقة | التوقيع | وصف |
|---|---|---|
Append(text, style=None) | `(str, TextStyle | None) -> RichText` |
Replace(old_value, new_value) | (str, str) -> None | استبدال السلسلة في الذاكرة على Text;لا يحدّث TextRuns |
TextRun
قطعة نصية واحدة في RichText.TextRuns.
| الممتلكات | النوع | وصف |
|---|---|---|
Text | str | محتوى النص في الشريحة (الجهاز الافتراضي) "") |
Style | TextStyle | خصائص التنسيق |
TextStyle
خصائص التنسيق لكل حرف لـ TextRun.
| الممتلكات | النوع | التخفيضات المقصودة | وصف |
|---|---|---|---|
IsBold | bool | False | جريئة |
IsItalic | bool | False | إيطالية |
IsUnderline | bool | False | التشديد |
IsStrikethrough | bool | False | التمرير |
IsSuperscript | bool | False | المخطوطة الفائقة |
IsSubscript | bool | False | المشتريات |
FontName | `str | None` | None |
FontSize | `float | None` | None |
FontColor | `int | None` | None |
Highlight | `int | None` | None |
Language | `int | None` | None |
IsHyperlink | bool | False | ما إذا كان هذا التشغيل هو رابط فوق الصفحة. |
HyperlinkAddress | `str | None` | None |
صورة
المدى CompositeNode.صورة مدمجة.
| الممتلكات | النوع | وصف |
|---|---|---|
FileName | `str | None` |
FilePath | `str | None` |
Format | `str | None` |
Bytes | bytes | بيانات بايت الصورة الخام (الجهل) b"") |
OriginalWidth | `float | None` |
OriginalHeight | `float | None` |
Alignment | `HorizontalAlignment | None` |
Tags | list[NoteTag] | علامات OneNote المرفقة بهذه الصورة |
الطرق:
| طريقة | وصف |
|---|---|
Replace(image) | نسخة Bytes و FileName من شخص آخر Image عقدة في هذا واحد |
AttachedFile
المدى Node.ملف ملحق مدمج.
| الممتلكات | النوع | وصف |
|---|---|---|
FileName | `str | None` |
Bytes | bytes | بيانات الملف الخام (الجهل) b"") |
Tags | list[NoteTag] | علامات OneNote المرفقة لهذا الملحق |
الجدول
المدى CompositeNode.طاولة داخل OutlineElement.
| الممتلكات | النوع | التخفيضات المقصودة | وصف |
|---|---|---|---|
Columns | list[TableColumn] | [] | قائمة البيانات الوصفية للصفحات؛ كل صفحة. TableColumn لديه .Width (طائرة) و .LockedWidth (كعب) |
Tags | list[NoteTag] | [] | علامات OneNote المرفقة لهذا الجدول |
TableRow
المدى CompositeNode.صف داخل خط Table. التكرارية GetChildNodes(TableCell) للوصول إلى الخلايا.
TableCell
المدى CompositeNode.خلية داخل TableRow.يحتوي على: RichText, Image,، والعقد المحتوى الأخرى.
NoteTag
علامة OneNote مرفقة بعقدة المحتوى.
| الممتلكات | النوع | التخفيضات المقصودة | وصف |
|---|---|---|---|
Icon | `int | None` | None |
Label | `str | None` | None |
FontColor | `int | None` | None |
Highlight | `int | None` | None |
CreationTime | `datetime | None` | None |
CompletedTime | `datetime | None` | None |
Status | TagStatus | مشتق | TagStatus.Completed إذا كان CompletedTime هو المحدد، غير ذلك. TagStatus.Open |
طرق المصنع:
| طريقة | وصف |
|---|---|
NoteTag.CreateYellowStar(label=None) | يخلق NoteTag(Label="Yellow Star", Icon=13) |
NoteTag.CreateQuestionMark(label=None) | يخلق NoteTag(Label="Question Mark", Icon=15) |
NoteTag.CreateMusicalNote(label=None) | يخلق NoteTag(Label="Musical Note", Icon=121) |
NumberList
بيانات الميتاداتا للقائمة التي تم إدخالها بالرقم أو مع البوتيك على OutlineElement.
| الممتلكات | النوع | التخفيضات المقصودة | وصف |
|---|---|---|---|
Format | `str | None` | None |
NumberFormat | `str | None` | None |
Font | `str | None` | None |
FontSize | `float | None` | None |
FontColor | `int | None` | None |
IsBold | bool | False | الوزن المضخم لمقدمة القائمة |
IsItalic | bool | False | نمط التراجع لمقدمة القائمة |
Restart | `int | None` | None |
LoadOptions
| الممتلكات | النوع | التخفيضات المقصودة | وصف |
|---|---|---|---|
DocumentPassword | `str | None` | None |
LoadHistory | bool | False | حقل توافق API؛ غير مستخدم وظيفيا في v26.3.1 |
SaveOptions
طبقة أساسية لخيارات الحفاظ. مطلوب دليل وضعي.
| الممتلكات | النوع | وصف |
|---|---|---|
SaveFormat | SaveFormat | تنسيق حفظ الهدف |
PdfSaveOptions
المدى SaveOptions. تكوين التصدير الخاص بـ PDF. بناء مع PdfSaveOptions() (كل الحجج هي كلمات مفتاحية فقط مع الافتراضات).
| الممتلكات | النوع | التخفيضات المقصودة | وصف |
|---|---|---|---|
PageIndex | int | 0 | الحقل موجود.; لم يتم إرسالها إلى المصدر PDF في النسخة 26.3.1: لا يؤثر على الإنتاج |
PageCount | `int | None` | None |
ImageCompression | `Any | None` | None |
JpegQuality | `int | None` | None |
PageSettings | `Any | None` | None |
PageSplittingAlgorithm | `Any | 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.
إحصاءات
مرجع التعداد الكامل: إحصاءات
SaveFormat
| القيمة | وصف |
|---|---|
SaveFormat.Pdf | تصدير PDF: تم تنفيذها، يتطلب ذلك. pip install "aspose-note[pdf]" |
FileFormat
قيم Enum تمثل نسخة تنسيق ملف OneNote. Document.FileFormat يقدم إشارة أفضل جهد.
| القيمة | قيمة السلسلة |
|---|---|
FileFormat.OneNote2010 | "onenote2010" |
FileFormat.OneNoteOnline | "onenoteonline" |
FileFormat.OneNote2007 | "onenote2007" |
HorizontalAlignment
| القيمة | قيمة السلسلة |
|---|---|
HorizontalAlignment.Left | "left" |
HorizontalAlignment.Center | "center" |
HorizontalAlignment.Right | "right" |
NodeType
| القيمة | قيمة السلسلة |
|---|---|
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" |
الاستثناءات
إشارة الاستثناء الكامل: الاستثناءات
| استثناء | وصف |
|---|---|
AsposeNoteError | الطبقة الأساسية لجميع استثناءات Aspose.Note FOSS |
FileCorruptedException | المجلس الوزاري .one لا يمكن تحليل الملف (الثنائي الفاسد أو غير المنشأ) |
IncorrectDocumentStructureException | هيكل الملف غير صحيح أو لا يدعم |
IncorrectPasswordException | تمت تربيته عندما LoadOptions.DocumentPassword تم تعيينها؛ المستندات المشفرة غير مدعومة. |
UnsupportedFileFormatException | صيغة الملف غير معترف بها؛ تعرض a FileFormat المجال (سلسلة) |
UnsupportedSaveFormatException | الطلبات SaveFormat لا يتم تنفيذها في هذا الإصدار. |