Aspose.Note FOSS for Python

Ta referencja obejmuje pełny publiczny interfejs API aspose-note wersja 26.3.1. Tylko symbole eksportowane z aspose.note pakietu są dokumentowane tutaj. Wszystko pod aspose.note._internal jest szczegółem implementacji i może ulec zmianie bez powiadomienia.

ImageRenderOptions: pip install aspose-note (core) lub pip install "aspose-note[pdf]" (z eksportem PDF)

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

ImageRenderOptions

Dokument i przeglądanie

ImageRenderOptionsImageRenderOptions
DocumentObiekt głównego dokumentu. Załaduj .one plik, iteruj strony i zapisz do PDF.
DocumentVisitorAbstrakcyjna podstawa dla przeglądania drzewa dokumentu metodą wzorca odwiedzającego.
NodeKlasa bazowa dla wszystkich węzłów dokumentu.
CompositeNodeKlasa bazowa dla węzłów, które mogą zawierać węzły potomne.

Struktura dokumentu

ImageRenderOptionsImageRenderOptions
PageReprezentuje stronę OneNote.
TitleBlok tytułu strony zawierający TitleText, TitleDate, TitleTime.
OutlineKontener pozycyjny dla węzłów OutlineElement.
OutlineElementKontener liścia; przechowuje RichText, Image, Table, AttachedFile.

ImageRenderOptions

ImageRenderOptionsImageRenderOptions
RichTextBlok tekstowy z fragmentami formatowania, tagami i hiperłączami.
TextRunPojedynczy sformatowany segment tekstu w RichText.
TextStyleWłaściwości formatowania dla TextRun.
ImageOsadzony obraz z surowymi bajtami i metadanymi.
AttachedFileOsadzony załącznik pliku z surowymi bajtami.
TableTabela z wierszami, komórkami i szerokościami kolumn.
TableRowWiersz w tabeli.
TableCellKomórka w TableRow; zawiera węzły treści.
NoteTagTag OneNote (gwiazdka, pole wyboru itp.) dołączony do węzła treści.
NumberListMetadane listy numerowanej w OutlineElement.

ImageRenderOptions

ImageRenderOptionsImageRenderOptions
LoadOptionsOpcje ładowania .one pliku.
SaveOptionsKlasa bazowa dla opcji zapisu.
PdfSaveOptionsOpcje zapisu specyficzne dla PDF (ikony tagów).

Stuby zgodności

ImageRenderOptionsImageRenderOptions
LicenseZastawka kompatybilności: SetLicense() jest operacją pustą w tej implementacji FOSS.
MeteredZastawka kompatybilności: SetMeteredKey() jest operacją pustą w tej implementacji FOSS.

Szczegóły klasy

ImageRenderOptions

Klasa dokumentu głównego. Wczytaj .one plik z ścieżki pliku, a pathlib.Path, lub strumień binarny.

from aspose.note import Document, LoadOptions

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

Parametry konstruktora:

ImageRenderOptionsImageRenderOptionsImageRenderOptions
source`strPath
load_options`LoadOptionsNone`

ImageRenderOptions:

ImageRenderOptionsImageRenderOptionsImageRenderOptions
DisplayName`strNone`
CreationTime`datetimeNone`
FileFormatFileFormatWskazanie wersji formatu pliku OneNote w miarę możliwości

ImageRenderOptions:

ImageRenderOptionsImageRenderOptionsImageRenderOptions
Count()() -> intLiczba bezpośrednich podstron
GetPageHistory(page)(Page) -> list[Page]ImageRenderOptions [page] (szkielet; pełna historia nie została jeszcze zaimplementowana)
DetectLayoutChanges()() -> NoneSzkielet kompatybilności; brak operacji
Save(target, format_or_options)`(strPath
Accept(visitor)(DocumentVisitor) -> NoneWywołaj przeglądanie przez odwiedzającego
for page in docN/AIteruj bezpośrednie podwęzły Page węzły

Document.FileFormat uwaga: Właściwość zapewnia przybliżone wskazanie wersji formatu pliku OneNote. Ta FileFormat enum ma trzy wartości: OneNote2010, OneNoteOnline, i OneNote2007.

Document.Save() obsługa strumieni: target może być strumieniem binarnym (io.BytesIO, uchwyt pliku otwarty w trybie binarnego zapisu, itp.). To jest potwierdzone przez zestaw testów: doc.Save(io.BytesIO(), PdfSaveOptions(SaveFormat.Pdf)).

DocumentVisitor

Abstrakcyjna klasa bazowa dla przeglądania w stylu wzorca odwiedzającego. Nadpisz potrzebne metody odwiedzające:

ImageRenderOptionsWywoływane, gdy
VisitDocumentStart(doc)Wchodzenie do węzła Document
VisitDocumentEnd(doc)Opuszczanie węzła Document
VisitPageStart(page)Wchodzenie do węzła Page
VisitPageEnd(page)Opuszczanie węzła Page
VisitTitleStart(title)Wchodzenie do węzła Title
VisitTitleEnd(title)Opuszczanie węzła Title
VisitOutlineStart(outline)Wejście do węzła Outline
VisitOutlineEnd(outline)Wyjście z węzła Outline
VisitOutlineElementStart(oe)Wejście do węzła OutlineElement
VisitOutlineElementEnd(oe)Wyjście z węzła OutlineElement
VisitRichTextStart(rt)Wejście do węzła RichText
VisitRichTextEnd(rt)Wyjście z węzła RichText
VisitImageStart(img)Wejście do węzła Image
VisitImageEnd(img)Wyjście z węzła Image

ImageRenderOptions

Klasa bazowa dla wszystkich węzłów drzewa dokumentu.

Właściwość / MetodaImageRenderOptionsImageRenderOptions
ParentNode`NodeNone`
Document`DocumentNone`
Accept(visitor)(DocumentVisitor) -> NoneWywołaj odwiedzającego dla tego węzła

CompositeNode

ImageRenderOptions Node. Dodaje zarządzanie dziećmi:

Właściwość / MetodaImageRenderOptions
FirstChildPierwszy węzeł dziecka, lub None
LastChildOstatni węzeł dziecka, lub None
AppendChildLast(node)Dodaj węzeł dziecka na końcu; ustawia node.ParentNode = self
AppendChildFirst(node)Dodaj węzeł dziecka na początku
InsertChild(index, node)Wstaw dziecko na podanej pozycji
RemoveChild(node)Usuń węzeł dziecka; ustawia node.ParentNode = None
GetEnumerator()Zwraca iterator po bezpośrednich dzieciach
for child in nodeIteruj po bezpośrednich dzieciach
GetChildNodes(Type)(Type) -> list[Type]: rekurencyjne, przeszukiwanie w głąb całego poddrzewa, w tym self

ImageRenderOptions

ImageRenderOptions CompositeNode. Reprezentuje stronę OneNote.

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

ImageRenderOptions:

ImageRenderOptionsImageRenderOptions
Clone(deep=False)Zwróć płytką lub głęboką kopię strony

ImageRenderOptions

ImageRenderOptions CompositeNode. Przechowuje blok tytułu a Page.

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

ImageRenderOptions

ImageRenderOptions CompositeNode. Kontener pozycjonujący dla OutlineElement węzły.

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

OutlineElement

ImageRenderOptions CompositeNode. Kontener liściowy, który przechowuje węzły treści.

ImageRenderOptionsImageRenderOptionsImageRenderOptions
IndentLevelintGłębokość zagnieżdżenia (0 = najbardziej zewnętrzny)
NumberList`NumberListNone`
Tagslist[NoteTag]Tagi OneNote dołączone do tego elementu

RichText

ImageRenderOptions CompositeNode. Blok sformatowanego tekstu.

ImageRenderOptionsImageRenderOptionsImageRenderOptions
TextstrPełny ciąg zwykłego tekstu (wszystkie fragmenty połączone)
Runslist[TextRun]Uporządkowana lista sformatowanych segmentów
FontSize`floatNone`
Tagslist[NoteTag]Tagi OneNote dołączone do tego bloku

ImageRenderOptions:

ImageRenderOptionsImageRenderOptionsImageRenderOptions
Append(text, style=None)`(str, TextStyleNone) -> RichText`
Replace(old_value, new_value)(str, str) -> NonePodstawianie ciągów w pamięci włączone Text; nie aktualizuje Runs

TextRun

ImageRenderOptions Node. Pojedynczy sformatowany segment tekstu.

ImageRenderOptionsImageRenderOptionsImageRenderOptions
TextstrZawartość tekstowa segmentu (domyślnie "")
StyleTextStyleWłaściwości formatowania
Start`intNone`
End`intNone`

TextStyle

ImageRenderOptions Node. Właściwości formatowania dla każdego znaku TextRun.

ImageRenderOptionsImageRenderOptionsImageRenderOptionsImageRenderOptions
BoldboolFalseImageRenderOptions
ItalicboolFalseImageRenderOptions
UnderlineboolFalseImageRenderOptions
StrikethroughboolFalseImageRenderOptions
SuperscriptboolFalseImageRenderOptions
SubscriptboolFalseImageRenderOptions
FontName`strNone`None
FontSize`floatNone`None
FontColor`intNone`None
HighlightColor`intNone`None
LanguageId`intNone`None
IsHyperlinkboolFalseCzy ten fragment jest hiperłączem
HyperlinkAddress`strNone`None

ImageRenderOptions

ImageRenderOptions CompositeNode. Osadzony obraz.

ImageRenderOptionsImageRenderOptionsImageRenderOptions
FileName`strNone`
BytesbytesSurowe dane obrazu (domyślnie b"")
Width`floatNone`
Height`floatNone`
AlternativeTextTitle`strNone`
AlternativeTextDescription`strNone`
HyperlinkUrl`strNone`
Tagslist[NoteTag]Tagi OneNote dołączone do tego obrazu

ImageRenderOptions:

ImageRenderOptionsImageRenderOptions
Replace(image)ImageRenderOptions Bytes i FileName z innego Image węzeł do tego

AttachedFile

ImageRenderOptions CompositeNode. Osadzony załącznik pliku.

ImageRenderOptionsImageRenderOptionsImageRenderOptions
FileName`strNone`
BytesbytesSurowe dane pliku (domyślnie b"")
Tagslist[NoteTag]Tagi OneNote dołączone do tego załącznika

ImageRenderOptions

ImageRenderOptions CompositeNode. Tabela w obrębie OutlineElement.

ImageRenderOptionsImageRenderOptionsImageRenderOptionsImageRenderOptions
Columnslist[float][]Szerokość każdej kolumny w punktach
IsBordersVisibleboolTrueCzy obramowania tabeli są widoczne
Tagslist[NoteTag][]Tagi OneNote dołączone do tej tabeli

TableRow

ImageRenderOptions CompositeNode. Wiersz w Table. Iteruj GetChildNodes(TableCell) aby uzyskać dostęp do komórek.

TableCell

ImageRenderOptions CompositeNode. Komórka w TableRow. Zawiera RichText, Image, oraz inne węzły treści.

NoteTag

ImageRenderOptions Node. Tag OneNote dołączony do węzła treści.

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

Uwaga o znaczniku czasu: created i completed są surowymi znacznikami czasu w postaci liczb całkowitych, odczytanymi z binarnego formatu MS-ONE, nie datetime obiekty.

Metody fabryczne:

ImageRenderOptionsImageRenderOptions
NoteTag.CreateYellowStar()Tworzy a NoteTag(shape=None, label="Yellow Star")

NumberList

ImageRenderOptions Node. Metadane list numerowanych lub wypunktowanych na OutlineElement.

ImageRenderOptionsImageRenderOptionsImageRenderOptionsImageRenderOptions
Format`strNone`None
Restart`intNone`None
IsNumberedboolFalsetrue dla list uporządkowanych (numerowanych)

LoadOptions

ImageRenderOptionsImageRenderOptionsImageRenderOptionsImageRenderOptions
DocumentPassword`strNone`None
LoadHistoryboolFalsePole kompatybilności API; nie jest funkcjonalnie używane w v26.3.1

SaveOptions

Klasa bazowa dla wszystkich opcji zapisu. Wymagany argument pozycyjny.

ImageRenderOptionsImageRenderOptionsImageRenderOptions
SaveFormatSaveFormatDocelowy format zapisu

PdfSaveOptions

ImageRenderOptions SaveOptions. Konfiguracja eksportu specyficzna dla PDF. Tworzyć z PdfSaveOptions(SaveFormat.Pdf).

ImageRenderOptionsImageRenderOptionsImageRenderOptionsImageRenderOptions
PageIndexint0Pole istnieje; nie jest przekazywane do eksportera PDF w v26.3.1:nie ma wpływu na wynik
PageCount`intNone`None
TagIconDir`strNone`None
TagIconSize`floatNone`None
TagIconGap`floatNone`None

PageIndex / PageCount uwaga: Te pola są zadeklarowane w PdfSaveOptions dla zgodności API, ale Document.Save() implementacja w wersji v26.3.1 nie odczytuje ich ani nie przekazuje do eksportera PDF. Wszystkie strony są zawsze eksportowane.

Licencja i rozliczanie

Stuby kompatybilności eksportowane w celu zachowania kształtu API z Aspose.Note dla .NET. Wszystkie metody są operacjami bez efektu w tej implementacji 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

Nie jest wymagany klucz licencyjny, aby korzystać z dowolnej funkcji Aspose.Note FOSS dla Python.

ImageRenderOptions

Pełna referencja wyliczenia: ImageRenderOptions

SaveFormat

ImageRenderOptionsImageRenderOptions
SaveFormat.PdfEksport PDF: zaimplementowany; wymaga pip install "aspose-note[pdf]"
SaveFormat.OneFormat OneNote: tylko zadeklarowany; wywołuje UnsupportedSaveFormatException

FileFormat

Wartości wyliczenia reprezentujące wersję formatu pliku OneNote. Document.FileFormat zapewnia wskazówkę w miarę możliwości.

ImageRenderOptionsWartość łańcucha
FileFormat.OneNote2010"onenote2010"
FileFormat.OneNoteOnline"onenoteonline"
FileFormat.OneNote2007"onenote2007"

HorizontalAlignment

ImageRenderOptionsWartość łańcucha
HorizontalAlignment.Left"left"
HorizontalAlignment.Center"center"
HorizontalAlignment.Right"right"

NodeType

ImageRenderOptionsWartość łańcucha
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

Pełna referencja wyjątków: ImageRenderOptions

ImageRenderOptionsImageRenderOptions
AsposeNoteErrorKlasa bazowa dla wszystkich wyjątków Aspose.Note FOSS
FileCorruptedExceptionImageRenderOptions .one plik nie może zostać sparsowany (uszkodzony lub nieprawidłowy plik binarny)
IncorrectDocumentStructureExceptionStruktura pliku jest nieprawidłowa lub nieobsługiwana
IncorrectPasswordExceptionRzucane, gdy LoadOptions.DocumentPassword jest ustawione; zaszyfrowane dokumenty nie są obsługiwane
UnsupportedFileFormatExceptionFormat pliku nie jest rozpoznany; udostępnia FileFormat pole (ciąg znaków)
UnsupportedSaveFormatExceptionŻądany SaveFormat nie jest zaimplementowane w tej wersji

Zobacz także

 Polski