Aspose.Note FOSS for Python

Ez a referencia lefedi a teljes nyilvános API felületet a aspose-note 26.3.1 verzió. Csak a csomagból exportált szimbólumok aspose.note csomagban dokumentálva vannak itt. Minden, ami alatta aspose.note._internal egy implementációs részlet, és előzetes értesítés nélkül változhat.

ImageRenderOptions: pip install aspose-note (core) vagy pip install "aspose-note[pdf]" (PDF exporttal)

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

ImageRenderOptions

Dokumentum és bejárás

ImageRenderOptionsImageRenderOptions
DocumentGyökér dokumentumobjektum. Tölts be egy .one fájlt, iterálj az oldalakon, és ments PDF-be.
DocumentVisitorAbsztrakt alap a látogató-minta szerinti bejáráshoz a dokumentumfában.
NodeAlaposztály minden dokumentumcsomóponthoz.
CompositeNodeAlaposztály azokhoz a csomópontokhoz, amelyek gyermekcsomópontokat tartalmazhatnak.

Dokumentum struktúra

ImageRenderOptionsImageRenderOptions
PageEgy OneNote oldalt reprezentál.
TitleOldalcím blokk, amely a TitleText, TitleDate és TitleTime elemeket tartalmazza.
OutlinePozíciós tároló az OutlineElement csomópontok számára.
OutlineElementLevél tároló; RichText, Image, Table és AttachedFile elemeket tartalmaz.

ImageRenderOptions

ImageRenderOptionsImageRenderOptions
RichTextSzöveges blokk formázási futamokkal, címkékkel és hiperhivatkozásokkal.
TextRunEgyetlen formázott szövegszakasz a RichText-ben.
TextStyleFormázási tulajdonságok a TextRun számára.
ImageBeágyazott kép nyers bájtokkal és metaadatokkal.
AttachedFileBeágyazott fájlcsatolás nyers bájtokkal.
TableTáblázat sorokkal, cellákkal és oszlopszélességekkel.
TableRowEgy sor a táblázaton belül.
TableCellEgy cella egy TableRow-ban; tartalmaz tartalomcsomópontokat.
NoteTagOneNote címke (csillag, jelölőnégyzet stb.) egy tartalomcsomóponthoz csatolva.
NumberListSzámozott lista metaadatai egy OutlineElement-en.

ImageRenderOptions

ImageRenderOptionsImageRenderOptions
LoadOptionsBetöltési beállítások egy .one fájl.
SaveOptionsAlaposztály a mentési beállításokhoz.
PdfSaveOptionsPDF-specifikus mentési beállítások (címkeikonok).

Kompatibilitási stubok

ImageRenderOptionsImageRenderOptions
LicenseKompatibilitási helyettesítő: SetLicense() nem csinál semmit ebben a FOSS megvalósításban.
MeteredKompatibilitási stub: SetMeteredKey() nem csinál semmit ebben a FOSS megvalósításban.

Osztály részletei

ImageRenderOptions

A gyökér dokumentumosztály. Töltsön be egy .one fájlt egy fájl útvonalról, egy pathlib.Path, vagy egy bináris adatfolyam.

from aspose.note import Document, LoadOptions

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

Konstruktor paraméterek:

ImageRenderOptionsImageRenderOptionsImageRenderOptions
source`strPath
load_options`LoadOptionsNone`

ImageRenderOptions:

ImageRenderOptionsImageRenderOptionsImageRenderOptions
DisplayName`strNone`
CreationTime`datetimeNone`
FileFormatFileFormatLegjobb erőfeszítéssel nyújtott jelzés a OneNote fájlformátum verziójáról

ImageRenderOptions:

ImageRenderOptionsImageRenderOptionsImageRenderOptions
Count()() -> intKözvetlen gyermekoldalak száma
GetPageHistory(page)(Page) -> list[Page]ImageRenderOptions [page] (helyőrző; a teljes előzmény még nincs megvalósítva)
DetectLayoutChanges()() -> NoneKompatibilitási helyőrző; nincs művelet
Save(target, format_or_options)`(strPath
Accept(visitor)(DocumentVisitor) -> NoneLátogató bejárás meghívása
for page in docN/AKözvetlen gyermek iterálása Page csomópontok

Document.FileFormat megjegyzés: A tulajdonság legjobb erőfeszítéssel nyújtott jelzést ad a OneNote fájlformátum verziójáról. A FileFormat az enum három értékkel rendelkezik: OneNote2010, OneNoteOnline, és OneNote2007.

Document.Save() stream támogatás: target lehet bináris folyam (io.BytesIO, bináris írási módban megnyitott fájlkezelő, stb.). Ezt a tesztsorozat erősíti meg: doc.Save(io.BytesIO(), PdfSaveOptions(SaveFormat.Pdf)).

DocumentVisitor

Absztrakt bázisosztály a látogató-minta bejáráshoz. Felülírhatja a szükséges visit metódusokat:

ImageRenderOptionsHívva, amikor
VisitDocumentStart(doc)Belépés egy Document csomópontba
VisitDocumentEnd(doc)Kilépés egy Document csomópontból
VisitPageStart(page)Belépés egy Page csomópontba
VisitPageEnd(page)Kilépés egy Page csomópontból
VisitTitleStart(title)Belépés egy Title csomópontba
VisitTitleEnd(title)Kilépés egy Title csomópontból
VisitOutlineStart(outline)Belépés egy Outline csomópontba
VisitOutlineEnd(outline)Kilépés egy Outline csomópontból
VisitOutlineElementStart(oe)Belépés egy OutlineElement csomópontba
VisitOutlineElementEnd(oe)Kilépés egy OutlineElement csomópontból
VisitRichTextStart(rt)Belépés egy RichText csomópontba
VisitRichTextEnd(rt)Kilépés egy RichText csomópontból
VisitImageStart(img)Belépés egy Image csomópontba
VisitImageEnd(img)Kilépés egy Image csomópontból

ImageRenderOptions

Alaposztály minden dokumentumfa csomópont számára.

Tulajdonság / MetódusImageRenderOptionsImageRenderOptions
ParentNode`NodeNone`
Document`DocumentNone`
Accept(visitor)(DocumentVisitor) -> NoneLefuttatja a látogatót ehhez a csomóponthoz

CompositeNode

ImageRenderOptions Node. Gyermekkezelést ad hozzá:

Tulajdonság / MetódusImageRenderOptions
FirstChildElső gyermekcsomópont, vagy None
LastChildUtolsó gyermekcsomópont, vagy None
AppendChildLast(node)Gyermekcsomópont hozzáadása a végén; beállítja node.ParentNode = self
AppendChildFirst(node)Gyermekcsomópont hozzáadása az elején
InsertChild(index, node)Gyermek beszúrása a megadott pozícióba
RemoveChild(node)Gyermekcsomópont eltávolítása; beállítja node.ParentNode = None
GetEnumerator()Visszaad egy iterátort a közvetlen gyermekek felett
for child in nodeKözvetlen gyermekek iterálása
GetChildNodes(Type)(Type) -> list[Type]: rekurzív, mélységi bejárás az egész alfa struktúrában, beleértve self

ImageRenderOptions

ImageRenderOptions CompositeNode. Egy OneNote oldalt ábrázol.

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

ImageRenderOptions:

ImageRenderOptionsImageRenderOptions
Clone(deep=False)Visszaadja az oldal sekély vagy mély klónját

ImageRenderOptions

ImageRenderOptions CompositeNode. Tartja egy címblokkot Page.

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

ImageRenderOptions

ImageRenderOptions CompositeNode. Egy pozíciós tároló a OutlineElement csomópontok.

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

OutlineElement

ImageRenderOptions CompositeNode. Egy levél tároló, amely tartalomcsomópontokat tartalmaz.

ImageRenderOptionsImageRenderOptionsImageRenderOptions
IndentLevelintBeágyazási mélység (0 = legkülső)
NumberList`NumberListNone`
Tagslist[NoteTag]OneNote címkék, amelyek ehhez az elemhez vannak csatolva

RichText

ImageRenderOptions CompositeNode. Egy stílusos szövegrész.

ImageRenderOptionsImageRenderOptionsImageRenderOptions
TextstrTeljes egyszerű szöveg karakterlánc (az összes futam összefűzve)
Runslist[TextRun]Rendezett lista a formázott szegmensekből
FontSize`floatNone`
Tagslist[NoteTag]OneNote címkék, amelyek ehhez a blokkhoz vannak csatolva

ImageRenderOptions:

ImageRenderOptionsImageRenderOptionsImageRenderOptions
Append(text, style=None)`(str, TextStyleNone) -> RichText`
Replace(old_value, new_value)(str, str) -> NoneMemóriában végzett karakterlánc helyettesítés Text; nem frissül Runs

TextRun

ImageRenderOptions Node. Egyetlen formázott szövegszegmens.

ImageRenderOptionsImageRenderOptionsImageRenderOptions
TextstrA szegmens szövegtartalma (alapértelmezett "")
StyleTextStyleFormázási tulajdonságok
Start`intNone`
End`intNone`

TextStyle

ImageRenderOptions Node. Karakterenkénti formázási tulajdonságok egy TextRun.

ImageRenderOptionsImageRenderOptionsImageRenderOptionsImageRenderOptions
BoldboolFalseImageRenderOptions
ItalicboolFalseImageRenderOptions
UnderlineboolFalseImageRenderOptions
StrikethroughboolFalseImageRenderOptions
SuperscriptboolFalseImageRenderOptions
SubscriptboolFalseImageRenderOptions
FontName`strNone`None
FontSize`floatNone`None
FontColor`intNone`None
HighlightColor`intNone`None
LanguageId`intNone`None
IsHyperlinkboolFalseEz a futás hiperhivatkozás-e
HyperlinkAddress`strNone`None

ImageRenderOptions

ImageRenderOptions CompositeNode. Beágyazott kép.

ImageRenderOptionsImageRenderOptionsImageRenderOptions
FileName`strNone`
BytesbytesNyers képadatok (alapértelmezett b"")
Width`floatNone`
Height`floatNone`
AlternativeTextTitle`strNone`
AlternativeTextDescription`strNone`
HyperlinkUrl`strNone`
Tagslist[NoteTag]OneNote címkék, amelyek ehhez a képhez vannak csatolva

ImageRenderOptions:

ImageRenderOptionsImageRenderOptions
Replace(image)ImageRenderOptions Bytes és FileName másikból Image ebbe a csomópontba

AttachedFile

ImageRenderOptions CompositeNode. Beágyazott fájlcsatolás.

ImageRenderOptionsImageRenderOptionsImageRenderOptions
FileName`strNone`
BytesbytesNyers fájladatok (alapértelmezett b"")
Tagslist[NoteTag]OneNote címkék, amelyek ehhez a csatolmányhoz vannak csatolva

ImageRenderOptions

ImageRenderOptions CompositeNode. Egy táblázat egy OutlineElementben.

ImageRenderOptionsImageRenderOptionsImageRenderOptionsImageRenderOptions
Columnslist[float][]Minden oszlop szélessége pontban
IsBordersVisibleboolTrueA táblázat szegélyeinek láthatósága
Tagslist[NoteTag][]OneNote címkék, amelyek ehhez a táblázathoz vannak csatolva

TableRow

ImageRenderOptions CompositeNode. Egy sor egy Table. Iterálj GetChildNodes(TableCell) a cellák eléréséhez.

TableCell

ImageRenderOptions CompositeNode. Egy cella egy TableRow. Tartalmaz RichText, Image, és egyéb tartalomcsomópontok.

NoteTag

ImageRenderOptions Node. Egy OneNote címke, amely egy tartalomcsomóponthoz van csatolva.

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

Időbélyeg megjegyzés: created és completed nyers egész számú időbélyegek, ahogy a MS-ONE bináris formátumból ki lettek értelmezve, nem datetime objektumok.

Gyári metódusok:

ImageRenderOptionsImageRenderOptions
NoteTag.CreateYellowStar()Létrehoz egy NoteTag(shape=None, label="Yellow Star")

NumberList

ImageRenderOptions Node. Számozott vagy felsorolásjeles lista metaadatai egy OutlineElement.

ImageRenderOptionsImageRenderOptionsImageRenderOptionsImageRenderOptions
Format`strNone`None
Restart`intNone`None
IsNumberedboolFalseIgaz a rendezett (számozott) listák esetén

LoadOptions

ImageRenderOptionsImageRenderOptionsImageRenderOptionsImageRenderOptions
DocumentPassword`strNone`None
LoadHistoryboolFalseAPI kompatibilitási mező; funkcionálisan nem használatos a v26.3.1‑ben

SaveOptions

Alaposztály minden mentési beállításhoz. Kötelező pozíciós argumentum.

ImageRenderOptionsImageRenderOptionsImageRenderOptions
SaveFormatSaveFormatCél mentési formátum

PdfSaveOptions

ImageRenderOptions SaveOptions. PDF-specifikus export konfiguráció. Létrehozva a PdfSaveOptions(SaveFormat.Pdf).

ImageRenderOptionsImageRenderOptionsImageRenderOptionsImageRenderOptions
PageIndexint0Mező létezik; nem továbbítva a PDF exportálóhoz a v26.3.1‑ben: nincs hatása a kimenetre
PageCount`intNone`None
TagIconDir`strNone`None
TagIconSize`floatNone`None
TagIconGap`floatNone`None

PageIndex / PageCount figyelmeztetés: Ezek a mezők deklarálva vannak a PdfSaveOptions az API-kompatibilitás érdekében, de a Document.Save() a v26.3.1-es megvalósítás nem olvassa be, és nem továbbítja őket a PDF exportálóhoz. Az összes oldal mindig exportálva van.

Licenc és Mérő

Kompatibilitási stubok exportálva az API szerkezet kompatibilitásához a Aspose.Note és .NET között. Minden metódus semmit nem csinál ebben a FOSS megvalósításban.

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

Nem szükséges licenckulcs a Aspose.Note FOSS Python funkcióinak használatához.

ImageRenderOptions

Teljes felsorolás hivatkozás: ImageRenderOptions

SaveFormat

ImageRenderOptionsImageRenderOptions
SaveFormat.PdfPDF exportálás: megvalósítva; igényli pip install "aspose-note[pdf]"
SaveFormat.OneOneNote formátum: csak deklarált; kivételt dob UnsupportedSaveFormatException

FileFormat

Felsorolásértékek, amelyek a OneNote fájlformátum verzióját képviselik. Document.FileFormat legjobb erőfeszítéssel nyújtott jelzés.

ImageRenderOptionsKarakterlánc érték
FileFormat.OneNote2010"onenote2010"
FileFormat.OneNoteOnline"onenoteonline"
FileFormat.OneNote2007"onenote2007"

HorizontalAlignment

ImageRenderOptionsKarakterlánc érték
HorizontalAlignment.Left"left"
HorizontalAlignment.Center"center"
HorizontalAlignment.Right"right"

NodeType

ImageRenderOptionsKarakterlánc érték
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

Teljes kivétel hivatkozás: ImageRenderOptions

ImageRenderOptionsImageRenderOptions
AsposeNoteErrorAlaposztály minden Aspose.Note FOSS kivételhez
FileCorruptedExceptionImageRenderOptions .one a fájlt nem lehet feldolgozni (sérült vagy hibás bináris)
IncorrectDocumentStructureExceptionA fájlstruktúra érvénytelen vagy nem támogatott
IncorrectPasswordExceptionKivétel dobódik, amikor LoadOptions.DocumentPassword be van állítva; a titkosított dokumentumok nem támogatottak
UnsupportedFileFormatExceptionA fájlformátum nem felismert; egy FileFormat mező (string)
UnsupportedSaveFormatExceptionA kért SaveFormat nincs megvalósítva ebben a verzióban

Lásd még

 Magyar