Class Notebook

Namespace

LinqToOneNote

Assembly

LinqToOneNote.dll

Represents a notebook in OneNote.

public class Notebook : OneNoteItem, INotebookOrSectionGroup, INameInvalidCharacters, IHasPath, IHasColor, IOneNoteItem, INavigable

Inheritance

object

OneNoteItem

Notebook

Implements

INotebookOrSectionGroup

INameInvalidCharacters

IHasPath

IHasColor

IOneNoteItem

INavigable

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Extension Methods

Extensions.Open(INavigable)

Extensions.Sync(INavigable)

Extensions.CreateSection(INotebookOrSectionGroup, string, OpenMode)

Extensions.CreateSectionGroup(INotebookOrSectionGroup, string, OpenMode)

Extensions.DeleteOrClose(IOneNoteItem, DateTime, bool, bool)

Extensions.GetRelativePath(IOneNoteItem, bool, string)

Extensions.IsInRecycleBin(IOneNoteItem)

Extensions.ItemEquals(IOneNoteItem, IOneNoteItem)

Extensions.Rename(IOneNoteItem, string)

Extensions.TryGetNotebook(IOneNoteItem, out Notebook)

LinqExtensions.AfterSelf(IOneNoteItem)

LinqExtensions.AfterSelf(IOneNoteItem, Func<IOneNoteItem, bool>)

LinqExtensions.Ancestors(IOneNoteItem)

LinqExtensions.Ancestors(IOneNoteItem, Func<IOneNoteItem, bool>)

LinqExtensions.BeforeSelf(IOneNoteItem)

LinqExtensions.BeforeSelf(IOneNoteItem, Func<IOneNoteItem, bool>)

LinqExtensions.Descendants(IOneNoteItem)

LinqExtensions.Descendants(IOneNoteItem, Func<IOneNoteItem, bool>)

LinqExtensions.GetAllPages(IOneNoteItem)

LinqExtensions.GetAllPages(IOneNoteItem, Func<IOneNoteItem, bool>)

Extensions.Close(Notebook, bool)

Extensions.GetRecycleBin(Notebook, out SectionGroup)

Properties

Children

The direct children of the notebook, containing its sections and section groups.

public IReadOnlyList<IOneNoteItem> Children { get; }

Property Value

IReadOnlyList<IOneNoteItem>

Color

The color of the notebook.

public Color? Color { get; }

Property Value

Color?

DisplayName

The display name of the notebook. Differs from Name as it may contain characters that are invalid for folder names. Furthermore, Name represents the folder name of the notebook on disk.

public string DisplayName { get; }

Property Value

string

Id

The id of the OneNote hierarchy item.

public string Id { get; }

Property Value

string

InvalidCharacters

A collection containing the characters that are not allowed in a notebook name.
These are: \ / * ? " | < > : % # .

public static IReadOnlyList<char> InvalidCharacters { get; }

Property Value

IReadOnlyList<char>

See Also

IsValidName<THierarchyItem>(string)

IsUnread

Indicates whether the OneNote hierarchy item has unread information.

public bool IsUnread { get; }

Property Value

bool

LastModified

The time when the OneNote hierarchy item was last modified.

public DateTime LastModified { get; }

Property Value

DateTime

Name

The name of the notebook. This is the name of the folder in which the notebook contents are contained.

public string Name { get; }

Property Value

string

Path

The full path to the notebook.

public string Path { get; }

Property Value

string

SectionGroups

The section groups that this notebook contains (direct children only).

public IReadOnlyList<SectionGroup> SectionGroups { get; }

Property Value

IReadOnlyList<SectionGroup>

Sections

The sections that this notebook contains (direct children only).

public IReadOnlyList<Section> Sections { get; }

Property Value

IReadOnlyList<Section>