Aspose.Note FOSS for Python

Denna referens täcker hela den offentliga API-ytan för aspose-note version 26.3.1. Endast symboler som exporteras från aspose.note paketet dokumenteras här. Allt under aspose.note._internal är en implementationsdetalj och kan ändras utan förvarning.

ImageRenderOptions: pip install aspose-note (core) eller pip install "aspose-note[pdf]" (med PDF-export)

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

ImageRenderOptions

Dokument och traversering

ImageRenderOptionsImageRenderOptions
DocumentRotdokumentobjekt. Ladda en .one fil, iterera sidor och spara till PDF.
DocumentVisitorAbstrakt bas för besökarmönstertraversering av dokumentträdet.
NodeBasklass för alla dokumentnoder.
CompositeNodeBasklass för noder som kan innehålla undernoder.

Dokumentstruktur

ImageRenderOptionsImageRenderOptions
PageRepresenterar en OneNote-sida.
TitleSidans titelblock som innehåller TitleText, TitleDate, TitleTime.
OutlinePositionsbehållare för OutlineElement-noder.
OutlineElementLövbehållare; innehåller RichText, Image, Table, AttachedFile.

ImageRenderOptions

ImageRenderOptionsImageRenderOptions
RichTextTextblock med formateringssekvenser, taggar och hyperlänkar.
TextRunEnstaka formaterad textsegment inom en RichText.
TextStyleFormateringsegenskaper för en TextRun.
ImageInbäddad bild med råa byte och metadata.
AttachedFileInbäddad filbilaga med råa byte.
TableTabell med rader, celler och kolumnbredder.
TableRowEn rad i en tabell.
TableCellEn cell i en TableRow; innehåller innehållsnoder.
NoteTagOneNote‑tagg (stjärna, kryssruta osv.) som är bifogad till en innehållsnod.
NumberListNumrerad listmetadata på ett OutlineElement.

ImageRenderOptions

ImageRenderOptionsImageRenderOptions
LoadOptionsAlternativ för att ladda en .one fil.
SaveOptionsBasklass för sparalternativ.
PdfSaveOptionsPDF‑specifika sparalternativ (taggikoner).

Kompatibilitetsstubb

ImageRenderOptionsImageRenderOptions
LicenseKompatibilitetsstub: SetLicense() är en ingen‑operation i denna FOSS‑implementation.
MeteredKompatibilitetsstub: SetMeteredKey() är en ingen‑operation i denna FOSS‑implementation.

Klassdetaljer

ImageRenderOptions

Rotdokumentklassen. Ladda en .one fil från en filsökväg, en pathlib.Path, eller en binär ström.

from aspose.note import Document, LoadOptions

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

Konstruktörsparametrar:

ImageRenderOptionsImageRenderOptionsImageRenderOptions
source`strPath
load_options`LoadOptionsNone`

ImageRenderOptions:

ImageRenderOptionsImageRenderOptionsImageRenderOptions
DisplayName`strNone`
CreationTime`datetimeNone`
FileFormatFileFormatBästa möjliga indikation på OneNote-filformatets version

ImageRenderOptions:

ImageRenderOptionsImageRenderOptionsImageRenderOptions
Count()() -> intAntal direkta underordnade sidor
GetPageHistory(page)(Page) -> list[Page]ImageRenderOptions [page] (platshållare; fullständig historik ännu inte implementerad)
DetectLayoutChanges()() -> NoneKompatibilitetsplatshållare; ingen operation
Save(target, format_or_options)`(strPath
Accept(visitor)(DocumentVisitor) -> NoneAnropa besökare‑traversering
for page in docN/AIterera direkta underordnade Page noder

Document.FileFormat anteckning: Egenskapen ger en bästa möjliga indikation på OneNote-filformatets version. Den FileFormat enum har tre värden: OneNote2010, OneNoteOnline, och OneNote2007.

Document.Save() strömstöd: target kan vara en binärström (io.BytesIO, filhandtag öppnat i binärt skrivläge, etc.). Detta bekräftas av testsviten: doc.Save(io.BytesIO(), PdfSaveOptions(SaveFormat.Pdf)).

DocumentVisitor

Abstrakt basklass för traversering med besökarmönster. Åsidosätt de besöksmetoder du behöver:

ImageRenderOptionsKallas när
VisitDocumentStart(doc)Går in i en Document-nod
VisitDocumentEnd(doc)Lämnar en Document-nod
VisitPageStart(page)Går in i en Page-nod
VisitPageEnd(page)Lämnar en Page-nod
VisitTitleStart(title)Går in i en Title-nod
VisitTitleEnd(title)Lämnar en Title-nod
VisitOutlineStart(outline)Går in i en Outline-nod
VisitOutlineEnd(outline)Lämnar en Outline-nod
VisitOutlineElementStart(oe)Går in i en OutlineElement-nod
VisitOutlineElementEnd(oe)Lämnar en OutlineElement-nod
VisitRichTextStart(rt)Går in i en RichText-nod
VisitRichTextEnd(rt)Lämnar en RichText-nod
VisitImageStart(img)Går in i en Image-nod
VisitImageEnd(img)Lämnar en Image-nod

ImageRenderOptions

Basklass för alla dokumentträdnoder.

Egenskap / MetodImageRenderOptionsImageRenderOptions
ParentNode`NodeNone`
Document`DocumentNone`
Accept(visitor)(DocumentVisitor) -> NoneSkicka besökare för den här noden

CompositeNode

ImageRenderOptions Node. Lägger till barnhantering:

Egenskap / MetodImageRenderOptions
FirstChildFörsta barnnod, eller None
LastChildSista barnnod, eller None
AppendChildLast(node)Lägg till en barnnod i slutet; sätter node.ParentNode = self
AppendChildFirst(node)Lägg till en barnnod i början
InsertChild(index, node)Infoga ett barn på angiven position
RemoveChild(node)Ta bort en barnnod; sätter node.ParentNode = None
GetEnumerator()Returnerar en iterator över direkta barn
for child in nodeIterera direkta barn
GetChildNodes(Type)(Type) -> list[Type]: rekursiv, djup-först-sökning av hela underträdet inklusive self

ImageRenderOptions

ImageRenderOptions CompositeNode. Representerar en OneNote-sida.

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

ImageRenderOptions:

ImageRenderOptionsImageRenderOptions
Clone(deep=False)Returnera en ytlig eller djup klon av sidan

ImageRenderOptions

ImageRenderOptions CompositeNode. Innehåller titelblocket för en Page.

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

ImageRenderOptions

ImageRenderOptions CompositeNode. En positionsbehållare för OutlineElement noder.

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

OutlineElement

ImageRenderOptions CompositeNode. En bladbehållare som innehåller innehållsnoder.

ImageRenderOptionsImageRenderOptionsImageRenderOptions
IndentLevelintNästningsdjup (0 = ytterst)
NumberList`NumberListNone`
Tagslist[NoteTag]OneNote-taggar kopplade till detta element

RichText

ImageRenderOptions CompositeNode. Ett block med formaterad text.

ImageRenderOptionsImageRenderOptionsImageRenderOptions
TextstrFullständig klartextsträng (alla körningar sammanfogade)
Runslist[TextRun]Ordnad lista med formaterade segment
FontSize`floatNone`
Tagslist[NoteTag]OneNote-taggar kopplade till detta block

ImageRenderOptions:

ImageRenderOptionsImageRenderOptionsImageRenderOptions
Append(text, style=None)`(str, TextStyleNone) -> RichText`
Replace(old_value, new_value)(str, str) -> NoneSträngsubstitution i minnet på Text; uppdateras inte Runs

TextRun

ImageRenderOptions Node. Ett enda formaterat textsegment.

ImageRenderOptionsImageRenderOptionsImageRenderOptions
TextstrSegmentets textinnehåll (standard "")
StyleTextStyleFormateringsegenskaper
Start`intNone`
End`intNone`

TextStyle

ImageRenderOptions Node. Per-tecken formateringsegenskaper för en TextRun.

ImageRenderOptionsImageRenderOptionsImageRenderOptionsImageRenderOptions
BoldboolFalseImageRenderOptions
ItalicboolFalseImageRenderOptions
UnderlineboolFalseImageRenderOptions
StrikethroughboolFalseImageRenderOptions
SuperscriptboolFalseImageRenderOptions
SubscriptboolFalseImageRenderOptions
FontName`strNone`None
FontSize`floatNone`None
FontColor`intNone`None
HighlightColor`intNone`None
LanguageId`intNone`None
IsHyperlinkboolFalseOm detta segment är en hyperlänk
HyperlinkAddress`strNone`None

ImageRenderOptions

ImageRenderOptions CompositeNode. En inbäddad bild.

ImageRenderOptionsImageRenderOptionsImageRenderOptions
FileName`strNone`
BytesbytesRå bilddata (standard b"")
Width`floatNone`
Height`floatNone`
AlternativeTextTitle`strNone`
AlternativeTextDescription`strNone`
HyperlinkUrl`strNone`
Tagslist[NoteTag]OneNote-taggar kopplade till den här bilden

ImageRenderOptions:

ImageRenderOptionsImageRenderOptions
Replace(image)ImageRenderOptions Bytes och FileName från en annan Image nod till den här

AttachedFile

ImageRenderOptions CompositeNode. En inbäddad filbilaga.

ImageRenderOptionsImageRenderOptionsImageRenderOptions
FileName`strNone`
BytesbytesRå fildata (standard b"")
Tagslist[NoteTag]OneNote-taggar kopplade till den här bilagan

ImageRenderOptions

ImageRenderOptions CompositeNode. En tabell inom ett OutlineElement.

ImageRenderOptionsImageRenderOptionsImageRenderOptionsImageRenderOptions
Columnslist[float][]Bredd på varje kolumn i punkter
IsBordersVisibleboolTrueOm tabellramar är synliga
Tagslist[NoteTag][]OneNote-taggar kopplade till den här tabellen

TableRow

ImageRenderOptions CompositeNode. En rad inom en Table. Iterera GetChildNodes(TableCell) för att komma åt celler.

TableCell

ImageRenderOptions CompositeNode. En cell inom en TableRow. Innehåller RichText, Image, och andra innehållsnoder.

NoteTag

ImageRenderOptions Node. En OneNote‑tagg bifogad till en innehållsnod.

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

Tidsstämpelanteckning: created och completed är råa heltalstidsstämplar som parsats från MS-ONE‑binärformatet, inte datetime objekt.

Fabrikmetoder:

ImageRenderOptionsImageRenderOptions
NoteTag.CreateYellowStar()Skapar en NoteTag(shape=None, label="Yellow Star")

NumberList

ImageRenderOptions Node. Numrerad eller punktlista metadata på en OutlineElement.

ImageRenderOptionsImageRenderOptionsImageRenderOptionsImageRenderOptions
Format`strNone`None
Restart`intNone`None
IsNumberedboolFalseSant för ordnade (numrerade) listor

LoadOptions

ImageRenderOptionsImageRenderOptionsImageRenderOptionsImageRenderOptions
DocumentPassword`strNone`None
LoadHistoryboolFalseAPI-kompatibilitetsfält; används inte funktionellt i v26.3.1

SaveOptions

Basklass för alla sparalternativ. Obligatoriskt positionsargument.

ImageRenderOptionsImageRenderOptionsImageRenderOptions
SaveFormatSaveFormatMålsparformat

PdfSaveOptions

ImageRenderOptions SaveOptions. PDF-specifik exportkonfiguration. Bygg med PdfSaveOptions(SaveFormat.Pdf).

ImageRenderOptionsImageRenderOptionsImageRenderOptionsImageRenderOptions
PageIndexint0Fältet finns; skickas inte vidare till PDF-exportören i v26.3.1: har ingen effekt på utdata
PageCount`intNone`None
TagIconDir`strNone`None
TagIconSize`floatNone`None
TagIconGap`floatNone`None

PageIndex / PageCount förbehåll: Dessa fält är deklarerade på PdfSaveOptions för API-kompatibilitet, men Document.Save() implementationen i v26.3.1 läser inte dem eller vidarebefordrar dem till PDF-exportören. Alla sidor exporteras alltid.

Licens och mätad

Kompatibilitetsstubbar exporteras för API‑formkompatibilitet med Aspose.Note för .NET. Alla metoder är ingen‑operationer i denna FOSS‑implementation.

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

Ingen licensnyckel krävs för att använda någon funktion i Aspose.Note FOSS för Python.

ImageRenderOptions

Fullständig uppräkningreferens: ImageRenderOptions

SaveFormat

ImageRenderOptionsImageRenderOptions
SaveFormat.PdfPDF-export: implementerad; kräver pip install "aspose-note[pdf]"
SaveFormat.OneOneNote-format: endast deklarerat; kastar UnsupportedSaveFormatException

FileFormat

Enum‑värden som representerar OneNote‑filformatets version. Document.FileFormat ger en bästa‑möjliga indikation.

ImageRenderOptionsSträngvärde
FileFormat.OneNote2010"onenote2010"
FileFormat.OneNoteOnline"onenoteonline"
FileFormat.OneNote2007"onenote2007"

HorizontalAlignment

ImageRenderOptionsSträngvärde
HorizontalAlignment.Left"left"
HorizontalAlignment.Center"center"
HorizontalAlignment.Right"right"

NodeType

ImageRenderOptionsSträngvärde
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

Fullständig undantagsreferens: ImageRenderOptions

ImageRenderOptionsImageRenderOptions
AsposeNoteErrorBasklass för alla Aspose.Note FOSS‑undantag
FileCorruptedExceptionImageRenderOptions .one filen kan inte parsas (korrupt eller felaktig binär)
IncorrectDocumentStructureExceptionFilstrukturen är ogiltig eller stöds inte
IncorrectPasswordExceptionKastas när LoadOptions.DocumentPassword är satt; krypterade dokument stöds inte
UnsupportedFileFormatExceptionFilformatet känns inte igen; exponerar en FileFormat fält (string)
UnsupportedSaveFormatExceptionDen begärda SaveFormat är inte implementerad i den här versionen

Se även

 Svenska