Create Bookmark In Word Document

In this article, we will explore the C# source code above to understand how to use the Create Bookmark function in the Aspose.Words for .NET library. This feature allows you to create bookmarks in a document and specify bookmark preview levels in an output PDF file.

Prerequisites

  • Basic knowledge of the C# language.
  • .NET development environment with Aspose.Words library installed.

Step 1: Creating the Document and Generator

Before creating bookmarks, we need to create a document and a document builder using the Document and DocumentBuilder objects:

string dataDir = "YOUR DOCUMENT DIRECTORY";
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);

Step 2: Creating the main bookmark

We use the StartBookmark method to start a main bookmark and the EndBookmark method to end it. In between, we can add text and other bookmarks:

builder. StartBookmark("My Bookmark");
builder.Writeln("Text inside a bookmark.");

// Add more bookmarks or text here.

builder. EndBookmark("My Bookmark");

Step 3: Creating Nested Bookmarks

We can also create nested bookmarks inside a main bookmark. We use the same StartBookmark and EndBookmark methods to create and end nested bookmarks:

builder.StartBookmark("Embedded bookmark");
builder.Writeln("Text inside nested bookmark.");
builder.EndBookmark("Embedded bookmark");

Step 4: Specifying bookmark preview levels in the output PDF file

We use the PdfSaveOptions object to specify the bookmark preview levels in the output PDF file. We use the BookmarksOutlineLevels property

to add main bookmarks and nested bookmarks with their respective levels:

PdfSaveOptions options = new PdfSaveOptions();
options.OutlineOptions.BookmarksOutlineLevels.Add("My Bookmark", 1);
options.OutlineOptions.BookmarksOutlineLevels.Add("Embedded bookmark", 2);
doc.Save(dataDir + "WorkingWithBookmarks.CreateBookmark.pdf", options);

Example source code for Create Bookmark using Aspose.Words for .NET

Here is the full example source code to demonstrate creating bookmarks using Aspose.Words for .NET:


	// The path to the documents directory.
	string dataDir = "YOUR DOCUMENT DIRECTORY";
	Document doc = new Document();
	DocumentBuilder builder = new DocumentBuilder(doc);

	builder.StartBookmark("My Bookmark");
	builder.Writeln("Text inside a bookmark.");

	builder.StartBookmark("Nested Bookmark");
	builder.Writeln("Text inside a NestedBookmark.");
	builder.EndBookmark("Nested Bookmark");

	builder.Writeln("Text after Nested Bookmark.");
	builder.EndBookmark("My Bookmark");

	PdfSaveOptions options = new PdfSaveOptions();
	options.OutlineOptions.BookmarksOutlineLevels.Add("My Bookmark", 1);
	options.OutlineOptions.BookmarksOutlineLevels.Add("Nested Bookmark", 2);

	doc.Save(dataDir + "WorkingWithBookmarks.CreateBookmark.pdf", options);

Conclusion

In this article, we explored the C# source code to understand how to use the Create Bookmark function of Aspose.Words for .NET. We’ve followed a step-by-step guide to creating bookmarks in a document and specifying bookmark preview levels in an output PDF file.

FAQs

Q: What are the prerequisites to use the “Create bookmarks” function in Aspose.Words for .NET?

A: To use the “Create bookmarks” function in Aspose.Words for .NET, you must have basic knowledge of the C# language. You also need a .NET development environment with the Aspose.Words library installed.

Q: How to create a document in Aspose.Words for .NET?

A: To create a document in Aspose.Words for .NET, you can use the Document class. Here is a sample code:

Document doc = new Document();

Q: How to create a master bookmark in a document using Aspose.Words for .NET?

A: To create a main bookmark in a document using Aspose.Words for .NET, you can use the StartBookmark method to start the bookmark, add text or other bookmarks inside, then use the EndBookmark to end it. Here is a sample code:

builder.StartBookmark("My Bookmark");
builder.Writeln("Text inside bookmark.");
builder.EndBookmark("My Bookmark");

Q: How to create a nested bookmark inside a main bookmark using Aspose.Words for .NET?

A: To create a nested bookmark inside a main bookmark using Aspose.Words for .NET, you can use the same StartBookmark and EndBookmark methods to start and end the nested bookmark. Here is a sample code:

builder.StartBookmark("Embedded bookmark");
builder.Writeln("Text inside nested bookmark.");
builder.EndBookmark("Embedded bookmark");

Q: How to specify bookmark preview levels in an output PDF using Aspose.Words for .NET?

A: To specify bookmark preview levels in an output PDF using Aspose.Words for .NET, you can use the PdfSaveOptions class and the BookmarksOutlineLevels property. You can add main bookmarks and nested bookmarks with their respective levels. Here is a sample code:

PdfSaveOptions options = new PdfSaveOptions();
options.OutlineOptions.BookmarksOutlineLevels.Add("My Bookmark", 1);
options.OutlineOptions.BookmarksOutlineLevels.Add("Embedded bookmark", 2);

Q: How to save a document after creating bookmarks using Aspose.Words for .NET?

A: To save a document after creating bookmarks using Aspose.Words for .NET, you can use the Save method of the Document object specifying the destination file path. Here is a sample code:

doc.Save("path/to/your/output-document.docx");

Q: How to specify bookmark preview levels in an output PDF using Aspose.Words for .NET?

A: To specify bookmark preview levels in an output PDF using Aspose.Words for .NET, you can use the PdfSaveOptions class and the BookmarksOutlineLevels property. You can add main bookmarks and nested bookmarks with their respective levels. Here is a sample code:

PdfSaveOptions options = new PdfSaveOptions();
options.OutlineOptions.BookmarksOutlineLevels.Add("My Bookmark", 1);
options.OutlineOptions.BookmarksOutlineLevels.Add("Embedded bookmark", 2);
doc.Save("path/to/your/output-pdf-file.pdf", options);

Q: How to create nested bookmarks inside a main bookmark using Aspose.Words for .NET?

A: To create nested bookmarks inside a main bookmark using Aspose.Words for .NET, you can use the same StartBookmark and EndBookmark methods to start and end nested bookmarks. Be sure to specify the parent bookmark as a parameter when calling the StartBookmark method. Here is a sample code:

builder.StartBookmark("Main bookmark");
builder.Writeln("Text inside main bookmark.");

builder.StartBookmark("Nested bookmark 1");
builder.Writeln("Text inside first nested bookmark.");
builder.EndBookmark("Nested bookmark 1");

builder.StartBookmark("Nested bookmark 2");
builder.Writeln("Text inside second nested bookmark.");
builder.EndBookmark("Nested bookmark 2");

builder.EndBookmark("Main bookmark");

Q: How to add text inside a bookmark using Aspose.Words for .NET?

A: To add text inside a bookmark using Aspose.Words for .NET, you can use the Write method of the DocumentBuilder object specifying the text to add. Here is a sample code:

builder.StartBookmark("My Bookmark");
builder.Write("Text inside bookmark.");
builder.EndBookmark("My Bookmark");

Q: How to create a master bookmark in a document using Aspose.Words for .NET?

A: To create a main bookmark in a document using Aspose.Words for .NET, you can use the StartBookmark method to start the bookmark and the EndBookmark method to end it. Here is a sample code:

builder.StartBookmark("My Bookmark");
builder.Writeln("Text inside bookmark.");
builder.EndBookmark("My Bookmark");