Aspose.Note FOSS for Python

Cette référence couvre l’intégralité de la surface de l’API publique de aspose-note version 26.3.1. Seuls les symboles exportés depuis le aspose.note package sont documentés ici. Tout ce qui se trouve sous aspose.note._internal est un détail d’implémentation et peut changer sans préavis.

Examples: pip install aspose-note (core) ou pip install "aspose-note[pdf]" (avec export PDF)

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

Examples

Document et parcours

ExamplesExamples
DocumentObjet racine du document. Chargez un .one fichier, parcourez les pages, et enregistrez en PDF.
DocumentVisitorBase abstraite pour le parcours en mode visiteur de l’arbre du document.
NodeClasse de base pour tous les nœuds de document.
CompositeNodeClasse de base pour les nœuds pouvant contenir des nœuds enfants.

Structure du document

ExamplesExamples
PageReprésente une page OneNote.
TitleBloc de titre de page contenant TitleText, TitleDate, TitleTime.
OutlineConteneur positionnel pour les nœuds OutlineElement.
OutlineElementConteneur feuille ; contient RichText, Image, Table, AttachedFile.

Examples

ExamplesExamples
RichTextBloc de texte avec des séquences de formatage, des balises et des hyperliens.
TextRunSegment de texte formaté unique au sein d’un RichText.
TextStylePropriétés de formatage pour un TextRun.
ImageImage intégrée avec des octets bruts et des métadonnées.
AttachedFilePièce jointe de fichier intégrée avec des octets bruts.
TableTableau avec des lignes, des cellules et des largeurs de colonnes.
TableRowUne ligne dans un tableau.
TableCellUne cellule dans une TableRow; contient des nœuds de contenu.
NoteTagÉtiquette OneNote (étoile, case à cocher, etc.) attachée à un nœud de contenu.
NumberListMétadonnées de liste numérotée sur un OutlineElement.

Examples

ExamplesExamples
LoadOptionsOptions de chargement d’un .one fichier.
SaveOptionsClasse de base pour les options d’enregistrement.
PdfSaveOptionsOptions d’enregistrement spécifiques au PDF (icônes d’étiquette).

Stubs de compatibilité

ExamplesExamples
LicenseBouchon de compatibilité : SetLicense() est une opération nulle dans cette implémentation FOSS.
MeteredBouchon de compatibilité : SetMeteredKey() est une opération nulle dans cette implémentation FOSS.

Détails de la classe

Examples

La classe de document racine. Charger un .one fichier depuis un chemin de fichier, un pathlib.Path, ou un flux binaire.

from aspose.note import Document, LoadOptions

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

Paramètres du constructeur:

ExamplesExamplesExamples
source`strPath
load_options`LoadOptionsNone`

Examples:

ExamplesExamplesExamples
DisplayName`strNone`
CreationTime`datetimeNone`
FileFormatFileFormatIndication approximative de la version du format de fichier OneNote

Examples:

ExamplesExamplesExamples
Count()() -> intNombre de pages enfants directes
GetPageHistory(page)(Page) -> list[Page]Examples [page] (stub ; historique complet pas encore implémenté)
DetectLayoutChanges()() -> NoneBouchon de compatibilité ; aucune opération
Save(target, format_or_options)`(strPath
Accept(visitor)(DocumentVisitor) -> NoneInvoker le parcours du visiteur
for page in docN/AItérer l’enfant direct Page nœuds

Document.FileFormat note: La propriété fournit une indication approximative de la version du format de fichier OneNote. Le FileFormat enum a trois valeurs : OneNote2010, OneNoteOnline, et OneNote2007.

Document.Save() prise en charge du flux: target peut être un flux binaire (io.BytesIO, poignée de fichier ouverte en mode écriture binaire, etc.). Ceci est confirmé par la suite de tests : doc.Save(io.BytesIO(), PdfSaveOptions(SaveFormat.Pdf)).

DocumentVisitor

Classe de base abstraite pour le parcours selon le pattern visiteur. Surchargez les méthodes de visite dont vous avez besoin :

ExamplesAppelé lorsque
VisitDocumentStart(doc)Entrée dans un nœud Document
VisitDocumentEnd(doc)Sortie du nœud Document
VisitPageStart(page)Entrée dans un nœud Page
VisitPageEnd(page)Sortie d’un nœud Page
VisitTitleStart(title)Entrée d’un nœud Title
VisitTitleEnd(title)Sortie d’un nœud Title
VisitOutlineStart(outline)Entrée d’un nœud Outline
VisitOutlineEnd(outline)Sortie d’un nœud Outline
VisitOutlineElementStart(oe)Entrée d’un nœud OutlineElement
VisitOutlineElementEnd(oe)Sortie d’un nœud OutlineElement
VisitRichTextStart(rt)Entrée d’un nœud RichText
VisitRichTextEnd(rt)Sortie d’un nœud RichText
VisitImageStart(img)Entrée dans un nœud Image
VisitImageEnd(img)Sortie d’un nœud Image

Examples

Classe de base pour tous les nœuds de l’arbre de documents.

Propriété / MéthodeExamplesExamples
ParentNode`NodeNone`
Document`DocumentNone`
Accept(visitor)(DocumentVisitor) -> NoneDispatcher le visiteur pour ce nœud

CompositeNode

Examples Node. Ajoute la gestion des enfants :

Propriété / MéthodeExamples
FirstChildPremier nœud enfant, ou None
LastChildDernier nœud enfant, ou None
AppendChildLast(node)Ajouter un nœud enfant à la fin ; définit node.ParentNode = self
AppendChildFirst(node)Ajouter un nœud enfant au début
InsertChild(index, node)Insérer un enfant à la position donnée
RemoveChild(node)Supprimer un nœud enfant ; définit node.ParentNode = None
GetEnumerator()Renvoie un itérateur sur les enfants directs
for child in nodeItérer les enfants directs
GetChildNodes(Type)(Type) -> list[Type]: recherche récursive en profondeur de l’ensemble du sous‑arbre incluant self

Examples

Examples CompositeNode. Représente une page OneNote.

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

Examples:

ExamplesExamples
Clone(deep=False)Renvoie un clone superficiel ou profond de la page

Examples

Examples CompositeNode. Contient le bloc de titre d’une Page.

ExamplesExamplesExamples
TitleText`RichTextNone`
TitleDate`RichTextNone`
TitleTime`RichTextNone`

Examples

Examples CompositeNode. Un conteneur positionnel pour OutlineElement nœuds.

ExamplesExamplesExamples
X`floatNone`
Y`floatNone`
Width`floatNone`

OutlineElement

Examples CompositeNode. Un conteneur feuille qui contient des nœuds de contenu.

ExamplesExamplesExamples
IndentLevelintProfondeur d’imbrication (0 = la plus externe)
NumberList`NumberListNone`
Tagslist[NoteTag]Étiquettes OneNote attachées à cet élément

RichText

Examples CompositeNode. Un bloc de texte stylisé.

ExamplesExamplesExamples
TextstrChaîne texte brut complète (tous les runs concaténés)
Runslist[TextRun]Liste ordonnée de segments formatés
FontSize`floatNone`
Tagslist[NoteTag]Étiquettes OneNote attachées à ce bloc

Examples:

ExamplesExamplesExamples
Append(text, style=None)`(str, TextStyleNone) -> RichText`
Replace(old_value, new_value)(str, str) -> NoneSubstitution de chaîne en mémoire sur Text; ne met pas à jour Runs

TextRun

Examples Node. Un seul segment de texte formaté.

ExamplesExamplesExamples
TextstrLe contenu texte du segment (par défaut "")
StyleTextStylePropriétés de formatage
Start`intNone`
End`intNone`

TextStyle

Examples Node. Propriétés de mise en forme par caractère pour un TextRun.

ExamplesExamplesExamplesExamples
BoldboolFalseExamples
ItalicboolFalseExamples
UnderlineboolFalseExamples
StrikethroughboolFalseExamples
SuperscriptboolFalseExamples
SubscriptboolFalseExamples
FontName`strNone`None
FontSize`floatNone`None
FontColor`intNone`None
HighlightColor`intNone`None
LanguageId`intNone`None
IsHyperlinkboolFalseIndique si cette séquence est un hyperlien
HyperlinkAddress`strNone`None

Examples

Examples CompositeNode. Une image intégrée.

ExamplesExamplesExamples
FileName`strNone`
BytesbytesDonnées d’image brutes (par défaut b"")
Width`floatNone`
Height`floatNone`
AlternativeTextTitle`strNone`
AlternativeTextDescription`strNone`
HyperlinkUrl`strNone`
Tagslist[NoteTag]Balises OneNote attachées à cette image

Examples:

ExamplesExamples
Replace(image)Examples Bytes et FileName d’un autre Image nœud dans celui-ci

AttachedFile

Examples CompositeNode. Une pièce jointe de fichier intégrée.

ExamplesExamplesExamples
FileName`strNone`
BytesbytesDonnées brutes du fichier (par défaut b"")
Tagslist[NoteTag]Balises OneNote attachées à cette pièce jointe

Examples

Examples CompositeNode. Un tableau dans un OutlineElement.

ExamplesExamplesExamplesExamples
Columnslist[float][]Largeur de chaque colonne en points
IsBordersVisibleboolTrueSi les bordures du tableau sont visibles
Tagslist[NoteTag][]Étiquettes OneNote attachées à ce tableau

TableRow

Examples CompositeNode. Une ligne dans un Table. Itérer GetChildNodes(TableCell) pour accéder aux cellules.

TableCell

Examples CompositeNode. Une cellule dans un TableRow. Contient RichText, Image, et d’autres nœuds de contenu.

NoteTag

Examples Node. Une étiquette OneNote attachée à un nœud de contenu.

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

Note d’horodatage: created et completed sont des horodatages entiers bruts tels qu’extraits du format binaire MS-ONE, pas datetime objets.

Méthodes de fabrique:

ExamplesExamples
NoteTag.CreateYellowStar()Crée un NoteTag(shape=None, label="Yellow Star")

NumberList

Examples Node. Métadonnées de liste numérotée ou à puces sur un OutlineElement.

ExamplesExamplesExamplesExamples
Format`strNone`None
Restart`intNone`None
IsNumberedboolFalseVrai pour les listes ordonnées (numérotées)

LoadOptions

ExamplesExamplesExamplesExamples
DocumentPassword`strNone`None
LoadHistoryboolFalseChamp de compatibilité API ; non utilisé fonctionnellement dans la v26.3.1

SaveOptions

Classe de base pour toutes les options d’enregistrement. Argument positionnel requis.

ExamplesExamplesExamples
SaveFormatSaveFormatFormat d’enregistrement cible

PdfSaveOptions

Examples SaveOptions. Configuration d’export spécifique au PDF. Construire avec PdfSaveOptions(SaveFormat.Pdf).

ExamplesExamplesExamplesExamples
PageIndexint0Le champ existe ; non transmis à l’exportateur PDF dans la v26.3.1: n’a aucun effet sur la sortie
PageCount`intNone`None
TagIconDir`strNone`None
TagIconSize`floatNone`None
TagIconGap`floatNone`None

PageIndex / PageCount avertissement: Ces champs sont déclarés sur PdfSaveOptions : pour la compatibilité de l’API, mais le Document.Save() : implémentation dans la version v26.3.1 ne les lit pas et ne les transmet pas à l’exportateur PDF. Toutes les pages sont toujours exportées.

Licence et Facturation à l’usage

Stubs de compatibilité exportés pour assurer la forme de l’API avec Aspose.Note pour .NET. Toutes les méthodes sont des no‑ops dans cette implémentation 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

Aucune clé de licence n’est requise pour utiliser toute fonctionnalité de Aspose.Note FOSS pour Python.

Examples

: Référence complète de l’énumération : Examples

SaveFormat

ExamplesExamples
SaveFormat.Pdf: Export PDF : implémenté ; nécessite pip install "aspose-note[pdf]"
SaveFormat.One: Format OneNote : déclaré uniquement ; génère UnsupportedSaveFormatException

FileFormat

: Valeurs d’énumération représentant la version du format de fichier OneNote. Document.FileFormat : fournit une indication au mieux de ses capacités.

Examples: Valeur de chaîne
FileFormat.OneNote2010"onenote2010"
FileFormat.OneNoteOnline"onenoteonline"
FileFormat.OneNote2007"onenote2007"

HorizontalAlignment

ExamplesValeur de chaîne
HorizontalAlignment.Left"left"
HorizontalAlignment.Center"center"
HorizontalAlignment.Right"right"

NodeType

ExamplesValeur de chaîne
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"

Examples

Référence complète de l’exception : Examples

ExamplesExamples
AsposeNoteErrorClasse de base pour toutes les exceptions Aspose.Note FOSS
FileCorruptedExceptionExamples .one Le fichier ne peut pas être analysé (corrompu ou binaire malformé)
IncorrectDocumentStructureExceptionLa structure du fichier est invalide ou non prise en charge
IncorrectPasswordExceptionDéclenchée lorsque LoadOptions.DocumentPassword est défini ; les documents chiffrés ne sont pas pris en charge
UnsupportedFileFormatExceptionLe format du fichier n’est pas reconnu ; expose un FileFormat champ (string)
UnsupportedSaveFormatExceptionLe demandé SaveFormat n’est pas implémenté dans cette version

Voir aussi

 Français