Aspose.Note FOSS - FOSS für Python

Diese Referenz umfasst die gesamte öffentliche API-Oberfläche von: aspose-note Version 26.3.1 Nur Symbole, die aus dem Europäischen Union ausgeführt werden. aspose.note Die Daten sind hier dokumentiert. aspose.note._internal ist ein Durchführungsdetail und kann ohne vorherige Ankündigung geändert werden.

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

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

Klassen

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

Dokument und Durchlauf

Klasse	Beschreibung
`Document`	Root-Dokumentobjekt. Repräsentiert ein OneNote Dokument; Iteration von Seiten und Export in PDF.
`DocumentVisitor`	Abstrakte Basis für die Besucher-Muster-Übersicht des Dokumentbaums.
`Node`	Basisklasse für alle Dokumentenknoten.
`CompositeNode`	Basisklasse für Knoten, die Kinderknoten enthalten können.

Dokumentstruktur

Klasse	Beschreibung
`Page`	Repräsentiert eine OneNote-Seite.
`Title`	Der Titelblock der Seite enthält TitleText, TitleDate und TitleTime.
`Outline`	Positionscontainer für OutlineElement-Knoten.
`OutlineElement`	Blätterbehälter; enthält RichText, Bild, Tabelle, AttachedFile.

Inhalt der Veranstaltung

Klasse	Beschreibung
`RichText`	Textblock mit Formatierungsläufen, Tags und Hyperlinks.
`TextRun`	Ein einzelnes formatiertes Textsegment innerhalb eines RichText.
`TextStyle`	Formatierungseigenschaften für TextRun.
`Image`	Eingebettetes Bild mit Rohbyte und Metadaten.
`AttachedFile`	Eingebettete Dateiauflage mit Rohbyte.
`Table`	Tabelle mit Zeilen-, Zellen- und Spaltenbreiten.
`TableRow`	Eine Reihe innerhalb einer Tabelle.
`TableCell`	Eine Zelle innerhalb eines TableRow; enthält Inhaltsknoten.
`NoteTag`	OneNote-Tag (Stern, Kontrollkästchen usw.) an einen Inhaltsknoten angeschlossen.
`NumberList`	Nummerierte Metadaten der Liste auf einem OutlineElement.

Optionen

Klasse	Beschreibung
`LoadOptions`	Optionen für die Beförderung von `.one` Die Akte.
`SaveOptions`	Basisklasse für Speicheroptionen.
`PdfSaveOptions` (siehe Kapitel 2) Optionen und Parameter)	Optionen für den Dokumentenexport: steuert die Bildkompression, JPEG-Qualität und Seiteneinstellungen für PDF-Ausgabe.

Kompatibilitäts-Stubbs

Klasse	Beschreibung
`License`	Kompatibilitätsstück: `SetLicense()` ist eine No-O in dieser FOSS Implementierung.
`Metered`	Kompatibilitätsstück: `SetMeteredKey()` ist eine No-O in dieser FOSS Implementierung.

Klassendetails

Dokumenten und Informationen

Die Wurzel-Dokumentklasse. .one Datei aus einem Dateipfad, a pathlib.Path, oder binärer Strom.

from aspose.note import Document, LoadOptions

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

Konstruktionsparameter:

Parameter	Typ der	Beschreibung
`source`	`str	Path
`load_options`	`LoadOptions	None`

Eigenschaften:

Immobilien und Vermögenswerte	Typ der	Beschreibung
`FileFormat`	`FileFormat`	Best-effort Angabe der Version des Dateifformats OneNote

Methoden und Verfahren:

Verfahren	Unterzeichnung	Beschreibung
`GetPageHistory(page)`	`(Page) -> PageHistory`	Rückkehr `[page]` (Stub; vollständige Geschichte noch nicht umgesetzt)
`DetectLayoutChanges()`	`() -> None`	Kompatibilitätsstück; keine Operation
`Save(target, format_or_options)`	`(str	Path
`Accept(visitor)`	`(DocumentVisitor) -> None`	Aufruf der Besucherübertragung
`for page in doc`	N/A	Iterations- und direkte Nachwuchs `Page` Knoten

Document.FileFormat Anmerkung::Die Eigenschaft liefert eine Best-Ensay-Angabe der Version des Dateifformats OneNote. FileFormat enum hat drei Werte: OneNote2010, OneNoteOnline,und . OneNote2007.

Document.Save() Streaming-Unterstützung: target kann ein binärer Strom sein (io.BytesIO, Datei-Handschrift im binären Schreibmodus geöffnet, etc.).

DocumentVisitor

Abstrakte Basisklasse für Besucher-Muster-Traversal. Überschreiben Sie die benötigten Besuchsmethoden:

Verfahren	Ich rief an, als…
`VisitDocumentStart(doc)`	Eingabe eines Dokumentknoten
`VisitDocumentEnd(doc)`	Ein Dokumentknoten verlassen
`VisitPageStart(page)`	Eingabe eines Seitenknoten
`VisitPageEnd(page)`	Verlassen eines Seitenknoten
`VisitTitleStart(title)`	Eingabe eines Titelknoten
`VisitTitleEnd(title)`	Titelknoten verlassen
`VisitOutlineStart(outline)`	Eingabe eines Outline-Knopfs
`VisitOutlineEnd(outline)`	Verlassen eines Outline-Knotenpunkts
`VisitOutlineElementStart(oe)`	Einzug in einen OutlineElement-Knoten
`VisitOutlineElementEnd(oe)`	Verlassen eines OutlineElement-Knotens
`VisitRichTextStart(rt)`	Einzug in einen RichText-Knoten
`VisitRichTextEnd(rt)`	Verlassen eines RichText-Knotens
`VisitImageStart(img)`	Eingabe eines Bildknoten
`VisitImageEnd(img)`	Ablassen eines Bildknoten

Knoten

Basisklasse für alle Dokumentbaumknoten.

Eigenschaft / Methode	Typ der	Beschreibung
`ParentNode`	`Node	None`
`Document`	`Document	None`
`Accept(visitor)`	`(DocumentVisitor) -> None`	Besucher für diesen Knoten senden

CompositeNode

Ausdehnung Node.Die Kinderbetreuung wird ergänzt durch:

Eigenschaft / Methode	Beschreibung
`FirstChild`	Erster Kindenknoten oder `None`
`LastChild`	Letzter Kindenknoten oder `None`
`AppendChildLast(node)`	Hinzufügen eines Kinderknoten am Ende; Sets `node.ParentNode = self`
`AppendChildFirst(node)`	Ein Kindknoten am Anfang hinzufügen
`InsertChild(index, node)`	Einfügen Sie ein Kind in die angegebene Position.
`RemoveChild(node)`	Entfernen eines Kinderknoten; Sets `node.ParentNode = None`
`GetEnumerator()`	Gibt einen Iterator über direkte Kinder zurück.
`for child in node`	Iterative direkte Kinder
`GetChildNodes(Type)`	`(Type) -> list[Type]`: rekursive, tiefgründige Suche des gesamten Unterbaums einschließlich `self`

Seite

Ausdehnung CompositeNode. Repräsentiert eine OneNote-Seite.

Immobilien und Vermögenswerte	Typ der	Beschreibung
`Title`	`Title	None`
`Author`	`str	None`
`CreationTime`	`datetime	None`
`LastModifiedTime`	`datetime	None`
`Level`	`int	None`

Methoden und Verfahren:

Verfahren	Beschreibung
`Clone(deep=False)`	Geben Sie einen flachen oder tiefen Klon der Seite zurück .

Titel der Verordnung (EG) Nr.

Ausdehnung CompositeNode.Die Kommission hat die Anmeldung der Page.

Immobilien und Vermögenswerte	Typ der	Beschreibung
`TitleText`	`RichText	None`
`TitleDate`	`RichText	None`
`TitleTime`	`RichText	None`

Umrisse

Ausdehnung CompositeNode.Ein Positionsbehälter für die OutlineElement Knoten.

Immobilien und Vermögenswerte	Typ der	Beschreibung
`HorizontalOffset`	`float	None`
`VerticalOffset`	`float	None`
`MaxWidth`	`float	None`
`MaxHeight`	`float	None`
`MinWidth`	`float	None`
`ReservedWidth`	`float	None`
`IndentPosition`	`float	None`

OutlineElement

Ausdehnung CompositeNode.Ein Blattbehälter, der die Inhalte enthält.

Immobilien und Vermögenswerte	Typ der	Beschreibung
`NumberList`	`NumberList	None`

RichText

Ausdehnung Node.Ein Block mit geschriebenem Text.

Immobilien und Vermögenswerte	Typ der	Beschreibung
`Text`	`str`	Vollständige Textzeile (alle Laufzüge verknüpft)
`TextRuns`	`list[TextRun]`	Geordnete Liste der formatierten Segmente
`Tags`	`list[NoteTag]`	Tags, die an diesen Block angebracht sind.

Methoden und Verfahren:

Verfahren	Unterzeichnung	Beschreibung
`Append(text, style=None)`	`(str, TextStyle	None) -> RichText`
`Replace(old_value, new_value)`	`(str, str) -> None`	In-Memory String Substitution auf `Text`; wird nicht aktualisiert. `TextRuns`

TextRun

Ein einzelnes formatiertes Textsegment innerhalb der RichText.TextRuns.

Immobilien und Vermögenswerte	Typ der	Beschreibung
`Text`	`str`	Textinhalt des Segments (Standard) `""`)
`Style`	`TextStyle`	Formatierungseigenschaften

TextStyle

Die Eigenschaften der Pro-Charakter-Formatierung für eine TextRun.

Immobilien und Vermögenswerte	Typ der	Standard-Nummer	Beschreibung
`IsBold`	`bool`	`False`	- Scharf .
`IsItalic`	`bool`	`False`	Kursiv geschrieben
`IsUnderline`	`bool`	`False`	Unterstreifen
`IsStrikethrough`	`bool`	`False`	Durchschlag
`IsSuperscript`	`bool`	`False`	Überschrift
`IsSubscript`	`bool`	`False`	Abonnement für die
`FontName`	`str	None`	`None`
`FontSize`	`float	None`	`None`
`FontColor`	`int	None`	`None`
`Highlight`	`int	None`	`None`
`Language`	`int	None`	`None`
`IsHyperlink`	`bool`	`False`	Ob dieser Lauf ein Hyperlink ist
`HyperlinkAddress`	`str	None`	`None`

Bild und Aufnahme:

Ausdehnung CompositeNode.Ein eingebettetes Bild.

Immobilien und Vermögenswerte	Typ der	Beschreibung
`FileName`	`str	None`
`FilePath`	`str	None`
`Format`	`str	None`
`Bytes`	`bytes`	Rohbild-Byte-Daten (Standard) `b""`)
`OriginalWidth`	`float	None`
`OriginalHeight`	`float	None`
`Alignment`	`HorizontalAlignment	None`
`Tags`	`list[NoteTag]`	Tags, die an dieses Bild angebracht sind.

Methoden und Verfahren:

Verfahren	Beschreibung
`Replace(image)`	Er hat es. `Bytes` und . `FileName` von einem anderen `Image` Knoten in diesen ein

AttachedFile

Ausdehnung Node.Ein eingebetteter Dateianhänger.

Immobilien und Vermögenswerte	Typ der	Beschreibung
`FileName`	`str	None`
`Bytes`	`bytes`	Rohdateidaten (Standard) `b""`)
`Tags`	`list[NoteTag]`	Tags, die zu diesem Anhang angehängt sind.

Tabelle 1 und 2

Ausdehnung CompositeNode.Eine Tabelle innerhalb eines OutlineElement.

Immobilien und Vermögenswerte	Typ der	Standard-Nummer	Beschreibung
`Columns`	`list[TableColumn]`	`[]`	Liste der Metadaten für jede Spalte; `TableColumn` hat `.Width` (Float) und `.LockedWidth` - Ich bin nicht hier.
`Tags`	`list[NoteTag]`	`[]`	OneNote Tags, die an dieser Tabelle angebracht sind.

TableRow

Ausdehnung CompositeNode.Eine Reihe innerhalb einer Table.Iteration GetChildNodes(TableCell) um auf Zellen zuzugreifen.

TableCell

Ausdehnung CompositeNode.Eine Zelle innerhalb einer TableRow. enthält RichText, Image, und andere Inhaltsknoten.

NoteTag

Ein Tag OneNote, das an einen Inhaltsknoten angebracht ist.

Immobilien und Vermögenswerte	Typ der	Standard-Nummer	Beschreibung
`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`	abgeleitet	`TagStatus.Completed` wenn: `CompletedTime` ist eingestellt, sonst: `TagStatus.Open`

Betriebsverfahren:

Verfahren	Beschreibung
`NoteTag.CreateYellowStar(label=None)`	Erstellt eine `NoteTag(Label="Yellow Star", Icon=13)`
`NoteTag.CreateQuestionMark(label=None)`	Erstellt eine `NoteTag(Label="Question Mark", Icon=15)`
`NoteTag.CreateMusicalNote(label=None)`	Erstellt eine `NoteTag(Label="Musical Note", Icon=121)`

NumberList

Metadaten der nummerierten oder mit Schaltfaden versehenen Listen auf einem OutlineElement.

Immobilien und Vermögenswerte	Typ der	Standard-Nummer	Beschreibung
`Format`	`str	None`	`None`
`NumberFormat`	`str	None`	`None`
`Font`	`str	None`	`None`
`FontSize`	`float	None`	`None`
`FontColor`	`int	None`	`None`
`IsBold`	`bool`	`False`	Fettgewicht für die Listevorzeichen
`IsItalic`	`bool`	`False`	Kursivschrift für die Listepräfix
`Restart`	`int	None`	`None`

LoadOptions

Immobilien und Vermögenswerte	Typ der	Standard-Nummer	Beschreibung
`DocumentPassword`	`str	None`	`None`
`LoadHistory`	`bool`	`False`	API-Kompatibilitätsfeld; nicht in der Version 26.3.1 verwendet.

SaveOptions

Basisklasse für Speicheroptionen. Positionsargument erforderlich.

Immobilien und Vermögenswerte	Typ der	Beschreibung
`SaveFormat`	`SaveFormat`	Ziel-Speicherformat

PdfSaveOptions

Ausdehnung SaveOptions. PDF-spezifische Exportkonfiguration. Konstruieren mit PdfSaveOptions() (alle Argumente sind nur für Stichwörter mit Standardvorgaben).

Immobilien und Vermögenswerte	Typ der	Standard-Nummer	Beschreibung
`PageIndex`	`int`	`0`	Das Feld existiert.; nicht an den PDF-Exporteur in der Version 26.3.1 weitergeleitet.: hat keine Auswirkungen auf die Produktion.
`PageCount`	`int	None`	`None`
`ImageCompression`	`Any	None`	`None`
`JpegQuality`	`int	None`	`None`
`PageSettings`	`Any	None`	`None`
`PageSplittingAlgorithm`	`Any	None`	`None`

PageIndex / PageCount Warnung::Diese Felder werden auf: PdfSaveOptions für die API-Kompatibilität, aber der Document.Save() Die Implementierung in v26.3.1 gilt nicht und wird dem PDF-Exporteur nicht weitergeleitet. Alle Seiten werden immer exportiert.

Lizenz und Meterung

Kompatibilitätsstubs für die API-Formkompatibilität mit Aspose.Note für .NET exportiert. Alle Methoden sind in dieser FOSS-Implementierung No-Ops.

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

Für die Verwendung von Funktionen in Aspose.Note FOSS für Python ist kein Lizenzschlüssel erforderlich.

Aufzählungen

Vollständige Aufzählung: Aufzählungen

SaveFormat

Wert der	Beschreibung
`SaveFormat.Pdf`	PDF-Export: implementiert; erforderlich `pip install "aspose-note[pdf]"`

FileFormat

Enum-Werte, die das Dateifortformat OneNote darstellen. Document.FileFormat eine Best-Effort-Indikation liefert.

Wert der	Stringwert
`FileFormat.OneNote2010`	`"onenote2010"`
`FileFormat.OneNoteOnline`	`"onenoteonline"`
`FileFormat.OneNote2007`	`"onenote2007"`

HorizontalAlignment

Wert der	Stringwert
`HorizontalAlignment.Left`	`"left"`
`HorizontalAlignment.Center`	`"center"`
`HorizontalAlignment.Right`	`"right"`

NodeType

Wert der	Stringwert
`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"`

Ausnahmen

Vollständige Ausnahmeregelung: Ausnahmen

Ausnahme	Beschreibung
`AsposeNoteError`	Basisklasse für alle Aspose.Note FOSS-Ausnahmen
`FileCorruptedException`	Die `.one` Datei nicht analysiert werden kann (korropierte oder fehlerhafte Binärdatei)
`IncorrectDocumentStructureException`	Dateistruktur ungültig oder nicht unterstützt
`IncorrectPasswordException`	Aufgewachsen, wenn: `LoadOptions.DocumentPassword` ist eingestellt; verschlüsselte Dokumente werden nicht unterstützt.
`UnsupportedFileFormatException`	Das Dateifort ist nicht erkannt; zeigt eine `FileFormat` Feld (Streifen)
`UnsupportedSaveFormatException`	Die ersuchten `SaveFormat` ist in dieser Version nicht implementiert.

Aspose.Note FOSS - FOSS für Python

Klassen

Dokument und Durchlauf

Dokumentstruktur

Inhalt der Veranstaltung

Optionen

Kompatibilitäts-Stubbs

Klassendetails

Dokumenten und Informationen

DocumentVisitor

Knoten

CompositeNode

Seite

Titel der Verordnung (EG) Nr.

Umrisse

OutlineElement

RichText

TextRun

TextStyle

Bild und Aufnahme:

AttachedFile

Tabelle 1 und 2

TableRow

TableCell

NoteTag

NumberList

LoadOptions

SaveOptions

PdfSaveOptions

Lizenz und Meterung

Aufzählungen

SaveFormat

FileFormat

HorizontalAlignment

NodeType

Ausnahmen

Siehe auch: