Work, Extract or Replace Text in OneNote Document using C# API

Extract Text from OneNote Document

One of the tasks that developers need to perform is extracting text from an OneNote document. Aspose.Note for .NET allows developers to extract text from OneNote document in various ways.

Aspose.Note for .NET offers the Document class that represents the OneNote file. The simple LINQ can be used to extract text from the OneNote document.

Extracting All Text from OneNote Document

This example works as follows:

1. Create an object of the Document class.
2. Call the LINQ-based Code to extract text
3. Display text on the output screen.

The following code example demonstrates how to extract all text from the OneNote document.

// The path to the documents directory.
string dataDir = RunExamples.GetDataDir_Text();

// Load the document into Aspose.Note.
Document oneFile = new Document(dataDir + "Aspose.one");

// Retrieve text
string text = string.Join(Environment.NewLine, oneFile.GetChildNodes<RichText>().Select(e => e.Text)) + Environment.NewLine;

// Print text on the output screen
Console.WriteLine(text);

Extracting Text from a Specified Page of OneNote Document

This example works as follows:

1. Create an object of the Document class.
2. Filter out a list of page nodes.
3. Retrieve the page node by index.
4. Call the LINQ-based Code to extract text
5. Display the text on the output screen.

The following code example demonstrates how to extract text from a specified page in OneNote document.

// The path to the documents directory.
string dataDir = RunExamples.GetDataDir_Text();

// Load the document into Aspose.Note.
Document oneFile = new Document(dataDir + "Aspose.one");

// Get list of page nodes
IList<Node> nodes = oneFile.GetChildNodes<Node>();

if (nodes.Count > 0 && nodes[0].NodeType == NodeType.Page)
{
    Page page = (Page)nodes[0];
    // Retrieve text
    string text = string.Join(Environment.NewLine, page.GetChildNodes<RichText>().Select(e => e.Text)) + Environment.NewLine;
    // Print text on the output screen
    Console.WriteLine(text);
}

Replace Text in Pages of OneNote Document

Aspose.Note for .NET supports finding and then replacing text within OneNote document. Aspose.Note for .NET offers the Document class that represents the OneNote file.

Replace Text on All Pages

The following code example demonstrates how to replace text on all pages.

// The path to the documents directory.
string dataDir = RunExamples.GetDataDir_Text();

Dictionary<string, string> replacements = new Dictionary<string, string>();
replacements.Add("Some task here", "New Text Here");

// Load the document into Aspose.Note.
Document oneFile = new Document(dataDir + "Aspose.one");

// Get all RichText nodes
IList<RichText> textNodes = oneFile.GetChildNodes<RichText>();

foreach (RichText richText in textNodes)
{
    foreach (KeyValuePair<string, string> kvp in replacements)
    {
        if (richText != null && richText.Text.Contains(kvp.Key))
        {
            // Replace text of a shape
            richText.Text = richText.Text.Replace(kvp.Key, kvp.Value);
        }
    }
}

dataDir = dataDir + "ReplaceTextOnAllPages_out.pdf";

// Save to any supported file format
oneFile.Save(dataDir, SaveFormat.Pdf);

Replace Text on a Particular Page

The following code example demonstrates how to replace text on a particular page.

// The path to the documents directory.
string dataDir = RunExamples.GetDataDir_Text();

Dictionary<string, string> replacements = new Dictionary<string, string>();
replacements.Add("voice over", "voice over new text");

// Load the document into Aspose.Note.
Document oneFile = new Document(dataDir + "Aspose.one");

IList<Page> pageNodes = oneFile.GetChildNodes<Page>();


// Get all RichText nodes
IList<RichText> textNodes = pageNodes[0].GetChildNodes<RichText>();

foreach (RichText richText in textNodes)
{
    foreach (KeyValuePair<string, string> kvp in replacements)
    {
        if (richText != null && richText.Text.Contains(kvp.Key))
        {
            // Replace text of a shape
            richText.Text = richText.Text.Replace(kvp.Key, kvp.Value);
        }
    }
}
dataDir = dataDir + "ReplaceTextOnParticularPage_out.pdf";
// Save to any supported file format
oneFile.Save(dataDir, SaveFormat.Pdf);

Retrieve Bullet or Number List Properties

Aspose.Note for .NET provides comprehensive support for Microsoft OneNote lists. Developers can access a number of list properties, such as font name, numbering format, and many others.

Retrieving Properties

Aspose.Note for .NET offers the OutlineElement class that represents an outline inside a OneNote document. The OutlineElement class exposes the NumberList property that can be called to extract bullet or numbered list properties. The following example shows how to extract bullet or numbered list properties from a OneNote document.

string dataDir = RunExamples.GetDataDir_Text();

// Load the document into Aspose.Note.
Document oneFile = new Document(dataDir + "ApplyNumberingOnText.one");

// Retrieve a collection nodes of the outline element
IList<OutlineElement> nodes = oneFile.GetChildNodes<OutlineElement>();

// Iterate through each node
foreach (OutlineElement node in nodes)
{
    if (node.NumberList != null)
    {
        NumberList list = node.NumberList;
        // Retrieve font name
        Console.WriteLine("Font Name: " + list.Font);
        // Retrieve font length
        Console.WriteLine("Font Length: " + list.Font.Length);
        // Retrieve font size
        Console.WriteLine("Font Size: " + list.FontSize);
        // Retrieve font color
        Console.WriteLine("Font Color: " + list.FontColor);
        // Retrieve format
        Console.WriteLine("Font format: " + list.Format);
        // Check bold
        Console.WriteLine("Is bold: " + list.IsBold);
        // Check italic
        Console.WriteLine("Is italic: " + list.IsItalic);
        Console.WriteLine();
    }
}

Apply Bullets on the Text

Arranging texts in bullet form is a very common approach. Aspose.Note for .NET APIs allows developers to arrange text items in bullets.

Aspose.Note for .NET offers the Document class that represents a OneNote file. Writing text to a OneNote document page involves creating an OutlineElement, which offers NumberList property to define the bullet.

Please see a brief description to add and apply bullets on the text in OneNote document using the Aspose.Note APIs:

1. Create an instance of the Document class that represents a OneNote document.
2. Initialize three objects of Page class and set their levels.
3. Initialize the objects of Outline, OutlineElement and RichText classes. Setting the NumberList property of the OutlineElement class adds bullets.
4. The ParagraphStyle class defines the text formatting.
5. Generate the OneNote document by calling the Save method of the Document object.

The following code example demonstrates how to apply a bullet on the OneNote document.

string dataDir = RunExamples.GetDataDir_Text();

// Create an object of the Document class
Aspose.Note.Document doc = new Aspose.Note.Document();
// Initialize Page class object
Aspose.Note.Page page = new Aspose.Note.Page(doc);
// Initialize Outline class object
Outline outline = new Outline(doc);
// Initialize TextStyle class object and set formatting properties
ParagraphStyle defaultStyle = new ParagraphStyle { FontColor = Color.Black, FontName = "Arial", FontSize = 10 };

// Initialize OutlineElement class objects and apply bullets
OutlineElement outlineElem1 = new OutlineElement(doc) { NumberList = new NumberList("*", "Arial", 10) };
// Initialize RichText class object and apply text style
RichText text1 = new RichText(doc) { Text = "First", ParagraphStyle = defaultStyle };
outlineElem1.AppendChildLast(text1);

OutlineElement outlineElem2 = new OutlineElement(doc) { NumberList = new NumberList("*", "Arial", 10) };
RichText text2 = new RichText(doc) { Text = "Second", ParagraphStyle = defaultStyle };
outlineElem2.AppendChildLast(text2);

OutlineElement outlineElem3 = new OutlineElement(doc) { NumberList = new NumberList("*", "Arial", 10) };
RichText text3 = new RichText(doc) { Text = "Third", ParagraphStyle = defaultStyle };
outlineElem3.AppendChildLast(text3);

// Add outline elements
outline.AppendChildLast(outlineElem1);
outline.AppendChildLast(outlineElem2);
outline.AppendChildLast(outlineElem3);

// Add Outline node
page.AppendChildLast(outline);
// Add Page node
doc.AppendChildLast(page);

dataDir = dataDir + "ApplyBulletsOnText_out.one"; 
// Save OneNote document
doc.Save(dataDir);

Apply Numbering on the Text

Arranging texts in numbering form is a very common approach. Aspose.Note for .NET APIs allows developers to arrange text items in numbering.

Aspose.Note for .NET offers the Document class that represents a OneNote file. Writing text to a OneNote document page involves creating an OutlineElement, which offers NumberList property to define the bullet.

Please see a brief description to add and apply bullets on the text in OneNote document using the Aspose.Note APIs:

1. Create an instance of the Document class that represents a OneNote document.
2. Initialize three objects of Page class and set their levels.
3. Initialize the objects of Outline, OutlineElement and RichText classes. Setting the NumberList property of the OutlineElement class adds bullets.
4. The ParagraphStyle class defines the text formatting.
5. Generate the OneNote document by calling the Save method of the Document object.

The following code example demonstrates how to apply a bullet on the OneNote document.

string dataDir = RunExamples.GetDataDir_Text();
            
// Create an object of the Document class
Document doc = new Document();
            
// Initialize Page class object
Aspose.Note.Page page = new Aspose.Note.Page(doc);
            
// Initialize Outline class object
Outline outline = new Outline(doc);

// Initialize TextStyle class object and set formatting properties
ParagraphStyle defaultStyle = new ParagraphStyle { FontColor = Color.Black, FontName = "Arial", FontSize = 10 };

// Initialize OutlineElement class objects and apply numbering
// Numbers in the same outline are automatically incremented.
OutlineElement outlineElem1 = new OutlineElement(doc) { NumberList = new NumberList("{0})", NumberFormat.DecimalNumbers, "Arial", 10) };
RichText text1 = new RichText(doc) { Text = "First", ParagraphStyle = defaultStyle };
outlineElem1.AppendChildLast(text1);

OutlineElement outlineElem2 = new OutlineElement(doc) { NumberList = new NumberList("{0})", NumberFormat.DecimalNumbers, "Arial", 10) };
RichText text2 = new RichText(doc) { Text = "Second", ParagraphStyle = defaultStyle };
outlineElem2.AppendChildLast(text2);

OutlineElement outlineElem3 = new OutlineElement(doc) { NumberList = new NumberList("{0})", NumberFormat.DecimalNumbers, "Arial", 10) };
RichText text3 = new RichText(doc) { Text = "Third", ParagraphStyle = defaultStyle };
outlineElem3.AppendChildLast(text3);

// Add outline elements
outline.AppendChildLast(outlineElem1);
outline.AppendChildLast(outlineElem2);
outline.AppendChildLast(outlineElem3);

// Add Outline node
page.AppendChildLast(outline);
// Add Page node
doc.AppendChildLast(page);

dataDir = dataDir + "ApplyNumberingOnText_out.one"; 
// Save OneNote document
doc.Save(dataDir);

Insert Chinese Number List in the OneNote Document

Aspose.Note for .NET APIs support inserting the Chinese number list in the OneNote document.

Aspose.Note for .NET offers the Document class that represents the OneNote file. Inserting the Chinese number list to the OneNote document page involves creating an OutlineElement, which offers NumberList property to define the bullet.

Please see a brief description to add and apply bullets on the text in OneNote document using the Aspose.Note APIs:

1. Create an instance of the Document class that represents the OneNote document.
2. Initialize three objects of Page class and set their levels.
3. Initialize the objects of Outline, OutlineElement, and RichText classes. Setting the NumberList property with Chinese counting format of the OutlineElement class adds bullets.
4. The ParagraphStyle class defines the text formatting.
5. Generate the OneNote document by calling the Save method of the Document object.

The following code example demonstrates how to apply a bullet on the OneNote document.

string dataDir = RunExamples.GetDataDir_Text();

// Initialize OneNote document
Aspose.Note.Document doc = new Aspose.Note.Document();
// Initialize OneNote page
Aspose.Note.Page page = new Aspose.Note.Page(doc);
Outline outline = new Outline(doc);
// Apply text style settings
ParagraphStyle defaultStyle = new ParagraphStyle { FontColor = Color.Black, FontName = "Arial", FontSize = 10 };

// Numbers in the same outline are automatically incremented.
OutlineElement outlineElem1 = new OutlineElement(doc) { NumberList = new NumberList("{0})", NumberFormat.ChineseCounting, "Arial", 10) };
RichText text1 = new RichText(doc) { Text = "First", ParagraphStyle = defaultStyle };
outlineElem1.AppendChildLast(text1);
//------------------------
OutlineElement outlineElem2 = new OutlineElement(doc) { NumberList = new NumberList("{0})", NumberFormat.ChineseCounting, "Arial", 10) };
RichText text2 = new RichText(doc) { Text = "Second", ParagraphStyle = defaultStyle };
outlineElem2.AppendChildLast(text2);
//------------------------
OutlineElement outlineElem3 = new OutlineElement(doc) { NumberList = new NumberList("{0})", NumberFormat.ChineseCounting, "Arial", 10) };
RichText text3 = new RichText(doc) { Text = "Third", ParagraphStyle = defaultStyle };
outlineElem3.AppendChildLast(text3);
//------------------------
outline.AppendChildLast(outlineElem1);
outline.AppendChildLast(outlineElem2);
outline.AppendChildLast(outlineElem3);
page.AppendChildLast(outline);
doc.AppendChildLast(page);

dataDir = dataDir + "InsertChineseNumberList_out.one"; 
// Save OneNote document
doc.Save(dataDir);

Creating Page Title in MS OneNote Style

Aspose.Note for .NET allows creating a page tile in default MS OneNote Style. The DefaultMsOneNoteTitleTextStyle property of the TextStyle class can be used to set the page title for this purpose.

Setting Page Title in Microsoft OneNote Style

string dataDir = RunExamples.GetDataDir_Text();
string outputPath = dataDir + "CreateTitleMsStyle_out.one";

var doc = new Document();
var page = new Page(doc);

page.Title = new Title(doc)
{
    TitleText = new RichText(doc)
    {
        Text = "Title text.",
        ParagraphStyle = ParagraphStyle.Default
    },
    TitleDate = new RichText(doc)
    {
        Text = new DateTime(2011, 11, 11).ToString("D", CultureInfo.InvariantCulture),
        ParagraphStyle = ParagraphStyle.Default
    },
    TitleTime = new RichText(doc)
    {
        Text = "12:34",
        ParagraphStyle = ParagraphStyle.Default
    }
};

doc.AppendChildLast(page);

doc.Save(outputPath);