Class Notebook

Notebook class

Representa un cuaderno Aspose.Note.

public class Notebook : IEnumerable<INotebookChildNode>, INotebookChildNode

Constructores

NombreDescripción
Notebook()Inicializa una nueva instancia delNotebook clase.
Notebook(Stream)Inicializa una nueva instancia delNotebook class. Abre un bloc de notas de OneNote existente desde una secuencia.
Notebook(string)Inicializa una nueva instancia delNotebook class. Abre un bloc de notas de OneNote existente desde un archivo.
Notebook(Stream, NotebookLoadOptions)Inicializa una nueva instancia delNotebook class. Abre un bloc de notas de OneNote existente desde una secuencia. Permite especificar opciones de carga adicionales.
Notebook(string, NotebookLoadOptions)Inicializa una nueva instancia delNotebook class. Abre un bloc de notas de OneNote existente desde un archivo. Permite especificar opciones adicionales, como una estrategia de carga de niños (“lazy”/instant).

Propiedades

NombreDescripción
Color { get; set; }Obtiene o establece el color.
Count { get; }Obtiene el número de elementos contenidos en elNotebook .
DisplayName { get; set; }Obtiene o establece el nombre para mostrar.
FileFormat { get; }Obtiene el formato de archivo (OneNote 2010, OneNote Online).
Guid { get; }Obtiene la identificación única global del objeto.
IsHistoryEnabled { get; set; }Obtiene o establece un valor que indica si el historial está habilitado.
Item { get; }Obtiene el nodo secundario del cuaderno por el índice dado.

Métodos

NombreDescripción
AppendChild(INotebookChildNode)Agrega el nodo al final de la lista.
GetChildNodes<T1>()Obtener todos los nodos secundarios por tipo de nodo.
GetEnumerator()Devuelve un enumerador que itera a través de los nodos secundarios delNotebook .
LoadChildDocument(Stream)Agrega un nodo de documento secundario. Abre un documento de OneNote existente desde una secuencia.
LoadChildDocument(string)Agrega un nodo de documento secundario. Abre un documento de OneNote existente desde un archivo.
LoadChildDocument(Stream, LoadOptions)Agrega un nodo de documento secundario. Abre un documento de OneNote existente desde una secuencia. Permite especificar opciones de carga adicionales.
LoadChildDocument(string, LoadOptions)Agrega un nodo de documento secundario. Abre un documento de OneNote existente desde un archivo. Permite especificar opciones de carga adicionales.
LoadChildNotebook(Stream)Agrega un nodo de bloc de notas secundario. Abre un bloc de notas de OneNote existente desde una secuencia.
LoadChildNotebook(string)Agrega un nodo de bloc de notas secundario. Abre un bloc de notas de OneNote existente desde un archivo.
LoadChildNotebook(Stream, NotebookLoadOptions)Agrega un nodo de bloc de notas secundario. Abre un bloc de notas de OneNote existente desde una secuencia. Permite especificar opciones de carga adicionales.
LoadChildNotebook(string, NotebookLoadOptions)Agrega un nodo de bloc de notas secundario. Abre un bloc de notas de OneNote existente desde un archivo. Permite especificar opciones de carga adicionales.
RemoveChild(INotebookChildNode)Elimina el nodo secundario.
Save(Stream)Guarda el documento de OneNote en una secuencia.
Save(string)Guarda el documento de OneNote en un archivo.
Save(Stream, NotebookSaveOptions)Guarda el documento de OneNote en una secuencia con las opciones de guardado especificadas.
Save(Stream, SaveFormat)Guarda el documento de OneNote en una secuencia en el formato especificado.
Save(string, NotebookSaveOptions)Guarda el documento de OneNote en un archivo usando las opciones de guardado especificadas.
Save(string, SaveFormat)Guarda el documento de OneNote en un archivo con el formato especificado.

Ejemplos

Muestra cómo guardar el cuaderno.

// La ruta al directorio de documentos.
string dataDir = RunExamples.GetDataDir_NoteBook();

var notebook = new Notebook();

dataDir = dataDir + "test_out.onetoc2";

// Guardar el cuaderno
notebook.Save(dataDir);

Muestra cómo guardar el cuaderno en formato pdf.

// La ruta al directorio de documentos.
string dataDir = RunExamples.GetDataDir_NoteBook();

// Cargar un cuaderno de OneNote
var notebook = new Notebook(dataDir + "Notizbuch �ffnen.onetoc2");

dataDir = dataDir + "ConvertToPDF_out.pdf";

// Guardar el cuaderno
notebook.Save(dataDir);

Muestra cómo guardar el cuaderno como imagen.

// La ruta al directorio de documentos.
string dataDir = RunExamples.GetDataDir_NoteBook();

// Cargar un cuaderno de OneNote
var notebook = new Notebook(dataDir + "Notizbuch �ffnen.onetoc2");

dataDir = dataDir + "ConvertToImage_out.png";

// Guardar el cuaderno
notebook.Save(dataDir);

Muestra cómo obtener todo el texto de un bloc de notas.

string inputFile = "notebook.onetoc2";
string dataDir = RunExamples.GetDataDir_NoteBook();

Notebook rootNotebook = new Notebook(dataDir + inputFile);

IList<RichText> allRichTextNodes = rootNotebook.GetChildNodes<RichText>();
foreach (RichText richTextNode in allRichTextNodes)
{
    Console.WriteLine(richTextNode.Text);
}

Muestra cómo guardar un cuaderno aplanado en formato pdf.

// La ruta al directorio de documentos.
string dataDir = RunExamples.GetDataDir_NoteBook();

// Cargar un cuaderno de OneNote
var notebook = new Notebook(dataDir + "Notizbuch �ffnen.onetoc2");

// Guardar el cuaderno
dataDir = dataDir + "ConvertToPDFAsFlattened_out.pdf";
notebook.Save(
    dataDir,
    new NotebookPdfSaveOptions
    {
        Flatten = true
    });

Muestra cómo iterar a través de documentos de un cuaderno cargándolos con pereza.

string inputFile = "Notizbuch öffnen.onetoc2";
string dataDir = RunExamples.GetDataDir_NoteBook();

// Por defecto, la carga de niños es "perezosa".
Notebook notebook = new Notebook(dataDir + inputFile);

foreach (var notebookChildNode in notebook.OfType<Document>()) 
{
    // La carga real del documento secundario ocurre solo aquí.
    // Hacer algo con el documento secundario
}

Muestra cómo agregar una nueva sección a un cuaderno.

// La ruta al directorio de documentos.
string dataDir = RunExamples.GetDataDir_NoteBook();

// Cargar un cuaderno de OneNote
var notebook = new Notebook(dataDir + "Notizbuch �ffnen.onetoc2");

// Agregar un nuevo hijo al Cuaderno
notebook.AppendChild(new Document(dataDir + "Neuer Abschnitt 1.one"));

dataDir = dataDir + "AddChildNode_out.onetoc2";

// Guardar el cuaderno
notebook.Save(dataDir);

Muestra cómo cargar un cuaderno desde una secuencia.

// La ruta al directorio de documentos.
string dataDir = RunExamples.GetDataDir_NoteBook();

FileStream stream = new FileStream(dataDir + "Notizbuch öffnen.onetoc2", FileMode.Open);

var notebook = new Notebook(stream);

using (FileStream childStream = new FileStream(dataDir + "Aspose.one", FileMode.Open))
{
    notebook.LoadChildDocument(childStream);
}

notebook.LoadChildDocument(dataDir + "Sample1.one");

Muestra cómo un cuaderno encriptado.

// La ruta al directorio de documentos.
string dataDir = RunExamples.GetDataDir_NoteBook();
var notebook = new Notebook(dataDir + "test.onetoc2", new NotebookLoadOptions() { DeferredLoading = true });

notebook.LoadChildDocument(dataDir + "Aspose.one");  
notebook.LoadChildDocument(dataDir + "Locked Pass1.one", new LoadOptions() { DocumentPassword = "pass" });
notebook.LoadChildDocument(dataDir + "Locked Pass2.one", new LoadOptions() { DocumentPassword = "pass2" });

Muestra cómo guardar el cuaderno como imagen con opciones específicas.

// La ruta al directorio de documentos.
string dataDir = RunExamples.GetDataDir_NoteBook();

// Cargar un cuaderno de OneNote
var notebook = new Notebook(dataDir + "Notizbuch �ffnen.onetoc2");

var notebookSaveOptions = new NotebookImageSaveOptions(SaveFormat.Png);

var documentSaveOptions = notebookSaveOptions.DocumentSaveOptions;

documentSaveOptions.Resolution = 400;

dataDir = dataDir + "ConvertToImageWithOptions_out.png";

// Guardar el cuaderno
notebook.Save(dataDir, notebookSaveOptions);

Muestra cómo guardar un cuaderno aplanado como imagen.

// La ruta al directorio de documentos.
string dataDir = RunExamples.GetDataDir_NoteBook();

// Cargar un cuaderno de OneNote
var notebook = new Notebook(dataDir + "Notizbuch öffnen.onetoc2");

var notebookSaveOptions = new NotebookImageSaveOptions(SaveFormat.Png);

var documentSaveOptions = notebookSaveOptions.DocumentSaveOptions;

documentSaveOptions.Resolution = 400;
notebookSaveOptions.Flatten = true;

dataDir = dataDir + "ConvertToImageAsFlattenedNotebook_out.png";

// Guardar el cuaderno
notebook.Save(dataDir, notebookSaveOptions);

Muestra cómo eliminar una sección de un bloc de notas.

// La ruta al directorio de documentos.
string dataDir = RunExamples.GetDataDir_NoteBook();

// Cargar un cuaderno de OneNote
var notebook = new Notebook(dataDir + "test.onetoc2");

// Atraviesa sus nodos secundarios para buscar el elemento secundario deseado
foreach (var child in new List<INotebookChildNode>(notebook))
{
    if (child.DisplayName == "Remove Me")
    {
        // Eliminar el elemento secundario del cuaderno
        notebook.RemoveChild(child);
    }
}

dataDir = dataDir + "RemoveChildNode_out.onetoc2";

// Guardar el cuaderno
notebook.Save(dataDir);

Muestra cómo iterar a través de documentos precargados de un cuaderno.

// Por defecto, la carga de niños es "perezosa".
// Por lo tanto, para carga instantánea ha tenido lugar,
// es necesario establecer el indicador NotebookLoadOptions.InstantLoading.
NotebookLoadOptions loadOptions = new NotebookLoadOptions { InstantLoading = true };

String inputFile = "Notizbuch öffnen.onetoc2";
String dataDir = RunExamples.GetDataDir_NoteBook();
Notebook notebook = new Notebook(dataDir + inputFile, loadOptions);

// Todos los documentos secundarios ya están cargados.
foreach (INotebookChildNode notebookChildNode in notebook.OfType<Document>()) 
{
   // Hacer algo con el documento secundario
}

Muestra cómo pasar el contenido de un bloc de notas.

// La ruta al directorio de documentos.
string dataDir = RunExamples.GetDataDir_LoadingAndSaving();
string fileName = "Open Notebook.onetoc2";
try
{
    var notebook = new Notebook(dataDir + fileName);
    foreach (var notebookChildNode in notebook)
    {
        Console.WriteLine(notebookChildNode.DisplayName);
        if (notebookChildNode is Document)
        {
            // Hacer algo con el documento secundario
        }
        else if (notebookChildNode is Notebook)
        {
            // Hacer algo con el cuaderno del niño
        }
    }
}
catch (Exception ex)
{
    Console.WriteLine(ex.Message);
}

Ver también