Class Notebook

Notebook class

Представляет записную книжку Aspose.Note.

public class Notebook : IEnumerable<INotebookChildNode>, INotebookChildNode

Конструкторы

ИмяОписание
Notebook()Инициализирует новый экземплярNotebook класс.
Notebook(Stream)Инициализирует новый экземплярNotebook class. Открывает существующую записную книжку OneNote из потока.
Notebook(string)Инициализирует новый экземплярNotebook class. Открывает существующую записную книжку OneNote из файла.
Notebook(Stream, NotebookLoadOptions)Инициализирует новый экземплярNotebook class. Открывает существующую записную книжку OneNote из потока. Позволяет указать дополнительные параметры загрузки.
Notebook(string, NotebookLoadOptions)Инициализирует новый экземплярNotebook class. Открывает существующую записную книжку OneNote из файла. Позволяет указать дополнительные параметры, такие как стратегия загрузки детей («ленивый»/мгновенный).

Характеристики

ИмяОписание
Color { get; set; }Получает или задает цвет.
Count { get; }Получает количество элементов, содержащихся вNotebook .
DisplayName { get; set; }Получает или задает отображаемое имя.
FileFormat { get; }Получает формат файла (OneNote 2010, OneNote Online).
Guid { get; }Получает глобально уникальный идентификатор объекта.
IsHistoryEnabled { get; set; }Получает или задает значение, указывающее, включена ли история.
Item { get; }Получает дочерний узел ноутбука по заданному индексу.

Методы

ИмяОписание
AppendChild(INotebookChildNode)Добавляет узел в конец списка.
GetChildNodes<T1>()Получить все дочерние узлы по типу узла.
GetEnumerator()Возвращает перечислитель, который перебирает дочерние узлыNotebook .
LoadChildDocument(Stream)Добавляет узел дочернего документа. Открывает существующий документ OneNote из потока.
LoadChildDocument(string)Добавляет узел дочернего документа. Открывает существующий документ OneNote из файла.
LoadChildDocument(Stream, LoadOptions)Добавляет дочерний узел документа. Открывает существующий документ OneNote из потока. Позволяет указать дополнительные параметры загрузки.
LoadChildDocument(string, LoadOptions)Добавляет дочерний узел документа. Открывает существующий документ OneNote из файла. Позволяет указать дополнительные параметры загрузки.
LoadChildNotebook(Stream)Добавляет узел дочерней записной книжки. Открывает существующую записную книжку OneNote из потока.
LoadChildNotebook(string)Добавляет узел дочерней записной книжки. Открывает существующую записную книжку OneNote из файла.
LoadChildNotebook(Stream, NotebookLoadOptions)Добавляет узел дочерней записной книжки. Открывает существующую записную книжку OneNote из потока. Позволяет указать дополнительные параметры загрузки.
LoadChildNotebook(string, NotebookLoadOptions)Добавляет узел дочерней записной книжки. Открывает существующую записную книжку OneNote из файла. Позволяет указать дополнительные параметры загрузки.
RemoveChild(INotebookChildNode)Удаляет дочерний узел.
Save(Stream)Сохраняет документ OneNote в поток.
Save(string)Сохраняет документ OneNote в файл.
Save(Stream, NotebookSaveOptions)Сохраняет документ OneNote в поток, используя указанные параметры сохранения.
Save(Stream, SaveFormat)Сохраняет документ OneNote в поток в указанном формате.
Save(string, NotebookSaveOptions)Сохраняет документ OneNote в файл, используя указанные параметры сохранения.
Save(string, SaveFormat)Сохраняет документ OneNote в файл в указанном формате.

Примеры

Показывает, как сохранить блокнот.

// Путь к каталогу документов.
string dataDir = RunExamples.GetDataDir_NoteBook();

var notebook = new Notebook();

dataDir = dataDir + "test_out.onetoc2";

// Сохраняем блокнот
notebook.Save(dataDir);

Показывает, как сохранить блокнот в формате pdf.

// Путь к каталогу документов.
string dataDir = RunExamples.GetDataDir_NoteBook();

// Загрузить блокнот OneNote
var notebook = new Notebook(dataDir + "Notizbuch �ffnen.onetoc2");

dataDir = dataDir + "ConvertToPDF_out.pdf";

// Сохраняем блокнот
notebook.Save(dataDir);

Показывает, как сохранить блокнот как изображение.

// Путь к каталогу документов.
string dataDir = RunExamples.GetDataDir_NoteBook();

// Загрузить блокнот OneNote
var notebook = new Notebook(dataDir + "Notizbuch �ffnen.onetoc2");

dataDir = dataDir + "ConvertToImage_out.png";

// Сохраняем блокнот
notebook.Save(dataDir);

Показывает, как получить весь текст из записной книжки.

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);
}

Показывает, как сохранить плоский блокнот в формате pdf.

// Путь к каталогу документов.
string dataDir = RunExamples.GetDataDir_NoteBook();

// Загрузить блокнот OneNote
var notebook = new Notebook(dataDir + "Notizbuch �ffnen.onetoc2");

// Сохраняем блокнот
dataDir = dataDir + "ConvertToPDFAsFlattened_out.pdf";
notebook.Save(
    dataDir,
    new NotebookPdfSaveOptions
    {
        Flatten = true
    });

Показывает, как перебирать документы блокнота, загружая их лениво.

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

// По умолчанию загрузка детей «ленивая».
Notebook notebook = new Notebook(dataDir + inputFile);

foreach (var notebookChildNode in notebook.OfType<Document>()) 
{
    // Фактическая загрузка дочернего документа происходит только здесь.
    // Делаем что-то с дочерним документом
}

Показывает, как добавить новый раздел в записную книжку.

// Путь к каталогу документов.
string dataDir = RunExamples.GetDataDir_NoteBook();

// Загрузить блокнот OneNote
var notebook = new Notebook(dataDir + "Notizbuch �ffnen.onetoc2");

// Добавляем новый дочерний элемент в Блокнот
notebook.AppendChild(new Document(dataDir + "Neuer Abschnitt 1.one"));

dataDir = dataDir + "AddChildNode_out.onetoc2";

// Сохраняем блокнот
notebook.Save(dataDir);

Показывает, как загрузить блокнот из потока.

// Путь к каталогу документов.
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");

Показывает, как зашифровать блокнот.

// Путь к каталогу документов.
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" });

Показывает, как сохранить записную книжку как изображение с указанными параметрами.

// Путь к каталогу документов.
string dataDir = RunExamples.GetDataDir_NoteBook();

// Загрузить блокнот 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";

// Сохраняем блокнот
notebook.Save(dataDir, notebookSaveOptions);

Показывает, как сохранить плоский блокнот как изображение.

// Путь к каталогу документов.
string dataDir = RunExamples.GetDataDir_NoteBook();

// Загрузить блокнот 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";

// Сохраняем блокнот
notebook.Save(dataDir, notebookSaveOptions);

Показывает, как удалить раздел из блокнота.

// Путь к каталогу документов.
string dataDir = RunExamples.GetDataDir_NoteBook();

// Загрузить блокнот OneNote
var notebook = new Notebook(dataDir + "test.onetoc2");

// Проходим через его дочерние узлы для поиска нужного дочернего элемента
foreach (var child in new List<INotebookChildNode>(notebook))
{
    if (child.DisplayName == "Remove Me")
    {
        // Удалить дочерний элемент из блокнота
        notebook.RemoveChild(child);
    }
}

dataDir = dataDir + "RemoveChildNode_out.onetoc2";

// Сохраняем блокнот
notebook.Save(dataDir);

Показывает, как перебирать предварительно загруженные документы записной книжки.

// По умолчанию загрузка детей «ленивая».
// Поэтому для мгновенной загрузки произошла,
// необходимо установить флаг 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);

// Все дочерние документы уже загружены.
foreach (INotebookChildNode notebookChildNode in notebook.OfType<Document>()) 
{
   // Делаем что-то с дочерним документом
}

Показывает, как пройти через содержимое записной книжки.

// Путь к каталогу документов.
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)
        {
            // Делаем что-то с дочерним документом
        }
        else if (notebookChildNode is Notebook)
        {
            // Делаем что-нибудь с дочерним блокнотом
        }
    }
}
catch (Exception ex)
{
    Console.WriteLine(ex.Message);
}

Смотрите также