Aspose.Note FOSS for Python
यह संदर्भ पूर्ण सार्वजनिक API सतह को कवर करता है aspose-note संस्करण 26.3.1। केवल उन प्रतीकों को दस्तावेज़ित किया गया है जो aspose.note पैकेज से निर्यातित होते हैं यहाँ। aspose.note._internal यह एक कार्यान्वयन विवरण है और बिना सूचना के बदल सकता है।.
ImageRenderOptions: pip install aspose-note (कोर) या 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 | लोड करने के लिए विकल्प a .one फ़ाइल।. |
SaveOptions | सेव विकल्पों के लिए बेस क्लास।. |
PdfSaveOptions | PDF-विशिष्ट सेव विकल्प (टैग आइकन)।. |
संगतता स्टब्स
| ImageRenderOptions | ImageRenderOptions |
|---|---|
License | संगतता स्टब: SetLicense() इस FOSS कार्यान्वयन में कोई ऑपरेशन नहीं है।. |
Metered | संगतता स्टब: SetMeteredKey() इस 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 | OneNote फ़ाइल फ़ॉर्मेट संस्करण का सर्वश्रेष्ठ प्रयास संकेत |
ImageRenderOptions:
| ImageRenderOptions | ImageRenderOptions | ImageRenderOptions |
|---|---|---|
Count() | () -> int | प्रत्यक्ष चाइल्ड पेजों की संख्या |
GetPageHistory(page) | (Page) -> list[Page] | ImageRenderOptions [page] (स्टब; पूर्ण इतिहास अभी तक लागू नहीं किया गया है) |
DetectLayoutChanges() | () -> None | संगतता स्टब; कोई ऑपरेशन नहीं |
Save(target, format_or_options) | `(str | Path |
Accept(visitor) | (DocumentVisitor) -> None | विज़िटर ट्रैवर्सल को बुलाएँ |
for page in doc | N/A | सीधे चाइल्ड को इटरेट करें Page नोड्स |
Document.FileFormat नोट: यह प्रॉपर्टी OneNote फ़ाइल फ़ॉर्मेट संस्करण का सर्वश्रेष्ठ‑प्रयास संकेत प्रदान करती है। यह 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) | एक 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
सभी दस्तावेज़ ट्री नोड्स के लिए बेस क्लास।.
| प्रॉपर्टी / मेथड | 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 | इन-मेमोरी स्ट्रिंग प्रतिस्थापन पर 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 | क्रमबद्ध (क्रमांकित) सूचियों के लिए True |
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 | फ़ील्ड मौजूद है; v26.3.1 में PDF निर्यातकर्ता को अग्रेषित नहीं किया गया: आउटपुट पर कोई प्रभाव नहीं पड़ता |
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 निर्यातकर्ता को पढ़ता या फ़ॉरवर्ड नहीं करता। सभी पृष्ठ हमेशा निर्यात किए जाते हैं।.
लाइसेंस और मीटरड
.NET के लिए Aspose.Note के साथ API आकार संगतता हेतु संगतता स्टब्स निर्यात किए गए हैं। इस 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-opPython के लिए Aspose.Note FOSS की किसी भी सुविधा का उपयोग करने के लिए कोई लाइसेंस कुंजी आवश्यक नहीं है।.
ImageRenderOptions
पूर्ण एनीमरेशन संदर्भ: ImageRenderOptions
SaveFormat
| ImageRenderOptions | ImageRenderOptions |
|---|---|
SaveFormat.Pdf | PDF निर्यात: लागू किया गया; आवश्यक है pip install "aspose-note[pdf]" |
SaveFormat.One | OneNote फ़ॉर्मेट: केवल घोषित; उत्पन्न करता है UnsupportedSaveFormatException |
FileFormat
OneNote फ़ाइल फ़ॉर्मेट संस्करण को दर्शाने वाले एनीम मान।. Document.FileFormat एक सर्वश्रेष्ठ-प्रयास संकेत प्रदान करता है।.
| ImageRenderOptions | String मान |
|---|---|
FileFormat.OneNote2010 | "onenote2010" |
FileFormat.OneNoteOnline | "onenoteonline" |
FileFormat.OneNote2007 | "onenote2007" |
HorizontalAlignment
| ImageRenderOptions | String मान |
|---|---|
HorizontalAlignment.Left | "left" |
HorizontalAlignment.Center | "center" |
HorizontalAlignment.Right | "right" |
NodeType
| ImageRenderOptions | 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
पूर्ण अपवाद संदर्भ: ImageRenderOptions
| ImageRenderOptions | ImageRenderOptions |
|---|---|
AsposeNoteError | सभी Aspose.Note FOSS अपवादों के लिए बेस क्लास |
FileCorruptedException | ImageRenderOptions .one फ़ाइल को पार्स नहीं किया जा सकता (दोषपूर्ण या विकृत बाइनरी) |
IncorrectDocumentStructureException | फ़ाइल संरचना अमान्य या असमर्थित है |
IncorrectPasswordException | उठाया जाता है जब LoadOptions.DocumentPassword सेट है; एन्क्रिप्टेड दस्तावेज़ समर्थित नहीं हैं |
UnsupportedFileFormatException | फ़ाइल फ़ॉर्मेट पहचाना नहीं गया; एक को उजागर करता है FileFormat फ़ील्ड (string) |
UnsupportedSaveFormatException | अनुरोधित SaveFormat इस संस्करण में लागू नहीं किया गया है |