Foxit PDF SDK

Public 类型 | Public 成员函数 | 静态 Public 成员函数 | 所有成员列表
foxit.pdf.actions.Destination类 参考
类 foxit.pdf.actions.Destination 继承关系图:

## Public 类型
enum | ZoomMode { ZoomMode.e_ZoomXYZ = 1, ZoomMode.e_ZoomFitPage = 2, ZoomMode.e_ZoomFitHorz = 3, ZoomMode.e_ZoomFitVert = 4, ZoomMode.e_ZoomFitRect = 5, ZoomMode.e_ZoomFitBBox = 6, ZoomMode.e_ZoomFitBHorz = 7, ZoomMode.e_ZoomFitBVert = 8 }
| 缩放模式枚举。 更多...

## Public 成员函数
| Destination (PDFArray dest_array)
| 构造函数，使用指定的PDF数组对象。 更多...
| Destination (Destination other)
| 构造函数，使用另一个目标对象。 更多...
float | GetBottom ()
| 获取底部位置值。 更多...
PDFArray | GetDestArray ()
| 获取目标PDF数组。 更多...
float | GetLeft ()
| 获取左位置值。 更多...
int | GetPageIndex (PDFDoc document)
| 获取目标页面的索引。 更多...
float | GetRight ()
| 获取右侧位置值。 更多...
float | GetTop ()
| 获取顶部位置值。 更多...
float | GetZoomFactor ()
| 获取缩放因子。 更多...
Destination.ZoomMode | GetZoomMode ()
| 获取缩放模式。 更多...
bool | IsEmpty ()
| 检查当前对象是否为空。 更多...
bool | IsLeftNull ()
| 检查左位置值是否为空对象。 更多...
bool | IsTopNull ()
| 检查顶部位置值是否为空对象。 更多...

## 静态 Public 成员函数
static Destination | CreateFitBBox (PDFDoc document, int page_index)
| 为缩放模式foxit.pdf.actions.Destination.ZoomMode.e_ZoomFitBBox 创建目标对象。 更多...
static Destination | CreateFitBHorz (PDFDoc document, int page_index, float top)
| 为缩放模式foxit.pdf.actions.Destination.ZoomMode.e_ZoomFitBHorz 创建目标对象。 更多...
static Destination | CreateFitBVert (PDFDoc document, int page_index, float left)
| 为缩放模式foxit.pdf.actions.Destination.ZoomMode.e_ZoomFitBVert 创建目标对象。 更多...
static Destination | CreateFitHorz (PDFDoc document, int page_index, float top)
| 为缩放模式foxit.pdf.actions.Destination.ZoomMode.e_ZoomFitHorz 创建目标对象。 更多...
static Destination | CreateFitPage (PDFDoc document, int page_index)
| 为缩放模式foxit.pdf.actions.Destination.ZoomMode.e_ZoomFitPage 创建目标对象。 更多...
static Destination | CreateFitRect (PDFDoc document, int page_index, float left, float bottom, float right, float top)
| 为缩放模式foxit.pdf.actions.Destination.ZoomMode.e_ZoomFitRect 创建目标对象。 更多...
static Destination | CreateFitVert (PDFDoc document, int page_index, float left)
| 为缩放模式foxit.pdf.actions.Destination.ZoomMode.e_ZoomFitVert 创建目标对象。 更多...
static Destination | CreateFromPDFArray (PDFDoc document, PDFArray pdf_array)
| 从现有的目标数组创建目标对象。 更多...
static Destination | CreateXYZ (PDFDoc document, int page_index, float left, float top, float zoom_factor)
| 为缩放模式foxit.pdf.actions.Destination.ZoomMode.e_ZoomXYZ 创建目标对象。 更多...

## 详细描述

目标定义了PDF文档的特定视图，包含以下项目：

- 要显示的文档页面。

- 文档窗口在该页面上的位置。

- 显示页面时使用的放大（缩放）因子。

Destinations may be associated with bookmarks, or some types of actions. In each case, the destination specifies the view of the document to be presented when the bookmark item or link annotation is opened or 执行动作时。
此类提供了为不同缩放模式创建目标对象以及获取目标数据的函数。

参见
  foxit.pdf.Bookmark
  foxit.pdf.actions.GotoAction
  foxit.pdf.actions.RemoteGotoAction
  foxit.pdf.actions.EmbeddedGotoAction

## 成员枚举类型说明

## ◆ ZoomMode

enum foxit.pdf.actions.Destination.ZoomMode
| strong

缩放模式枚举。

此枚举的值应单独使用。

枚举值
e_ZoomXYZ | 以指定位置和指定缩放因子显示页面。 如果使用此选项，意味着页面的指定位置将在页面渲染时被视为左上角位置， 此位置应位于显示区域的左上角。页面内容应按指定的缩放因子放大。
e_ZoomFitPage | 在显示页面时使整个页面适合显示区域。 如果使用此选项，意味着页面内容应恰好放大到足以使整个页面在水平和垂直方向 都适合显示区域。如果所需的水平和垂直放大因子不同，使用较小的那个， 并在另一个维度中将页面居中显示在窗口中。
e_ZoomFitHorz | 在显示页面时使页面的整个宽度适合显示区域。 如果使用此选项，意味着页面内容应恰好放大到足以使页面的整个宽度 适合显示区域。
e_ZoomFitVert | 在显示页面时使页面的整个高度适合显示区域。 如果使用此选项，意味着页面内容应恰好放大到足以使页面的整个高度 适合显示区域。
e_ZoomFitRect | 在显示页面时使指定矩形中的页面内容完全适合显示区域。 如果使用此选项，意味着页面内容应恰好放大到足以使指定矩形中的页面内容 在水平和垂直方向都完全适合显示区域。如果所需的水平和垂直放大因子不同， 使用较小的那个，并在另一个维度中将矩形居中显示在显示区域中。
e_ZoomFitBBox | 在显示页面时使页面的边界框完全适合显示区域。 如果使用此选项，意味着页面内容应恰好放大到足以使其边界框在水平和垂直方向 都完全适合显示区域。如果所需的水平和垂直放大因子不同，使用较小的那个， 并在另一个维度中将边界框居中显示在显示区域中。
e_ZoomFitBHorz | 在显示页面时使页面边界框的整个宽度适合显示区域。 如果使用此选项，意味着页面内容应恰好放大到足以使页面边界框的整个宽度 适合显示区域。
e_ZoomFitBVert | 在显示页面时使页面边界框的整个高度适合显示区域。 如果使用此选项，意味着页面内容应恰好放大到足以使页面边界框的整个高度 适合显示区域。

## 构造及析构函数说明

## ◆ Destination() [1/2]

foxit.pdf.actions.Destination.Destination | ( | PDFArray | dest_array | ) |
| inline

构造函数，使用指定的PDF数组对象。

参数

  [in] | dest_array | 表示目标数据的PDF数组对象。

## ◆ Destination() [2/2]

foxit.pdf.actions.Destination.Destination | ( | Destination | other | ) |
| inline

构造函数，使用另一个目标对象。

参数

  [in] | other | 另一个目标对象。

## 成员函数说明

## ◆ CreateFitBBox()

static Destination foxit.pdf.actions.Destination.CreateFitBBox | ( | PDFDoc | document,
|  | int | page_index
| ) |  |
| inline static

为缩放模式foxit.pdf.actions.Destination.ZoomMode.e_ZoomFitBBox 创建目标对象。

参数

  [in] | document | 有效的PDF文档对象。
  [in] | page_index | PDF文档中目标页面的索引。

返回
  新的目标对象。

## ◆ CreateFitBHorz()

static Destination foxit.pdf.actions.Destination.CreateFitBHorz | ( | PDFDoc | document,
|  | int | page_index,
|  | float | top
| ) |  |
| inline static

为缩放模式foxit.pdf.actions.Destination.ZoomMode.e_ZoomFitBHorz 创建目标对象。

参数

  [in] | document | 有效的PDF文档对象。
  [in] | page_index | PDF文档中目标页面的索引。
  [in] | top | 顶边的垂直坐标。

返回
  新的目标对象。

## ◆ CreateFitBVert()

static Destination foxit.pdf.actions.Destination.CreateFitBVert | ( | PDFDoc | document,
|  | int | page_index,
|  | float | left
| ) |  |
| inline static

为缩放模式foxit.pdf.actions.Destination.ZoomMode.e_ZoomFitBVert 创建目标对象。

参数

  [in] | document | 有效的PDF文档对象。
  [in] | page_index | PDF文档中目标页面的索引。
  [in] | left | 左边缘的水平坐标。

返回
  新的目标对象。

## ◆ CreateFitHorz()

static Destination foxit.pdf.actions.Destination.CreateFitHorz | ( | PDFDoc | document,
|  | int | page_index,
|  | float | top
| ) |  |
| inline static

为缩放模式foxit.pdf.actions.Destination.ZoomMode.e_ZoomFitHorz 创建目标对象。

参数

  [in] | document | 有效的PDF文档对象。
  [in] | page_index | PDF文档中目标页面的索引。
  [in] | top | 顶边的垂直坐标。

返回
  新的目标对象。

## ◆ CreateFitPage()

static Destination foxit.pdf.actions.Destination.CreateFitPage | ( | PDFDoc | document,
|  | int | page_index
| ) |  |
| inline static

为缩放模式foxit.pdf.actions.Destination.ZoomMode.e_ZoomFitPage 创建目标对象。

参数

  [in] | document | 有效的PDF文档对象。
  [in] | page_index | PDF文档中目标页面的索引。

返回
  新的目标对象。

## ◆ CreateFitRect()

static Destination foxit.pdf.actions.Destination.CreateFitRect | ( | PDFDoc | document,
|  | int | page_index,
|  | float | left,
|  | float | bottom,
|  | float | right,
|  | float | top
| ) |  |
| inline static

为缩放模式foxit.pdf.actions.Destination.ZoomMode.e_ZoomFitRect 创建目标对象。

参数

  [in] | document | 有效的PDF文档对象。
  [in] | page_index | PDF文档中目标页面的索引。
  [in] | left | 矩形的左坐标。
  [in] | bottom | 矩形的底坐标。
  [in] | right | 矩形的右坐标。
  [in] | top | 矩形的顶坐标。

返回
  新的目标对象。

## ◆ CreateFitVert()

static Destination foxit.pdf.actions.Destination.CreateFitVert | ( | PDFDoc | document,
|  | int | page_index,
|  | float | left
| ) |  |
| inline static

为缩放模式foxit.pdf.actions.Destination.ZoomMode.e_ZoomFitVert 创建目标对象。

参数

  [in] | document | 有效的PDF文档对象。
  [in] | page_index | PDF文档中目标页面的索引。
  [in] | left | 左边缘的水平坐标。

返回
  新的目标对象。

## ◆ CreateFromPDFArray()

static Destination foxit.pdf.actions.Destination.CreateFromPDFArray | ( | PDFDoc | document,
|  | PDFArray | pdf_array
| ) |  |
| inline static

从现有的目标数组创建目标对象。

参数

  [in] | document | 有效的PDF文档对象。
  [in] | pdf_array | 目标PDF数组。此PDF数组可以从类型为foxit.pdf.objects.PDFNameTree.Type.e_Dests 的foxit.pdf.objects.PDFNameTree 中检索。

返回
  新的目标对象。

## ◆ CreateXYZ()

static Destination foxit.pdf.actions.Destination.CreateXYZ | ( | PDFDoc | document,
|  | int | page_index,
|  | float | left,
|  | float | top,
|  | float | zoom_factor
| ) |  |
| inline static

为缩放模式foxit.pdf.actions.Destination.ZoomMode.e_ZoomXYZ 创建目标对象。

参数

  [in] | document | 有效的PDF文档对象。
  [in] | page_index | PDF文档中目标页面的索引。
  [in] | left | 作为页面左上角位置的水平坐标值。
  [in] | top | 作为页面左上角位置的垂直坐标值。
  [in] | zoom_factor | 缩放因子值。

返回
  新的目标对象。

## ◆ GetBottom()

float foxit.pdf.actions.Destination.GetBottom | ( |  | ) |
| inline

获取底部位置值。

此方法仅在缩放模式为foxit.pdf.actions.Destination.ZoomMode.e_ZoomFitRect 时有用。 对于其他缩放模式，此函数将返回0.0f。

返回
  底部位置值。

## ◆ GetDestArray()

PDFArray foxit.pdf.actions.Destination.GetDestArray | ( |  | ) |
| inline

获取目标PDF数组。

返回
  目标PDF数组。如果发生任何错误，此函数将返回null。

## ◆ GetLeft()

float foxit.pdf.actions.Destination.GetLeft | ( |  | ) |
| inline

获取左位置值。

这仅在缩放模式为foxit.pdf.actions.Destination.ZoomMode.e_ZoomXYZ 、foxit.pdf.actions.Destination.ZoomMode.e_ZoomFitVert 、 foxit.pdf.actions.Destination.ZoomMode.e_ZoomFitRect 或foxit.pdf.actions.Destination.ZoomMode.e_ZoomFitBVert 时有用。 特别是对于foxit.pdf.actions.Destination.ZoomMode.e_ZoomXYZ 、foxit.pdf.actions.Destination.ZoomMode.e_ZoomFitVert 和 foxit.pdf.actions.Destination.ZoomMode.e_ZoomFitBVert ，左值可能是一个空对象， 这意味着只需使用应用程序的当前左值作为目标的左值。 在这种情况下，此函数将返回0.0f。为了检查左值是否为0或 空对象，建议用户调用函数Destination.IsLeftNull 。
对于其他缩放模式，此函数将返回0.0f。

返回
  左位置值。

## ◆ GetPageIndex()

int foxit.pdf.actions.Destination.GetPageIndex | ( | PDFDoc | document | ) |
| inline

获取目标页面的索引。

参数

  [in] | document | 有效的PDF文档对象。

返回
  页面索引，从0开始。如果有任何错误，此函数将返回-1。

## ◆ GetRight()

float foxit.pdf.actions.Destination.GetRight | ( |  | ) |
| inline

获取右侧位置值。

此方法仅在缩放模式为foxit.pdf.actions.Destination.ZoomMode.e_ZoomFitRect 时有用。 对于其他缩放模式，此函数将返回0.0f。

返回
  右侧位置值。

## ◆ GetTop()

float foxit.pdf.actions.Destination.GetTop | ( |  | ) |
| inline

获取顶部位置值。

此方法仅在缩放模式为foxit.pdf.actions.Destination.ZoomMode.e_ZoomXYZ 、foxit.pdf.actions.Destination.ZoomMode.e_ZoomFitHorz 、 foxit.pdf.actions.Destination.ZoomMode.e_ZoomFitBHorz 或foxit.pdf.actions.Destination.ZoomMode.e_ZoomFitRect 时有用。 特别地，对于foxit.pdf.actions.Destination.ZoomMode.e_ZoomXYZ 、foxit.pdf.actions.Destination.ZoomMode.e_ZoomFitHorz 和 foxit.pdf.actions.Destination.ZoomMode.e_ZoomFitBHorz ，顶部位置值可能是空对象，这意味着只使用 应用程序的当前顶部位置值作为目标的顶部位置值。在这种情况下， 此函数将返回0.0f。为了检查左位置值是否为0或空对象， 建议用户调用函数Destination.IsTopNull 。
对于其他缩放模式，此函数将返回0.0f。

返回
  顶部位置值。

## ◆ GetZoomFactor()

float foxit.pdf.actions.Destination.GetZoomFactor | ( |  | ) |
| inline

获取缩放因子。

此方法仅在缩放模式为foxit.pdf.actions.Destination.ZoomMode.e_ZoomXYZ 时有用。 对于foxit.pdf.actions.Destination.ZoomMode.e_ZoomXYZ ，如果缩放因子为0， 这意味着只使用应用程序的当前缩放因子作为目标缩放因子。
对于其他缩放模式，此函数将返回0.0f。

返回
  缩放因子。

## ◆ GetZoomMode()

Destination.ZoomMode foxit.pdf.actions.Destination.GetZoomMode | ( |  | ) |
| inline

获取缩放模式。

返回
  缩放模式值。请参考从foxit.pdf.actions.Destination.ZoomMode.e_ZoomXYZ 开始的值， 这将是这些值中的一个。如果没有缩放模式或缩放模式未知，此函数将返回0。

## ◆ IsEmpty()

bool foxit.pdf.actions.Destination.IsEmpty | ( |  | ) |
| inline

检查当前对象是否为空。

当当前对象为空时，意味着当前对象无用。

返回
  true表示当前对象为空，false表示不为空。

## ◆ IsLeftNull()

bool foxit.pdf.actions.Destination.IsLeftNull | ( |  | ) |
| inline

检查左位置值是否为空对象。

此方法仅在缩放模式为foxit.pdf.actions.Destination.ZoomMode.e_ZoomXYZ 、foxit.pdf.actions.Destination.ZoomMode.e_ZoomFitVert 或foxit.pdf.actions.Destination.ZoomMode.e_ZoomFitBVert 时有用。 此函数可用于检查左位置值是否为空对象。 对于其他缩放模式，此函数将返回false。

返回
  true表示左位置值是空对象，false表示左位置值不是空对象， 可以通过函数Destination.GetLeft 获取左位置值。

## ◆ IsTopNull()

bool foxit.pdf.actions.Destination.IsTopNull | ( |  | ) |
| inline

检查顶部位置值是否为空对象。

此方法仅在缩放模式为foxit.pdf.actions.Destination.ZoomMode.e_ZoomXYZ 、foxit.pdf.actions.Destination.ZoomMode.e_ZoomFitHorz 或foxit.pdf.actions.Destination.ZoomMode.e_ZoomFitBHorz 时有用。 此函数可用于检查顶部位置值是否为空对象。 对于其他缩放模式，此函数将返回false。

返回
  true表示顶部位置值是空对象，false表示顶部位置值不是空对象， 可以通过函数Destination.GetTop 获取顶部位置值。