Aspose.Note FOSS pro Python

Tento odkaz pokrývá celou veřejnou plochu API pro: aspose-note Verze 26.3.1 Pouze symboly vyvážené z EU a ze zemí, které jsou součástí Evropské unie. aspose.note Vše, co je pod tímto kódem, se zde dokumentuje. aspose.note._internal je prováděcí podrobnost a může se bez předchozího oznámení změnit.

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

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

Třídy

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

Dokumenty a průběh

TřídaPopis:
DocumentRoot document object. Reprezentuje OneNote dokument; iteruje stránky a exportuje do PDF.
DocumentVisitorAbstraktní základ pro průcházku vzorce návštěvníka v stromu dokumentu.
NodeZákladní třída pro všechny uzly dokumentu.
CompositeNodeZákladní třída pro uzly, které mohou obsahovat dětské uzliny.

Struktura dokumentu

TřídaPopis:
PageZobrazuje stránku OneNote.
TitleBlok názvu stránky obsahující TitleText, TitleDate a TitleTime.
OutlinePoziční kontejner pro uzly OutlineElement.
OutlineElementObsahující RichText, obrázek, tabulka, AttachedFile.

Obsah:

TřídaPopis:
RichTextTextový blok s formátováním, tagy a hypertextovými odkazy.
TextRunJednotný formátovaný textový segment v rámci RichText.
TextStyleFormátování vlastností pro TextRun.
ImageVestavěný obrázek s surovými bajty a metadaty.
AttachedFileVestavěná souborová příloha s surovými bajty.
TableTabulka s šířkou řádků, buněk a sloupců.
TableRowŘada v rámci stolu.
TableCellBuňka uvnitř TableRow; obsahuje obsahové uzly.
NoteTagOneNote tag (hvězda, zaškrtnutí políčka atd.) připojený k obsahu uzlu.
NumberListNumerované metadata seznamu na OutlineElement.

Možnosti

TřídaPopis:
LoadOptionsMožnosti nakládky a .one - Soubor.
SaveOptionsZákladní třída pro možnosti uložení.
PdfSaveOptions (viz bod 1.4.1): možnosti a parametry)Klasa možností pro export dokumentu: ovládá komprese obrázků, kvalitu JPEG a nastavení stránek pro výstup PDF.

Kompatibilní stuby

TřídaPopis:
LicenseZákladní část kompatibility: SetLicense() je no-op v této implementaci FOSS.
MeteredZákladní část kompatibility: SetMeteredKey() je no-op v této implementaci FOSS.

Podrobnosti o třídě

Dokumenty

Klasifikace základního dokumentu. .one soubor z cesty souboru, a pathlib.Path,nebo binární proud.

from aspose.note import Document, LoadOptions

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

Parametry konstruktoru:

Parametr:Typ:Popis:
source`strPath
load_options`LoadOptionsNone`

Vlastnosti:

VlastnictvíTyp:Popis:
FileFormatFileFormatZásada nejlepšího úsilí pro verzi formátu souboru OneNote

Metody:

MetodikaPodpis:Popis:
GetPageHistory(page)(Page) -> PageHistoryZpětné výnosy [page] (stub; úplná historie ještě nebyla provedena)
DetectLayoutChanges()() -> NoneZákladní stub kompatibility; žádná operace
Save(target, format_or_options)`(strPath
Accept(visitor)(DocumentVisitor) -> NoneVyvolání návštěvníka
for page in docN/AIterovaný přímý syn Page uzly

Document.FileFormat poznámka::Vlastnost poskytuje nejlepší indikátor verze formátu souboru OneNote . FileFormat enum má tři hodnoty: OneNote2010, OneNoteOnline,a) OneNote2007.

Document.Save() Podpora proudění: target může být binární tok (io.BytesIO, souborová ruka otevřená v binárním režimu psaní atd.).

DocumentVisitor

Abstraktní základní třída pro průcházku vzorů návštěvníků. Přehlížet potřebné metody návštevy:

MetodikaZavolal jsem, když…
VisitDocumentStart(doc)Vstup do uzlu dokumentu
VisitDocumentEnd(doc)Zanechání uzlu dokumentu
VisitPageStart(page)Vstup do uzlu stránky
VisitPageEnd(page)Zanechání uzlu stránky
VisitTitleStart(title)Vkládání uzlu názvu
VisitTitleEnd(title)Zanechání uzlu Titulu
VisitOutlineStart(outline)Vstup do uzlu Outline
VisitOutlineEnd(outline)Zanechání uzlu v přehledu
VisitOutlineElementStart(oe)Vstup na uzel OutlineElement
VisitOutlineElementEnd(oe)Zanechání uzlu OutlineElement
VisitRichTextStart(rt)Vstup na uzel RichText
VisitRichTextEnd(rt)Zanechání uzlu RichText
VisitImageStart(img)Vstup do uzlu snímku
VisitImageEnd(img)Zanechání uzlu snímku

Vstupní uzel

Základní třída pro všechny uzly stromů dokumentů.

Vlastnost / metodaTyp:Popis:
ParentNode`NodeNone`
Document`DocumentNone`
Accept(visitor)(DocumentVisitor) -> NoneOdeslat návštěvníka pro tento uzel .

CompositeNode

Rozsah: Node.Přidává se:

Vlastnost / metodaPopis:
FirstChildPrvní dětský uzel nebo None
LastChildPoslední dětský uzel nebo None
AppendChildLast(node)Přidat dětský uzel na konci; soubory node.ParentNode = self
AppendChildFirst(node)Přidat dítětský uzel na začátku .
InsertChild(index, node)Vložte dítě do dané polohy.
RemoveChild(node)Odstranit dětský uzel; soubory node.ParentNode = None
GetEnumerator()Vrátí iterátor přes přímé děti.
for child in nodeIterované přímé děti
GetChildNodes(Type)(Type) -> list[Type]: rekurzivní, hluboký vyhledávání celého podstromu včetně: self

Stránka

Rozsah: CompositeNode. Zobrazuje stránku OneNote.

VlastnictvíTyp:Popis:
Title`TitleNone`
Author`strNone`
CreationTime`datetimeNone`
LastModifiedTime`datetimeNone`
Level`intNone`

Metody:

MetodikaPopis:
Clone(deep=False)Vrátit povrchní nebo hluboký klon stránky .

Název:

Rozsah: CompositeNode.- Je držitelem titulu . Page.

VlastnictvíTyp:Popis:
TitleText`RichTextNone`
TitleDate`RichTextNone`
TitleTime`RichTextNone`

Přehled

Rozsah: CompositeNode.Postulatelný kontejner pro: OutlineElement uzly.

VlastnictvíTyp:Popis:
HorizontalOffset`floatNone`
VerticalOffset`floatNone`
MaxWidth`floatNone`
MaxHeight`floatNone`
MinWidth`floatNone`
ReservedWidth`floatNone`
IndentPosition`floatNone`

OutlineElement

Rozsah: CompositeNode.Obsahující obsahové uzly.

VlastnictvíTyp:Popis:
NumberList`NumberListNone`

RichText

Rozsah: Node.- Blok stylizovaného textu.

VlastnictvíTyp:Popis:
TextstrPlný textový řetěz (všechny běhy souřadnice)
TextRunslist[TextRun]Pořadový seznam formátovaných segmentů
Tagslist[NoteTag]OneNote značky připojené k tomuto bloku

Metody:

MetodikaPodpis:Popis:
Append(text, style=None)`(str, TextStyleNone) -> RichText`
Replace(old_value, new_value)(str, str) -> NoneV paměti nahradit řetězce na Text; není aktualizován TextRuns

TextRun

Jediný formátovaný textový segment v rámci: RichText.TextRuns.

VlastnictvíTyp:Popis:
TextstrObsah textu segmentu (podstatné) "")
StyleTextStyleVlastnosti formátování

TextStyle

Vlastnosti formátování na znak pro: TextRun.

VlastnictvíTyp:PředvoleněPopis:
IsBoldboolFalseOdvážný .
IsItalicboolFalseKurzovní písmeno
IsUnderlineboolFalsePodtrhnout
IsStrikethroughboolFalsePrůběh
IsSuperscriptboolFalsePřehled
IsSubscriptboolFalsePodpis
FontName`strNone`None
FontSize`floatNone`None
FontColor`intNone`None
Highlight`intNone`None
Language`intNone`None
IsHyperlinkboolFalseZda je tento běh hypertextový odkaz.
HyperlinkAddress`strNone`None

Obraz:

Rozsah: CompositeNode.Vložený obraz.

VlastnictvíTyp:Popis:
FileName`strNone`
FilePath`strNone`
Format`strNone`
BytesbytesPrvní data bytu obrazu (podstatné) b"")
OriginalWidth`floatNone`
OriginalHeight`floatNone`
Alignment`HorizontalAlignmentNone`
Tagslist[NoteTag]OneNote značky připojené k tomuto obrázku

Metody:

MetodikaPopis:
Replace(image)Přepsané. Bytes a) FileName z jiného Image Vstupte do tohoto.

AttachedFile

Rozsah: Node.- Vkládaný soubor.

VlastnictvíTyp:Popis:
FileName`strNone`
BytesbytesPrvní data souboru (podstatné) b"")
Tagslist[NoteTag]OneNote značky připojené k tomuto přílohovému dokumentu

Tabulka 1

Rozsah: CompositeNode.Tabela uvnitř OutlineElement.

VlastnictvíTyp:PředvoleněPopis:
Columnslist[TableColumn][]Seznam sloupců metadát; každý TableColumn má: .Width (plavka) a .LockedWidth - Ne, ne. - Cože?
Tagslist[NoteTag][]OneNote značky připojené k této tabulce

TableRow

Rozsah: CompositeNode.Řádek v rámci řady . Table.- Iterativní. GetChildNodes(TableCell) k přístupu do buňky.

TableCell

Rozsah: CompositeNode. Buňka v rámci … TableRow.Obsahuje: RichText, Image, a další obsahové uzly.

NoteTag

Tyg OneNote připojený k obsahu.

VlastnictvíTyp:PředvoleněPopis:
Icon`intNone`None
Label`strNone`None
FontColor`intNone`None
Highlight`intNone`None
CreationTime`datetimeNone`None
CompletedTime`datetimeNone`None
StatusTagStatusodvozenéTagStatus.Completed pokud: CompletedTime je nastaven, jinak TagStatus.Open

Zpracovatelské metody:

MetodikaPopis:
NoteTag.CreateYellowStar(label=None)Vytváří se NoteTag(Label="Yellow Star", Icon=13)
NoteTag.CreateQuestionMark(label=None)Vytváří se NoteTag(Label="Question Mark", Icon=15)
NoteTag.CreateMusicalNote(label=None)Vytváří se NoteTag(Label="Musical Note", Icon=121)

NumberList

Metadata čísleného nebo sčítaného seznamu na OutlineElement.

VlastnictvíTyp:PředvoleněPopis:
Format`strNone`None
NumberFormat`strNone`None
Font`strNone`None
FontSize`floatNone`None
FontColor`intNone`None
IsBoldboolFalseTvrdá váha pro předponu seznamu
IsItalicboolFalseKurzivní styl pro předčíslo seznamu
Restart`intNone`None

LoadOptions

VlastnictvíTyp:PředvoleněPopis:
DocumentPassword`strNone`None
LoadHistoryboolFalsePole kompatibility API; není funkčně použito v verzi 26.3.1

SaveOptions

Základní třída pro možnosti uložení. Požadovaný poziční argument.

VlastnictvíTyp:Popis:
SaveFormatSaveFormatFormát ukládání cíle

PdfSaveOptions

Rozsah: SaveOptions. PDF-specifikní konfigurace vývozu. Konstruovat s PdfSaveOptions() (všechny argumenty jsou pouze klíčová slova s výchozími funkcemi).

VlastnictvíTyp:PředvoleněPopis:
PageIndexint0Pole existuje; není předán vývozci PDF v verzi 26.3.1: nemá vliv na výstup
PageCount`intNone`None
ImageCompression`AnyNone`None
JpegQuality`intNone`None
PageSettings`AnyNone`None
PageSplittingAlgorithm`AnyNone`None

PageIndex / PageCount výstraha:Tato pole jsou vyjádřena na: PdfSaveOptions pro kompatibilitu s API, ale Document.Save() Implementace v verzi 26.3.1 se nepoužije a není předávána vývozci PDF. Všechny stránky jsou vždy exportovány.

Licence a měření

Kompatibilita stubů exportované pro API tvar kompatibility s Aspose.Note pro .NET. Všechny metody jsou no-ops v této implementaci FOSS.

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

Žádný licenční klíč není potřebný k použití jakékoli funkce Aspose.Note FOSS pro Python.

Číslování

Úplný odkaz na vyčíslení: Číslování

SaveFormat

HodnotaPopis:
SaveFormat.PdfExport PDF: realizován; vyžaduje se pip install "aspose-note[pdf]"

FileFormat

Věci, které představují verzi formátu souboru OneNote. Document.FileFormat poskytuje indikátor nejlepšího úsilí.

HodnotaHodnota řetězce
FileFormat.OneNote2010"onenote2010"
FileFormat.OneNoteOnline"onenoteonline"
FileFormat.OneNote2007"onenote2007"

HorizontalAlignment

HodnotaHodnota řetězce
HorizontalAlignment.Left"left"
HorizontalAlignment.Center"center"
HorizontalAlignment.Right"right"

NodeType

HodnotaHodnota řetězce
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"

Výjimky

Úplná výjimka: Výjimky

VýjimkaPopis:
AsposeNoteErrorZákladní třída pro všechny výjimky FOSS Aspose.Note
FileCorruptedExceptionÚřad pro bezpečnost a ochranu zdraví .one soubor nelze analyzovat (poškozený nebo špatně formovaný binární kód)
IncorrectDocumentStructureExceptionStruktura souboru je neplatná nebo nepodporovaná.
IncorrectPasswordExceptionVyrostl, když LoadOptions.DocumentPassword je nastaveno; šifrované dokumenty nejsou podporovány.
UnsupportedFileFormatExceptionFormát souboru není rozpoznán; odhalí FileFormat pole (struna)
UnsupportedSaveFormatExceptionŽádost o SaveFormat není implementován v této verzi.

Viz také:

 Čeština