Aspose.Note FOSS - FOSS per a Python

Aquesta referència cobreix tota la superfície API pública de: aspose-note Versió 26.3.1. Només els símbols exportats des de la aspose.note Tot el que es troba sota la marca de l’equipatge està documentat aquí. aspose.note._internal és un detall d’aplicació i pot canviar sense previ avís.

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

Importació: from aspose.note import Document, RichText, ...

Classes

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

Document i travessa

Classe	Descripció
`Document`	Object document root. Representa un document OneNote; itera pàgines i exporta a PDF.
`DocumentVisitor`	Base abstracta per a la travessa de patrons d’usuari en l’arbre del document.
`Node`	Clasa base per a tots els nodes de document.
`CompositeNode`	Clase base per a nodes que poden contenir nodos fills.

Estructura del document

Classe	Descripció
`Page`	Representa una pàgina OneNote.
`Title`	Bloc de títol de pàgina que conté TitleText, TitleDate i TitleTime.
`Outline`	Contenidor de posició per als nodes OutlineElement.
`OutlineElement`	Contenidor de fulles; conté RichText, Imatge, Taula, AttachedFile.

Contenit

Classe	Descripció
`RichText`	Bloc de text amb formatatge, etiquetes i hipervincles.
`TextRun`	Segment de text format únic dins d’un RichText.
`TextStyle`	Formatatge de propietats per a un TextRun.
`Image`	Imatge incrustada amb bytes i metadades.
`AttachedFile`	Anex de fitxer incrustat amb bytes bruts.
`Table`	Taula amb llargor de files, cèl·lules i columnes.
`TableRow`	Una fila dins d’una taula.
`TableCell`	Una cel·la dins d’un TableRow; conté nodes de contingut.
`NoteTag`	OneNote etiqueta (estrella, casella de selecció, etc.) adjunta a un node de contingut.
`NumberList`	Metadades de llistes numerades d’un OutlineElement.

Opcions

Classe	Descripció
`LoadOptions`	Opcions per a la càrrega d’un `.one` Arxiu.
`SaveOptions`	Classe base per a opcions de salvament.
`PdfSaveOptions` (vegeu opcions i paràmetres)	Classe d’opcions per a l’exportació de documents: controla la compressió d ‘imatges, la qualitat JPEG i les configuracions de pàgines per al format PDF.

Estampes de compatibilitat

Classe	Descripció
`License`	Estoc de compatibilitat: `SetLicense()` és una no-op en aquesta implementació FOSS.
`Metered`	Estoc de compatibilitat: `SetMeteredKey()` és una no-op en aquesta implementació FOSS.

Detalls de classe

Document

La classe de document raí. Carregar un .one arxiu d’una ruta de fitxer, un pathlib.Path, o un flux binari.

from aspose.note import Document, LoadOptions

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

Parametres del constructor:

Paramètre	Tipus de productes	Descripció
`source`	`str	Path
`load_options`	`LoadOptions	None`

Propietats:

Immobiliari	Tipus de productes	Descripció
`FileFormat`	`FileFormat`	Indicació de la versió del format de fitxer OneNote amb el millor esforç.

Mètodes:

Mètode	Signatura	Descripció
`GetPageHistory(page)`	`(Page) -> PageHistory`	Retorns `[page]` (stub; història completa encara no implementada)
`DetectLayoutChanges()`	`() -> None`	Estoc de compatibilitat; no operació.
`Save(target, format_or_options)`	`(str	Path
`Accept(visitor)`	`(DocumentVisitor) -> None`	Invocar la travessa de visitants
`for page in doc`	N/A	Iterat descendent directe `Page` nodes

Document.FileFormat nota:: La propietat proporciona una indicació de millor esforç del format de fitxer OneNote. FileFormat enum té tres valors: OneNote2010, OneNoteOnline, i OneNote2007.

Document.Save() Suport de flux: target pot ser un flux binari (io.BytesIO, màquina de fitxer oberta en mode d’escriptura binari, etc.).

DocumentVisitor

Classe de base abstracta per a la travessa del patró dels visitants. Sobrescriu els mètodes de visita que necessites:

Mètode	Va trucar quan
`VisitDocumentStart(doc)`	Introducció d’ un nod de document
`VisitDocumentEnd(doc)`	Deixar un nod de document
`VisitPageStart(page)`	Introducció d’ un node de pàgina
`VisitPageEnd(page)`	Deixar un nod de pàgina
`VisitTitleStart(title)`	Introducció d’ un nod de títol
`VisitTitleEnd(title)`	Deixar un nod de títol
`VisitOutlineStart(outline)`	Introducció d’ un nod de contorns
`VisitOutlineEnd(outline)`	Deixar un nod de contorns
`VisitOutlineElementStart(oe)`	Introducció d’un node OutlineElement
`VisitOutlineElementEnd(oe)`	Deixar un node OutlineElement
`VisitRichTextStart(rt)`	Introducció d’un node RichText
`VisitRichTextEnd(rt)`	Deixar un node RichText
`VisitImageStart(img)`	Introducció d’ un node d ’ imatge
`VisitImageEnd(img)`	Deixar un node d’ imatge

Nòs

Classe base per a tots els nodes de l’arbre del document.

Propietat / mètode	Tipus de productes	Descripció
`ParentNode`	`Node	None`
`Document`	`Document	None`
`Accept(visitor)`	`(DocumentVisitor) -> None`	Enviar un visitant per a aquest node

CompositeNode

Extensos Node.Adjunta la gestió de nens:

Propietat / mètode	Descripció
`FirstChild`	Nòs fill primer, o `None`
`LastChild`	Últim node fill, o `None`
`AppendChildLast(node)`	Afegir un node fill al final; sets `node.ParentNode = self`
`AppendChildFirst(node)`	Afegir un node fill al començament
`InsertChild(index, node)`	Insertar un nen a la posició donada.
`RemoveChild(node)`	Eliminar un node fill; sets `node.ParentNode = None`
`GetEnumerator()`	Retorna un iterador sobre fills directes.
`for child in node`	Infants directes iterats
`GetChildNodes(Type)`	`(Type) -> list[Type]`: recerca recursiva, de primer a profunditat de tot el subarbre incloent-hi: `self`

Pàgina

Extensos CompositeNode. Representa una pàgina OneNote.

Immobiliari	Tipus de productes	Descripció
`Title`	`Title	None`
`Author`	`str	None`
`CreationTime`	`datetime	None`
`LastModifiedTime`	`datetime	None`
`Level`	`int	None`

Mètodes:

Mètode	Descripció
`Clone(deep=False)`	Retornar un cló poc profund o de la pàgina

Títol

Extensos CompositeNode.Té el bloc de títol d’un Page.

Immobiliari	Tipus de productes	Descripció
`TitleText`	`RichText	None`
`TitleDate`	`RichText	None`
`TitleTime`	`RichText	None`

Esbós de la història

Extensos CompositeNode.Un contenidor de posició per a: OutlineElement nodes.

Immobiliari	Tipus de productes	Descripció
`HorizontalOffset`	`float	None`
`VerticalOffset`	`float	None`
`MaxWidth`	`float	None`
`MaxHeight`	`float	None`
`MinWidth`	`float	None`
`ReservedWidth`	`float	None`
`IndentPosition`	`float	None`

OutlineElement

Extensos CompositeNode.Un contenidor de fulles que conté nodes.

Immobiliari	Tipus de productes	Descripció
`NumberList`	`NumberList	None`

RichText

Extensos Node.Un bloc de text amb estil.

Immobiliari	Tipus de productes	Descripció
`Text`	`str`	Cadenes de text sencer complet (totes les correccions concatenades)
`TextRuns`	`list[TextRun]`	Lista ordenada de segments formatats
`Tags`	`list[NoteTag]`	Les etiquetes adjuntades a aquest bloc

Mètodes:

Mètode	Signatura	Descripció
`Append(text, style=None)`	`(str, TextStyle	None) -> RichText`
`Replace(old_value, new_value)`	`(str, str) -> None`	Substitució de cadenes en memòria `Text`; no actualitza `TextRuns`

TextRun

Un únic segment de text formatat dins del sistema d’enllaç. RichText.TextRuns.

Immobiliari	Tipus de productes	Descripció
`Text`	`str`	Contenit de text del segment (default) `""`)
`Style`	`TextStyle`	Propietats de formatatge

TextStyle

Propietats de formatació per caràcters d’un TextRun.

Immobiliari	Tipus de productes	Default	Descripció
`IsBold`	`bool`	`False`	Engaixada.
`IsItalic`	`bool`	`False`	Italic
`IsUnderline`	`bool`	`False`	Subratlla
`IsStrikethrough`	`bool`	`False`	L’impacte
`IsSuperscript`	`bool`	`False`	Superscript
`IsSubscript`	`bool`	`False`	Subscripció
`FontName`	`str	None`	`None`
`FontSize`	`float	None`	`None`
`FontColor`	`int	None`	`None`
`Highlight`	`int	None`	`None`
`Language`	`int	None`	`None`
`IsHyperlink`	`bool`	`False`	Si aquesta pista és un hipervincle
`HyperlinkAddress`	`str	None`	`None`

Imatge

Extensos CompositeNode.Una imatge incrustada.

Immobiliari	Tipus de productes	Descripció
`FileName`	`str	None`
`FilePath`	`str	None`
`Format`	`str	None`
`Bytes`	`bytes`	Dades d’imatge en byte brut (default) `b""`)
`OriginalWidth`	`float	None`
`OriginalHeight`	`float	None`
`Alignment`	`HorizontalAlignment	None`
`Tags`	`list[NoteTag]`	Etiquetes adjuntades a aquesta imatge.

Mètodes:

Mètode	Descripció
`Replace(image)`	Comptació. `Bytes` i de la `FileName` d’un altre `Image` Nòt en aquest

AttachedFile

Extensos Node.Un arxiu incrustat.

Immobiliari	Tipus de productes	Descripció
`FileName`	`str	None`
`Bytes`	`bytes`	Dades de fitxer brut (default) `b""`)
`Tags`	`list[NoteTag]`	Etiquetes adjuntades a aquest document adjunte.

Taula de la Comissió

Extensos CompositeNode.Una taula dins d’un OutlineElement.

Immobiliari	Tipus de productes	Default	Descripció
`Columns`	`list[TableColumn]`	`[]`	Lista de metadades de columnes; cada una `TableColumn` té `.Width` (flot) i `.LockedWidth` (bool)
`Tags`	`list[NoteTag]`	`[]`	Etiquetes adjuntades a aquesta taula.

TableRow

Extensos CompositeNode.Una fila dins d’un Table.Iterat. GetChildNodes(TableCell) per accedir a les cel·les.

TableCell

Extensos CompositeNode.Una cel·la dins d’un TableRow.Conté: RichText, Image, i altres nodes de contingut.

NoteTag

Una etiqueta OneNote adjunta a un node de contingut.

Immobiliari	Tipus de productes	Default	Descripció
`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`	derivada	`TagStatus.Completed` si: `CompletedTime` està establert, si no ho és. `TagStatus.Open`

Metodes d’obra en fàbrica:

Mètode	Descripció
`NoteTag.CreateYellowStar(label=None)`	Crea un `NoteTag(Label="Yellow Star", Icon=13)`
`NoteTag.CreateQuestionMark(label=None)`	Crea un `NoteTag(Label="Question Mark", Icon=15)`
`NoteTag.CreateMusicalNote(label=None)`	Crea un `NoteTag(Label="Musical Note", Icon=121)`

NumberList

Metadades de llistes numerades o amb puntes en un OutlineElement.

Immobiliari	Tipus de productes	Default	Descripció
`Format`	`str	None`	`None`
`NumberFormat`	`str	None`	`None`
`Font`	`str	None`	`None`
`FontSize`	`float	None`	`None`
`FontColor`	`int	None`	`None`
`IsBold`	`bool`	`False`	Peso en negrit per al prefix de la llista
`IsItalic`	`bool`	`False`	Estil en cursiva per al prefix de la llista
`Restart`	`int	None`	`None`

LoadOptions

Immobiliari	Tipus de productes	Default	Descripció
`DocumentPassword`	`str	None`	`None`
`LoadHistory`	`bool`	`False`	Camp de compatibilitat API; no utilitzat funcionalment en la v26.3.1

SaveOptions

Classe de base per a opcions d’estalvi. Argument posicional requerit.

Immobiliari	Tipus de productes	Descripció
`SaveFormat`	`SaveFormat`	Format de guarda del objectiu

PdfSaveOptions

Extensos SaveOptions. Configuració d’exportació específica per a PDF. Construir amb PdfSaveOptions() (tots els arguments són només per paraules clau amb paràmetres predeterminats).

Immobiliari	Tipus de productes	Default	Descripció
`PageIndex`	`int`	`0`	El camp existeix; No s’ha enviat a l’exportador PDF en la versió 26.3.1.: no té efecte en la producció.
`PageCount`	`int	None`	`None`
`ImageCompression`	`Any	None`	`None`
`JpegQuality`	`int	None`	`None`
`PageSettings`	`Any	None`	`None`
`PageSplittingAlgorithm`	`Any	None`	`None`

PageIndex / PageCount advertença:Aquests camps s’han de declarar en: PdfSaveOptions per a la compatibilitat amb API, però el Document.Save() La implementació en la v26.3.1 no s’aplica ni les transmet al exportador de PDF. Totes les pàgines sempre són exportades.

Licència i mètre

Estubs de compatibilitat exportats per a la compatibilització de forma d’API amb Aspose.Note per .NET. Tots els mètodes no són opcions en aquesta 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

No es requereix cap clau de llicència per utilitzar qualsevol característica de Aspose.Note FOSS for Python.

Enumeracions

Referència completa d’enumeració: Enumeracions

SaveFormat

Valor de la moneda	Descripció
`SaveFormat.Pdf`	Exportació PDF: implementada; requereix `pip install "aspose-note[pdf]"`

FileFormat

Valors enum que representen la versió del format de fitxer OneNote. Document.FileFormat proporciona una indicació de millor esforç.

Valor de la moneda	Valor de la cadena
`FileFormat.OneNote2010`	`"onenote2010"`
`FileFormat.OneNoteOnline`	`"onenoteonline"`
`FileFormat.OneNote2007`	`"onenote2007"`

HorizontalAlignment

Valor de la moneda	Valor de la cadena
`HorizontalAlignment.Left`	`"left"`
`HorizontalAlignment.Center`	`"center"`
`HorizontalAlignment.Right`	`"right"`

NodeType

Valor de la moneda	Valor de la cadena
`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"`

Excepcions

Referència d’excepció completa: Excepcions

Excepció	Descripció
`AsposeNoteError`	Classe base per a totes les excepcions FOSS Aspose.Note
`FileCorruptedException`	El `.one` no es pot analitzar el fitxer (binari corromput o malformat)
`IncorrectDocumentStructureException`	L’estructura de fitxer és invàlida o no està suportada.
`IncorrectPasswordException`	Creat quan `LoadOptions.DocumentPassword` està establert; no es suporten documents xifrats.
`UnsupportedFileFormatException`	El format de fitxer no és reconegut; exposa un `FileFormat` camp (cadença)
`UnsupportedSaveFormatException`	Els requisits `SaveFormat` no està implementat en aquesta versió.

Aspose.Note FOSS - FOSS per a Python

Classes

Document i travessa

Estructura del document

Contenit

Opcions

Estampes de compatibilitat

Detalls de classe

Document

DocumentVisitor

Nòs

CompositeNode

Pàgina

Títol

Esbós de la història

OutlineElement

RichText

TextRun

TextStyle

Imatge

AttachedFile

Taula de la Comissió

TableRow

TableCell

NoteTag

NumberList

LoadOptions

SaveOptions

PdfSaveOptions

Licència i mètre

Enumeracions

SaveFormat

FileFormat

HorizontalAlignment

NodeType

Excepcions

Veure també