Aspose.Note FOSS for Python

این مرجع تمام سطح عمومی API را شامل می‌شود aspose-note نسخه 26.3.1. فقط نمادهای صادر شده از aspose.note پکیج در اینجا مستند شده‌اند. هر چیزی زیر aspose.note._internal یک جزئیات پیاده‌سازی است و ممکن است بدون اطلاع تغییر کند.

ImageRenderOptions: pip install aspose-note (core) یا pip install "aspose-note[pdf]" (with PDF export)

ImageRenderOptions: from aspose.note import Document, RichText, ...

ImageRenderOptions

سند و پیمایش

ImageRenderOptionsImageRenderOptions
Documentشیء ریشه سند. یک .one فایل را بارگذاری کنید، صفحات را پیمایش کنید و به PDF ذخیره کنید.
DocumentVisitorپایهٔ انتزاعی برای پیمایش الگوی بازدیدگر در درخت سند.
Nodeکلاس پایه برای تمام گره‌های سند.
CompositeNodeکلاس پایه برای گره‌هایی که می‌توانند گره‌های فرزند را دربر بگیرند.

ساختار سند

ImageRenderOptionsImageRenderOptions
Pageنمایانگر یک صفحه OneNote.
Titleبلوک عنوان صفحه شامل TitleText، TitleDate و TitleTime.
Outlineمحفظه موقعیتی برای گره‌های OutlineElement.
OutlineElementمحفظه برگ؛ شامل RichText، Image، Table و AttachedFile است.

ImageRenderOptions

ImageRenderOptionsImageRenderOptions
RichTextبلوک متن با دنباله‌های قالب‌بندی، برچسب‌ها و پیوندهای فراگیر.
TextRunبخش متن قالب‌بندی‌شدهٔ تک درون یک RichText.
TextStyleویژگی‌های قالب‌بندی برای یک TextRun.
Imageتصویر جاسازی‌شده با بایت‌های خام و فراداده.
AttachedFileپیوست فایل جاسازی‌شده با بایت‌های خام.
Tableجدول با ردیف‌ها، سلول‌ها و عرض ستون‌ها.
TableRowیک ردیف درون جدول.
TableCellیک سلول درون ردیف جدول؛ شامل گره‌های محتوا است.
NoteTagبرچسب OneNote (ستاره، چک‌باکس و غیره) که به یک گره محتوا پیوست شده است.
NumberListمتادیتای فهرست شماره‌دار روی یک عنصر OutlineElement.

ImageRenderOptions

ImageRenderOptionsImageRenderOptions
LoadOptionsگزینه‌ها برای بارگذاری یک .one فایل.
SaveOptionsکلاس پایه برای گزینه‌های ذخیره‌سازی.
PdfSaveOptionsگزینه‌های ذخیره‌سازی مخصوص PDF (آیکون‌های برچسب).

قالب‌های سازگاری

ImageRenderOptionsImageRenderOptions
Licenseقطعه کد سازگاری: SetLicense() یک عملیات بی‌اثر در این پیاده‌سازی منبع باز است.
Meteredقطعه سازگاری: SetMeteredKey() یک عملیات بی‌اثر در این پیاده‌سازی منبع باز است.

جزئیات کلاس

ImageRenderOptions

کلاس سند ریشه. بارگذاری یک .one فایل از مسیر فایل، یک pathlib.Path, یا یک جریان باینری.

from aspose.note import Document, LoadOptions

doc = Document(source=None, load_options=None)

پارامترهای سازنده:

ImageRenderOptionsImageRenderOptionsImageRenderOptions
source`strPath
load_options`LoadOptionsNone`

ImageRenderOptions:

ImageRenderOptionsImageRenderOptionsImageRenderOptions
DisplayName`strNone`
CreationTime`datetimeNone`
FileFormatFileFormatنشانه‌گذاری با بهترین تلاش از نسخهٔ قالب فایل OneNote

ImageRenderOptions:

ImageRenderOptionsImageRenderOptionsImageRenderOptions
Count()() -> intتعداد صفحات فرزند مستقیم
GetPageHistory(page)(Page) -> list[Page]ImageRenderOptions [page] (قالب؛ تاریخچهٔ کامل هنوز پیاده‌سازی نشده است)
DetectLayoutChanges()() -> Noneقالب سازگاری؛ بدون عملیات
Save(target, format_or_options)`(strPath
Accept(visitor)(DocumentVisitor) -> Noneاجرای عبور بازدیدکننده
for page in docN/Aتکرار فرزند مستقیم Page گره‌ها

Document.FileFormat یادداشت: این ویژگی یک نشانگر تقریباً دقیق از نسخهٔ قالب فایل OneNote فراهم می‌کند. این FileFormat enum دارای سه مقدار است: OneNote2010, OneNoteOnline, و OneNote2007.

Document.Save() پشتیبانی از جریان: target می‌تواند یک جریان باینری باشد (io.BytesIO, دسته‌فایل باز شده در حالت نوشتن باینری، و غیره). این توسط مجموعهٔ آزمون تأیید می‌شود: doc.Save(io.BytesIO(), PdfSaveOptions(SaveFormat.Pdf)).

DocumentVisitor

کلاس پایهٔ انتزاعی برای پیمایش الگوی بازدیدکننده. متدهای visit مورد نیاز خود را بازنویسی کنید:

ImageRenderOptionsفراخوانی می‌شود زمانی که
VisitDocumentStart(doc)ورود به گره Document
VisitDocumentEnd(doc)خروج از گره Document
VisitPageStart(page)ورود به گره Page
VisitPageEnd(page)خروج از گره Page
VisitTitleStart(title)ورود به گره Title
VisitTitleEnd(title)خروج از گره Title
VisitOutlineStart(outline)ورود به گره Outline
VisitOutlineEnd(outline)خروج از گره Outline
VisitOutlineElementStart(oe)ورود به گره OutlineElement
VisitOutlineElementEnd(oe)خروج از گره OutlineElement
VisitRichTextStart(rt)ورود به گره RichText
VisitRichTextEnd(rt)خروج از گره RichText
VisitImageStart(img)ورود به گره Image
VisitImageEnd(img)خروج از گره Image

ImageRenderOptions

کلاس پایه برای تمام گره‌های درخت سند.

ویژگی / متدImageRenderOptionsImageRenderOptions
ParentNode`NodeNone`
Document`DocumentNone`
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 است.

ImageRenderOptionsImageRenderOptionsImageRenderOptions
Title`TitleNone`
Author`strNone`
CreationTime`datetimeNone`
LastModifiedTime`datetimeNone`
Level`intNone`

ImageRenderOptions:

ImageRenderOptionsImageRenderOptions
Clone(deep=False)یک نسخهٔ سطحی یا عمیق از صفحه را برگردانید

ImageRenderOptions

ImageRenderOptions CompositeNode. بلوک عنوان یک را نگه می‌دارد Page.

ImageRenderOptionsImageRenderOptionsImageRenderOptions
TitleText`RichTextNone`
TitleDate`RichTextNone`
TitleTime`RichTextNone`

ImageRenderOptions

ImageRenderOptions CompositeNode. یک محفظه موقعیتی برای OutlineElement گره‌ها.

ImageRenderOptionsImageRenderOptionsImageRenderOptions
X`floatNone`
Y`floatNone`
Width`floatNone`

OutlineElement

ImageRenderOptions CompositeNode. یک محفظه برگ که گره‌های محتوا را نگه می‌دارد.

ImageRenderOptionsImageRenderOptionsImageRenderOptions
IndentLevelintعمق تو در تو (0 = بیرونی‌ترین)
NumberList`NumberListNone`
Tagslist[NoteTag]برچسب‌های OneNote پیوست شده به این عنصر

RichText

ImageRenderOptions CompositeNode. یک بلوک متن قالب‌بندی‌شده.

ImageRenderOptionsImageRenderOptionsImageRenderOptions
Textstrرشتهٔ متن ساده کامل (تمام بخش‌ها به‌هم‌پیوسته)
Runslist[TextRun]فهرست مرتب‌شده‌ای از بخش‌های قالب‌بندی‌شده
FontSize`floatNone`
Tagslist[NoteTag]برچسب‌های OneNote پیوست شده به این بلوک

ImageRenderOptions:

ImageRenderOptionsImageRenderOptionsImageRenderOptions
Append(text, style=None)`(str, TextStyleNone) -> RichText`
Replace(old_value, new_value)(str, str) -> Noneجایگزینی رشته در حافظه بر روی Text; به‌روزرسانی نمی‌شود Runs

TextRun

ImageRenderOptions Node. یک بخش متن قالب‌بندی‌شدهٔ تک.

ImageRenderOptionsImageRenderOptionsImageRenderOptions
Textstrمتن محتوای بخش (پیش‌فرض "")
StyleTextStyleویژگی‌های قالب‌بندی
Start`intNone`
End`intNone`

TextStyle

ImageRenderOptions Node. ویژگی‌های قالب‌بندی به‌ازای هر کاراکتر برای یک TextRun.

ImageRenderOptionsImageRenderOptionsImageRenderOptionsImageRenderOptions
BoldboolFalseImageRenderOptions
ItalicboolFalseImageRenderOptions
UnderlineboolFalseImageRenderOptions
StrikethroughboolFalseImageRenderOptions
SuperscriptboolFalseImageRenderOptions
SubscriptboolFalseImageRenderOptions
FontName`strNone`None
FontSize`floatNone`None
FontColor`intNone`None
HighlightColor`intNone`None
LanguageId`intNone`None
IsHyperlinkboolFalseاینکه آیا این اجرا یک پیوند است
HyperlinkAddress`strNone`None

ImageRenderOptions

ImageRenderOptions CompositeNode. یک تصویر جاسازی‌شده.

ImageRenderOptionsImageRenderOptionsImageRenderOptions
FileName`strNone`
Bytesbytesداده‌های خام تصویر (به‌صورت پیش‌فرض b"")
Width`floatNone`
Height`floatNone`
AlternativeTextTitle`strNone`
AlternativeTextDescription`strNone`
HyperlinkUrl`strNone`
Tagslist[NoteTag]برچسب‌های OneNote پیوست شده به این تصویر

ImageRenderOptions:

ImageRenderOptionsImageRenderOptions
Replace(image)ImageRenderOptions Bytes و FileName از دیگری Image گره به این گره

AttachedFile

ImageRenderOptions CompositeNode. یک پیوست فایل جاسازی‌شده.

ImageRenderOptionsImageRenderOptionsImageRenderOptions
FileName`strNone`
Bytesbytesداده‌های فایل خام (پیش‌فرض b"")
Tagslist[NoteTag]برچسب‌های OneNote پیوست شده به این پیوست

ImageRenderOptions

ImageRenderOptions CompositeNode. یک جدول درون یک OutlineElement.

ImageRenderOptionsImageRenderOptionsImageRenderOptionsImageRenderOptions
Columnslist[float][]عرض هر ستون بر حسب پوینت
IsBordersVisibleboolTrueآیا حاشیه‌های جدول قابل مشاهده هستند
Tagslist[NoteTag][]برچسب‌های OneNote پیوست شده به این جدول

TableRow

ImageRenderOptions CompositeNode. یک ردیف درون یک Table. تکرار GetChildNodes(TableCell) برای دسترسی به سلول‌ها.

TableCell

ImageRenderOptions CompositeNode. یک سلول درون یک TableRow. شامل RichText, Image, و سایر گره‌های محتوا.

NoteTag

ImageRenderOptions Node. یک برچسب OneNote که به یک گره محتوا پیوست شده است.

ImageRenderOptionsImageRenderOptionsImageRenderOptionsImageRenderOptions
shape`intNone`None
label`strNone`None
text_color`intNone`None
highlight_color`intNone`None
created`intNone`None
completed`intNone`None

یادداشت زمان‌مهر: created و completed به‌عنوان زمان‌مهرهای عددی خام که از فرمت باینری MS-ONE تجزیه شده‌اند، نه datetime اشیاء.

متدهای کارخانه‌ای:

ImageRenderOptionsImageRenderOptions
NoteTag.CreateYellowStar()یک … می‌سازد NoteTag(shape=None, label="Yellow Star")

NumberList

ImageRenderOptions Node. فرادادهٔ فهرست شماره‌دار یا بولت‌دار روی یک OutlineElement.

ImageRenderOptionsImageRenderOptionsImageRenderOptionsImageRenderOptions
Format`strNone`None
Restart`intNone`None
IsNumberedboolFalseدرست برای فهرست‌های مرتب (شماره‌دار)

LoadOptions

ImageRenderOptionsImageRenderOptionsImageRenderOptionsImageRenderOptions
DocumentPassword`strNone`None
LoadHistoryboolFalseفیلد سازگاری API؛ در نسخه v26.3.1 به‌صورت عملکردی استفاده نمی‌شود

SaveOptions

کلاس پایه برای تمام گزینه‌های ذخیره‌سازی. آرگومان موقعیتی اجباری.

ImageRenderOptionsImageRenderOptionsImageRenderOptions
SaveFormatSaveFormatقالب ذخیره هدف

PdfSaveOptions

ImageRenderOptions SaveOptions. پیکربندی صادرات مخصوص PDF. ساخت با PdfSaveOptions(SaveFormat.Pdf).

ImageRenderOptionsImageRenderOptionsImageRenderOptionsImageRenderOptions
PageIndexint0فیلد موجود است؛; به صادرکننده PDF در نسخه v26.3.1 ارسال نمی‌شود: هیچ تأثیری بر خروجی ندارد
PageCount`intNone`None
TagIconDir`strNone`None
TagIconSize`floatNone`None
TagIconGap`floatNone`None

PageIndex / PageCount caveat هشدار: These fields are declared on : این فیلدها در PdfSaveOptions for API compatibility, but the برای سازگاری API، اما Document.Save() پیاده‌سازی در نسخه v26.3.1 این موارد را نمی‌خواند یا به صادرکننده PDF منتقل نمی‌کند. تمام صفحات همیشه صادر می‌شوند.

License and Metered

قطعات سازگاری برای سازگاری شکل 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

ImageRenderOptionsImageRenderOptions
SaveFormat.Pdfصادر کردن PDF: پیاده‌سازی شده؛ نیاز دارد به pip install "aspose-note[pdf]"
SaveFormat.Oneقالب OneNote: فقط اعلام شده؛ ایجاد می‌کند UnsupportedSaveFormatException

FileFormat

مقادیر شمارشی که نسخه قالب فایل 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

ImageRenderOptionsImageRenderOptions
AsposeNoteErrorکلاس پایه برای تمام استثناهای Aspose.Note FOSS
FileCorruptedExceptionImageRenderOptions .one فایل قابل تجزیه نیست (خراب یا باینری نامعتبر)
IncorrectDocumentStructureExceptionساختار فایل نامعتبر یا پشتیبانی نشده است
IncorrectPasswordExceptionزمانی که LoadOptions.DocumentPassword تنظیم شده است؛ اسناد رمزگذاری‌شده پشتیبانی نمی‌شوند
UnsupportedFileFormatExceptionقالب فایل شناسایی نشد؛ یک FileFormat فیلد (رشته)
UnsupportedSaveFormatExceptionدرخواست شده SaveFormat در این نسخه پیاده‌سازی نشده است

همچنین ببینید

 فارسی