Aspose.Note FOSS for Python

Esta referencia cubre la superficie completa de la API pública de aspose-note versión 26.3.1. Sólo los símbolos exportados desde el aspose.note paquete se documentan aquí. Cualquier cosa bajo aspose.note._internal es un detalle de implementación y puede cambiar sin previo aviso.

Examples: pip install aspose-note (core) o pip install "aspose-note[pdf]" (con exportación a PDF)

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

Examples

Documento y Recorrido

Examples	Examples
`Document`	Objeto raíz del documento. Carga un `.one` archivo, itera páginas y guarda en PDF.
`DocumentVisitor`	Base abstracta para el recorrido del árbol de documentos mediante el patrón visitor.
`Node`	Clase base para todos los nodos del documento.
`CompositeNode`	Clase base para nodos que pueden contener nodos hijos.

Estructura del Documento

Examples	Examples
`Page`	Representa una página de OneNote.
`Title`	Bloque de título de página que contiene TitleText, TitleDate, TitleTime.
`Outline`	Contenedor posicional para nodos OutlineElement.
`OutlineElement`	Contenedor hoja; contiene RichText, Image, Table, AttachedFile.

Examples

Examples	Examples
`RichText`	Bloque de texto con ejecuciones de formato, etiquetas y enlaces.
`TextRun`	Segmento de texto formateado único dentro de un RichText.
`TextStyle`	Propiedades de formato para un TextRun.
`Image`	Imagen incrustada con bytes sin procesar y metadatos.
`AttachedFile`	Archivo adjunto incrustado con bytes sin procesar.
`Table`	Tabla con filas, celdas y anchos de columna.
`TableRow`	Una fila dentro de una Tabla.
`TableCell`	Una celda dentro de una TableRow; contiene nodos de contenido.
`NoteTag`	Etiqueta de OneNote (estrella, casilla de verificación, etc.) adjunta a un nodo de contenido.
`NumberList`	Metadatos de lista numerada en un OutlineElement.

Examples

Examples	Examples
`LoadOptions`	Opciones para cargar un `.one` archivo.
`SaveOptions`	Clase base para opciones de guardado.
`PdfSaveOptions`	Opciones de guardado específicas de PDF (iconos de etiquetas).

Stubs de compatibilidad

Examples	Examples
`License`	Stub de compatibilidad: `SetLicense()` es una operación nula en esta implementación FOSS.
`Metered`	Stub de compatibilidad: `SetMeteredKey()` es una operación nula en esta implementación FOSS.

Detalles de la Clase

Examples

La clase de documento raíz. Cargar un .one archivo desde una ruta de archivo, un pathlib.Path, o un flujo binario.

from aspose.note import Document, LoadOptions

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

Parámetros del constructor:

Examples	Examples	Examples
`source`	`str	Path
`load_options`	`LoadOptions	None`

Examples:

Examples	Examples	Examples
`DisplayName`	`str	None`
`CreationTime`	`datetime	None`
`FileFormat`	`FileFormat`	Indicador de mejor esfuerzo de la versión del formato de archivo OneNote

Examples:

Examples	Examples	Examples
`Count()`	`() -> int`	Número de páginas hijas directas
`GetPageHistory(page)`	`(Page) -> list[Page]`	Examples `[page]` (boceto; historial completo aún no implementado)
`DetectLayoutChanges()`	`() -> None`	Boceto de compatibilidad; sin operación
`Save(target, format_or_options)`	`(str	Path
`Accept(visitor)`	`(DocumentVisitor) -> None`	Invocar recorrido de visitante
`for page in doc`	N/A	Iterar hijo directo `Page` nodos

Document.FileFormat nota: La propiedad proporciona una indicación de mejor esfuerzo de la versión del formato de archivo OneNote. La FileFormat enumeración tiene tres valores: OneNote2010, OneNoteOnline, y OneNote2007.

Document.Save() soporte de flujo: target puede ser un flujo binario (io.BytesIO, controlador de archivo abierto en modo de escritura binaria, etc.). Esto está confirmado por el conjunto de pruebas: doc.Save(io.BytesIO(), PdfSaveOptions(SaveFormat.Pdf)).

DocumentVisitor

Clase base abstracta para el recorrido con patrón visitor. Sobrescribe los métodos de visita que necesites:

Examples	Llamado cuando
`VisitDocumentStart(doc)`	Entrando en un nodo Document
`VisitDocumentEnd(doc)`	Saliendo de un nodo Document
`VisitPageStart(page)`	Entrando en un nodo Page
`VisitPageEnd(page)`	Saliendo de un nodo Page
`VisitTitleStart(title)`	Entrando en un nodo Title
`VisitTitleEnd(title)`	Saliendo de un nodo Title
`VisitOutlineStart(outline)`	Entrando en un nodo Outline
`VisitOutlineEnd(outline)`	Saliendo de un nodo Outline
`VisitOutlineElementStart(oe)`	Entrando en un nodo OutlineElement
`VisitOutlineElementEnd(oe)`	Saliendo de un nodo OutlineElement
`VisitRichTextStart(rt)`	Entrando en un nodo RichText
`VisitRichTextEnd(rt)`	Saliendo de un nodo RichText
`VisitImageStart(img)`	Entrando en un nodo Image
`VisitImageEnd(img)`	Saliendo de un nodo Image

Examples

Clase base para todos los nodos del árbol de documentos.

Propiedad / Método	Examples	Examples
`ParentNode`	`Node	None`
`Document`	`Document	None`
`Accept(visitor)`	`(DocumentVisitor) -> None`	Despachar visitante para este nodo

CompositeNode

Examples Node. Añade gestión de hijos:

Propiedad / Método	Examples
`FirstChild`	Primer nodo hijo, o `None`
`LastChild`	Último nodo hijo, o `None`
`AppendChildLast(node)`	Añade un nodo hijo al final; establece `node.ParentNode = self`
`AppendChildFirst(node)`	Añade un nodo hijo al inicio
`InsertChild(index, node)`	Inserta un hijo en la posición dada
`RemoveChild(node)`	Elimina un nodo hijo; establece `node.ParentNode = None`
`GetEnumerator()`	Devuelve un iterador sobre los hijos directos
`for child in node`	Iterar los hijos directos
`GetChildNodes(Type)`	`(Type) -> list[Type]`: recursivo, búsqueda en profundidad de todo el subárbol incluyendo `self`

Examples

Examples CompositeNode. Representa una página de OneNote.

Examples	Examples	Examples
`Title`	`Title	None`
`Author`	`str	None`
`CreationTime`	`datetime	None`
`LastModifiedTime`	`datetime	None`
`Level`	`int	None`

Examples:

Examples	Examples
`Clone(deep=False)`	Devuelve una clonación superficial o profunda de la página

Examples

Examples CompositeNode. Contiene el bloque de título de un Page.

Examples	Examples	Examples
`TitleText`	`RichText	None`
`TitleDate`	`RichText	None`
`TitleTime`	`RichText	None`

Examples

Examples CompositeNode. Un contenedor posicional para OutlineElement nodos.

Examples	Examples	Examples
`X`	`float	None`
`Y`	`float	None`
`Width`	`float	None`

OutlineElement

Examples CompositeNode. Un contenedor hoja que contiene nodos de contenido.

Examples	Examples	Examples
`IndentLevel`	`int`	Profundidad de anidamiento (0 = más externo)
`NumberList`	`NumberList	None`
`Tags`	`list[NoteTag]`	Etiquetas de OneNote adjuntas a este elemento

RichText

Examples CompositeNode. Un bloque de texto con estilo.

Examples	Examples	Examples
`Text`	`str`	Cadena de texto plano completa (todas las ejecuciones concatenadas)
`Runs`	`list[TextRun]`	Lista ordenada de segmentos formateados
`FontSize`	`float	None`
`Tags`	`list[NoteTag]`	Etiquetas de OneNote adjuntas a este bloque

Examples:

Examples	Examples	Examples
`Append(text, style=None)`	`(str, TextStyle	None) -> RichText`
`Replace(old_value, new_value)`	`(str, str) -> None`	Sustitución de cadena en memoria en `Text`; no actualiza `Runs`

TextRun

Examples Node. Un único segmento de texto formateado.

Examples	Examples	Examples
`Text`	`str`	El contenido de texto del segmento (por defecto `""`)
`Style`	`TextStyle`	Propiedades de formato
`Start`	`int	None`
`End`	`int	None`

TextStyle

Examples Node. Propiedades de formato por carácter para un TextRun.

Examples	Examples	Examples	Examples
`Bold`	`bool`	`False`	Examples
`Italic`	`bool`	`False`	Examples
`Underline`	`bool`	`False`	Examples
`Strikethrough`	`bool`	`False`	Examples
`Superscript`	`bool`	`False`	Examples
`Subscript`	`bool`	`False`	Examples
`FontName`	`str	None`	`None`
`FontSize`	`float	None`	`None`
`FontColor`	`int	None`	`None`
`HighlightColor`	`int	None`	`None`
`LanguageId`	`int	None`	`None`
`IsHyperlink`	`bool`	`False`	Si esta ejecución es un hipervínculo
`HyperlinkAddress`	`str	None`	`None`

Examples

Examples CompositeNode. Una imagen incrustada.

Examples	Examples	Examples
`FileName`	`str	None`
`Bytes`	`bytes`	Datos de imagen sin procesar (por defecto `b""`)
`Width`	`float	None`
`Height`	`float	None`
`AlternativeTextTitle`	`str	None`
`AlternativeTextDescription`	`str	None`
`HyperlinkUrl`	`str	None`
`Tags`	`list[NoteTag]`	Etiquetas de OneNote adjuntas a esta imagen

Examples:

Examples	Examples
`Replace(image)`	Examples `Bytes` y `FileName` de otro `Image` nodo a este

AttachedFile

Examples CompositeNode. Un archivo adjunto incrustado.

Examples	Examples	Examples
`FileName`	`str	None`
`Bytes`	`bytes`	Datos brutos del archivo (por defecto `b""`)
`Tags`	`list[NoteTag]`	Etiquetas de OneNote adjuntas a este adjunto

Examples

Examples CompositeNode. Una tabla dentro de un OutlineElement.

Examples	Examples	Examples	Examples
`Columns`	`list[float]`	`[]`	Ancho de cada columna en puntos
`IsBordersVisible`	`bool`	`True`	Si los bordes de la tabla son visibles
`Tags`	`list[NoteTag]`	`[]`	Etiquetas de OneNote adjuntas a esta tabla

TableRow

Examples CompositeNode. Una fila dentro de un Table. Iterar GetChildNodes(TableCell) para acceder a las celdas.

TableCell

Examples CompositeNode. Una celda dentro de un TableRow. Contiene RichText, Image, y otros nodos de contenido.

NoteTag

Examples Node. Una etiqueta de OneNote adjunta a un nodo de contenido.

Examples	Examples	Examples	Examples
`shape`	`int	None`	`None`
`label`	`str	None`	`None`
`text_color`	`int	None`	`None`
`highlight_color`	`int	None`	`None`
`created`	`int	None`	`None`
`completed`	`int	None`	`None`

Nota de marca de tiempo: created y completed son marcas de tiempo enteras sin procesar extraídas del formato binario MS-ONE, no datetime objetos.

Métodos de fábrica:

Examples	Examples
`NoteTag.CreateYellowStar()`	Crea un `NoteTag(shape=None, label="Yellow Star")`

NumberList

Examples Node. Metadatos de listas numeradas o con viñetas en un OutlineElement.

Examples	Examples	Examples	Examples
`Format`	`str	None`	`None`
`Restart`	`int	None`	`None`
`IsNumbered`	`bool`	`False`	Verdadero para listas ordenadas (numeradas)

LoadOptions

Examples	Examples	Examples	Examples
`DocumentPassword`	`str	None`	`None`
`LoadHistory`	`bool`	`False`	Campo de compatibilidad de API; no se usa funcionalmente en v26.3.1

SaveOptions

Clase base para todas las opciones de guardado. Argumento posicional requerido.

Examples	Examples	Examples
`SaveFormat`	`SaveFormat`	Formato de guardado objetivo

PdfSaveOptions

Examples SaveOptions. Configuración de exportación específica de PDF. Construir con PdfSaveOptions(SaveFormat.Pdf).

Examples	Examples	Examples	Examples
`PageIndex`	`int`	`0`	El campo existe; no se reenvía al exportador PDF en v26.3.1: no tiene efecto en la salida
`PageCount`	`int	None`	`None`
`TagIconDir`	`str	None`	`None`
`TagIconSize`	`float	None`	`None`
`TagIconGap`	`float	None`	`None`

PageIndex / PageCount advertencia: Estos campos están declarados en PdfSaveOptions para compatibilidad de API, pero el Document.Save() implementación en v26.3.1 no los lee ni los reenvía al exportador PDF. Todas las páginas siempre se exportan.

Licencia y Medido

Stubs de compatibilidad exportados para la compatibilidad de forma de API con Aspose.Note para .NET. Todos los métodos son no operativos en esta implementación 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 se requiere una clave de licencia para usar ninguna función de Aspose.Note FOSS para Python.

Examples

Referencia completa de la enumeración: Examples

SaveFormat

Examples	Examples
`SaveFormat.Pdf`	Exportación PDF: implementada; requiere `pip install "aspose-note[pdf]"`
`SaveFormat.One`	Formato OneNote: solo declarado; genera `UnsupportedSaveFormatException`

FileFormat

Valores de enumeración que representan la versión del formato de archivo OneNote. Document.FileFormat proporciona una indicación de mejor esfuerzo.

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

HorizontalAlignment

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

NodeType

Examples	Valor de 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"`

Examples

Referencia completa de excepciones: Examples

Examples	Examples
`AsposeNoteError`	Clase base para todas las excepciones Aspose.Note FOSS
`FileCorruptedException`	Examples `.one` el archivo no se puede analizar (binario corrupto o malformado)
`IncorrectDocumentStructureException`	La estructura del archivo es inválida o no compatible
`IncorrectPasswordException`	Se lanza cuando `LoadOptions.DocumentPassword` está configurado; los documentos cifrados no son compatibles
`UnsupportedFileFormatException`	El formato de archivo no se reconoce; expone un `FileFormat` campo (cadena)
`UnsupportedSaveFormatException`	La solicitada `SaveFormat` no está implementado en esta versión

Aspose.Note FOSS for Python

Examples

Documento y Recorrido

Estructura del Documento

Examples

Examples

Stubs de compatibilidad

Detalles de la Clase

Examples

DocumentVisitor

Examples

CompositeNode

Examples

Examples

Examples

OutlineElement

RichText

TextRun

TextStyle

Examples

AttachedFile

Examples

TableRow

TableCell

NoteTag

NumberList

LoadOptions

SaveOptions

PdfSaveOptions

Licencia y Medido

Examples

SaveFormat

FileFormat

HorizontalAlignment

NodeType

Examples

Ver también