SetOutlineRemoteDestination

书签大纲

描述

设置大纲项(书签),使其在被单击时打开另一份 PDF

可指定起始页码以及各种大小和位置值

注意:由于目标文档的页面大小未知,所有位置均以打开页面左下角为起点的磅为单位指定

语法

Delphi

Function TPDFlib.SetOutlineRemoteDestination(OutlineID: Integer; Const FileName: WideString; OpenPage, Zoom, DestType: Integer; PntLeft, PntTop, PntRight, PntBottom: Double; NewWindow: Integer): Integer;

ActiveX

Function PDFlib::SetOutlineRemoteDestination(OutlineID As Long, FileName As String, OpenPage As Long, Zoom As Long, DestType As Long, PntLeft As Double, PntTop As Double, PntRight As Double, PntBottom As Double, NewWindow As Long) As Long

DLL

int DLSetOutlineRemoteDestination(int InstanceID, int OutlineID, const wchar_t * FileName, int OpenPage, int Zoom, int DestType, double PntLeft, double PntTop, double PntRight, double PntBottom, int NewWindow);

参数

OutlineID

NewOutline 函数返回的大纲 ID,也可使用 GetOutlineID 函数获取有效的大纲 ID

FileName

点击大纲时要打开的 PDF 文档文件名,此值应采用特定格式,应将反斜杠转换为正斜杠;若指定驱动器,则驱动器应写为两个正斜杠之间且不带冒号的单个驱动器号,例如,文件 "c:\my documents\hello.pdf" 应指定为 "/c/my documents/hello.pdf",相对路径名有效,包括含有用于向上移动一个目录的 ".." 运算符的路径

OpenPage

打开目标文档时要跳转到的页码,第一页的索引为零 (0)

Zoom

文档打开时使用的缩放百分比,有效值为 0 到 6400。仅用于 DestType = 1,其他 DestType 应设为 0

DestType

1 = "XYZ" - 目标页面定位在 Left 和 Top 参数指定的点,Zoom 参数指定缩放百分比

2 = "适合" - 整个页面会缩放以适合窗口。不会使用其他任何参数,应将其设为零

3 = "FitH" - 页面会缩放至完整宽度可见,页面高度可能大于或小于窗口高度,页面将定位在 Top 参数指定的垂直位置

4 = "FitV" - 页面会缩放至可看到整个页面高度。页面宽度可能大于或小于窗口宽度。页面会定位在 Left 参数指定的水平位置

5 = "FitR" - 页面缩放以使页面上的特定矩形可见。Left、Top、Right 和 Bottom 参数定义页面上的矩形区域

6 = "FitB" - 缩放页面,使其'边界框可见

7 = "FitBH" - 页面会在 Top 参数指定的位置垂直定位。页面会缩放,使页面'边界框的整个宽度可见

8 = "FitBV" - 页面定位到 Left 参数指定的水平位置。页面仅缩放至足以使边界框的整个高度适合窗口

PntLeft

DestType = 1、4、5 和 8 使用的水平位置,该位置以目标文档's 页面左下角为起点、以磅为单位指定

PntTop

DestType = 1、3、5 和 7 使用的垂直位置。该位置以距目标文档's页面左下角的点数指定

PntRight

矩形右边缘的水平位置。由 DestType = 5 使用。该位置以距目标文档's 页面左下角的点为单位指定

PntBottom

矩形底边的水平位置。供 DestType = 5 使用。该位置以目标文档's 页面左下角为基准,以点为单位指定

NewWindow

0 = 以目标文档替换当前文档

1 = 在新窗口中打开目标文档,除非用户已在 PDF 查看器中指定其他首选项

返回值

0OutlineID 无效
1已成功设置大纲目标 double PntBottom, int NewWindow)