Aspose.Note FOSS for Python
Bu referans, tam kamu API yüzeyini kapsar aspose-note 26.3.1 sürümü. Yalnızca paketten dışa aktarılan semboller aspose.note paket burada belgelenir. Altındaki her şey aspose.note._internal bir uygulama detayıdır ve önceden bildirim olmadan değişebilir.
Enumerations: pip install aspose-note (core) veya pip install "aspose-note[pdf]" (PDF dışa aktarımıyla)
Enumerations: from aspose.note import Document, RichText, ...
Enumerations
Belge ve Gezinme
| Enumerations | Enumerations |
|---|---|
Document | Kök belge nesnesi. Bir .one dosya yükleyin, sayfaları yineleyin ve PDF olarak kaydedin. |
DocumentVisitor | Ziyaretçi deseniyle belge ağacının dolaşımı için soyut temel. |
Node | Tüm belge düğümleri için temel sınıf. |
CompositeNode | Alt düğüm içerebilen düğümler için temel sınıf. |
Belge Yapısı
| Enumerations | Enumerations |
|---|---|
Page | Bir OneNote sayfasını temsil eder. |
Title | TitleText, TitleDate, TitleTime içeren sayfa başlık bloğu. |
Outline | OutlineElement düğümleri için konumsal kapsayıcı. |
OutlineElement | Yaprak kapsayıcı; RichText, Image, Table, AttachedFile içerir. |
Enumerations
| Enumerations | Enumerations |
|---|---|
RichText | Biçimlendirme aralıkları, etiketler ve bağlantılar içeren metin bloğu. |
TextRun | RichText içinde tek biçimlendirilmiş metin bölümü. |
TextStyle | TextRun için biçimlendirme özellikleri. |
Image | Ham baytlar ve meta verilerle gömülü görüntü. |
AttachedFile | Ham baytlarla gömülü dosya eki. |
Table | Satırları, hücreleri ve sütun genişlikleri olan tablo. |
TableRow | Bir tablodaki satır. |
TableCell | Bir TableRow içindeki hücre; içerik düğümlerini içerir. |
NoteTag | Bir içerik düğümüne eklenmiş OneNote etiketi (yıldız, onay kutusu vb.). |
NumberList | OutlineElement üzerindeki numaralı liste meta verileri. |
Enumerations
| Enumerations | Enumerations |
|---|---|
LoadOptions | Yükleme seçenekleri .one dosya. |
SaveOptions | Kaydetme seçenekleri için temel sınıf. |
PdfSaveOptions | PDF’ye özgü kaydetme seçenekleri (etiket simgeleri). |
Uyumluluk Stub’ları
| Enumerations | Enumerations |
|---|---|
License | Uyumluluk kancası: SetLicense() bu FOSS uygulamasında bir no-op’tur. |
Metered | Uyumluluk kancası: SetMeteredKey() bu FOSS uygulamasında bir no-op’tur. |
Sınıf Ayrıntıları
Enumerations
Kök belge sınıfı. Bir .one dosyayı bir dosya yolundan, bir pathlib.Path, ya da ikili akış.
from aspose.note import Document, LoadOptions
doc = Document(source=None, load_options=None)Yapıcı parametreleri:
| Enumerations | Enumerations | Enumerations |
|---|---|---|
source | `str | Path |
load_options | `LoadOptions | None` |
Enumerations:
| Enumerations | Enumerations | Enumerations |
|---|---|---|
DisplayName | `str | None` |
CreationTime | `datetime | None` |
FileFormat | FileFormat | OneNote dosya formatı sürümünün en iyi çaba gösteren göstergesi |
Enumerations:
| Enumerations | Enumerations | Enumerations |
|---|---|---|
Count() | () -> int | Doğrudan alt sayfa sayısı |
GetPageHistory(page) | (Page) -> list[Page] | Enumerations [page] (taslak; tam geçmiş henüz uygulanmadı) |
DetectLayoutChanges() | () -> None | Uyumluluk taslağı; işlem yok |
Save(target, format_or_options) | `(str | Path |
Accept(visitor) | (DocumentVisitor) -> None | Ziyaretçi geçişini çağır |
for page in doc | N/A | Doğrudan alt öğeyi yinele Page düğümler |
Document.FileFormat not: Özellik, OneNote dosya formatı sürümünün en iyi çaba gösteren bir göstergesini sağlar. Bu FileFormat enum üç değer içerir: OneNote2010, OneNoteOnline, ve OneNote2007.
Document.Save() akış desteği: target ikili bir akış olabilir (io.BytesIO, ikili yazma modunda açılmış dosya tanıtıcısı vb.). Bu, test paketi tarafından doğrulanmıştır: doc.Save(io.BytesIO(), PdfSaveOptions(SaveFormat.Pdf)).
DocumentVisitor
Ziyaretçi deseni gezinmesi için soyut temel sınıf. İhtiyacınız olan ziyaret metodlarını geçersiz kılın:
| Enumerations | Çağrıldığında |
|---|---|
VisitDocumentStart(doc) | Belge düğümüne giriliyor |
VisitDocumentEnd(doc) | Belge düğümünden çıkılıyor |
VisitPageStart(page) | Sayfa düğümüne giriliyor |
VisitPageEnd(page) | Sayfa düğümünden çıkılıyor |
VisitTitleStart(title) | Başlık düğümüne giriliyor |
VisitTitleEnd(title) | Başlık düğümünden çıkılıyor |
VisitOutlineStart(outline) | Anahat düğümüne giriliyor |
VisitOutlineEnd(outline) | Anahat düğümünden çıkılıyor |
VisitOutlineElementStart(oe) | OutlineElement düğümüne giriliyor |
VisitOutlineElementEnd(oe) | OutlineElement düğümünden çıkılıyor |
VisitRichTextStart(rt) | RichText düğümüne giriliyor |
VisitRichTextEnd(rt) | RichText düğümünden çıkılıyor |
VisitImageStart(img) | Image düğümüne giriliyor |
VisitImageEnd(img) | Image düğümünden çıkılıyor |
Enumerations
Tüm belge ağacı düğümleri için temel sınıf.
| Özellik / Metot | Enumerations | Enumerations |
|---|---|---|
ParentNode | `Node | None` |
Document | `Document | None` |
Accept(visitor) | (DocumentVisitor) -> None | Bu node için ziyaretçiyi gönder |
CompositeNode
Enumerations Node. Çocuk yönetimi ekler:
| Özellik / Metot | Enumerations |
|---|---|
FirstChild | İlk çocuk düğüm, ya da None |
LastChild | Son çocuk düğüm, ya da None |
AppendChildLast(node) | Sonuna bir çocuk düğüm ekle; ayarlar node.ParentNode = self |
AppendChildFirst(node) | Başına bir çocuk düğüm ekle |
InsertChild(index, node) | Verilen konuma bir çocuk ekle |
RemoveChild(node) | Bir çocuk düğümünü kaldır; ayarlar node.ParentNode = None |
GetEnumerator() | Doğrudan çocuklar üzerinde bir yineleyici döndürür |
for child in node | Doğrudan çocukları yinele |
GetChildNodes(Type) | (Type) -> list[Type]: özyinelemeli, tüm alt ağacı içeren derinlemesine öncelikli arama self |
Enumerations
Enumerations CompositeNode. Bir OneNote sayfasını temsil eder.
| Enumerations | Enumerations | Enumerations |
|---|---|---|
Title | `Title | None` |
Author | `str | None` |
CreationTime | `datetime | None` |
LastModifiedTime | `datetime | None` |
Level | `int | None` |
Enumerations:
| Enumerations | Enumerations |
|---|---|
Clone(deep=False) | Sayfanın sığ ya da derin bir klonunu döndür |
Enumerations
Enumerations CompositeNode. Bir … başlık bloğunu tutar Page.
| Enumerations | Enumerations | Enumerations |
|---|---|---|
TitleText | `RichText | None` |
TitleDate | `RichText | None` |
TitleTime | `RichText | None` |
Enumerations
Enumerations CompositeNode. Konumsal bir kapsayıcı için OutlineElement düğümler.
| Enumerations | Enumerations | Enumerations |
|---|---|---|
X | `float | None` |
Y | `float | None` |
Width | `float | None` |
OutlineElement
Enumerations CompositeNode. İçerik düğümlerini tutan bir yaprak kapsayıcı.
| Enumerations | Enumerations | Enumerations |
|---|---|---|
IndentLevel | int | İç içe derinlik (0 = en dıştaki) |
NumberList | `NumberList | None` |
Tags | list[NoteTag] | Bu öğeye eklenmiş OneNote etiketleri |
RichText
Enumerations CompositeNode. Stil uygulanmış metin bloğu.
| Enumerations | Enumerations | Enumerations |
|---|---|---|
Text | str | Tam düz metin dizesi (tüm çalıştırmalar birleştirilmiş) |
Runs | list[TextRun] | Biçimlendirilmiş segmentlerin sıralı listesi |
FontSize | `float | None` |
Tags | list[NoteTag] | Bu bloğa eklenmiş OneNote etiketleri |
Enumerations:
| Enumerations | Enumerations | Enumerations |
|---|---|---|
Append(text, style=None) | `(str, TextStyle | None) -> RichText` |
Replace(old_value, new_value) | (str, str) -> None | Bellek içi dize değiştirme Text; güncellenmez Runs |
TextRun
Enumerations Node. Tek bir biçimlendirilmiş metin bölümü.
| Enumerations | Enumerations | Enumerations |
|---|---|---|
Text | str | Segmentin metin içeriği (varsayılan "") |
Style | TextStyle | Biçimlendirme özellikleri |
Start | `int | None` |
End | `int | None` |
TextStyle
Enumerations Node. Bir karakter başına biçimlendirme özellikleri TextRun.
| Enumerations | Enumerations | Enumerations | Enumerations |
|---|---|---|---|
Bold | bool | False | Enumerations |
Italic | bool | False | Enumerations |
Underline | bool | False | Enumerations |
Strikethrough | bool | False | Enumerations |
Superscript | bool | False | Enumerations |
Subscript | bool | False | Enumerations |
FontName | `str | None` | None |
FontSize | `float | None` | None |
FontColor | `int | None` | None |
HighlightColor | `int | None` | None |
LanguageId | `int | None` | None |
IsHyperlink | bool | False | Bu çalışmanın bir hiperlink olup olmadığı |
HyperlinkAddress | `str | None` | None |
Enumerations
Enumerations CompositeNode. Gömülü bir görüntü.
| Enumerations | Enumerations | Enumerations |
|---|---|---|
FileName | `str | None` |
Bytes | bytes | Ham görüntü verisi (varsayılan b"") |
Width | `float | None` |
Height | `float | None` |
AlternativeTextTitle | `str | None` |
AlternativeTextDescription | `str | None` |
HyperlinkUrl | `str | None` |
Tags | list[NoteTag] | Bu görsele eklenmiş OneNote etiketleri |
Enumerations:
| Enumerations | Enumerations |
|---|---|
Replace(image) | Enumerations Bytes ve FileName başka bir Image düğümden bu düğüme |
AttachedFile
Enumerations CompositeNode. Gömülü bir dosya eki.
| Enumerations | Enumerations | Enumerations |
|---|---|---|
FileName | `str | None` |
Bytes | bytes | Ham dosya verisi (varsayılan b"") |
Tags | list[NoteTag] | Bu eke eklenmiş OneNote etiketleri |
Enumerations
Enumerations CompositeNode. OutlineElement içinde bir tablo.
| Enumerations | Enumerations | Enumerations | Enumerations |
|---|---|---|---|
Columns | list[float] | [] | Her sütunun puan cinsinden genişliği |
IsBordersVisible | bool | True | Tablo kenarlıklarının görünür olup olmadığı |
Tags | list[NoteTag] | [] | Bu tabloya eklenmiş OneNote etiketleri |
TableRow
Enumerations CompositeNode. Bir satır içinde bir Table. Yinele GetChildNodes(TableCell) hücrelere erişmek için.
TableCell
Enumerations CompositeNode. Bir hücre içinde bir TableRow. İçerir RichText, Image, ve diğer içerik düğümleri.
NoteTag
Enumerations Node. Bir içerik düğümüne eklenmiş OneNote etiketi.
| Enumerations | Enumerations | Enumerations | Enumerations |
|---|---|---|---|
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 |
Zaman damgası notu: created ve completed MS-ONE ikili formatından ayrıştırılan ham tamsayı zaman damgalarıdır, ancak datetime nesneler.
Fabrika yöntemleri:
| Enumerations | Enumerations |
|---|---|
NoteTag.CreateYellowStar() | Bir şey oluşturur NoteTag(shape=None, label="Yellow Star") |
NumberList
Enumerations Node. Numaralı veya madde işaretli liste meta verileri bir OutlineElement.
| Enumerations | Enumerations | Enumerations | Enumerations |
|---|---|---|---|
Format | `str | None` | None |
Restart | `int | None` | None |
IsNumbered | bool | False | Sıralı (numaralı) listeler için True |
LoadOptions
| Enumerations | Enumerations | Enumerations | Enumerations |
|---|---|---|---|
DocumentPassword | `str | None` | None |
LoadHistory | bool | False | API uyumluluk alanı; v26.3.1’de işlevsel olarak kullanılmaz |
SaveOptions
Tüm kaydetme seçenekleri için temel sınıf. Gerekli konumsal argüman.
| Enumerations | Enumerations | Enumerations |
|---|---|---|
SaveFormat | SaveFormat | Hedef kaydetme formatı |
PdfSaveOptions
Enumerations SaveOptions. PDF’ye özgü dışa aktarma yapılandırması. Şununla oluşturun PdfSaveOptions(SaveFormat.Pdf).
| Enumerations | Enumerations | Enumerations | Enumerations |
|---|---|---|---|
PageIndex | int | 0 | Alan mevcut; v26.3.1’de PDF dışa aktarıcıya iletilmez: çıktıya etkisi yok |
PageCount | `int | None` | None |
TagIconDir | `str | None` | None |
TagIconSize | `float | None` | None |
TagIconGap | `float | None` | None |
PageIndex / PageCount uyarı: Bu alanlar şurada tanımlanır PdfSaveOptions API uyumluluğu için, ancak the Document.Save() v26.3.1 sürümündeki uygulama bunları PDF dışa aktarıcıya okumaz veya iletmez. Tüm sayfalar her zaman dışa aktarılır.
Lisans ve Ölçümlü
.NET için Aspose.Note ile API şekli uyumluluğu sağlamak amacıyla uyumluluk stub’ları dışa aktarıldı. Bu FOSS uygulamasında tüm yöntemler hiçbir işlem yapmaz.
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 için Aspose.Note FOSS’un herhangi bir özelliğini kullanmak için lisans anahtarı gerekmez.
Enumerations
Tam enum referansı: Enumerations
SaveFormat
| Enumerations | Enumerations |
|---|---|
SaveFormat.Pdf | PDF dışa aktarımı: uygulanmış; gerektirir pip install "aspose-note[pdf]" |
SaveFormat.One | OneNote formatı: yalnızca bildirildi; yükseltir UnsupportedSaveFormatException |
FileFormat
OneNote dosya formatı sürümünü temsil eden enum değerleri. Document.FileFormat en iyi çaba gösteren bir gösterge sağlar.
| Enumerations | Dize değeri |
|---|---|
FileFormat.OneNote2010 | "onenote2010" |
FileFormat.OneNoteOnline | "onenoteonline" |
FileFormat.OneNote2007 | "onenote2007" |
HorizontalAlignment
| Enumerations | Dize değeri |
|---|---|
HorizontalAlignment.Left | "left" |
HorizontalAlignment.Center | "center" |
HorizontalAlignment.Right | "right" |
NodeType
| Enumerations | Dize değeri |
|---|---|
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" |
Enumerations
Tam istisna referansı: Enumerations
| Enumerations | Enumerations |
|---|---|
AsposeNoteError | Tüm Aspose.Note FOSS istisnaları için temel sınıf |
FileCorruptedException | Enumerations .one dosya ayrıştırılamıyor (bozuk veya hatalı ikili) |
IncorrectDocumentStructureException | Dosya yapısı geçersiz veya desteklenmiyor |
IncorrectPasswordException | Atıldığında LoadOptions.DocumentPassword ayarlandığında; şifreli belgeler desteklenmiyor |
UnsupportedFileFormatException | Dosya formatı tanınmıyor; bir FileFormat alan (string) |
UnsupportedSaveFormatException | İstenen SaveFormat bu sürümde uygulanmadı |