书签不仅可以帮助我们跳转到文档中相应的位置,还可以让我们快速地了解文档所讲述的内容。
这篇文章将介绍如何使用spire.pdf组件给pdf文档添加书签,以及修改和删除现有pdf文档中的指定书签。
添加书签
在spire.pdf中,每个pdf文档都有一个书签列表(pdfbookmarkcollection)。我们可以通过pdfdocument对象的bookmarks属性来获取该列表,然后通过add () 方法将书签添加到列表中。
c#
//新建pdf文档
pdfdocument pdf = new pdfdocument();
//添加页面
pdfpagebase page = pdf.pages.add();
//添加书签
pdfbookmark bookmark = pdf.bookmarks.add("第一页");
//设置书签所指向的页面和位置,(0,0)表示页面的开始位置
bookmark.destination = new pdfdestination(page);
bookmark.destination.location = new pointf(0, 0);
//设置书签的文本格式和颜色
bookmark.displaystyle = pdftextstyle.bold;
bookmark.color = color.black;
//保存文档
pdf.savetofile("bookmark2.pdf");
vb.net
'新建pdf文档
dim pdf as new pdfdocument()
'添加页面
dim page as pdfpagebase = pdf.pages.add()
'添加书签
dim bookmark as pdfbookmark = pdf.bookmarks.add("第一页")
'设置书签所指向的页面和位置,(0,0)表示页面的开始位置
bookmark.destination = new pdfdestination(page)
bookmark.destination.location = new pointf(0, 0)
'设置书签的文本格式和颜色
bookmark.displaystyle = pdftextstyle.bold
bookmark.color = color.black
'保存文档
pdf.savetofile("bookmark2.pdf")
添加子书签
添加子书签和添加普通书签的方式基本一样,不同的是普通书签是直接添加到文档的书签列表里,而子书签则是添加到父书签的列表里。
c#
//新建pdf文档
pdfdocument pdf = new pdfdocument();
//添加页面
pdfpagebase page = pdf.pages.add();
//添加书签
pdfbookmark bookmark = pdf.bookmarks.add("第一章 热传导");
//设置书签指向的页面和位置
bookmark.destination = new pdfdestination(page);
bookmark.destination.location = new pointf(0, 0);
//设置书签的文本格式和颜色
bookmark.displaystyle = pdftextstyle.bold;
bookmark.color = color.seagreen;
//添加子书签
pdfbookmark childbookmark = bookmark.insert(0, "1.1 热传导基本知识");
//设置子书签指向的页面和位置
childbookmark.destination = new pdfdestination(page);
childbookmark.destination.location = new pointf(400, 300);
//设置子书签的文本格式和颜色
childbookmark.displaystyle = pdftextstyle.regular;
childbookmark.color = color.black;
//保存文档
pdf.savetofile("childbookmark.pdf");
vb.net
'新建pdf文档
dim pdf as new pdfdocument()
'添加页面
dim page as pdfpagebase = pdf.pages.add()
'添加书签
dim bookmark as pdfbookmark = pdf.bookmarks.add("第一章 热传导")
'设置书签指向的页面和位置
bookmark.destination = new pdfdestination(page)
bookmark.destination.location = new pointf(0, 0)
'设置书签的文本格式和颜色
bookmark.displaystyle = pdftextstyle.bold
bookmark.color = color.seagreen
'添加子书签
dim childbookmark as pdfbookmark = bookmark.insert(0, "1.1 热传导基本知识")
'设置子书签指向的页面和位置
childbookmark.destination = new pdfdestination(page)
childbookmark.destination.location = new pointf(400, 300)
'设置子书签的文本格式和颜色
childbookmark.displaystyle = pdftextstyle.regular
childbookmark.color = color.black
'保存文档
pdf.savetofile("childbookmark.pdf")
添加书签到现有文档
除了在新建的pdf文档里添加书签,我们还可以给现有的pdf文档添加书签。加载pdf文档的方法除loadfromfile以外,还有loadfromstream (从流加载),loadfromhtml(从html加载)等,可根据自己的需求选择相应的加载方式。
c#
//加载文档
pdfdocument pdf = new pdfdocument();
pdf.loadfromfile("示例.pdf");
for (int i = 0; i < pdf.pages.count; i )
{
//添加书签
pdfbookmark bookmark = pdf.bookmarks.add(string.format("第{0}章", i 1));
//设置书签指向的页面和位置
bookmark.destination = new pdfdestination(pdf.pages[i]);
bookmark.destination.location = new pointf(0, 0);
//设置书签的文本格式和颜色
bookmark.displaystyle = pdftextstyle.bold;
bookmark.color = color.black;
}
//保存文档
pdf.savetofile("bookmark2.pdf");
vb.net
'加载文档
dim pdf as new pdfdocument()
pdf.loadfromfile("示例.pdf")
for i as integer = 0 to pdf.pages.count - 1
'添加书签
dim bookmark as pdfbookmark = pdf.bookmarks.add(string.format("第{0}章", i 1))
'设置书签指向的页面和位置
bookmark.destination = new pdfdestination(pdf.pages(i))
bookmark.destination.location = new pointf(0, 0)
'设置书签的文本格式和颜色
bookmark.displaystyle = pdftextstyle.bold
bookmark.color = color.black
next
'保存文档
pdf.savetofile("bookmark2.pdf")
修改书签
spire.pdf支持多种书签修改方式,例如修改现有书签的内容,插入新书签到现有书签列表,插入子书签到现有书签等。这里我们选取修改书签内容和插入新书签到现有书签列表进行介绍。
修改现有书签内容
c#
//加载文档
pdfdocument pdf = new pdfdocument();
pdf.loadfromfile("bookmark2.pdf");
//获取书签列表
pdfbookmarkcollection bookmarks = pdf.bookmarks;
//获取第一个书签
pdfbookmark bookmark = bookmarks[0];
//修改书签指向的页面
bookmark.destination = new pdfdestination(document.pages[1]);
//修改书签的文本格式和颜色
bookmark.displaystyle = pdftextstyle.bold;
bookmark.color = color.green;
//修改书签的title
bookmark.title = "修改";
//保存文档
pdf.savetofile("modifybookmark.pdf");
vb.net
'加载文档
dim pdf as new pdfdocument()
pdf.loadfromfile("bookmark2.pdf")
'获取书签列表
dim bookmarks as pdfbookmarkcollection = pdf.bookmarks
'获取第一个书签
dim bookmark as pdfbookmark = bookmarks(0)
'修改书签指向的页面
bookmark.destination = new pdfdestination(document.pages(1))
'修改书签的文本格式和颜色
bookmark.displaystyle = pdftextstyle.bold
bookmark.color = color.green
'修改书签的title
bookmark.title = "修改"
'保存文档
pdf.savetofile("modifybookmark.pdf")
插入新书签到现有书签列表
c#
//加载文档
pdfdocument pdf = new pdfdocument();
pdf.loadfromfile("bookmark2.pdf");
//插入新书签到指定位置
pdfbookmark bookmark = pdf.bookmarks.insert(2, "新增第三章");
//设置书签所指向的页面和位置
bookmark.destination = new pdfdestination(document.pages[1]);
bookmark.destination.location = new pointf(0, 300);
//保存文档
pdf.savetofile("insertbookmark.pdf");
vb.net
'加载文档
dim pdf as new pdfdocument()
pdf.loadfromfile("bookmark2.pdf")
'插入新书签到指定位置
dim bookmark as pdfbookmark = pdf.bookmarks.insert(2, "新增第三章")
'设置书签所指向的页面和位置
bookmark.destination = new pdfdestination(document.pages(1))
bookmark.destination.location = new pointf(0, 300)
'保存文档
pdf.savetofile("insertbookmark.pdf")
删除书签
c#
删除书签时,可以使用书签的序号,也可以使用书签的名称。这里所使用的是序号的方式。
//加载文档
pdfdocument pdf = new pdfdocument();
pdf.loadfromfile("bookmark2.pdf");
//获取所有书签
pdfbookmarkcollection bookmarks = document.bookmarks;
//删除第一个书签
bookmarks.removeat(0);
//保存文档
pdf.savetofile("deletebookmark.pdf");
vb.net
'加载文档
dim pdf as new pdfdocument()
pdf.loadfromfile("bookmark2.pdf")
'获取所有书签
dim bookmarks as pdfbookmarkcollection = document.bookmarks
'删除第一个书签
bookmarks.removeat(0)
'保存文档
pdf.savetofile("deletebookmark.pdf")