BookmarksOutlineLevelCollection

BookmarksOutlineLevelCollection class

各个书签大纲级别的集合。

要了解更多信息，请访问使用书签文档文章。

public class BookmarksOutlineLevelCollection : IEnumerable<KeyValuePair<string, int>>

构造函数

姓名描述
BookmarksOutlineLevelCollection()默认构造函数。

特性

姓名描述
Count { get; }获取集合中包含的元素数量。
Item { get; set; }通过书签名称获取或设置书签大纲级别。 (2 indexers)

方法

姓名描述
Add(string, int)将书签添加到集合中。
Clear()从集合中删除所有元素。
Contains(string)确定集合中是否包含具有给定名称的书签。
GetEnumerator()返回一个枚举器对象，可用于迭代集合中的所有项目。
IndexOfKey(string)返回集合中指定书签的从零开始的索引。
Remove(string)从集合中删除具有指定名称的书签。
RemoveAt(int)删除指定索引处的书签。

评论

Key 是不区分大小写的字符串书签名称。值是一个 int 书签大纲级别。

书签大纲级别可以是 0 到 9 之间的值。指定 0，Word 书签将不会显示在文档大纲中。 指定 1，Word 书签将显示在文档大纲中的级别 1； 2 表示级别 2，依此类推。

例子

演示如何设置书签的大纲级别。

Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);

// 插入一个书签，其中嵌套另一个书签。
builder.StartBookmark("Bookmark 1");
builder.Writeln("Text inside Bookmark 1.");

builder.StartBookmark("Bookmark 2");
builder.Writeln("Text inside Bookmark 1 and 2.");
builder.EndBookmark("Bookmark 2");

builder.Writeln("Text inside Bookmark 1.");
builder.EndBookmark("Bookmark 1");

// 插入另一个书签。
builder.StartBookmark("Bookmark 3");
builder.Writeln("Text inside Bookmark 3.");
builder.EndBookmark("Bookmark 3");

// 保存为 .pdf 时，可以通过下拉菜单访问书签，并被大多数读者用作锚点。
// 书签也可以有大纲级别的数值，
// 启用较低级别的大纲条目，以便在阅读器中折叠时隐藏较高级别的子条目。
PdfSaveOptions pdfSaveOptions = new PdfSaveOptions();
BookmarksOutlineLevelCollection outlineLevels = pdfSaveOptions.OutlineOptions.BookmarksOutlineLevels;

outlineLevels.Add("Bookmark 1", 1);
outlineLevels.Add("Bookmark 2", 2);
outlineLevels.Add("Bookmark 3", 3);

Assert.AreEqual(3, outlineLevels.Count);
Assert.True(outlineLevels.Contains("Bookmark 1"));
Assert.AreEqual(1, outlineLevels[0]);
Assert.AreEqual(2, outlineLevels["Bookmark 2"]);
Assert.AreEqual(2, outlineLevels.IndexOfKey("Bookmark 3"));

// 我们可以删除两个元素，以便仅留下“书签 1”的大纲级别指定。
outlineLevels.RemoveAt(2);
outlineLevels.Remove("Bookmark 2");

// 有九个大纲级别。它们的编号将在保存操作期间进行优化。
// 在这种情况下，级别“5”和“9”将变为“2”和“3”。
outlineLevels.Add("Bookmark 2", 5);
outlineLevels.Add("Bookmark 3", 9);

doc.Save(ArtifactsDir + "BookmarksOutlineLevelCollection.BookmarkLevels.pdf", pdfSaveOptions);

// 清空此集合将保留书签并将它们全部放在同一大纲级别上。
outlineLevels.Clear();

也可以看看

ColorMode Enum