Aspose.Note FOSS for Python

Táto referencia pokrýva kompletný verejný povrch API verzie aspose-note 26.3.1. Iba symboly exportované z aspose.note balíka sú dokumentované tu. Čokoľvek pod aspose.note._internal je detail implementácie a môže sa zmeniť bez upozornenia.

ImageRenderOptions: pip install aspose-note (core) alebo pip install "aspose-note[pdf]" (s exportom PDF)

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


ImageRenderOptions

Dokument a prechádzanie

ImageRenderOptionsImageRenderOptions
DocumentKoreňový objekt dokumentu. Načítajte .one súbor, prechádzajte stránky a uložte do PDF.
DocumentVisitorAbstraktný základ pre prechádzanie stromom dokumentu pomocou vzoru návštevníka.
NodeZákladná trieda pre všetky uzly dokumentu.
CompositeNodeZákladná trieda pre uzly, ktoré môžu obsahovať poduzly.

Štruktúra dokumentu

ImageRenderOptionsImageRenderOptions
PageReprezentuje stránku OneNote.
TitleBlok titulku stránky obsahujúci TitleText, TitleDate, TitleTime.
OutlinePozicionálny kontajner pre uzly OutlineElement.
OutlineElementListový kontajner; obsahuje RichText, Image, Table, AttachedFile.

ImageRenderOptions

ImageRenderOptionsImageRenderOptions
RichTextTextový blok s formátovacími úsekmi, značkami a hyperodkazmi.
TextRunJednotlivý formátovaný textový segment v RichText.
TextStyleFormátovacie vlastnosti pre TextRun.
ImageVložený obrázok s nespracovanými bajtmi a metadátami.
AttachedFileVložená príloha súboru s nespracovanými bajtmi.
TableTabuľka s riadkami, bunkami a šírkami stĺpcov.
TableRowRiadok v tabuľke.
TableCellBunka v TableRow; obsahuje uzly obsahu.
NoteTagZnačka OneNote (hviezdička, zaškrtávacie políčko atď.) pripojená k uzlu obsahu.
NumberListMetadáta číslovaného zoznamu na OutlineElement.

ImageRenderOptions

ImageRenderOptionsImageRenderOptions
LoadOptionsMožnosti načítania .one súbor.
SaveOptionsZákladná trieda pre možnosti ukladania.
PdfSaveOptionsMožnosti ukladania špecifické pre PDF (ikony značiek).

Kompatibilné stuby

ImageRenderOptionsImageRenderOptions
LicenseKompatibilná náhrada: SetLicense() je v tejto FOSS implementácii nečinná operácia.
MeteredKompatibilná náhrada: SetMeteredKey() je v tejto FOSS implementácii nečinná operácia.

Detaily triedy

ImageRenderOptions

Koreňová trieda dokumentu. Načítajte .one súbor z cesty k súboru, a pathlib.Path, alebo binárny prúd.

from aspose.note import Document, LoadOptions

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

Parametre konštruktora:

ImageRenderOptionsImageRenderOptionsImageRenderOptions
source`strPath
load_options`LoadOptionsNone`

ImageRenderOptions:

ImageRenderOptionsImageRenderOptionsImageRenderOptions
DisplayName`strNone`
CreationTime`datetimeNone`
FileFormatFileFormatNajlepšia snaha o určenie verzie formátu súboru OneNote

ImageRenderOptions:

ImageRenderOptionsImageRenderOptionsImageRenderOptions
Count()() -> intPočet priamych podstránok
GetPageHistory(page)(Page) -> list[Page]ImageRenderOptions [page] (zástupný kód; úplná história ešte nie je implementovaná)
DetectLayoutChanges()() -> NoneZástupný kód kompatibility; žiadna operácia
Save(target, format_or_options)`(strPath
Accept(visitor)(DocumentVisitor) -> NoneVyvolať prechádzku návštevníka
for page in docN/AIterovať priamych potomkov Page uzlov

Document.FileFormat poznámka: Vlastnosť poskytuje najlepšiu snahu o určenie verzie formátu súboru OneNote. The FileFormat enum má tri hodnoty: OneNote2010, OneNoteOnline, a OneNote2007.

Document.Save() podpora streamu: target môže byť binárny stream (io.BytesIO, súborový handle otvorený v binárnom režime zápisu, atď.). Toto je potvrdené testovacou sadou: doc.Save(io.BytesIO(), PdfSaveOptions(SaveFormat.Pdf)).


DocumentVisitor

Abstraktná základná trieda pre prechádzanie podľa vzoru návštevníka. Predefinujte metódy návštevy, ktoré potrebujete:

ImageRenderOptionsVolané, keď
VisitDocumentStart(doc)Vstup do uzla Document
VisitDocumentEnd(doc)Opustenie uzla Document
VisitPageStart(page)Vstup do uzla Page
VisitPageEnd(page)Opustenie uzla Page
VisitTitleStart(title)Vstup do uzla Title
VisitTitleEnd(title)Opustenie uzla Title
VisitOutlineStart(outline)Vstup do uzla Outline
VisitOutlineEnd(outline)Opustenie uzla Outline
VisitOutlineElementStart(oe)Vstup do uzla OutlineElement
VisitOutlineElementEnd(oe)Opustenie uzla OutlineElement
VisitRichTextStart(rt)Vstup do uzla RichText
VisitRichTextEnd(rt)Opustenie uzla RichText
VisitImageStart(img)Vstup do uzla Image
VisitImageEnd(img)Opustenie uzla Image

ImageRenderOptions

Základná trieda pre všetky uzly stromu dokumentu.

Vlastnosť / MetódaImageRenderOptionsImageRenderOptions
ParentNode`NodeNone`
Document`DocumentNone`
Accept(visitor)(DocumentVisitor) -> NoneRozposlať návštevníka pre tento uzol

CompositeNode

ImageRenderOptions Node. Pridáva správu podriadených:

Vlastnosť / MetódaImageRenderOptions
FirstChildPrvý podriadený uzol, alebo None
LastChildPosledný podriadený uzol, alebo None
AppendChildLast(node)Pridá podriadený uzol na koniec; nastaví node.ParentNode = self
AppendChildFirst(node)Pridá podriadený uzol na začiatok
InsertChild(index, node)Vloží podriadený uzol na zadanú pozíciu
RemoveChild(node)Odstráni podriadený uzol; nastaví node.ParentNode = None
GetEnumerator()Vráti iterátor nad priamymi podriadenými uzlami
for child in nodeIterovať priamych podriadených
GetChildNodes(Type)(Type) -> list[Type]: rekurzívne, hĺbkové prehľadávanie celého podstromu vrátane self

ImageRenderOptions

ImageRenderOptions CompositeNode. Predstavuje stránku OneNote.

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

ImageRenderOptions:

ImageRenderOptionsImageRenderOptions
Clone(deep=False)Vráti plytkú alebo hlbokú kópiu stránky

ImageRenderOptions

ImageRenderOptions CompositeNode. Uchováva blok názvu Page.

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

ImageRenderOptions

ImageRenderOptions CompositeNode. Pozíciový kontajner pre OutlineElement uzly.

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

OutlineElement

ImageRenderOptions CompositeNode. Listový kontajner, ktorý obsahuje obsahové uzly.

ImageRenderOptionsImageRenderOptionsImageRenderOptions
IndentLevelintHĺbka vnorenia (0 = najvonkajší)
NumberList`NumberListNone`
Tagslist[NoteTag]OneNote značky pripojené k tomuto prvku

RichText

ImageRenderOptions CompositeNode. Blok štýlovaného textu.

ImageRenderOptionsImageRenderOptionsImageRenderOptions
TextstrÚplný reťazec obyčajného textu (všetky úseky zreťazené)
Runslist[TextRun]Usporiadaný zoznam formátovaných segmentov
FontSize`floatNone`
Tagslist[NoteTag]OneNote značky pripojené k tomuto bloku

ImageRenderOptions:

ImageRenderOptionsImageRenderOptionsImageRenderOptions
Append(text, style=None)`(str, TextStyleNone) -> RichText`
Replace(old_value, new_value)(str, str) -> NoneNahradenie reťazca v pamäti na Text; neaktualizuje sa Runs

TextRun

ImageRenderOptions Node. Jeden formátovaný textový segment.

ImageRenderOptionsImageRenderOptionsImageRenderOptions
TextstrTextový obsah segmentu (predvolené "")
StyleTextStyleVlastnosti formátovania
Start`intNone`
End`intNone`

TextStyle

ImageRenderOptions Node. Vlastnosti formátovania na znak pre TextRun.

ImageRenderOptionsImageRenderOptionsImageRenderOptionsImageRenderOptions
BoldboolFalseImageRenderOptions
ItalicboolFalseImageRenderOptions
UnderlineboolFalseImageRenderOptions
StrikethroughboolFalseImageRenderOptions
SuperscriptboolFalseImageRenderOptions
SubscriptboolFalseImageRenderOptions
FontName`strNone`None
FontSize`floatNone`None
FontColor`intNone`None
HighlightColor`intNone`None
LanguageId`intNone`None
IsHyperlinkboolFalseČi je tento úsek hyperodkazom
HyperlinkAddress`strNone`None

ImageRenderOptions

ImageRenderOptions CompositeNode. Vložený obrázok.

ImageRenderOptionsImageRenderOptionsImageRenderOptions
FileName`strNone`
BytesbytesSurové dáta obrázka (predvolené b"")
Width`floatNone`
Height`floatNone`
AlternativeTextTitle`strNone`
AlternativeTextDescription`strNone`
HyperlinkUrl`strNone`
Tagslist[NoteTag]OneNote značky pripojené k tomuto obrázku

ImageRenderOptions:

ImageRenderOptionsImageRenderOptions
Replace(image)ImageRenderOptions Bytes a FileName z iného Image uzla do tohto

AttachedFile

ImageRenderOptions CompositeNode. Vložená príloha súboru.

ImageRenderOptionsImageRenderOptionsImageRenderOptions
FileName`strNone`
BytesbytesSurové dáta súboru (predvolené b"")
Tagslist[NoteTag]OneNote značky pripojené k tejto prílohe

ImageRenderOptions

ImageRenderOptions CompositeNode. Tabuľka v rámci OutlineElementu.

ImageRenderOptionsImageRenderOptionsImageRenderOptionsImageRenderOptions
Columnslist[float][]Šírka každého stĺpca v bodoch
IsBordersVisibleboolTrueČi sú okraje tabuľky viditeľné
Tagslist[NoteTag][]OneNote značky pripojené k tejto tabuľke

TableRow

ImageRenderOptions CompositeNode. Riadok v rámci Table. Iterovať GetChildNodes(TableCell) na prístup k bunkám.


TableCell

ImageRenderOptions CompositeNode. Bunka v TableRow. Obsahuje RichText, Image, a ďalšie uzly obsahu.


NoteTag

ImageRenderOptions Node. Štítok OneNote pripojený k uzlu obsahu.

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

Poznámka k časovej značke: created a completed sú surové celočíselné časové značky parsované z binárneho formátu MS-ONE, nie datetime objekty.

Továrenské metódy:

ImageRenderOptionsImageRenderOptions
NoteTag.CreateYellowStar()Vytvára NoteTag(shape=None, label="Yellow Star")

NumberList

ImageRenderOptions Node. Metadáta číslovaného alebo odrážkového zoznamu na OutlineElement.

ImageRenderOptionsImageRenderOptionsImageRenderOptionsImageRenderOptions
Format`strNone`None
Restart`intNone`None
IsNumberedboolFalseTrue pre usporiadané (číslované) zoznamy

LoadOptions

ImageRenderOptionsImageRenderOptionsImageRenderOptionsImageRenderOptions
DocumentPassword`strNone`None
LoadHistoryboolFalsePole kompatibility API; funkčne nepoužívané vo verzii v26.3.1

SaveOptions

Základná trieda pre všetky možnosti ukladania. Povinný pozičný argument.

ImageRenderOptionsImageRenderOptionsImageRenderOptions
SaveFormatSaveFormatCieľový formát ukladania

PdfSaveOptions

ImageRenderOptions SaveOptions. PDF‑špecifická konfigurácia exportu. Vytvorte pomocou PdfSaveOptions(SaveFormat.Pdf).

ImageRenderOptionsImageRenderOptionsImageRenderOptionsImageRenderOptions
PageIndexint0Pole existuje; neodovzdávané PDF exportéru vo verzii v26.3.1: nemá vplyv na výstup
PageCount`intNone`None
TagIconDir`strNone`None
TagIconSize`floatNone`None
TagIconGap`floatNone`None

PageIndex / PageCount výhrada: Tieto polia sú deklarované na PdfSaveOptions pre kompatibilitu API, ale the Document.Save() implementácia vo verzii v26.3.1 nečítá ich ani ich neodovzdáva PDF exportéru. Všetky stránky sú vždy exportované.


Licencia a merané použitie

Exportované kompatibilné stuby pre zhodu tvaru API s Aspose.Note pre .NET. V tejto FOSS implementácii sú všetky metódy nečinné (no‑ops).

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

Na použitie akejkoľvek funkcie Aspose.Note FOSS pre Python nie je potrebný licenčný kľúč.


ImageRenderOptions

Úplná referencia výčtu: ImageRenderOptions

SaveFormat

ImageRenderOptionsImageRenderOptions
SaveFormat.PdfPDF export: implementovaný; vyžaduje pip install "aspose-note[pdf]"
SaveFormat.OneFormát OneNote: iba deklarovaný; vyvoláva UnsupportedSaveFormatException

FileFormat

Hodnoty výčtu predstavujúce verziu formátu súboru OneNote. Document.FileFormat poskytuje najlepšiu možnú indikáciu.

ImageRenderOptionsReťazcová hodnota
FileFormat.OneNote2010"onenote2010"
FileFormat.OneNoteOnline"onenoteonline"
FileFormat.OneNote2007"onenote2007"

HorizontalAlignment

ImageRenderOptionsReťazcová hodnota
HorizontalAlignment.Left"left"
HorizontalAlignment.Center"center"
HorizontalAlignment.Right"right"

NodeType

ImageRenderOptionsReťazcová hodnota
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

Úplná referencia výnimiek: ImageRenderOptions

ImageRenderOptionsImageRenderOptions
AsposeNoteErrorZákladná trieda pre všetky Aspose.Note FOSS výnimky
FileCorruptedExceptionImageRenderOptions .one súbor nie je možné analyzovať (poškodený alebo nesprávne formátovaný binárny súbor)
IncorrectDocumentStructureExceptionŠtruktúra súboru je neplatná alebo nepodporovaná
IncorrectPasswordExceptionVyvolané keď LoadOptions.DocumentPassword je nastavené; šifrované dokumenty nie sú podporované
UnsupportedFileFormatExceptionFormát súboru nie je rozpoznaný; odhaľuje a FileFormat pole (string)
UnsupportedSaveFormatExceptionPožadované SaveFormat nie je implementované v tejto verzii

Pozri tiež

 Slovenčina