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
| Klasse | Beskrivelse: |
|---|---|
Document | Root-dokumentobjekt. Repræsenter et OneNote -dokument; iterer sider og eksporterer til PDF. |
DocumentVisitor | Abstrakt basis for besøgsmønster gennem dokumenttræet. |
Node | Basisklasse for alle dokumentnoder. |
CompositeNode | Baseklasse for knuder, der kan indeholde datterknudepunkter. |
Dokumentstruktur
| Klasse | Beskrivelse: |
|---|---|
Page | Repræsenterede en OneNote-side. |
Title | Side titel blok indeholder TitleText, TitleDate og TitleTime. |
Outline | Positionsbeholder for OutlineElement-noder. |
OutlineElement | Bladbeholder; indeholder RichText, Image, Table, AttachedFile. |
Indholdet af dette dokument
| Klasse | Beskrivelse: |
|---|---|
RichText | Tekstblok med formateringsrundlag, tags og hyperlinks. |
TextRun | En enkelt formateret tekstsegment i en RichText. |
TextStyle | Formattemæssige egenskaber for en TextRun. |
Image | Indlejret billede med rå byte og metadata. |
AttachedFile | Indlejret fil vedhæftede filer med rå byte. |
Table | Tabel med rækker, celler og kolonnebredde. |
TableRow | En række i et bord. |
TableCell | En celle i en TableRow; indeholder indholdsknode. |
NoteTag | OneNote-tag (stjerne, krydsningsboks osv.) knyttet til en indholdsknode. |
NumberList | Metadata fra en nummereret liste på OutlineElement. |
Valgmuligheder
| Klasse | Beskrivelse: |
|---|---|
LoadOptions | Muligheder for at lægge en .one - Filer. |
SaveOptions | Basisklasse for opsparing. |
PdfSaveOptions (se også: muligheder og parametre) | Optionsklasse til dokumenteksport: kontrollerer billedkompression, JPEG-kvalitet og sideindstillinger for PDF-udgang. |
Kompatibilitetstubber
| Klasse | Beskrivelse: |
|---|---|
License | Kompatibilitetstub: SetLicense() er en no-op i denne FOSS implementering. |
Metered | Kompatibilitetstub: 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:
| Parameter | Type: | Beskrivelse: |
|---|---|---|
source | `str | Path |
load_options | `LoadOptions | None` |
Egenskaber:
| Ejendomme | Type: | Beskrivelse: |
|---|---|---|
FileFormat | FileFormat | Best-effort-indstilling af filformatsversionen OneNote |
Metoder til at anvende:
| Metode | Underskrift | Beskrivelse: |
|---|---|---|
GetPageHistory(page) | (Page) -> PageHistory | Tilbagebetalinger [page] (stub; fuld historie endnu ikke implementeret) |
DetectLayoutChanges() | () -> None | Kompatibilitetstub; ingen operation |
Save(target, format_or_options) | `(str | Path |
Accept(visitor) | (DocumentVisitor) -> None | Indkaldelse af besøgende-oversigt |
for page in doc | N/A | Itereret direkte barn Page Noder |
Document.FileFormatbemærkning:: Ejendommen giver en best-effort indikation af filformatsversionen OneNote.FileFormatenum har tre værdier:OneNote2010,OneNoteOnline, ogOneNote2007.
Document.Save()Støtte til strømning:targetkan 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:
| Metode | Ringede, 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 / metode | Type: | Beskrivelse: |
|---|---|---|
ParentNode | `Node | None` |
Document | `Document | None` |
Accept(visitor) | (DocumentVisitor) -> None | Send en besøgende til denne node |
CompositeNode
Udvidelse Node.Føjelse af børneforvaltning:
| Egenskab / metode | Beskrivelse: |
|---|---|
FirstChild | første barneknude, eller None |
LastChild | Den 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 node | Itererede 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.
| Ejendomme | Type: | Beskrivelse: |
|---|---|---|
Title | `Title | None` |
Author | `str | None` |
CreationTime | `datetime | None` |
LastModifiedTime | `datetime | None` |
Level | `int | None` |
Metoder til at anvende:
| Metode | Beskrivelse: |
|---|---|
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.
| Ejendomme | Type: | Beskrivelse: |
|---|---|---|
TitleText | `RichText | None` |
TitleDate | `RichText | None` |
TitleTime | `RichText | None` |
Udkast til udtalelse
Udvidelse CompositeNode.En positionel beholder til OutlineElement - Knuder.
| Ejendomme | Type: | Beskrivelse: |
|---|---|---|
HorizontalOffset | `float | None` |
VerticalOffset | `float | None` |
MaxWidth | `float | None` |
MaxHeight | `float | None` |
MinWidth | `float | None` |
ReservedWidth | `float | None` |
IndentPosition | `float | None` |
OutlineElement
Udvidelse CompositeNode.En bladbeholder, der indeholder indholdsnoder.
| Ejendomme | Type: | Beskrivelse: |
|---|---|---|
NumberList | `NumberList | None` |
RichText
Udvidelse Node.En blok af stiliseret tekst.
| Ejendomme | Type: | Beskrivelse: |
|---|---|---|
Text | str | Fuld tekststreng (alle løbeord er sammenkædet) |
TextRuns | list[TextRun] | Formand: |
Tags | list[NoteTag] | OneNote tags, der er knyttet til denne blok |
Metoder til at anvende:
| Metode | Underskrift | Beskrivelse: |
|---|---|---|
Append(text, style=None) | `(str, TextStyle | None) -> RichText` |
Replace(old_value, new_value) | (str, str) -> None | In-memory string substitution på Text; ikke opdateres TextRuns |
TextRun
Et enkelt formateret tekstsegment inden for RichText.TextRuns.
| Ejendomme | Type: | Beskrivelse: |
|---|---|---|
Text | str | Tekstindholdet i segmentet (standard) "") |
Style | TextStyle | Formateringsegnelser |
TextStyle
Propertierne for formatering pr. tegn til en TextRun.
| Ejendomme | Type: | Standardindstilling | Beskrivelse: |
|---|---|---|---|
IsBold | bool | False | Fuldstændig |
IsItalic | bool | False | Kursivt |
IsUnderline | bool | False | Understreger: |
IsStrikethrough | bool | False | Strikthrough |
IsSuperscript | bool | False | Overskrifter |
IsSubscript | bool | False | Underskrift |
FontName | `str | None` | None |
FontSize | `float | None` | None |
FontColor | `int | None` | None |
Highlight | `int | None` | None |
Language | `int | None` | None |
IsHyperlink | bool | False | Om dette løb er et hyperlink |
HyperlinkAddress | `str | None` | None |
Billed:
Udvidelse CompositeNode.- Et indlejret billede.
| Ejendomme | Type: | Beskrivelse: |
|---|---|---|
FileName | `str | None` |
FilePath | `str | None` |
Format | `str | None` |
Bytes | bytes | Rå billedbyte data (standard) b"") |
OriginalWidth | `float | None` |
OriginalHeight | `float | None` |
Alignment | `HorizontalAlignment | None` |
Tags | list[NoteTag] | OneNote tags vedhæftet til dette billede |
Metoder til at anvende:
| Metode | Beskrivelse: |
|---|---|
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.
| Ejendomme | Type: | Beskrivelse: |
|---|---|---|
FileName | `str | None` |
Bytes | bytes | Rå fildata (standard) b"") |
Tags | list[NoteTag] | OneNote tags, der er knyttet til dette bilag |
Tabel 1 - Indtægter
Udvidelse CompositeNode.En tabel i en OutlineElement.
| Ejendomme | Type: | Standardindstilling | Beskrivelse: |
|---|---|---|---|
Columns | list[TableColumn] | [] | Liste over kolonne-metadata; hver TableColumn har .Width (flåde) og .LockedWidth - Jeg er ikke sikker. |
Tags | list[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.
| Ejendomme | Type: | Standardindstilling | Beskrivelse: |
|---|---|---|---|
Icon | `int | None` | None |
Label | `str | None` | None |
FontColor | `int | None` | None |
Highlight | `int | None` | None |
CreationTime | `datetime | None` | None |
CompletedTime | `datetime | None` | None |
Status | TagStatus | afledt | TagStatus.Completed hvis: CompletedTime er indstillet, ellers TagStatus.Open |
Fabrikmetoder:
| Metode | Beskrivelse: |
|---|---|
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.
| Ejendomme | Type: | Standardindstilling | Beskrivelse: |
|---|---|---|---|
Format | `str | None` | None |
NumberFormat | `str | None` | None |
Font | `str | None` | None |
FontSize | `float | None` | None |
FontColor | `int | None` | None |
IsBold | bool | False | Fuldvægtig vægt for listen præfiks |
IsItalic | bool | False | Kursiv stil for listeforløbet |
Restart | `int | None` | None |
LoadOptions
| Ejendomme | Type: | Standardindstilling | Beskrivelse: |
|---|---|---|---|
DocumentPassword | `str | None` | None |
LoadHistory | bool | False | API-kompatibilitetsfelt; ikke funktionelt anvendt i v26.3.1 |
SaveOptions
Basisklasse for opsparing.
| Ejendomme | Type: | Beskrivelse: |
|---|---|---|
SaveFormat | SaveFormat | Målindslagningsformat |
PdfSaveOptions
Udvidelse SaveOptions. PDF-specifik eksportkonfiguration. Konstruer med PdfSaveOptions() (alle argumenter er kun søgeord med standardindstillinger).
| Ejendomme | Type: | Standardindstilling | Beskrivelse: |
|---|---|---|---|
PageIndex | int | 0 | Felt findes.; ikke videresendt til PDF-eksportør i v26.3.1: har ingen indvirkning på produktionen |
PageCount | `int | None` | None |
ImageCompression | `Any | None` | None |
JpegQuality | `int | None` | None |
PageSettings | `Any | None` | None |
PageSplittingAlgorithm | `Any | None` | None |
PageIndex/PageCountForsigtighed::Disse felter angives på:PdfSaveOptionsfor API-kompatibilitet, men denDocument.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-opDer 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ærdi | Beskrivelse: |
|---|---|
SaveFormat.Pdf | PDF-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ærdi | Stringværdi |
|---|---|
FileFormat.OneNote2010 | "onenote2010" |
FileFormat.OneNoteOnline | "onenoteonline" |
FileFormat.OneNote2007 | "onenote2007" |
HorizontalAlignment
| Værdi | Stringværdi |
|---|---|
HorizontalAlignment.Left | "left" |
HorizontalAlignment.Center | "center" |
HorizontalAlignment.Right | "right" |
NodeType
| Værdi | Stringvæ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
| Undtagelse | Beskrivelse: |
|---|---|
AsposeNoteError | Basisklasse for alle Aspose.Note FOSS-undtagelser |
FileCorruptedException | Den Europæiske Union .one fil kan ikke analyseres (korrupt eller fejlformet binær) |
IncorrectDocumentStructureException | Filstrukturen er ugyldig eller ikke understøttet. |
IncorrectPasswordException | Opvokset i LoadOptions.DocumentPassword er indstillet; krypterede dokumenter understøttes ikke |
UnsupportedFileFormatException | Filformatet er ikke genkendt; udsætter en FileFormat felt (string) |
UnsupportedSaveFormatException | Den anmodede SaveFormat er ikke implementeret i denne version |