Aspose.Note FOSS - FOSS for Python

Denne reference dækker hele den offentlige API-overflade for aspose-note Kun symboler, der eksporteres fra EU-landene. aspose.note - Alt, hvad der er under pakken, er dokumenteret her. aspose.note._internal er en gennemførelsesdetalje og kan ændres uden varsel.

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

Import af varer: from aspose.note import Document, RichText, ...


Klasse:

Install: pip install aspose-note (core) or pip install "aspose-note[pdf]" (with PDF export)

Dokument og gennemgang

KlasseBeskrivelse:
DocumentRoot-dokumentobjekt. Repræsenter et OneNote -dokument; iterer sider og eksporterer til PDF.
DocumentVisitorAbstrakt basis for besøgsmønster gennem dokumenttræet.
NodeBasisklasse for alle dokumentnoder.
CompositeNodeBaseklasse for knuder, der kan indeholde datterknudepunkter.

Dokumentstruktur

KlasseBeskrivelse:
PageRepræsenterede en OneNote-side.
TitleSide titel blok indeholder TitleText, TitleDate og TitleTime.
OutlinePositionsbeholder for OutlineElement-noder.
OutlineElementBladbeholder; indeholder RichText, Image, Table, AttachedFile.

Indholdet af dette dokument

KlasseBeskrivelse:
RichTextTekstblok med formateringsrundlag, tags og hyperlinks.
TextRunEn enkelt formateret tekstsegment i en RichText.
TextStyleFormattemæssige egenskaber for en TextRun.
ImageIndlejret billede med rå byte og metadata.
AttachedFileIndlejret fil vedhæftede filer med rå byte.
TableTabel med rækker, celler og kolonnebredde.
TableRowEn række i et bord.
TableCellEn celle i en TableRow; indeholder indholdsknode.
NoteTagOneNote-tag (stjerne, krydsningsboks osv.) knyttet til en indholdsknode.
NumberListMetadata fra en nummereret liste på OutlineElement.

Valgmuligheder

KlasseBeskrivelse:
LoadOptionsMuligheder for at lægge en .one - Filer.
SaveOptionsBasisklasse for opsparing.
PdfSaveOptions (se også: muligheder og parametre)Optionsklasse til dokumenteksport: kontrollerer billedkompression, JPEG-kvalitet og sideindstillinger for PDF-udgang.

Kompatibilitetstubber

KlasseBeskrivelse:
LicenseKompatibilitetstub: SetLicense() er en no-op i denne FOSS implementering.
MeteredKompatibilitetstub: SetMeteredKey() er en no-op i denne FOSS implementering.

Klasseoplysninger

Dokumentet

Klassen for roddokumentet. Lade en .one fil fra en filvej, a pathlib.Path,eller en binær strøm.

from aspose.note import Document, LoadOptions

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

Konstruktorparametre:

ParameterType:Beskrivelse:
source`strPath
load_options`LoadOptionsNone`

Egenskaber:

EjendommeType:Beskrivelse:
FileFormatFileFormatBest-effort-indstilling af filformatsversionen OneNote

Metoder til at anvende:

MetodeUnderskriftBeskrivelse:
GetPageHistory(page)(Page) -> PageHistoryTilbagebetalinger [page] (stub; fuld historie endnu ikke implementeret)
DetectLayoutChanges()() -> NoneKompatibilitetstub; ingen operation
Save(target, format_or_options)`(strPath
Accept(visitor)(DocumentVisitor) -> NoneIndkaldelse af besøgende-oversigt
for page in docN/AItereret direkte barn Page Noder

Document.FileFormat bemærkning:: Ejendommen giver en best-effort indikation af filformatsversionen OneNote. FileFormat enum har tre værdier: OneNote2010, OneNoteOnline, og OneNote2007.

Document.Save() Støtte til strømning: target kan være en binær strøm (io.BytesIO, filhåndtag åbnet i binær skrivetilstand osv.).


DocumentVisitor

Abstrakt basisklasse til besøgsmønster-overgange. Overskrive de besøgsmethoder, du har brug for:

MetodeRingede, da
VisitDocumentStart(doc)Indtastning af en dokumentknode
VisitDocumentEnd(doc)Lægning af en dokumentknode
VisitPageStart(page)Indtastning af en side-knode
VisitPageEnd(page)Lægger en side-knode tilbage
VisitTitleStart(title)Indtastning af en titelknode
VisitTitleEnd(title)Efterladelse af en titelknode
VisitOutlineStart(outline)Indtastning af en udformningsknode
VisitOutlineEnd(outline)Forlader en udformningsknudepunkt
VisitOutlineElementStart(oe)Indtastning af OutlineElement-knode
VisitOutlineElementEnd(oe)Forlader en OutlineElement-knode
VisitRichTextStart(rt)Indtastning af RichText-knode
VisitRichTextEnd(rt)Forlader en RichText-knode
VisitImageStart(img)Indtastning af billedknode
VisitImageEnd(img)Afslipning af billedknode

Knudepunkt

Basisklasse for alle dokumenttrænoder.

Egenskab / metodeType:Beskrivelse:
ParentNode`NodeNone`
Document`DocumentNone`
Accept(visitor)(DocumentVisitor) -> NoneSend en besøgende til denne node

CompositeNode

Udvidelse Node.Føjelse af børneforvaltning:

Egenskab / metodeBeskrivelse:
FirstChildførste barneknude, eller None
LastChildDen sidste børneknode, eller None
AppendChildLast(node)Tilføj en barneknude i slutningen; sæt node.ParentNode = self
AppendChildFirst(node)Tilføj en barneknude i starten
InsertChild(index, node)Indsæt et barn i den angivne position.
RemoveChild(node)Fjern en underknode; sæt node.ParentNode = None
GetEnumerator()Returnerer en iterator over direkte børn
for child in nodeItererede direkte børn
GetChildNodes(Type)(Type) -> list[Type]: rekursivt, dybde-først søgning af hele undertræet herunder self

Siderne

Udvidelse CompositeNode. Repræsenterede en OneNote side.

EjendommeType:Beskrivelse:
Title`TitleNone`
Author`strNone`
CreationTime`datetimeNone`
LastModifiedTime`datetimeNone`
Level`intNone`

Metoder til at anvende:

MetodeBeskrivelse:
Clone(deep=False)Returner en overfladisk eller dyb klon af siden

Udtrykket “indhold”

Udvidelse CompositeNode.Den har titlen på en af de to europæiske lande. Page.

EjendommeType:Beskrivelse:
TitleText`RichTextNone`
TitleDate`RichTextNone`
TitleTime`RichTextNone`

Udkast til udtalelse

Udvidelse CompositeNode.En positionel beholder til OutlineElement - Knuder.

EjendommeType:Beskrivelse:
HorizontalOffset`floatNone`
VerticalOffset`floatNone`
MaxWidth`floatNone`
MaxHeight`floatNone`
MinWidth`floatNone`
ReservedWidth`floatNone`
IndentPosition`floatNone`

OutlineElement

Udvidelse CompositeNode.En bladbeholder, der indeholder indholdsnoder.

EjendommeType:Beskrivelse:
NumberList`NumberListNone`

RichText

Udvidelse Node.En blok af stiliseret tekst.

EjendommeType:Beskrivelse:
TextstrFuld tekststreng (alle løbeord er sammenkædet)
TextRunslist[TextRun]Formand:
Tagslist[NoteTag]OneNote tags, der er knyttet til denne blok

Metoder til at anvende:

MetodeUnderskriftBeskrivelse:
Append(text, style=None)`(str, TextStyleNone) -> RichText`
Replace(old_value, new_value)(str, str) -> NoneIn-memory string substitution på Text; ikke opdateres TextRuns

TextRun

Et enkelt formateret tekstsegment inden for RichText.TextRuns.

EjendommeType:Beskrivelse:
TextstrTekstindholdet i segmentet (standard) "")
StyleTextStyleFormateringsegnelser

TextStyle

Propertierne for formatering pr. tegn til en TextRun.

EjendommeType:StandardindstillingBeskrivelse:
IsBoldboolFalseFuldstændig
IsItalicboolFalseKursivt
IsUnderlineboolFalseUnderstreger:
IsStrikethroughboolFalseStrikthrough
IsSuperscriptboolFalseOverskrifter
IsSubscriptboolFalseUnderskrift
FontName`strNone`None
FontSize`floatNone`None
FontColor`intNone`None
Highlight`intNone`None
Language`intNone`None
IsHyperlinkboolFalseOm dette løb er et hyperlink
HyperlinkAddress`strNone`None

Billed:

Udvidelse CompositeNode.- Et indlejret billede.

EjendommeType:Beskrivelse:
FileName`strNone`
FilePath`strNone`
Format`strNone`
BytesbytesRå billedbyte data (standard) b"")
OriginalWidth`floatNone`
OriginalHeight`floatNone`
Alignment`HorizontalAlignmentNone`
Tagslist[NoteTag]OneNote tags vedhæftet til dette billede

Metoder til at anvende:

MetodeBeskrivelse:
Replace(image)- Ja. Det er det. Bytes og: FileName fra en anden Image knob i denne en

AttachedFile

Udvidelse Node.- En indlejret fil vedhæftet.

EjendommeType:Beskrivelse:
FileName`strNone`
BytesbytesRå fildata (standard) b"")
Tagslist[NoteTag]OneNote tags, der er knyttet til dette bilag

Tabel 1 - Indtægter

Udvidelse CompositeNode.En tabel i en OutlineElement.

EjendommeType:StandardindstillingBeskrivelse:
Columnslist[TableColumn][]Liste over kolonne-metadata; hver TableColumn har .Width (flåde) og .LockedWidth - Jeg er ikke sikker.
Tagslist[NoteTag][]OneNote tags, der er knyttet til denne tabel

TableRow

Udvidelse CompositeNode.En række inden for en Table.Itereret GetChildNodes(TableCell) til at få adgang til celler.


TableCell

Udvidelse CompositeNode.En celle inden for en TableRow. indeholder: RichText, Image, og andre indholdsknode.


NoteTag

Et OneNote-tag, der er knyttet til en indholdsknode.

EjendommeType:StandardindstillingBeskrivelse:
Icon`intNone`None
Label`strNone`None
FontColor`intNone`None
Highlight`intNone`None
CreationTime`datetimeNone`None
CompletedTime`datetimeNone`None
StatusTagStatusafledtTagStatus.Completed hvis: CompletedTime er indstillet, ellers TagStatus.Open

Fabrikmetoder:

MetodeBeskrivelse:
NoteTag.CreateYellowStar(label=None)Det skaber en NoteTag(Label="Yellow Star", Icon=13)
NoteTag.CreateQuestionMark(label=None)Det skaber en NoteTag(Label="Question Mark", Icon=15)
NoteTag.CreateMusicalNote(label=None)Det skaber en NoteTag(Label="Musical Note", Icon=121)

NumberList

Metadata fra en nummereret eller med kugler markeret liste på et OutlineElement.

EjendommeType:StandardindstillingBeskrivelse:
Format`strNone`None
NumberFormat`strNone`None
Font`strNone`None
FontSize`floatNone`None
FontColor`intNone`None
IsBoldboolFalseFuldvægtig vægt for listen præfiks
IsItalicboolFalseKursiv stil for listeforløbet
Restart`intNone`None

LoadOptions

EjendommeType:StandardindstillingBeskrivelse:
DocumentPassword`strNone`None
LoadHistoryboolFalseAPI-kompatibilitetsfelt; ikke funktionelt anvendt i v26.3.1

SaveOptions

Basisklasse for opsparing.

EjendommeType:Beskrivelse:
SaveFormatSaveFormatMålindslagningsformat

PdfSaveOptions

Udvidelse SaveOptions. PDF-specifik eksportkonfiguration. Konstruer med PdfSaveOptions() (alle argumenter er kun søgeord med standardindstillinger).

EjendommeType:StandardindstillingBeskrivelse:
PageIndexint0Felt findes.; ikke videresendt til PDF-eksportør i v26.3.1: har ingen indvirkning på produktionen
PageCount`intNone`None
ImageCompression`AnyNone`None
JpegQuality`intNone`None
PageSettings`AnyNone`None
PageSplittingAlgorithm`AnyNone`None

PageIndex / PageCount Forsigtighed::Disse felter angives på: PdfSaveOptions for API-kompatibilitet, men den Document.Save() Implementeringen i v26.3.1 gælder ikke eller videresender dem til PDF-eksporteren. Alle sider eksporteres altid.


Licens og måling

Kompatibilitetstubs eksporteret til API-formkompatibiliteten med Aspose.Note for .NET. Alle metoder er no-ops i denne FOSS implementering.

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

Der kræves ingen licensnøgle for at bruge nogen funktion i Aspose.Note FOSS til Python.


Oplysninger om optegnelser

Fuldt opgørelsesreference: Oplysninger om optegnelser

SaveFormat

VærdiBeskrivelse:
SaveFormat.PdfPDF-eksport: implementeret; kræver pip install "aspose-note[pdf]"

FileFormat

Enum-værdier, der repræsenterer versionen af filformatet OneNote. Document.FileFormat giver en indikation af best effort.

VærdiStringværdi
FileFormat.OneNote2010"onenote2010"
FileFormat.OneNoteOnline"onenoteonline"
FileFormat.OneNote2007"onenote2007"

HorizontalAlignment

VærdiStringværdi
HorizontalAlignment.Left"left"
HorizontalAlignment.Center"center"
HorizontalAlignment.Right"right"

NodeType

VærdiStringværdi
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"

Undtagelser

Fuld reference: Undtagelser

UndtagelseBeskrivelse:
AsposeNoteErrorBasisklasse for alle Aspose.Note FOSS-undtagelser
FileCorruptedExceptionDen Europæiske Union .one fil kan ikke analyseres (korrupt eller fejlformet binær)
IncorrectDocumentStructureExceptionFilstrukturen er ugyldig eller ikke understøttet.
IncorrectPasswordExceptionOpvokset i LoadOptions.DocumentPassword er indstillet; krypterede dokumenter understøttes ikke
UnsupportedFileFormatExceptionFilformatet er ikke genkendt; udsætter en FileFormat felt (string)
UnsupportedSaveFormatExceptionDen anmodede SaveFormat er ikke implementeret i denne version

Se også:

 Dansk