Aspose.Note FOSS for Python

Esta referência cobre toda a superfície da API pública de aspose-note versão 26.3.1. Apenas símbolos exportados do aspose.note pacote são documentados aqui. Qualquer coisa sob aspose.note._internal é um detalhe de implementação e pode mudar sem aviso prévio.

ImageRenderOptions: pip install aspose-note (core) ou pip install "aspose-note[pdf]" (com exportação PDF)

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

ImageRenderOptions

Documento e Percurso

ImageRenderOptionsImageRenderOptions
DocumentObjeto raiz do documento. Carregue um .one arquivo, itere pelas páginas e salve em PDF.
DocumentVisitorBase abstrata para travessia em padrão visitor da árvore de documentos.
NodeClasse base para todos os nós de documento.
CompositeNodeClasse base para nós que podem conter nós filhos.

Estrutura do Documento

ImageRenderOptionsImageRenderOptions
PageRepresenta uma página do OneNote.
TitleBloco de título da página contendo TitleText, TitleDate, TitleTime.
OutlineContêiner posicional para nós OutlineElement.
OutlineElementContêiner folha; contém RichText, Image, Table, AttachedFile.

ImageRenderOptions

ImageRenderOptionsImageRenderOptions
RichTextBloco de texto com execuções de formatação, tags e hyperlinks.
TextRunSegmento de texto formatado único dentro de um RichText.
TextStylePropriedades de formatação para um TextRun.
ImageImagem incorporada com bytes brutos e metadados.
AttachedFileAnexo de arquivo incorporado com bytes brutos.
TableTabela com linhas, células e larguras de coluna.
TableRowUma linha dentro de uma Tabela.
TableCellUma célula dentro de um TableRow; contém nós de conteúdo.
NoteTagTag do OneNote (estrela, caixa de seleção, etc.) anexada a um nó de conteúdo.
NumberListMetadados de lista numerada em um OutlineElement.

ImageRenderOptions

ImageRenderOptionsImageRenderOptions
LoadOptionsOpções para carregar um .one arquivo.
SaveOptionsClasse base para opções de salvamento.
PdfSaveOptionsOpções de salvamento específicas para PDF (ícones de tags).

Stubs de Compatibilidade

ImageRenderOptionsImageRenderOptions
LicenseStub de compatibilidade: SetLicense() é uma operação nula nesta implementação FOSS.
MeteredStub de compatibilidade: SetMeteredKey() é uma operação nula nesta implementação FOSS.

Detalhes da Classe

ImageRenderOptions

A classe de documento raiz. Carregue um .one arquivo a partir de um caminho de arquivo, um pathlib.Path, ou um fluxo binário.

from aspose.note import Document, LoadOptions

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

Parâmetros do construtor:

ImageRenderOptionsImageRenderOptionsImageRenderOptions
source`strPath
load_options`LoadOptionsNone`

ImageRenderOptions:

ImageRenderOptionsImageRenderOptionsImageRenderOptions
DisplayName`strNone`
CreationTime`datetimeNone`
FileFormatFileFormatIndicação de melhor esforço da versão do formato de arquivo OneNote

ImageRenderOptions:

ImageRenderOptionsImageRenderOptionsImageRenderOptions
Count()() -> intNúmero de páginas filhas diretas
GetPageHistory(page)(Page) -> list[Page]ImageRenderOptions [page] (esboço; histórico completo ainda não implementado)
DetectLayoutChanges()() -> NoneEsboço de compatibilidade; nenhuma operação
Save(target, format_or_options)`(strPath
Accept(visitor)(DocumentVisitor) -> NoneInvocar travessia de visitante
for page in docN/AIterar filho direto Page nós

Document.FileFormat nota: A propriedade fornece uma indicação de melhor esforço da versão do formato de arquivo OneNote. O FileFormat enum tem três valores: OneNote2010, OneNoteOnline, e OneNote2007.

Document.Save() suporte a fluxo: target pode ser um fluxo binário (io.BytesIO, manipulador de arquivo aberto em modo de escrita binária, etc.). Isso é confirmado pela suíte de testes: doc.Save(io.BytesIO(), PdfSaveOptions(SaveFormat.Pdf)).

DocumentVisitor

Classe base abstrata para percorrimento usando o padrão visitor. Substitua os métodos de visita que precisar:

ImageRenderOptionsChamado quando
VisitDocumentStart(doc)Entrando em um nó Document
VisitDocumentEnd(doc)Saindo de um nó Document
VisitPageStart(page)Entrando em um nó Page
VisitPageEnd(page)Saindo de um nó Page
VisitTitleStart(title)Entrando em um nó Title
VisitTitleEnd(title)Saindo de um nó Title
VisitOutlineStart(outline)Entrando no nó Outline
VisitOutlineEnd(outline)Saindo do nó Outline
VisitOutlineElementStart(oe)Entrando no nó OutlineElement
VisitOutlineElementEnd(oe)Saindo do nó OutlineElement
VisitRichTextStart(rt)Entrando no nó RichText
VisitRichTextEnd(rt)Saindo do nó RichText
VisitImageStart(img)Entrando no nó Image
VisitImageEnd(img)Saindo do nó Image

ImageRenderOptions

Classe base para todos os nós da árvore de documentos.

Propriedade / MétodoImageRenderOptionsImageRenderOptions
ParentNode`NodeNone`
Document`DocumentNone`
Accept(visitor)(DocumentVisitor) -> NoneDespache o visitor para este nó

CompositeNode

ImageRenderOptions Node. Adiciona gerenciamento de filhos:

Propriedade / MétodoImageRenderOptions
FirstChildPrimeiro nó filho, ou None
LastChildÚltimo nó filho, ou None
AppendChildLast(node)Adicione um nó filho ao final; define node.ParentNode = self
AppendChildFirst(node)Adicione um nó filho no início
InsertChild(index, node)Insira um filho na posição especificada
RemoveChild(node)Remova um nó filho; define node.ParentNode = None
GetEnumerator()Retorna um iterador sobre os filhos diretos
for child in nodeIterar filhos diretos
GetChildNodes(Type)(Type) -> list[Type]: recursivo, busca em profundidade de toda a subárvore incluindo self

ImageRenderOptions

ImageRenderOptions CompositeNode. Representa uma página do OneNote.

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

ImageRenderOptions:

ImageRenderOptionsImageRenderOptions
Clone(deep=False)Retorna uma cópia rasa ou profunda da página

ImageRenderOptions

ImageRenderOptions CompositeNode. Contém o bloco de título de um Page.

ImageRenderOptionsImageRenderOptionsImageRenderOptions
TitleText`RichTextNone`
TitleDate`RichTextNone`
TitleTime`RichTextNone`

ImageRenderOptions

ImageRenderOptions CompositeNode. Um contêiner posicional para OutlineElement nós.

ImageRenderOptionsImageRenderOptionsImageRenderOptions
X`floatNone`
Y`floatNone`
Width`floatNone`

OutlineElement

ImageRenderOptions CompositeNode. Um contêiner folha que contém nós de conteúdo.

ImageRenderOptionsImageRenderOptionsImageRenderOptions
IndentLevelintProfundidade de aninhamento (0 = mais externo)
NumberList`NumberListNone`
Tagslist[NoteTag]Tags do OneNote anexadas a este elemento

RichText

ImageRenderOptions CompositeNode. Um bloco de texto formatado.

ImageRenderOptionsImageRenderOptionsImageRenderOptions
TextstrString completa em texto simples (todos os trechos concatenados)
Runslist[TextRun]Lista ordenada de segmentos formatados
FontSize`floatNone`
Tagslist[NoteTag]Tags do OneNote anexadas a este bloco

ImageRenderOptions:

ImageRenderOptionsImageRenderOptionsImageRenderOptions
Append(text, style=None)`(str, TextStyleNone) -> RichText`
Replace(old_value, new_value)(str, str) -> NoneSubstituição de string na memória em Text; não atualiza Runs

TextRun

ImageRenderOptions Node. Um único segmento de texto formatado.

ImageRenderOptionsImageRenderOptionsImageRenderOptions
TextstrO conteúdo de texto do segmento (padrão "")
StyleTextStylePropriedades de formatação
Start`intNone`
End`intNone`

TextStyle

ImageRenderOptions Node. Propriedades de formatação por caractere para um TextRun.

ImageRenderOptionsImageRenderOptionsImageRenderOptionsImageRenderOptions
BoldboolFalseImageRenderOptions
ItalicboolFalseImageRenderOptions
UnderlineboolFalseImageRenderOptions
StrikethroughboolFalseImageRenderOptions
SuperscriptboolFalseImageRenderOptions
SubscriptboolFalseImageRenderOptions
FontName`strNone`None
FontSize`floatNone`None
FontColor`intNone`None
HighlightColor`intNone`None
LanguageId`intNone`None
IsHyperlinkboolFalseSe esta execução é um hiperlink
HyperlinkAddress`strNone`None

ImageRenderOptions

ImageRenderOptions CompositeNode. Uma imagem incorporada.

ImageRenderOptionsImageRenderOptionsImageRenderOptions
FileName`strNone`
BytesbytesDados brutos da imagem (padrão b"")
Width`floatNone`
Height`floatNone`
AlternativeTextTitle`strNone`
AlternativeTextDescription`strNone`
HyperlinkUrl`strNone`
Tagslist[NoteTag]Tags do OneNote anexadas a esta imagem

ImageRenderOptions:

ImageRenderOptionsImageRenderOptions
Replace(image)ImageRenderOptions Bytes e FileName de outro Image nó para este

AttachedFile

ImageRenderOptions CompositeNode. Um anexo de arquivo incorporado.

ImageRenderOptionsImageRenderOptionsImageRenderOptions
FileName`strNone`
BytesbytesDados brutos do arquivo (padrão b"")
Tagslist[NoteTag]Tags do OneNote anexadas a este anexo

ImageRenderOptions

ImageRenderOptions CompositeNode. Uma tabela dentro de um OutlineElement.

ImageRenderOptionsImageRenderOptionsImageRenderOptionsImageRenderOptions
Columnslist[float][]Largura de cada coluna em pontos
IsBordersVisibleboolTrueSe as bordas da tabela são visíveis
Tagslist[NoteTag][]Tags do OneNote anexadas a esta tabela

TableRow

ImageRenderOptions CompositeNode. Uma linha dentro de um Table. Iterar GetChildNodes(TableCell) para acessar células.

TableCell

ImageRenderOptions CompositeNode. Uma célula dentro de um TableRow. Contém RichText, Image, e outros nós de conteúdo.

NoteTag

ImageRenderOptions Node. Uma tag do OneNote anexada a um nó de conteúdo.

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

Nota de timestamp: created e completed são timestamps inteiros brutos analisados a partir do formato binário MS-ONE, não datetime objetos.

Métodos de fábrica:

ImageRenderOptionsImageRenderOptions
NoteTag.CreateYellowStar()Cria um NoteTag(shape=None, label="Yellow Star")

NumberList

ImageRenderOptions Node. Metadados de lista numerada ou com marcadores em um OutlineElement.

ImageRenderOptionsImageRenderOptionsImageRenderOptionsImageRenderOptions
Format`strNone`None
Restart`intNone`None
IsNumberedboolFalseVerdadeiro para listas ordenadas (numeradas)

LoadOptions

ImageRenderOptionsImageRenderOptionsImageRenderOptionsImageRenderOptions
DocumentPassword`strNone`None
LoadHistoryboolFalseCampo de compatibilidade de API; não usado funcionalmente em v26.3.1

SaveOptions

Classe base para todas as opções de salvamento. Argumento posicional obrigatório.

ImageRenderOptionsImageRenderOptionsImageRenderOptions
SaveFormatSaveFormatFormato de salvamento de destino

PdfSaveOptions

ImageRenderOptions SaveOptions. Configuração de exportação específica para PDF. Construir com PdfSaveOptions(SaveFormat.Pdf).

ImageRenderOptionsImageRenderOptionsImageRenderOptionsImageRenderOptions
PageIndexint0Campo existe; não encaminhado para o exportador PDF em v26.3.1: não tem efeito na saída
PageCount`intNone`None
TagIconDir`strNone`None
TagIconSize`floatNone`None
TagIconGap`floatNone`None

PageIndex / PageCount advertência: Esses campos são declarados em PdfSaveOptions para compatibilidade de API, mas o Document.Save() implementação na v26.3.1 não lê nem encaminha-os para o exportador PDF. Todas as páginas são sempre exportadas.

Licença e Medição

Stubs de compatibilidade exportados para compatibilidade de forma de API com Aspose.Note para .NET. Todos os métodos são no-ops nesta implementação 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

Nenhuma chave de licença é necessária para usar qualquer recurso do Aspose.Note FOSS para Python.

ImageRenderOptions

Referência completa da enumeração: ImageRenderOptions

SaveFormat

ImageRenderOptionsImageRenderOptions
SaveFormat.PdfExportação PDF: implementada; requer pip install "aspose-note[pdf]"
SaveFormat.OneFormato OneNote: declarado apenas; gera UnsupportedSaveFormatException

FileFormat

Valores da enumeração que representam a versão do formato de arquivo OneNote. Document.FileFormat fornece uma indicação de melhor esforço.

ImageRenderOptionsValor de string
FileFormat.OneNote2010"onenote2010"
FileFormat.OneNoteOnline"onenoteonline"
FileFormat.OneNote2007"onenote2007"

HorizontalAlignment

ImageRenderOptionsValor de string
HorizontalAlignment.Left"left"
HorizontalAlignment.Center"center"
HorizontalAlignment.Right"right"

NodeType

ImageRenderOptionsValor de string
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"

ImageRenderOptions

Referência completa de exceções: ImageRenderOptions

ImageRenderOptionsImageRenderOptions
AsposeNoteErrorClasse base para todas as exceções Aspose.Note FOSS
FileCorruptedExceptionImageRenderOptions .one arquivo não pode ser analisado (binário corrompido ou malformado)
IncorrectDocumentStructureExceptionA estrutura do arquivo é inválida ou não suportada
IncorrectPasswordExceptionLançada quando LoadOptions.DocumentPassword está definido; documentos criptografados não são suportados
UnsupportedFileFormatExceptionO formato do arquivo não é reconhecido; expõe um FileFormat campo (string)
UnsupportedSaveFormatExceptionO solicitado SaveFormat não está implementado nesta versão

Veja Também

 Português